blob: 7d588dc51081c9f33fbde3b14ecd17aa04903134 [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*options.txt* For Vim version 8.1. Last change: 2018 May 15
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 Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 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).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100405 {not available when compiled without the |+eval|
406 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
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
420NOTE: expanding environment variables and "~/" is only done with the ":set"
421command, not when assigning a value to an option with ":let".
422
Bram Moolenaarc572da52017-08-27 16:52:01 +0200423 *$HOME-windows*
424On MS-Windows, if $HOME is not defined as an environment variable, then
425at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200426If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428This expanded value is not exported to the environment, this matters when
429running an external command: >
430 :echo system('set | findstr ^HOME=')
431and >
432 :echo luaeval('os.getenv("HOME")')
433should echo nothing (an empty string) despite exists('$HOME') being true.
434When setting $HOME to a non-empty string it will be exported to the
435subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200436
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Note the maximum length of an expanded option is limited. How much depends on
439the system, mostly it is something like 256 or 1024 characters.
440
441 *:fix* *:fixdel*
442:fix[del] Set the value of 't_kD':
443 't_kb' is 't_kD' becomes ~
444 CTRL-? CTRL-H
445 not CTRL-? CTRL-?
446
447 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
448
449 If your delete key terminal code is wrong, but the
450 code for backspace is alright, you can put this in
451 your .vimrc: >
452 :fixdel
453< This works no matter what the actual code for
454 backspace is.
455
456 If the backspace key terminal code is wrong you can
457 use this: >
458 :if &term == "termname"
459 : set t_kb=^V<BS>
460 : fixdel
461 :endif
462< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000463 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464 with your terminal name.
465
466 If your <Delete> key sends a strange key sequence (not
467 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
468 :if &term == "termname"
469 : set t_kD=^V<Delete>
470 :endif
471< Where "^V" is CTRL-V and "<Delete>" is the delete key
472 (don't type eight characters!). Replace "termname"
473 with your terminal name.
474
475 *Linux-backspace*
476 Note about Linux: By default the backspace key
477 produces CTRL-?, which is wrong. You can fix it by
478 putting this line in your rc.local: >
479 echo "keycode 14 = BackSpace" | loadkeys
480<
481 *NetBSD-backspace*
482 Note about NetBSD: If your backspace doesn't produce
483 the right code, try this: >
484 xmodmap -e "keycode 22 = BackSpace"
485< If this works, add this in your .Xmodmap file: >
486 keysym 22 = BackSpace
487< You need to restart for this to take effect.
488
489==============================================================================
4902. Automatically setting options *auto-setting*
491
492Besides changing options with the ":set" command, there are three alternatives
493to set options automatically for one or more files:
494
4951. When starting Vim initializations are read from various places. See
496 |initialization|. Most of them are performed for all editing sessions,
497 and some of them depend on the directory where Vim is started.
498 You can create an initialization file with |:mkvimrc|, |:mkview| and
499 |:mksession|.
5002. If you start editing a new file, the automatic commands are executed.
501 This can be used to set options for files matching a particular pattern and
502 many other things. See |autocommand|.
5033. If you start editing a new file, and the 'modeline' option is on, a
504 number of lines at the beginning and end of the file are checked for
505 modelines. This is explained here.
506
507 *modeline* *vim:* *vi:* *ex:* *E520*
508There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200511[text] any text or empty
512{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514[white] optional white space
515{options} a list of option settings, separated with white space
516 or ':', where each part between ':' is the argument
517 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaar14b69452013-06-29 23:05:20 +0200519Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000520 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523The second form (this is compatible with some versions of Vi):
524
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[text] any text or empty
528{white} at least one blank character (<Space> or <Tab>)
529{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
530[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531se[t] the string "set " or "se " (note the space); When
532 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533{options} a list of options, separated with white space, which
534 is the argument for a ":set" command
535: a colon
536[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar14b69452013-06-29 23:05:20 +0200538Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
543chance that a normal word like "lex:" is caught. There is one exception:
544"vi:" and "vim:" can also be at the start of the line (for compatibility with
545version 3.0). Using "ex:" at the start of the line will be ignored (this
546could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 *modeline-local*
549The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000550buffer and window that contain the file. Although it's possible to set global
551options from a modeline, this is unusual. If you have two windows open and
552the files in it set the same global option to a different value, the result
553depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000555When editing a file that was already loaded, only the window-local options
556from the modeline are used. Thus if you manually changed a buffer-local
557option after opening the file, it won't be changed if you edit the same buffer
558in another window. But window-local options will be set.
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-version*
561If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 vim{vers}: version {vers} or later
564 vim<{vers}: version before {vers}
565 vim={vers}: version {vers}
566 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100567{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
568For example, to use a modeline only for Vim 7.0:
569 /* vim700: set foldmethod=marker */ ~
570To use a modeline for Vim after version 7.2:
571 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572There can be no blanks between "vim" and the ":".
573
574
575The number of lines that are checked can be set with the 'modelines' option.
576If 'modeline' is off or 'modelines' is 0 no lines are checked.
577
578Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000579like:
580 /* vi:ts=4: */ ~
581will give an error message for the trailing "*/". This line is OK:
582 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584If an error is detected the rest of the line is skipped.
585
586If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000587backslash in front of the ':' will be removed. Example:
588 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589This sets the 'dir' option to "c:\tmp". Only a single backslash before the
590':' is removed. Thus to include "\:" you have to specify "\\:".
591
592No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000593might create a Trojan horse text file with modelines). And not all options
594can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000595|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000596causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
597are wrapped unexpectedly. So disable modelines before editing untrusted text.
598The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
600Hint: If you would like to do something else than setting an option, you could
601define an autocommand that checks the file for a specific string. For
602example: >
603 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
604And define a function SetVar() that does something with the line containing
605"VAR".
606
607==============================================================================
6083. Options summary *option-summary*
609
610In the list below all the options are mentioned with their full name and with
611an abbreviation if there is one. Both forms may be used.
612
613In this document when a boolean option is "set" that means that ":set option"
614is entered. When an option is "reset", ":set nooption" is used.
615
616For some options there are two default values: The "Vim default", which is
617used when 'compatible' is not set, and the "Vi default", which is used when
618'compatible' is set.
619
620Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000621are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622different value in each window. For example the 'list' option can be set in
623one window and reset in another for the same text, giving both types of view
624at the same time. There are a few options that are specific to a certain
625file. These can have a different value for each file or buffer. For example
626the 'textwidth' option can be 78 for a normal text file and 0 for a C
627program.
628
629 global one option for all buffers and windows
630 local to window each window has its own copy of this option
631 local to buffer each buffer has its own copy of this option
632
633When creating a new window the option values from the currently active window
634are used as a default value for the window-specific options. For the
635buffer-specific options this depends on the 's' and 'S' flags in the
636'cpoptions' option. If 's' is included (which is the default) the values for
637buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000638first entered. If 'S' is present the options are copied each time the buffer
639is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640present, the options are copied from the currently active buffer when the
641buffer is created.
642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000645Not all options are supported in all versions. This depends on the supported
646features and sometimes on the system. A remark about this is in curly braces
647below. When an option is not supported it may still be set without getting an
648error, this is called a hidden option. You can't get the value of a hidden
649option though, it is not stored.
650
651To test if option "foo" can be used with ":set" use something like this: >
652 if exists('&foo')
653This also returns true for a hidden option. To test if option "foo" is really
654supported use something like this: >
655 if exists('+foo')
656<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *E355*
658A jump table for the options with a short description can be found at |Q_op|.
659
660 *'aleph'* *'al'* *aleph* *Aleph*
661'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
662 global
663 {not in Vi}
664 {only available when compiled with the |+rightleft|
665 feature}
666 The ASCII code for the first letter of the Hebrew alphabet. The
667 routine that maps the keyboard in Hebrew mode, both in Insert mode
668 (when hkmap is set) and on the command-line (when hitting CTRL-_)
669 outputs the Hebrew characters in the range [aleph..aleph+26].
670 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
671 See |rileft.txt|.
672
673 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
674'allowrevins' 'ari' boolean (default off)
675 global
676 {not in Vi}
677 {only available when compiled with the |+rightleft|
678 feature}
679 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
680 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
681 into reverse Insert mode, and don't know how to get out. See
682 'revins'.
683 NOTE: This option is reset when 'compatible' is set.
684
685 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
686'altkeymap' 'akm' boolean (default off)
687 global
688 {not in Vi}
689 {only available when compiled with the |+farsi|
690 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 the keyboard map between Farsi and English, when 'allowrevins' set.
693
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 is useful to start the Vim in native mode i.e. English (left-to-right
696 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000697 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
702 {not in Vi}
703 {only available when compiled with the |+multi_byte|
704 feature}
705 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
706 Tells Vim what to do with characters with East Asian Width Class
707 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
708 letters, Cyrillic letters).
709
710 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 expected by most users.
713 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200714 *E834* *E835*
715 The value "double" cannot be used if 'listchars' or 'fillchars'
716 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
729 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
730 when the system locale is set to one of CJK locales. See Unicode
731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
741 {not in Vi}
742 {only available when compiled with GUI enabled
743 on Mac OS X}
744 This option only has an effect in the GUI version of Vim on Mac OS X
745 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
746 which can be easier to read at certain sizes on certain displays.
747 Setting this option can sometimes cause problems if 'guifont' is set
748 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
752'autochdir' 'acd' boolean (default off)
753 global
754 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200755 {only available when compiled with it, use
756 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000757 When on, Vim will change the current working directory whenever you
758 open a file, switch buffers, delete a buffer or open/close a window.
759 It will change to the directory containing the file which was opened
760 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000761 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
764'arabic' 'arab' boolean (default off)
765 local to window
766 {not in Vi}
767 {only available when compiled with the |+arabic|
768 feature}
769 This option can be set to start editing Arabic text.
770 Setting this option will:
771 - Set the 'rightleft' option, unless 'termbidi' is set.
772 - Set the 'arabicshape' option, unless 'termbidi' is set.
773 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
774 between typing English and Arabic key mapping.
775 - Set the 'delcombine' option
776 Note that 'encoding' must be "utf-8" for working with Arabic text.
777
778 Resetting this option will:
779 - Reset the 'rightleft' option.
780 - Disable the use of 'keymap' (without changing its value).
781 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200782 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Also see |arabic.txt|.
785
786 *'arabicshape'* *'arshape'*
787 *'noarabicshape'* *'noarshape'*
788'arabicshape' 'arshape' boolean (default on)
789 global
790 {not in Vi}
791 {only available when compiled with the |+arabic|
792 feature}
793 When on and 'termbidi' is off, the required visual character
794 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200795 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 one which encompasses:
797 a) the changing/morphing of characters based on their location
798 within a word (initial, medial, final and stand-alone).
799 b) the enabling of the ability to compose characters
800 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100801 When disabled the display shows each character's true stand-alone
802 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Arabic is a complex language which requires other settings, for
804 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100805 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
808'autoindent' 'ai' boolean (default off)
809 local to buffer
810 Copy indent from current line when starting a new line (typing <CR>
811 in Insert mode or when using the "o" or "O" command). If you do not
812 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000813 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
814 to another line has the same effect, unless the 'I' flag is included
815 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000816 When autoindent is on, formatting (with the "gq" command or when you
817 reach 'textwidth' in Insert mode) uses the indentation of the first
818 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 When 'smartindent' or 'cindent' is on the indent is changed in
820 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200821 The 'autoindent' option is reset when the 'paste' option is set and
822 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {small difference from Vi: After the indent is deleted when typing
824 <Esc> or <CR>, the cursor position when moving up or down is after the
825 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
826
827 *'autoread'* *'ar'* *'noautoread'* *'noar'*
828'autoread' 'ar' boolean (default off)
829 global or local to buffer |global-local|
830 {not in Vi}
831 When a file has been detected to have been changed outside of Vim and
832 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200833 When the file has been deleted this is not done, so you have the text
834 from before it was deleted. When it appears again then it is read.
835 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 If this option has a local value, use this command to switch back to
837 using the global value: >
838 :set autoread<
839<
840 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
841'autowrite' 'aw' boolean (default off)
842 global
843 Write the contents of the file, if it has been modified, on each
844 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000845 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
847 Note that for some commands the 'autowrite' option is not used, see
848 'autowriteall' for that.
849
850 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
851'autowriteall' 'awa' boolean (default off)
852 global
853 {not in Vi}
854 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
855 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
856 Setting this option also implies that Vim behaves like 'autowrite' has
857 been set.
858
859 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200860'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861 global
862 {not in Vi}
863 When set to "dark", Vim will try to use colors that look good on a
864 dark background. When set to "light", Vim will try to use colors that
865 look good on a light background. Any other value is illegal.
866 Vim tries to set the default value according to the terminal used.
867 This will not always be correct.
868 Setting this option does not change the background color, it tells Vim
869 what the background color looks like. For changing the background
870 color, see |:hi-normal|.
871
872 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000873 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000874 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100875 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 setting 'background' will cause the color scheme to be reloaded. If
877 the color scheme adjusts to the value of 'background' this will work.
878 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100879 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000880
881 When setting 'background' to the default value with: >
882 :set background&
883< Vim will guess the value. In the GUI this should work correctly,
884 in other cases Vim might not be able to guess the right value.
885
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200886 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200887 color from the terminal. If the returned RGB value is dark/light and
888 'background' is not dark/light, 'background' will be set and the
889 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200890 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100891 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200892
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 When starting the GUI, the default value for 'background' will be
894 "light". When the value is not set in the .gvimrc, and Vim detects
895 that the background is actually quite dark, 'background' is set to
896 "dark". But this happens only AFTER the .gvimrc file has been read
897 (because the window needs to be opened to find the actual background
898 color). To get around this, force the GUI window to be opened by
899 putting a ":gui" command in the .gvimrc file, before where the value
900 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200901
902 For MS-DOS, Windows and OS/2 the default is "dark".
903 For other systems "dark" is used when 'term' is "linux",
904 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
905 background. Otherwise the default is "light".
906
Bram Moolenaarc572da52017-08-27 16:52:01 +0200907 The |:terminal| command and the |term_start()| function use the
908 'background' value to decide whether the terminal window will start
909 with a white or black background.
910
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 Normally this option would be set in the .vimrc file. Possibly
912 depending on the terminal name. Example: >
913 :if &term == "pcterm"
914 : set background=dark
915 :endif
916< When this option is set, the default settings for the highlight groups
917 will change. To use other settings, place ":highlight" commands AFTER
918 the setting of the 'background' option.
919 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
920 to select the colors for syntax highlighting. After changing this
921 option, you must load syntax.vim again to see the result. This can be
922 done with ":syntax on".
923
924 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200925'backspace' 'bs' string (default "", set to "indent,eol,start"
926 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 global
928 {not in Vi}
929 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
930 mode. This is a list of items, separated by commas. Each item allows
931 a way to backspace over something:
932 value effect ~
933 indent allow backspacing over autoindent
934 eol allow backspacing over line breaks (join lines)
935 start allow backspacing over the start of insert; CTRL-W and CTRL-U
936 stop once at the start of insert.
937
938 When the value is empty, Vi compatible backspacing is used.
939
940 For backwards compatibility with version 5.4 and earlier:
941 value effect ~
942 0 same as ":set backspace=" (Vi compatible)
943 1 same as ":set backspace=indent,eol"
944 2 same as ":set backspace=indent,eol,start"
945
946 See |:fixdel| if your <BS> or <Del> key does not do what you want.
947 NOTE: This option is set to "" when 'compatible' is set.
948
949 *'backup'* *'bk'* *'nobackup'* *'nobk'*
950'backup' 'bk' boolean (default off)
951 global
952 {not in Vi}
953 Make a backup before overwriting a file. Leave it around after the
954 file has been successfully written. If you do not want to keep the
955 backup file, but you do want a backup while the file is being
956 written, reset this option and set the 'writebackup' option (this is
957 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000958 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 |backup-table| for more explanations.
960 When the 'backupskip' pattern matches, a backup is not made anyway.
961 When 'patchmode' is set, the backup may be renamed to become the
962 oldest version of a file.
963 NOTE: This option is reset when 'compatible' is set.
964
965 *'backupcopy'* *'bkc'*
966'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200967 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 {not in Vi}
969 When writing a file and a backup is made, this option tells how it's
970 done. This is a comma separated list of words.
971
972 The main values are:
973 "yes" make a copy of the file and overwrite the original one
974 "no" rename the file and write a new one
975 "auto" one of the previous, what works best
976
977 Extra values that can be combined with the ones above are:
978 "breaksymlink" always break symlinks when writing
979 "breakhardlink" always break hardlinks when writing
980
981 Making a copy and overwriting the original file:
982 - Takes extra time to copy the file.
983 + When the file has special attributes, is a (hard/symbolic) link or
984 has a resource fork, all this is preserved.
985 - When the file is a link the backup will have the name of the link,
986 not of the real file.
987
988 Renaming the file and writing a new one:
989 + It's fast.
990 - Sometimes not all attributes of the file can be copied to the new
991 file.
992 - When the file is a link the new file will not be a link.
993
994 The "auto" value is the middle way: When Vim sees that renaming file
995 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000996 the file is not a link) that is used. When problems are expected, a
997 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998
999 The "breaksymlink" and "breakhardlink" values can be used in
1000 combination with any of "yes", "no" and "auto". When included, they
1001 force Vim to always break either symbolic or hard links by doing
1002 exactly what the "no" option does, renaming the original file to
1003 become the backup and writing a new file in its place. This can be
1004 useful for example in source trees where all the files are symbolic or
1005 hard links and any changes should stay in the local source tree, not
1006 be propagated back to the original source.
1007 *crontab*
1008 One situation where "no" and "auto" will cause problems: A program
1009 that opens a file, invokes Vim to edit that file, and then tests if
1010 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001011 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 example.
1013
1014 When a copy is made, the original file is truncated and then filled
1015 with the new text. This means that protection bits, owner and
1016 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001017 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 group of the backup is set to the group of the original file. If this
1019 fails, the protection bits for the group are made the same as for
1020 others.
1021
1022 When the file is renamed this is the other way around: The backup has
1023 the same attributes of the original file, and the newly written file
1024 is owned by the current user. When the file was a (hard/symbolic)
1025 link, the new file will not! That's why the "auto" value doesn't
1026 rename when the file is a link. The owner and group of the newly
1027 written file will be set to the same ones as the original file, but
1028 the system may refuse to do this. In that case the "auto" value will
1029 again not rename the file.
1030
Bram Moolenaar036986f2017-03-16 17:41:02 +01001031 NOTE: This option is set to the Vi default value when 'compatible' is
1032 set and to the Vim default value when 'compatible' is reset.
1033
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 *'backupdir'* *'bdir'*
1035'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001036 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 for Unix: ".,~/tmp,~/")
1038 global
1039 {not in Vi}
1040 List of directories for the backup file, separated with commas.
1041 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001042 where this is possible. The directory must exist, Vim will not
1043 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001044 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 impossible!). Writing may fail because of this.
1046 - A directory "." means to put the backup file in the same directory
1047 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001048 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 put the backup file relative to where the edited file is. The
1050 leading "." is replaced with the path name of the edited file.
1051 ("." inside a directory name has no special meaning).
1052 - Spaces after the comma are ignored, other spaces are considered part
1053 of the directory name. To have a space at the start of a directory
1054 name, precede it with a backslash.
1055 - To include a comma in a directory name precede it with a backslash.
1056 - A directory name may end in an '/'.
1057 - Environment variables are expanded |:set_env|.
1058 - Careful with '\' characters, type one before a space, type two to
1059 get one in the option (see |option-backslash|), for example: >
1060 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1061< - For backwards compatibility with Vim version 3.0 a '>' at the start
1062 of the option is removed.
1063 See also 'backup' and 'writebackup' options.
1064 If you want to hide your backup files on Unix, consider this value: >
1065 :set backupdir=./.backup,~/.backup,.,/tmp
1066< You must create a ".backup" directory in each directory and in your
1067 home directory for this to work properly.
1068 The use of |:set+=| and |:set-=| is preferred when adding or removing
1069 directories from the list. This avoids problems when a future version
1070 uses another default.
1071 This option cannot be set from a |modeline| or in the |sandbox|, for
1072 security reasons.
1073
1074 *'backupext'* *'bex'* *E589*
1075'backupext' 'bex' string (default "~", for VMS: "_")
1076 global
1077 {not in Vi}
1078 String which is appended to a file name to make the name of the
1079 backup file. The default is quite unusual, because this avoids
1080 accidentally overwriting existing files with a backup file. You might
1081 prefer using ".bak", but make sure that you don't have files with
1082 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001083 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001085 If you like to keep a lot of backups, you could use a BufWritePre
1086 autocommand to change 'backupext' just before writing the file to
1087 include a timestamp. >
1088 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1089< Use 'backupdir' to put the backup in a different directory.
1090
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001092'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1093 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1094 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095 global
1096 {not in Vi}
1097 {not available when compiled without the |+wildignore|
1098 feature}
1099 A list of file patterns. When one of the patterns matches with the
1100 name of the file which is written, no backup file is created. Both
1101 the specified file name and the full path name of the file are used.
1102 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1103 Watch out for special characters, see |option-backslash|.
1104 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001105 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001106
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001107 WARNING: Not having a backup file means that when Vim fails to write
1108 your buffer correctly and then, for whatever reason, Vim exits, you
1109 lose both the original file and what you were writing. Only disable
1110 backups if you don't care about losing the file.
1111
Bram Moolenaar02467872007-05-06 13:22:01 +00001112 Note that environment variables are not expanded. If you want to use
1113 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001114 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001115
1116< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001117 backup would be made by renaming the original file crontab won't see
1118 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
1120 *'balloondelay'* *'bdlay'*
1121'balloondelay' 'bdlay' number (default: 600)
1122 global
1123 {not in Vi}
1124 {only available when compiled with the |+balloon_eval|
1125 feature}
1126 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1127
1128 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1129'ballooneval' 'beval' boolean (default off)
1130 global
1131 {not in Vi}
1132 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001133 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001134 Switch on the |balloon-eval| functionality for the GUI.
1135
1136 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1137 *'nobevalterm'*
1138'balloonevalterm' 'bevalterm' boolean (default off)
1139 global
1140 {not in Vi}
1141 {only available when compiled with the
1142 |+balloon_eval_term| feature}
1143 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 *'balloonexpr'* *'bexpr'*
1146'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001147 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001148 {not in Vi}
1149 {only available when compiled with the |+balloon_eval|
1150 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001151 Expression for text to show in evaluation balloon. It is only used
1152 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153
1154 v:beval_bufnr number of the buffer in which balloon is going to show
1155 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001156 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001157 v:beval_lnum line number
1158 v:beval_col column number (byte index)
1159 v:beval_text word under or after the mouse pointer
1160
1161 The evaluation of the expression must not have side effects!
1162 Example: >
1163 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001164 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 \', column ' . v:beval_col .
1166 \ ' of file ' . bufname(v:beval_bufnr) .
1167 \ ' on word "' . v:beval_text . '"'
1168 endfunction
1169 set bexpr=MyBalloonExpr()
1170 set ballooneval
1171<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001172 Also see |balloon_show()|, can be used if the content of the balloon
1173 is to be fetched asynchronously.
1174
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001175 NOTE: The balloon is displayed only if the cursor is on a text
1176 character. If the result of evaluating 'balloonexpr' is not empty,
1177 Vim does not try to send a message to an external debugger (Netbeans
1178 or Sun Workshop).
1179
Bram Moolenaar30b65812012-07-12 22:01:11 +02001180 The expression will be evaluated in the |sandbox| when set from a
1181 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001182
1183 It is not allowed to change text or jump to another window while
1184 evaluating 'balloonexpr' |textlock|.
1185
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001186 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001187 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001188< When they are supported "\n" characters will start a new line. If the
1189 expression evaluates to a |List| this is equal to using each List item
1190 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001191 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001192
Bram Moolenaar165bc692015-07-21 17:53:25 +02001193 *'belloff'* *'bo'*
1194'belloff' 'bo' string (default "")
1195 global
1196 {not in Vi}
1197 Specifies for which events the bell will not be rung. It is a comma
1198 separated list of items. For each item that is present, the bell
1199 will be silenced. This is most useful to specify specific events in
1200 insert mode to be silenced.
1201
1202 item meaning when present ~
1203 all All events.
1204 backspace When hitting <BS> or <Del> and deleting results in an
1205 error.
1206 cursor Fail to move around using the cursor keys or
1207 <PageUp>/<PageDown> in |Insert-mode|.
1208 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1209 |i_CTRL-X_CTRL-T|.
1210 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1211 |i_CTRL-E|.
1212 ctrlg Unknown Char after <C-G> in Insert mode.
1213 error Other Error occurred (e.g. try to join last line)
1214 (mostly used in |Normal-mode| or |Cmdline-mode|).
1215 esc hitting <Esc> in |Normal-mode|.
1216 ex In |Visual-mode|, hitting |Q| results in an error.
1217 hangul Error occurred when using hangul input.
1218 insertmode Pressing <Esc> in 'insertmode'.
1219 lang Calling the beep module for Lua/Mzscheme/TCL.
1220 mess No output available for |g<|.
1221 showmatch Error occurred for 'showmatch' function.
1222 operator Empty region error |cpo-E|.
1223 register Unknown register after <C-R> in |Insert-mode|.
1224 shell Bell from shell output |:!|.
1225 spell Error happened on spell suggest.
1226 wildmode More matches in |cmdline-completion| available
1227 (depends on the 'wildmode' setting).
1228
Bram Moolenaar036986f2017-03-16 17:41:02 +01001229 This is most useful to fine tune when in Insert mode the bell should
1230 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001231 indicate that an error occurred. It can be silenced by adding the
1232 "error" keyword.
1233
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1235'binary' 'bin' boolean (default off)
1236 local to buffer
1237 {not in Vi}
1238 This option should be set before editing a binary file. You can also
1239 use the |-b| Vim argument. When this option is switched on a few
1240 options will be changed (also when it already was on):
1241 'textwidth' will be set to 0
1242 'wrapmargin' will be set to 0
1243 'modeline' will be off
1244 'expandtab' will be off
1245 Also, 'fileformat' and 'fileformats' options will not be used, the
1246 file is read and written like 'fileformat' was "unix" (a single <NL>
1247 separates lines).
1248 The 'fileencoding' and 'fileencodings' options will not be used, the
1249 file is read without conversion.
1250 NOTE: When you start editing a(nother) file while the 'bin' option is
1251 on, settings from autocommands may change the settings again (e.g.,
1252 'textwidth'), causing trouble when editing. You might want to set
1253 'bin' again when the file has been loaded.
1254 The previous values of these options are remembered and restored when
1255 'bin' is switched from on to off. Each buffer has its own set of
1256 saved option values.
1257 To edit a file with 'binary' set you can use the |++bin| argument.
1258 This avoids you have to do ":set bin", which would have effect for all
1259 files you edit.
1260 When writing a file the <EOL> for the last line is only written if
1261 there was one in the original file (normally Vim appends an <EOL> to
1262 the last line if there is none; this would make the file longer). See
1263 the 'endofline' option.
1264
1265 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1266'bioskey' 'biosk' boolean (default on)
1267 global
1268 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001269 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270
1271 *'bomb'* *'nobomb'*
1272'bomb' boolean (default off)
1273 local to buffer
1274 {not in Vi}
1275 {only available when compiled with the |+multi_byte|
1276 feature}
1277 When writing a file and the following conditions are met, a BOM (Byte
1278 Order Mark) is prepended to the file:
1279 - this option is on
1280 - the 'binary' option is off
1281 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1282 endian variants.
1283 Some applications use the BOM to recognize the encoding of the file.
1284 Often used for UCS-2 files on MS-Windows. For other applications it
1285 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001286 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1288 check for the presence of the BOM is done and 'bomb' set accordingly.
1289 Unless 'binary' is set, it is removed from the first line, so that you
1290 don't see it when editing. When you don't change the options, the BOM
1291 will be restored when writing the file.
1292
1293 *'breakat'* *'brk'*
1294'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1295 global
1296 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001297 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 feature}
1299 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001300 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1301 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001302
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001303 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001304'breakindent' 'bri' boolean (default off)
1305 local to window
1306 {not in Vi}
1307 {not available when compiled without the |+linebreak|
1308 feature}
1309 Every wrapped line will continue visually indented (same amount of
1310 space as the beginning of that line), thus preserving horizontal blocks
1311 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001312 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313
1314 *'breakindentopt'* *'briopt'*
1315'breakindentopt' 'briopt' string (default empty)
1316 local to window
1317 {not in Vi}
1318 {not available when compiled without the |+linebreak|
1319 feature}
1320 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001321 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001322 min:{n} Minimum text width that will be kept after
1323 applying 'breakindent', even if the resulting
1324 text should normally be narrower. This prevents
1325 text indented almost to the right window border
1326 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001327 shift:{n} After applying 'breakindent', the wrapped line's
1328 beginning will be shifted by the given number of
1329 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001330 indentation (negative) or emphasizing the line
1331 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001332 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001333 additional indent.
1334 The default value for min is 20 and shift is 0.
1335
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001337'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001338 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001339 {not in Vi} {only for Motif, Athena, GTK, Mac and
1340 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001342 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001343 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 buffer Use the directory of the related buffer.
1345 current Use the current directory.
1346 {path} Use the specified directory
1347
1348 *'bufhidden'* *'bh'*
1349'bufhidden' 'bh' string (default: "")
1350 local to buffer
1351 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 This option specifies what happens when a buffer is no longer
1353 displayed in a window:
1354 <empty> follow the global 'hidden' option
1355 hide hide the buffer (don't unload it), also when 'hidden'
1356 is not set
1357 unload unload the buffer, also when 'hidden' is set or using
1358 |:hide|
1359 delete delete the buffer from the buffer list, also when
1360 'hidden' is set or using |:hide|, like using
1361 |:bdelete|
1362 wipe wipe out the buffer from the buffer list, also when
1363 'hidden' is set or using |:hide|, like using
1364 |:bwipeout|
1365
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001366 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001367 are lost without a warning. Also, these values may break autocommands
1368 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 This option is used together with 'buftype' and 'swapfile' to specify
1370 special kinds of buffers. See |special-buffers|.
1371
1372 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1373'buflisted' 'bl' boolean (default: on)
1374 local to buffer
1375 {not in Vi}
1376 When this option is set, the buffer shows up in the buffer list. If
1377 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1378 This option is reset by Vim for buffers that are only used to remember
1379 a file name or marks. Vim sets it when starting to edit a buffer.
1380 But not when moving to a buffer with ":buffer".
1381
1382 *'buftype'* *'bt'* *E382*
1383'buftype' 'bt' string (default: "")
1384 local to buffer
1385 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 The value of this option specifies the type of a buffer:
1387 <empty> normal buffer
1388 nofile buffer which is not related to a file and will not be
1389 written
1390 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001391 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001392 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001394 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 help help buffer (you are not supposed to set this
1396 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001397 terminal buffer for a |terminal| (you are not supposed to set
1398 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001399 prompt buffer where only the last line can be edited, meant
1400 to be used by a plugin, see |prompt-buffer|
1401 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001402
1403 This option is used together with 'bufhidden' and 'swapfile' to
1404 specify special kinds of buffers. See |special-buffers|.
1405
1406 Be careful with changing this option, it can have many side effects!
1407
Bram Moolenaar280f1262006-01-30 00:14:18 +00001408 A "quickfix" buffer is only used for the error list and the location
1409 list. This value is set by the |:cwindow| and |:lwindow| commands and
1410 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411
1412 "nofile" and "nowrite" buffers are similar:
1413 both: The buffer is not to be written to disk, ":w" doesn't
1414 work (":w filename" does work though).
1415 both: The buffer is never considered to be |'modified'|.
1416 There is no warning when the changes will be lost, for
1417 example when you quit Vim.
1418 both: A swap file is only created when using too much memory
1419 (when 'swapfile' has been reset there is never a swap
1420 file).
1421 nofile only: The buffer name is fixed, it is not handled like a
1422 file name. It is not modified in response to a |:cd|
1423 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001424 both: When using ":e bufname" and already editing "bufname"
1425 the buffer is made empty and autocommands are
1426 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001427 *E676*
1428 "acwrite" implies that the buffer name is not related to a file, like
1429 "nofile", but it will be written. Thus, in contrast to "nofile" and
1430 "nowrite", ":w" does work and a modified buffer can't be abandoned
1431 without saving. For writing there must be matching |BufWriteCmd|,
1432 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433
1434 *'casemap'* *'cmp'*
1435'casemap' 'cmp' string (default: "internal,keepascii")
1436 global
1437 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001438 {only available when compiled with the |+multi_byte|
1439 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 Specifies details about changing the case of letters. It may contain
1441 these words, separated by a comma:
1442 internal Use internal case mapping functions, the current
1443 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001444 matters when 'encoding' is a Unicode encoding,
1445 "latin1" or "iso-8859-15". When "internal" is
1446 omitted, the towupper() and towlower() system library
1447 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1449 case mapping, the current locale is not effective.
1450 This probably only matters for Turkish.
1451
1452 *'cdpath'* *'cd'* *E344* *E346*
1453'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1454 global
1455 {not in Vi}
1456 {not available when compiled without the
1457 |+file_in_path| feature}
1458 This is a list of directories which will be searched when using the
1459 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001460 for has a relative path, not an absolute part starting with "/", "./"
1461 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 The 'cdpath' option's value has the same form and semantics as
1463 |'path'|. Also see |file-searching|.
1464 The default value is taken from $CDPATH, with a "," prepended to look
1465 in the current directory first.
1466 If the default value taken from $CDPATH is not what you want, include
1467 a modified version of the following command in your vimrc file to
1468 override it: >
1469 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1470< This option cannot be set from a |modeline| or in the |sandbox|, for
1471 security reasons.
1472 (parts of 'cdpath' can be passed to the shell to expand file names).
1473
1474 *'cedit'*
1475'cedit' string (Vi default: "", Vim default: CTRL-F)
1476 global
1477 {not in Vi}
1478 {not available when compiled without the |+vertsplit|
1479 feature}
1480 The key used in Command-line Mode to open the command-line window.
1481 The default is CTRL-F when 'compatible' is off.
1482 Only non-printable keys are allowed.
1483 The key can be specified as a single character, but it is difficult to
1484 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001485 :exe "set cedit=\<C-Y>"
1486 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487< |Nvi| also has this option, but it only uses the first character.
1488 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001489 NOTE: This option is set to the Vim default value when 'compatible'
1490 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491
1492 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1493'charconvert' 'ccv' string (default "")
1494 global
1495 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001496 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 {not in Vi}
1498 An expression that is used for character encoding conversion. It is
1499 evaluated when a file that is to be read or has been written has a
1500 different encoding from what is desired.
1501 'charconvert' is not used when the internal iconv() function is
1502 supported and is able to do the conversion. Using iconv() is
1503 preferred, because it is much faster.
1504 'charconvert' is not used when reading stdin |--|, because there is no
1505 file to convert from. You will have to save the text in a file first.
1506 The expression must return zero or an empty string for success,
1507 non-zero for failure.
1508 The possible encoding names encountered are in 'encoding'.
1509 Additionally, names given in 'fileencodings' and 'fileencoding' are
1510 used.
1511 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1512 is done internally by Vim, 'charconvert' is not used for this.
1513 'charconvert' is also used to convert the viminfo file, if the 'c'
1514 flag is present in 'viminfo'. Also used for Unicode conversion.
1515 Example: >
1516 set charconvert=CharConvert()
1517 fun CharConvert()
1518 system("recode "
1519 \ . v:charconvert_from . ".." . v:charconvert_to
1520 \ . " <" . v:fname_in . " >" v:fname_out)
1521 return v:shell_error
1522 endfun
1523< The related Vim variables are:
1524 v:charconvert_from name of the current encoding
1525 v:charconvert_to name of the desired encoding
1526 v:fname_in name of the input file
1527 v:fname_out name of the output file
1528 Note that v:fname_in and v:fname_out will never be the same.
1529 Note that v:charconvert_from and v:charconvert_to may be different
1530 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1531 Encryption is not done by Vim when using 'charconvert'. If you want
1532 to encrypt the file after conversion, 'charconvert' should take care
1533 of this.
1534 This option cannot be set from a |modeline| or in the |sandbox|, for
1535 security reasons.
1536
1537 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1538'cindent' 'cin' boolean (default off)
1539 local to buffer
1540 {not in Vi}
1541 {not available when compiled without the |+cindent|
1542 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001543 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 that trigger reindenting in insert mode and 'cinoptions' to set your
1545 preferred indent style.
1546 If 'indentexpr' is not empty, it overrules 'cindent'.
1547 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1548 the "=" operator indents using this algorithm rather than calling an
1549 external program.
1550 See |C-indenting|.
1551 When you don't like the way 'cindent' works, try the 'smartindent'
1552 option or 'indentexpr'.
1553 This option is not used when 'paste' is set.
1554 NOTE: This option is reset when 'compatible' is set.
1555
1556 *'cinkeys'* *'cink'*
1557'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1558 local to buffer
1559 {not in Vi}
1560 {not available when compiled without the |+cindent|
1561 feature}
1562 A list of keys that, when typed in Insert mode, cause reindenting of
1563 the current line. Only used if 'cindent' is on and 'indentexpr' is
1564 empty.
1565 For the format of this option see |cinkeys-format|.
1566 See |C-indenting|.
1567
1568 *'cinoptions'* *'cino'*
1569'cinoptions' 'cino' string (default "")
1570 local to buffer
1571 {not in Vi}
1572 {not available when compiled without the |+cindent|
1573 feature}
1574 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1575 program. See |cinoptions-values| for the values of this option, and
1576 |C-indenting| for info on C indenting in general.
1577
1578
1579 *'cinwords'* *'cinw'*
1580'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1581 local to buffer
1582 {not in Vi}
1583 {not available when compiled without both the
1584 |+cindent| and the |+smartindent| features}
1585 These keywords start an extra indent in the next line when
1586 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1587 an appropriate place (inside {}).
1588 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1589 matter, include the keyword both the uppercase and lowercase:
1590 "if,If,IF".
1591
1592 *'clipboard'* *'cb'*
1593'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1594 for X-windows, "" otherwise)
1595 global
1596 {not in Vi}
1597 {only in GUI versions or when the |+xterm_clipboard|
1598 feature is included}
1599 This option is a list of comma separated names.
1600 These names are recognized:
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 unnamed When included, Vim will use the clipboard register '*'
1604 for all yank, delete, change and put operations which
1605 would normally go to the unnamed register. When a
1606 register is explicitly specified, it will always be
1607 used regardless of whether "unnamed" is in 'clipboard'
1608 or not. The clipboard register can always be
1609 explicitly accessed using the "* notation. Also see
1610 |gui-clipboard|.
1611
Bram Moolenaar30b65812012-07-12 22:01:11 +02001612 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001613 unnamedplus A variant of the "unnamed" flag which uses the
1614 clipboard register '+' (|quoteplus|) instead of
1615 register '*' for all yank, delete, change and put
1616 operations which would normally go to the unnamed
1617 register. When "unnamed" is also included to the
1618 option, yank operations (but not delete, change or
1619 put) will additionally copy the text into register
1620 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001621 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001622 Availability can be checked with: >
1623 if has('unnamedplus')
1624<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001625 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 autoselect Works like the 'a' flag in 'guioptions': If present,
1627 then whenever Visual mode is started, or the Visual
1628 area extended, Vim tries to become the owner of the
1629 windowing system's global selection or put the
1630 selected text on the clipboard used by the selection
1631 register "*. See |guioptions_a| and |quotestar| for
1632 details. When the GUI is active, the 'a' flag in
1633 'guioptions' is used, when the GUI is not active, this
1634 "autoselect" flag is used.
1635 Also applies to the modeless selection.
1636
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001637 *clipboard-autoselectplus*
1638 autoselectplus Like "autoselect" but using the + register instead of
1639 the * register. Compare to the 'P' flag in
1640 'guioptions'.
1641
1642 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 autoselectml Like "autoselect", but for the modeless selection
1644 only. Compare to the 'A' flag in 'guioptions'.
1645
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001646 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001647 html When the clipboard contains HTML, use this when
1648 pasting. When putting text on the clipboard, mark it
1649 as HTML. This works to copy rendered HTML from
1650 Firefox, paste it as raw HTML in Vim, select the HTML
1651 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001652 You probably want to add this only temporarily,
1653 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001654 Only supported for GTK version 2 and later.
1655 Only available with the |+multi_byte| feature.
1656
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001657 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 exclude:{pattern}
1659 Defines a pattern that is matched against the name of
1660 the terminal 'term'. If there is a match, no
1661 connection will be made to the X server. This is
1662 useful in this situation:
1663 - Running Vim in a console.
1664 - $DISPLAY is set to start applications on another
1665 display.
1666 - You do not want to connect to the X server in the
1667 console, but do want this in a terminal emulator.
1668 To never connect to the X server use: >
1669 exclude:.*
1670< This has the same effect as using the |-X| argument.
1671 Note that when there is no connection to the X server
1672 the window title won't be restored and the clipboard
1673 cannot be accessed.
1674 The value of 'magic' is ignored, {pattern} is
1675 interpreted as if 'magic' was on.
1676 The rest of the option value will be used for
1677 {pattern}, this must be the last entry.
1678
1679 *'cmdheight'* *'ch'*
1680'cmdheight' 'ch' number (default 1)
1681 global
1682 {not in Vi}
1683 Number of screen lines to use for the command-line. Helps avoiding
1684 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001685 The value of this option is stored with the tab page, so that each tab
1686 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687
1688 *'cmdwinheight'* *'cwh'*
1689'cmdwinheight' 'cwh' number (default 7)
1690 global
1691 {not in Vi}
1692 {not available when compiled without the |+vertsplit|
1693 feature}
1694 Number of screen lines to use for the command-line window. |cmdwin|
1695
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001696 *'colorcolumn'* *'cc'*
1697'colorcolumn' 'cc' string (default "")
1698 local to window
1699 {not in Vi}
1700 {not available when compiled without the |+syntax|
1701 feature}
1702 'colorcolumn' is a comma separated list of screen columns that are
1703 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1704 text. Will make screen redrawing slower.
1705 The screen column can be an absolute number, or a number preceded with
1706 '+' or '-', which is added to or subtracted from 'textwidth'. >
1707
1708 :set cc=+1 " highlight column after 'textwidth'
1709 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1710 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1711<
1712 When 'textwidth' is zero then the items with '-' and '+' are not used.
1713 A maximum of 256 columns are highlighted.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 *'columns'* *'co'* *E594*
1716'columns' 'co' number (default 80 or terminal width)
1717 global
1718 {not in Vi}
1719 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001720 initialization and does not have to be set by hand. Also see
1721 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 When Vim is running in the GUI or in a resizable window, setting this
1723 option will cause the window size to be changed. When you only want
1724 to use the size for the GUI, put the command in your |gvimrc| file.
1725 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001726 number of columns of the display, the display may be messed up. For
1727 the GUI it is always possible and Vim limits the number of columns to
1728 what fits on the screen. You can use this command to get the widest
1729 window possible: >
1730 :set columns=9999
1731< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732
1733 *'comments'* *'com'* *E524* *E525*
1734'comments' 'com' string (default
1735 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1736 local to buffer
1737 {not in Vi}
1738 {not available when compiled without the |+comments|
1739 feature}
1740 A comma separated list of strings that can start a comment line. See
1741 |format-comments|. See |option-backslash| about using backslashes to
1742 insert a space.
1743
1744 *'commentstring'* *'cms'* *E537*
1745'commentstring' 'cms' string (default "/*%s*/")
1746 local to buffer
1747 {not in Vi}
1748 {not available when compiled without the |+folding|
1749 feature}
1750 A template for a comment. The "%s" in the value is replaced with the
1751 comment text. Currently only used to add markers for folding, see
1752 |fold-marker|.
1753
1754 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001755'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001756 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 global
1758 {not in Vi}
1759 This option has the effect of making Vim either more Vi-compatible, or
1760 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001761
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001763 other options are also changed as a side effect.
1764 NOTE: Setting or resetting this option can have a lot of unexpected
1765 effects: Mappings are interpreted in another way, undo behaves
1766 differently, etc. If you set this option in your vimrc file, you
1767 should probably put it at the very start.
1768
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 By default this option is on and the Vi defaults are used for the
1770 options. This default was chosen for those people who want to use Vim
1771 just like Vi, and don't even (want to) know about the 'compatible'
1772 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001773 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001774 this option is switched off, and all options that have not been
1775 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001776 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001777 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001778 happen for the system-wide vimrc or gvimrc file, nor for a file given
1779 with the |-u| argument). Also see |compatible-default| and
1780 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 You can also set this option with the "-C" argument, and reset it with
1782 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 When this option is set, numerous other options are set to make Vim as
1786 Vi-compatible as possible. When this option is unset, various options
1787 are set to make Vim more useful. The table below lists all the
1788 options affected.
1789 The {?} column indicates when the options are affected:
1790 + Means that the option is set to the value given in {set value} when
1791 'compatible' is set.
1792 & Means that the option is set to the value given in {set value} when
1793 'compatible' is set AND is set to its Vim default value when
1794 'compatible' is unset.
1795 - Means the option is NOT changed when setting 'compatible' but IS
1796 set to its Vim default when 'compatible' is unset.
1797 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798
Bram Moolenaar036986f2017-03-16 17:41:02 +01001799 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001800
1801 'allowrevins' + off no CTRL-_ command
1802 'antialias' + off don't use antialiased fonts
1803 'arabic' + off reset arabic-related options
1804 'arabicshape' + on correct character shapes
1805 'backspace' + "" normal backspace
1806 'backup' + off no backup file
1807 'backupcopy' & Unix: "yes" backup file is a copy
1808 else: "auto" copy or rename backup file
1809 'balloonexpr' + "" text to show in evaluation balloon
1810 'breakindent' + off don't indent when wrapping lines
1811 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1812 'cindent' + off no C code indentation
1813 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1814 'copyindent' + off don't copy indent structure
1815 'cpoptions' & (all flags) Vi-compatible flags
1816 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001817 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001818 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001819 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'cscopeverbose' + off see |cscopeverbose|
1821 'delcombine' + off unicode: delete whole char combination
1822 'digraph' + off no digraphs
1823 'esckeys' & off no <Esc>-keys in Insert mode
1824 'expandtab' + off tabs not expanded to spaces
1825 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001827 'formatexpr' + "" use 'formatprg' for auto-formatting
1828 'formatoptions' & "vt" Vi compatible formatting
1829 'gdefault' + off no default 'g' flag for ":s"
1830 'history' & 0 no commandline history
1831 'hkmap' + off no Hebrew keyboard mapping
1832 'hkmapp' + off no phonetic Hebrew keyboard mapping
1833 'hlsearch' + off no highlighting of search matches
1834 'incsearch' + off no incremental searching
1835 'indentexpr' + "" no indenting by expression
1836 'insertmode' + off do not start in Insert mode
1837 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001839 'joinspaces' + on insert 2 spaces after period
1840 'modeline' & off no modelines
1841 'more' & off no pauses in listings
1842 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1843 'numberwidth' & 8 min number of columns for line number
1844 'preserveindent'+ off don't preserve current indent structure
1845 when changing it
1846 'revins' + off no reverse insert
1847 'ruler' + off no ruler
1848 'scrolljump' + 1 no jump scroll
1849 'scrolloff' + 0 no scroll offset
1850 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1851 'shiftround' + off indent not rounded to shiftwidth
1852 'shortmess' & "" no shortening of messages
1853 'showcmd' & off command characters not shown
1854 'showmode' & off current mode not shown
1855 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1856 'smartcase' + off no automatic ignore case switch
1857 'smartindent' + off no smart indentation
1858 'smarttab' + off no smart tab size
1859 'softtabstop' + 0 tabs are always 'tabstop' positions
1860 'startofline' + on goto startofline with some commands
1861 'tagcase' & "followic" 'ignorecase' when searching tags file
1862 'tagrelative' & off tag file names are not relative
1863 'termguicolors' + off don't use highlight-(guifg|guibg)
1864 'textauto' & off no automatic textmode detection
1865 'textwidth' + 0 no automatic line wrap
1866 'tildeop' + off tilde is not an operator
1867 'ttimeout' + off no terminal timeout
1868 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001869 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001870 'virtualedit' + "" cursor can only be placed on characters
1871 'whichwrap' & "" left-right movements don't wrap
1872 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001874 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875
1876 *'complete'* *'cpt'* *E535*
1877'complete' 'cpt' string (default: ".,w,b,u,t,i")
1878 local to buffer
1879 {not in Vi}
1880 This option specifies how keyword completion |ins-completion| works
1881 when CTRL-P or CTRL-N are used. It is also used for whole-line
1882 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1883 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001884 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 w scan buffers from other windows
1886 b scan other loaded buffers that are in the buffer list
1887 u scan the unloaded buffers that are in the buffer list
1888 U scan the buffers that are not in the buffer list
1889 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001890 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 k{dict} scan the file {dict}. Several "k" flags can be given,
1892 patterns are valid too. For example: >
1893 :set cpt=k/usr/dict/*,k~/spanish
1894< s scan the files given with the 'thesaurus' option
1895 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1896 are valid too.
1897 i scan current and included files
1898 d scan current and included files for defined name or macro
1899 |i_CTRL-X_CTRL-D|
1900 ] tag completion
1901 t same as "]"
1902
1903 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1904 not executed, this may lead to unexpected completions from some files
1905 (gzipped files for example). Unloaded buffers are not scanned for
1906 whole-line completion.
1907
1908 The default is ".,w,b,u,t,i", which means to scan:
1909 1. the current buffer
1910 2. buffers in other windows
1911 3. other loaded buffers
1912 4. unloaded buffers
1913 5. tags
1914 6. included files
1915
1916 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001917 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1918 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001920 *'completefunc'* *'cfu'*
1921'completefunc' 'cfu' string (default: empty)
1922 local to buffer
1923 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001924 {not available when compiled without the |+eval|
1925 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001926 This option specifies a function to be used for Insert mode completion
1927 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001928 See |complete-functions| for an explanation of how the function is
1929 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001930 This option cannot be set from a |modeline| or in the |sandbox|, for
1931 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001932
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001933 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001934'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001935 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001936 {not available when compiled without the
1937 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001938 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001939 A comma separated list of options for Insert mode completion
1940 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001941
1942 menu Use a popup menu to show the possible completions. The
1943 menu is only shown when there is more than one match and
1944 sufficient colors are available. |ins-completion-menu|
1945
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001946 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001947 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001948 match, e.g., what file it comes from.
1949
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001950 longest Only insert the longest common text of the matches. If
1951 the menu is displayed you can use CTRL-L to add more
1952 characters. Whether case is ignored depends on the kind
1953 of completion. For buffer text the 'ignorecase' option is
1954 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001955
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001956 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001957 completion in the preview window. Only works in
1958 combination with "menu" or "menuone".
1959
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001960 noinsert Do not insert any text for a match until the user selects
1961 a match from the menu. Only works in combination with
1962 "menu" or "menuone". No effect if "longest" is present.
1963
1964 noselect Do not select a match in the menu, force the user to
1965 select one from the menu. Only works in combination with
1966 "menu" or "menuone".
1967
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001968
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001969 *'concealcursor'* *'cocu'*
1970'concealcursor' 'cocu' string (default: "")
1971 local to window
1972 {not in Vi}
1973 {not available when compiled without the |+conceal|
1974 feature}
1975 Sets the modes in which text in the cursor line can also be concealed.
1976 When the current mode is listed then concealing happens just like in
1977 other lines.
1978 n Normal mode
1979 v Visual mode
1980 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001981 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001982
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001983 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001984 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001985 are moving around text is concealed, but when starting to insert text
1986 or selecting a Visual area the concealed text is displayed, so that
1987 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001988 Keep in mind that the cursor position is not always where it's
1989 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001990
1991
1992'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001993 number (default 0)
1994 local to window
1995 {not in Vi}
1996 {not available when compiled without the |+conceal|
1997 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001998 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1999 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002000
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002001 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002003 1 Each block of concealed text is replaced with one
2004 character. If the syntax item does not have a custom
2005 replacement character defined (see |:syn-cchar|) the
2006 character defined in 'listchars' is used (default is a
2007 space).
2008 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002009 2 Concealed text is completely hidden unless it has a
2010 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002011 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002012 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002013
Bram Moolenaara7781e02010-07-19 20:13:22 +02002014 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002015 edit and copy the text. This can be changed with the 'concealcursor'
2016 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002017
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2019'confirm' 'cf' boolean (default off)
2020 global
2021 {not in Vi}
2022 When 'confirm' is on, certain operations that would normally
2023 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2024 instead raise a |dialog| asking if you wish to save the current
2025 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2026 If 'confirm' is off you can still activate confirmation for one
2027 command only (this is most useful in mappings) with the |:confirm|
2028 command.
2029 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2030
2031 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2032'conskey' 'consk' boolean (default off)
2033 global
2034 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002035 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036
2037 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2038'copyindent' 'ci' boolean (default off)
2039 local to buffer
2040 {not in Vi}
2041 Copy the structure of the existing lines indent when autoindenting a
2042 new line. Normally the new indent is reconstructed by a series of
2043 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2044 in which case only spaces are used). Enabling this option makes the
2045 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002046 existing line. 'expandtab' has no effect on these characters, a Tab
2047 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002049 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 Also see 'preserveindent'.
2051
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002052 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053'cpoptions' 'cpo' string (Vim default: "aABceFs",
2054 Vi default: all flags)
2055 global
2056 {not in Vi}
2057 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002058 this indicates Vi-compatible behavior. This is used for things where
2059 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 'cpoptions' stands for "compatible-options".
2061 Commas can be added for readability.
2062 To avoid problems with flags that are added in the future, use the
2063 "+=" and "-=" feature of ":set" |add-option-flags|.
2064 NOTE: This option is set to the Vi default value when 'compatible' is
2065 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002066 NOTE: This option is set to the POSIX default value at startup when
2067 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002068 variable exists |posix|. This means Vim tries to behave like the
2069 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070
2071 contains behavior ~
2072 *cpo-a*
2073 a When included, a ":read" command with a file name
2074 argument will set the alternate file name for the
2075 current window.
2076 *cpo-A*
2077 A When included, a ":write" command with a file name
2078 argument will set the alternate file name for the
2079 current window.
2080 *cpo-b*
2081 b "\|" in a ":map" command is recognized as the end of
2082 the map command. The '\' is included in the mapping,
2083 the text after the '|' is interpreted as the next
2084 command. Use a CTRL-V instead of a backslash to
2085 include the '|' in the mapping. Applies to all
2086 mapping, abbreviation, menu and autocmd commands.
2087 See also |map_bar|.
2088 *cpo-B*
2089 B A backslash has no special meaning in mappings,
2090 abbreviations and the "to" part of the menu commands.
2091 Remove this flag to be able to use a backslash like a
2092 CTRL-V. For example, the command ":map X \<Esc>"
2093 results in X being mapped to:
2094 'B' included: "\^[" (^[ is a real <Esc>)
2095 'B' excluded: "<Esc>" (5 characters)
2096 ('<' excluded in both cases)
2097 *cpo-c*
2098 c Searching continues at the end of any match at the
2099 cursor position, but not further than the start of the
2100 next line. When not present searching continues
2101 one character from the cursor position. With 'c'
2102 "abababababab" only gets three matches when repeating
2103 "/abab", without 'c' there are five matches.
2104 *cpo-C*
2105 C Do not concatenate sourced lines that start with a
2106 backslash. See |line-continuation|.
2107 *cpo-d*
2108 d Using "./" in the 'tags' option doesn't mean to use
2109 the tags file relative to the current file, but the
2110 tags file in the current directory.
2111 *cpo-D*
2112 D Can't use CTRL-K to enter a digraph after Normal mode
2113 commands with a character argument, like |r|, |f| and
2114 |t|.
2115 *cpo-e*
2116 e When executing a register with ":@r", always add a
2117 <CR> to the last line, also when the register is not
2118 linewise. If this flag is not present, the register
2119 is not linewise and the last line does not end in a
2120 <CR>, then the last line is put on the command-line
2121 and can be edited before hitting <CR>.
2122 *cpo-E*
2123 E It is an error when using "y", "d", "c", "g~", "gu" or
2124 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002125 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 This makes "y0" fail in the first column.
2127 *cpo-f*
2128 f When included, a ":read" command with a file name
2129 argument will set the file name for the current buffer,
2130 if the current buffer doesn't have a file name yet.
2131 *cpo-F*
2132 F When included, a ":write" command with a file name
2133 argument will set the file name for the current
2134 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002135 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 *cpo-g*
2137 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002138 *cpo-H*
2139 H When using "I" on a line with only blanks, insert
2140 before the last blank. Without this flag insert after
2141 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 *cpo-i*
2143 i When included, interrupting the reading of a file will
2144 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002145 *cpo-I*
2146 I When moving the cursor up or down just after inserting
2147 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 *cpo-j*
2149 j When joining lines, only add two spaces after a '.',
2150 not after '!' or '?'. Also see 'joinspaces'.
2151 *cpo-J*
2152 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002153 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 white space.
2155 *cpo-k*
2156 k Disable the recognition of raw key codes in
2157 mappings, abbreviations, and the "to" part of menu
2158 commands. For example, if <Key> sends ^[OA (where ^[
2159 is <Esc>), the command ":map X ^[OA" results in X
2160 being mapped to:
2161 'k' included: "^[OA" (3 characters)
2162 'k' excluded: "<Key>" (one key code)
2163 Also see the '<' flag below.
2164 *cpo-K*
2165 K Don't wait for a key code to complete when it is
2166 halfway a mapping. This breaks mapping <F1><F1> when
2167 only part of the second <F1> has been read. It
2168 enables cancelling the mapping by typing <F1><Esc>.
2169 *cpo-l*
2170 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002171 literally, only "\]", "\^", "\-" and "\\" are special.
2172 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2174 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002175 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 *cpo-L*
2177 L When the 'list' option is set, 'wrapmargin',
2178 'textwidth', 'softtabstop' and Virtual Replace mode
2179 (see |gR|) count a <Tab> as two characters, instead of
2180 the normal behavior of a <Tab>.
2181 *cpo-m*
2182 m When included, a showmatch will always wait half a
2183 second. When not included, a showmatch will wait half
2184 a second or until a character is typed. |'showmatch'|
2185 *cpo-M*
2186 M When excluded, "%" matching will take backslashes into
2187 account. Thus in "( \( )" and "\( ( \)" the outer
2188 parenthesis match. When included "%" ignores
2189 backslashes, which is Vi compatible.
2190 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002191 n When included, the column used for 'number' and
2192 'relativenumber' will also be used for text of wrapped
2193 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 *cpo-o*
2195 o Line offset to search command is not remembered for
2196 next search.
2197 *cpo-O*
2198 O Don't complain if a file is being overwritten, even
2199 when it didn't exist when editing it. This is a
2200 protection against a file unexpectedly created by
2201 someone else. Vi didn't complain about this.
2202 *cpo-p*
2203 p Vi compatible Lisp indenting. When not present, a
2204 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002205 *cpo-P*
2206 P When included, a ":write" command that appends to a
2207 file will set the file name for the current buffer, if
2208 the current buffer doesn't have a file name yet and
2209 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002210 *cpo-q*
2211 q When joining multiple lines leave the cursor at the
2212 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 *cpo-r*
2214 r Redo ("." command) uses "/" to repeat a search
2215 command, instead of the actually used search string.
2216 *cpo-R*
2217 R Remove marks from filtered lines. Without this flag
2218 marks are kept like |:keepmarks| was used.
2219 *cpo-s*
2220 s Set buffer options when entering the buffer for the
2221 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002222 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 set when the buffer is created.
2224 *cpo-S*
2225 S Set buffer options always when entering a buffer
2226 (except 'readonly', 'fileformat', 'filetype' and
2227 'syntax'). This is the (most) Vi compatible setting.
2228 The options are set to the values in the current
2229 buffer. When you change an option and go to another
2230 buffer, the value is copied. Effectively makes the
2231 buffer options global to all buffers.
2232
2233 's' 'S' copy buffer options
2234 no no when buffer created
2235 yes no when buffer first entered (default)
2236 X yes each time when buffer entered (vi comp.)
2237 *cpo-t*
2238 t Search pattern for the tag command is remembered for
2239 "n" command. Otherwise Vim only puts the pattern in
2240 the history for search pattern, but doesn't change the
2241 last used search pattern.
2242 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002243 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 *cpo-v*
2245 v Backspaced characters remain visible on the screen in
2246 Insert mode. Without this flag the characters are
2247 erased from the screen right away. With this flag the
2248 screen newly typed text overwrites backspaced
2249 characters.
2250 *cpo-w*
2251 w When using "cw" on a blank character, only change one
2252 character and not all blanks until the start of the
2253 next word.
2254 *cpo-W*
2255 W Don't overwrite a readonly file. When omitted, ":w!"
2256 overwrites a readonly file, if possible.
2257 *cpo-x*
2258 x <Esc> on the command-line executes the command-line.
2259 The default in Vim is to abandon the command-line,
2260 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002261 *cpo-X*
2262 X When using a count with "R" the replaced text is
2263 deleted only once. Also when repeating "R" with "."
2264 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *cpo-y*
2266 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002267 *cpo-Z*
2268 Z When using "w!" while the 'readonly' option is set,
2269 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-!*
2271 ! When redoing a filter command, use the last used
2272 external command, whatever it was. Otherwise the last
2273 used -filter- command is used.
2274 *cpo-$*
2275 $ When making a change to one line, don't redisplay the
2276 line, but put a '$' at the end of the changed text.
2277 The changed text will be overwritten when you type the
2278 new text. The line is redisplayed if you type any
2279 command that moves the cursor from the insertion
2280 point.
2281 *cpo-%*
2282 % Vi-compatible matching is done for the "%" command.
2283 Does not recognize "#if", "#endif", etc.
2284 Does not recognize "/*" and "*/".
2285 Parens inside single and double quotes are also
2286 counted, causing a string that contains a paren to
2287 disturb the matching. For example, in a line like
2288 "if (strcmp("foo(", s))" the first paren does not
2289 match the last one. When this flag is not included,
2290 parens inside single and double quotes are treated
2291 specially. When matching a paren outside of quotes,
2292 everything inside quotes is ignored. When matching a
2293 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002294 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002295 This flag is also used for other features, such as
2296 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002297 *cpo--*
2298 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002299 it would go above the first line or below the last
2300 line. Without it the cursor moves to the first or
2301 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002302 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002303 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002304 *cpo-+*
2305 + When included, a ":write file" command will reset the
2306 'modified' flag of the buffer, even though the buffer
2307 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002308 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 * Use ":*" in the same way as ":@". When not included,
2310 ":*" is an alias for ":'<,'>", select the Visual area.
2311 *cpo-<*
2312 < Disable the recognition of special key codes in |<>|
2313 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002314 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 ":map X <Tab>" results in X being mapped to:
2316 '<' included: "<Tab>" (5 characters)
2317 '<' excluded: "^I" (^I is a real <Tab>)
2318 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002319 *cpo->*
2320 > When appending to a register, put a line break before
2321 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002322 *cpo-;*
2323 ; When using |,| or |;| to repeat the last |t| search
2324 and the cursor is right in front of the searched
2325 character, the cursor won't move. When not included,
2326 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002327 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328
2329 POSIX flags. These are not included in the Vi default value, except
2330 when $VIM_POSIX was set on startup. |posix|
2331
2332 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002333 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002334 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002335 *cpo-&*
2336 & When ":preserve" was used keep the swap file when
2337 exiting normally while this buffer is still loaded.
2338 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002339 *cpo-\*
2340 \ Backslash in a [] range in a search pattern is taken
2341 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002342 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2343 '\' excluded: "/[ \-]" finds <Space> and '-'
2344 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002345 *cpo-/*
2346 / When "%" is used as the replacement string in a |:s|
2347 command, use the previous replacement string. |:s%|
2348 *cpo-{*
2349 { The |{| and |}| commands also stop at a "{" character
2350 at the start of a line.
2351 *cpo-.*
2352 . The ":chdir" and ":cd" commands fail if the current
2353 buffer is modified, unless ! is used. Vim doesn't
2354 need this, since it remembers the full path of an
2355 opened file.
2356 *cpo-bar*
2357 | The value of the $LINES and $COLUMNS environment
2358 variables overrule the terminal size values obtained
2359 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002360
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002362 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002363'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002364 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002365 {not in Vi}
2366 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002367 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002368 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002369 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002370 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002371 blowfish Blowfish method. Medium strong encryption but it has
2372 an implementation flaw. Requires Vim 7.3 or later,
2373 files can NOT be read by Vim 7.2 and older. This adds
2374 a "seed" to the file, every time you write the file
2375 the encrypted bytes will be different.
2376 *blowfish2*
2377 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002378 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002379 and older. This adds a "seed" to the file, every time
2380 you write the file the encrypted bytes will be
2381 different. The whole undo file is encrypted, not just
2382 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002383
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002384 You should use "blowfish2", also to re-encrypt older files.
2385
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002386 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002387 to the detected method of the file being read. Thus if you write it
2388 without changing 'cryptmethod' the same method will be used.
2389 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002390 explicitly write it, you don't get a warning unless there are other
2391 modifications. Also see |:X|.
2392
2393 When setting the global value to an empty string, it will end up with
2394 the value "zip". When setting the local value to an empty string the
2395 buffer will use the global value.
2396
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002397 When a new encryption method is added in a later version of Vim, and
2398 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002399 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002400
2401
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 *'cscopepathcomp'* *'cspc'*
2403'cscopepathcomp' 'cspc' number (default 0)
2404 global
2405 {not available when compiled without the |+cscope|
2406 feature}
2407 {not in Vi}
2408 Determines how many components of the path to show in a list of tags.
2409 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002410 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411
2412 *'cscopeprg'* *'csprg'*
2413'cscopeprg' 'csprg' string (default "cscope")
2414 global
2415 {not available when compiled without the |+cscope|
2416 feature}
2417 {not in Vi}
2418 Specifies the command to execute cscope. See |cscopeprg|.
2419 This option cannot be set from a |modeline| or in the |sandbox|, for
2420 security reasons.
2421
2422 *'cscopequickfix'* *'csqf'*
2423'cscopequickfix' 'csqf' string (default "")
2424 global
2425 {not available when compiled without the |+cscope|
2426 or |+quickfix| features}
2427 {not in Vi}
2428 Specifies whether to use quickfix window to show cscope results.
2429 See |cscopequickfix|.
2430
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002431 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002432'cscoperelative' 'csre' boolean (default off)
2433 global
2434 {not available when compiled without the |+cscope|
2435 feature}
2436 {not in Vi}
2437 In the absence of a prefix (-P) for cscope. setting this option enables
2438 to use the basename of cscope.out path as the prefix.
2439 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002440 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002441
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2443'cscopetag' 'cst' boolean (default off)
2444 global
2445 {not available when compiled without the |+cscope|
2446 feature}
2447 {not in Vi}
2448 Use cscope for tag commands. See |cscope-options|.
2449 NOTE: This option is reset when 'compatible' is set.
2450
2451 *'cscopetagorder'* *'csto'*
2452'cscopetagorder' 'csto' number (default 0)
2453 global
2454 {not available when compiled without the |+cscope|
2455 feature}
2456 {not in Vi}
2457 Determines the order in which ":cstag" performs a search. See
2458 |cscopetagorder|.
2459 NOTE: This option is set to 0 when 'compatible' is set.
2460
2461 *'cscopeverbose'* *'csverb'*
2462 *'nocscopeverbose'* *'nocsverb'*
2463'cscopeverbose' 'csverb' boolean (default off)
2464 global
2465 {not available when compiled without the |+cscope|
2466 feature}
2467 {not in Vi}
2468 Give messages when adding a cscope database. See |cscopeverbose|.
2469 NOTE: This option is reset when 'compatible' is set.
2470
Bram Moolenaar860cae12010-06-05 23:22:07 +02002471 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2472'cursorbind' 'crb' boolean (default off)
2473 local to window
2474 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002475 When this option is set, as the cursor in the current
2476 window moves other cursorbound windows (windows that also have
2477 this option set) move their cursors to the corresponding line and
2478 column. This option is useful for viewing the
2479 differences between two versions of a file (see 'diff'); in diff mode,
2480 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002481 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002482
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002483
2484 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2485'cursorcolumn' 'cuc' boolean (default off)
2486 local to window
2487 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002488 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002489 feature}
2490 Highlight the screen column of the cursor with CursorColumn
2491 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2492 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002493 If you only want the highlighting in the current window you can use
2494 these autocommands: >
2495 au WinLeave * set nocursorline nocursorcolumn
2496 au WinEnter * set cursorline cursorcolumn
2497<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002498
2499 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2500'cursorline' 'cul' boolean (default off)
2501 local to window
2502 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002503 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002504 feature}
2505 Highlight the screen line of the cursor with CursorLine
2506 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2507 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002508 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002509 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002510
2511
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512 *'debug'*
2513'debug' string (default "")
2514 global
2515 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002516 These values can be used:
2517 msg Error messages that would otherwise be omitted will be given
2518 anyway.
2519 throw Error messages that would otherwise be omitted will be given
2520 anyway and also throw an exception and set |v:errmsg|.
2521 beep A message will be given when otherwise only a beep would be
2522 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002523 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002524 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2525 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526
2527 *'define'* *'def'*
2528'define' 'def' string (default "^\s*#\s*define")
2529 global or local to buffer |global-local|
2530 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002531 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 pattern, just like for the "/" command. This option is used for the
2533 commands like "[i" and "[d" |include-search|. The 'isident' option is
2534 used to recognize the defined name after the match:
2535 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2536 See |option-backslash| about inserting backslashes to include a space
2537 or backslash.
2538 The default value is for C programs. For C++ this value would be
2539 useful, to include const type declarations: >
2540 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2541< When using the ":set" command, you need to double the backslashes!
2542
2543 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2544'delcombine' 'deco' boolean (default off)
2545 global
2546 {not in Vi}
2547 {only available when compiled with the |+multi_byte|
2548 feature}
2549 If editing Unicode and this option is set, backspace and Normal mode
2550 "x" delete each combining character on its own. When it is off (the
2551 default) the character along with its combining characters are
2552 deleted.
2553 Note: When 'delcombine' is set "xx" may work different from "2x"!
2554
2555 This is useful for Arabic, Hebrew and many other languages where one
2556 may have combining characters overtop of base characters, and want
2557 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002558 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559
2560 *'dictionary'* *'dict'*
2561'dictionary' 'dict' string (default "")
2562 global or local to buffer |global-local|
2563 {not in Vi}
2564 List of file names, separated by commas, that are used to lookup words
2565 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2566 contain a list of words. This can be one word per line, or several
2567 words per line, separated by non-keyword characters (white space is
2568 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002569
2570 When this option is empty or an entry "spell" is present, and spell
2571 checking is enabled, words in the word lists for the currently active
2572 'spelllang' are used. See |spell|.
2573
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 after a comma are ignored, otherwise spaces are included in the file
2576 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002577 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Where to find a list of words?
2579 - On FreeBSD, there is the file "/usr/share/dict/words".
2580 - In the Simtel archive, look in the "msdos/linguist" directory.
2581 - In "miscfiles" of the GNU collection.
2582 The use of |:set+=| and |:set-=| is preferred when adding or removing
2583 directories from the list. This avoids problems when a future version
2584 uses another default.
2585 Backticks cannot be used in this option for security reasons.
2586
2587 *'diff'* *'nodiff'*
2588'diff' boolean (default off)
2589 local to window
2590 {not in Vi}
2591 {not available when compiled without the |+diff|
2592 feature}
2593 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002594 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595
2596 *'dex'* *'diffexpr'*
2597'diffexpr' 'dex' string (default "")
2598 global
2599 {not in Vi}
2600 {not available when compiled without the |+diff|
2601 feature}
2602 Expression which is evaluated to obtain an ed-style diff file from two
2603 versions of a file. See |diff-diffexpr|.
2604 This option cannot be set from a |modeline| or in the |sandbox|, for
2605 security reasons.
2606
2607 *'dip'* *'diffopt'*
2608'diffopt' 'dip' string (default "filler")
2609 global
2610 {not in Vi}
2611 {not available when compiled without the |+diff|
2612 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002613 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 All are optional. Items must be separated by a comma.
2615
2616 filler Show filler lines, to keep the text
2617 synchronized with a window that has inserted
2618 lines at the same position. Mostly useful
2619 when windows are side-by-side and 'scrollbind'
2620 is set.
2621
2622 context:{n} Use a context of {n} lines between a change
2623 and a fold that contains unchanged lines.
2624 When omitted a context of six lines is used.
2625 See |fold-diff|.
2626
2627 icase Ignore changes in case of text. "a" and "A"
2628 are considered the same. Adds the "-i" flag
2629 to the "diff" command if 'diffexpr' is empty.
2630
2631 iwhite Ignore changes in amount of white space. Adds
2632 the "-b" flag to the "diff" command if
2633 'diffexpr' is empty. Check the documentation
2634 of the "diff" command for what this does
2635 exactly. It should ignore adding trailing
2636 white space, but not leading white space.
2637
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002638 horizontal Start diff mode with horizontal splits (unless
2639 explicitly specified otherwise).
2640
2641 vertical Start diff mode with vertical splits (unless
2642 explicitly specified otherwise).
2643
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002644 hiddenoff Do not use diff mode for a buffer when it
2645 becomes hidden.
2646
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002647 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2648 starting diff mode. Without this 2 is used.
2649
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 Examples: >
2651
2652 :set diffopt=filler,context:4
2653 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002654 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655<
2656 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2657'digraph' 'dg' boolean (default off)
2658 global
2659 {not in Vi}
2660 {not available when compiled without the |+digraphs|
2661 feature}
2662 Enable the entering of digraphs in Insert mode with {char1} <BS>
2663 {char2}. See |digraphs|.
2664 NOTE: This option is reset when 'compatible' is set.
2665
2666 *'directory'* *'dir'*
2667'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002668 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 for Unix: ".,~/tmp,/var/tmp,/tmp")
2670 global
2671 List of directory names for the swap file, separated with commas.
2672 - The swap file will be created in the first directory where this is
2673 possible.
2674 - Empty means that no swap file will be used (recovery is
2675 impossible!).
2676 - A directory "." means to put the swap file in the same directory as
2677 the edited file. On Unix, a dot is prepended to the file name, so
2678 it doesn't show in a directory listing. On MS-Windows the "hidden"
2679 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002680 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 put the swap file relative to where the edited file is. The leading
2682 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002683 - For Unix and Win32, if a directory ends in two path separators "//"
2684 or "\\", the swap file name will be built from the complete path to
2685 the file with all path separators substituted to percent '%' signs.
2686 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002687 On Win32, when a separating comma is following, you must use "//",
2688 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 - Spaces after the comma are ignored, other spaces are considered part
2690 of the directory name. To have a space at the start of a directory
2691 name, precede it with a backslash.
2692 - To include a comma in a directory name precede it with a backslash.
2693 - A directory name may end in an ':' or '/'.
2694 - Environment variables are expanded |:set_env|.
2695 - Careful with '\' characters, type one before a space, type two to
2696 get one in the option (see |option-backslash|), for example: >
2697 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2698< - For backwards compatibility with Vim version 3.0 a '>' at the start
2699 of the option is removed.
2700 Using "." first in the list is recommended. This means that editing
2701 the same file twice will result in a warning. Using "/tmp" on Unix is
2702 discouraged: When the system crashes you lose the swap file.
2703 "/var/tmp" is often not cleared when rebooting, thus is a better
2704 choice than "/tmp". But it can contain a lot of files, your swap
2705 files get lost in the crowd. That is why a "tmp" directory in your
2706 home directory is tried first.
2707 The use of |:set+=| and |:set-=| is preferred when adding or removing
2708 directories from the list. This avoids problems when a future version
2709 uses another default.
2710 This option cannot be set from a |modeline| or in the |sandbox|, for
2711 security reasons.
2712 {Vi: directory to put temp file in, defaults to "/tmp"}
2713
2714 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002715'display' 'dy' string (default "", set to "truncate" in
2716 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 global
2718 {not in Vi}
2719 Change the way text is displayed. This is comma separated list of
2720 flags:
2721 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002722 in a window will be displayed. "@@@" is put in the
2723 last columns of the last screen line to indicate the
2724 rest of the line is not displayed.
2725 truncate Like "lastline", but "@@@" is displayed in the first
2726 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 uhex Show unprintable characters hexadecimal as <xx>
2728 instead of using ^C and ~C.
2729
Bram Moolenaard0796902016-09-16 20:02:31 +02002730 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002731 doesn't fit is replaced with "@" lines.
2732
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 *'eadirection'* *'ead'*
2734'eadirection' 'ead' string (default "both")
2735 global
2736 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002737 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 feature}
2739 Tells when the 'equalalways' option applies:
2740 ver vertically, width of windows is not affected
2741 hor horizontally, height of windows is not affected
2742 both width and height of windows is affected
2743
2744 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2745'edcompatible' 'ed' boolean (default off)
2746 global
2747 Makes the 'g' and 'c' flags of the ":substitute" command to be
2748 toggled each time the flag is given. See |complex-change|. See
2749 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002750 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751
Bram Moolenaar03413f42016-04-12 21:07:15 +02002752 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002753'emoji' 'emo' boolean (default: on)
2754 global
2755 {not in Vi}
2756 {only available when compiled with the |+multi_byte|
2757 feature}
2758 When on all Unicode emoji characters are considered to be full width.
2759
2760
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 *'encoding'* *'enc'* *E543*
2762'encoding' 'enc' string (default: "latin1" or value from $LANG)
2763 global
2764 {only available when compiled with the |+multi_byte|
2765 feature}
2766 {not in Vi}
2767 Sets the character encoding used inside Vim. It applies to text in
2768 the buffers, registers, Strings in expressions, text stored in the
2769 viminfo file, etc. It sets the kind of characters which Vim can work
2770 with. See |encoding-names| for the possible values.
2771
2772 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002773 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002775 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776
Bram Moolenaar865242e2010-07-14 21:12:05 +02002777 This option cannot be set from a |modeline|. It would most likely
2778 corrupt the text.
2779
Bram Moolenaar3df01732017-02-17 22:47:16 +01002780 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2781 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 'encoding', "utf-8" is the natural choice for the environment and
2783 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002784 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 versions, and to avoid changing the encoding of newly created files
2786 without your knowledge (in case 'fileencodings' is empty).
2787
2788 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002789 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 iconv() or as specified with 'charconvert'.
2791
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002792 If you need to know whether 'encoding' is a multi-byte encoding, you
2793 can use: >
2794 if has("multi_byte_encoding")
2795<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 Normally 'encoding' will be equal to your current locale. This will
2797 be the default if Vim recognizes your environment settings. If
2798 'encoding' is not set to the current locale, 'termencoding' must be
2799 set to convert typed and displayed text. See |encoding-table|.
2800
2801 When you set this option, it fires the |EncodingChanged| autocommand
2802 event so that you can set up fonts if necessary.
2803
2804 When the option is set, the value is converted to lowercase. Thus
2805 you can set it with uppercase values too. Underscores are translated
2806 to '-' signs.
2807 When the encoding is recognized, it is changed to the standard name.
2808 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2809 "iso-8859-2" and "utf8" becomes "utf-8".
2810
2811 Note: "latin1" is also used when the encoding could not be detected.
2812 This only works when editing files in the same encoding! When the
2813 actual character set is not latin1, make sure 'fileencoding' and
2814 'fileencodings' are empty. When conversion is needed, switch to using
2815 utf-8.
2816
2817 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2818 You don't notice this while editing, but it does matter for the
2819 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2820 setting 'encoding' to one of these values instead of utf-8 only has
2821 effect for encoding used for files when 'fileencoding' is empty.
2822
Bram Moolenaar661b1822005-07-28 22:36:45 +00002823 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2824 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825
2826 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2827'endofline' 'eol' boolean (default on)
2828 local to buffer
2829 {not in Vi}
2830 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002831 is on, or 'fixeol' option is off, no <EOL> will be written for the
2832 last line in the file. This option is automatically set or reset when
2833 starting to edit a new file, depending on whether file has an <EOL>
2834 for the last line in the file. Normally you don't have to set or
2835 reset this option.
2836 When 'binary' is off and 'fixeol' is on the value is not used when
2837 writing the file. When 'binary' is on or 'fixeol' is off it is used
2838 to remember the presence of a <EOL> for the last line in the file, so
2839 that when you write the file the situation from the original file can
2840 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2843'equalalways' 'ea' boolean (default on)
2844 global
2845 {not in Vi}
2846 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002847 splitting or closing a window. This also happens the moment the
2848 option is switched on. When off, splitting a window will reduce the
2849 size of the current window and leave the other windows the same. When
2850 closing a window the extra lines are given to the window next to it
2851 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 When mixing vertically and horizontally split windows, a minimal size
2853 is computed and some windows may be larger if there is room. The
2854 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002855 Changing the height and width of a window can be avoided by setting
2856 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002857 If a window size is specified when creating a new window sizes are
2858 currently not equalized (it's complicated, but may be implemented in
2859 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
2861 *'equalprg'* *'ep'*
2862'equalprg' 'ep' string (default "")
2863 global or local to buffer |global-local|
2864 {not in Vi}
2865 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002866 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002867 or 'indentexpr'. When Vim was compiled without internal formatting,
2868 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002869 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 about including spaces and backslashes.
2871 This option cannot be set from a |modeline| or in the |sandbox|, for
2872 security reasons.
2873
2874 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2875'errorbells' 'eb' boolean (default off)
2876 global
2877 Ring the bell (beep or screen flash) for error messages. This only
2878 makes a difference for error messages, the bell will be used always
2879 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002880 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002881 screen flash or do nothing. See 'belloff' to finetune when to ring the
2882 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883
2884 *'errorfile'* *'ef'*
2885'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2886 others: "errors.err")
2887 global
2888 {not in Vi}
2889 {not available when compiled without the |+quickfix|
2890 feature}
2891 Name of the errorfile for the QuickFix mode (see |:cf|).
2892 When the "-q" command-line argument is used, 'errorfile' is set to the
2893 following argument. See |-q|.
2894 NOT used for the ":make" command. See 'makeef' for that.
2895 Environment variables are expanded |:set_env|.
2896 See |option-backslash| about including spaces and backslashes.
2897 This option cannot be set from a |modeline| or in the |sandbox|, for
2898 security reasons.
2899
2900 *'errorformat'* *'efm'*
2901'errorformat' 'efm' string (default is very long)
2902 global or local to buffer |global-local|
2903 {not in Vi}
2904 {not available when compiled without the |+quickfix|
2905 feature}
2906 Scanf-like description of the format for the lines in the error file
2907 (see |errorformat|).
2908
2909 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2910'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2911 global
2912 {not in Vi}
2913 Function keys that start with an <Esc> are recognized in Insert
2914 mode. When this option is off, the cursor and function keys cannot be
2915 used in Insert mode if they start with an <Esc>. The advantage of
2916 this is that the single <Esc> is recognized immediately, instead of
2917 after one second. Instead of resetting this option, you might want to
2918 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2919 when 'esckeys' is off, you can still map anything, but the cursor keys
2920 won't work by default.
2921 NOTE: This option is set to the Vi default value when 'compatible' is
2922 set and to the Vim default value when 'compatible' is reset.
2923
2924 *'eventignore'* *'ei'*
2925'eventignore' 'ei' string (default "")
2926 global
2927 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002929 When set to "all" or when "all" is one of the items, all autocommand
2930 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 Otherwise this is a comma separated list of event names. Example: >
2932 :set ei=WinEnter,WinLeave
2933<
2934 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2935'expandtab' 'et' boolean (default off)
2936 local to buffer
2937 {not in Vi}
2938 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002939 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2941 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002942 This option is reset when the 'paste' option is set and restored when
2943 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 NOTE: This option is reset when 'compatible' is set.
2945
2946 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2947'exrc' 'ex' boolean (default off)
2948 global
2949 {not in Vi}
2950 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002951 directory.
2952
2953 Setting this option is a potential security leak. E.g., consider
2954 unpacking a package or fetching files from github, a .vimrc in there
2955 might be a trojan horse. BETTER NOT SET THIS OPTION!
2956 Instead, define an autocommand in your .vimrc to set options for a
2957 matching directory.
2958
2959 If you do switch this option on you should also consider setting the
2960 'secure' option (see |initialization|).
2961 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 This option cannot be set from a |modeline| or in the |sandbox|, for
2963 security reasons.
2964
2965 *'fileencoding'* *'fenc'* *E213*
2966'fileencoding' 'fenc' string (default: "")
2967 local to buffer
2968 {only available when compiled with the |+multi_byte|
2969 feature}
2970 {not in Vi}
2971 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002974 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 When 'fileencoding' is empty, the same value as 'encoding' will be
2976 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002977 No error will be given when the value is set, only when it is used,
2978 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002979 Conversion will also be done when 'encoding' and 'fileencoding' are
2980 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2981 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002983 'encoding' is "utf-8" or another Unicode encoding, conversion
2984 is most likely done in a way that the reverse conversion
2985 results in the same text. When 'encoding' is not "utf-8" some
2986 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 See 'encoding' for the possible values. Additionally, values may be
2989 specified that can be handled by the converter, see
2990 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002991
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 When reading a file 'fileencoding' will be set from 'fileencodings'.
2993 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002994 'fileencoding', use the |++enc| argument. One exception: when
2995 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002996 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002997
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2999 When the option is set, the value is converted to lowercase. Thus
3000 you can set it with uppercase values too. '_' characters are
3001 replaced with '-'. If a name is recognized from the list for
3002 'encoding', it is replaced by the standard name. For example
3003 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 When this option is set, after starting to edit a file, the 'modified'
3006 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003007
3008 Keep in mind that changing 'fenc' from a modeline happens
3009 AFTER the text has been read, thus it applies to when the file will be
3010 written. If you do set 'fenc' in a modeline, you might want to set
3011 'nomodified' to avoid not being able to ":q".
3012
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 This option can not be changed when 'modifiable' is off.
3014
3015 *'fe'*
3016 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003017 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 old short name was 'fe', which is no longer used.
3019
3020 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003021'fileencodings' 'fencs' string (default: "ucs-bom",
3022 "ucs-bom,utf-8,default,latin1" when
3023 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 global
3025 {only available when compiled with the |+multi_byte|
3026 feature}
3027 {not in Vi}
3028 This is a list of character encodings considered when starting to edit
3029 an existing file. When a file is read, Vim tries to use the first
3030 mentioned character encoding. If an error is detected, the next one
3031 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003032 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 an empty string, which means the value of 'encoding' is used.
3034 WARNING: Conversion can cause loss of information! When
3035 'encoding' is "utf-8" (or one of the other Unicode variants)
3036 conversion is most likely done in a way that the reverse
3037 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003038 "utf-8" some non-ASCII characters may be lost! You can use
3039 the |++bad| argument to specify what is done with characters
3040 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 For an empty file or a file with only ASCII characters most encodings
3042 will work and the first entry of 'fileencodings' will be used (except
3043 "ucs-bom", which requires the BOM to be present). If you prefer
3044 another encoding use an BufReadPost autocommand event to test if your
3045 preferred encoding is to be used. Example: >
3046 au BufReadPost * if search('\S', 'w') == 0 |
3047 \ set fenc=iso-2022-jp | endif
3048< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3049 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003050 When the |++enc| argument is used then the value of 'fileencodings' is
3051 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003052 Note that 'fileencodings' is not used for a new file, the global value
3053 of 'fileencoding' is used instead. You can set it with: >
3054 :setglobal fenc=iso-8859-2
3055< This means that a non-existing file may get a different encoding than
3056 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 The special value "ucs-bom" can be used to check for a Unicode BOM
3058 (Byte Order Mark) at the start of the file. It must not be preceded
3059 by "utf-8" or another Unicode encoding for this to work properly.
3060 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3061 because Vim cannot detect an error, thus the encoding is always
3062 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003063 The special value "default" can be used for the encoding from the
3064 environment. This is the default value for 'encoding'. It is useful
3065 when 'encoding' is set to "utf-8" and your environment uses a
3066 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003067 When 'encoding' is "utf-8" and a file contains an illegal byte
3068 sequence it won't be recognized as UTF-8. You can use the |8g8|
3069 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 WRONG VALUES: WHAT'S WRONG:
3071 latin1,utf-8 "latin1" will always be used
3072 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3073 file
3074 cp1250,latin1 "cp1250" will always be used
3075 If 'fileencodings' is empty, 'fileencoding' is not modified.
3076 See 'fileencoding' for the possible values.
3077 Setting this option does not have an effect until the next time a file
3078 is read.
3079
3080 *'fileformat'* *'ff'*
3081'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3082 Unix default: "unix",
3083 Macintosh default: "mac")
3084 local to buffer
3085 {not in Vi}
3086 This gives the <EOL> of the current buffer, which is used for
3087 reading/writing the buffer from/to a file:
3088 dos <CR> <NL>
3089 unix <NL>
3090 mac <CR>
3091 When "dos" is used, CTRL-Z at the end of a file is ignored.
3092 See |file-formats| and |file-read|.
3093 For the character encoding of the file see 'fileencoding'.
3094 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003095 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 This option is set automatically when starting to edit a file and
3097 'fileformats' is not empty and 'binary' is off.
3098 When this option is set, after starting to edit a file, the 'modified'
3099 option is set, because the file would be different when written.
3100 This option can not be changed when 'modifiable' is off.
3101 For backwards compatibility: When this option is set to "dos",
3102 'textmode' is set, otherwise 'textmode' is reset.
3103
3104 *'fileformats'* *'ffs'*
3105'fileformats' 'ffs' string (default:
3106 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3107 Vim Unix: "unix,dos",
3108 Vim Mac: "mac,unix,dos",
3109 Vi Cygwin: "unix,dos",
3110 Vi others: "")
3111 global
3112 {not in Vi}
3113 This gives the end-of-line (<EOL>) formats that will be tried when
3114 starting to edit a new buffer and when reading a file into an existing
3115 buffer:
3116 - When empty, the format defined with 'fileformat' will be used
3117 always. It is not set automatically.
3118 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003119 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 'fileformats' name will be used when a file is read into an existing
3121 buffer, no matter what 'fileformat' for that buffer is set to.
3122 - When more than one name is present, separated by commas, automatic
3123 <EOL> detection will be done when reading a file. When starting to
3124 edit a file, a check is done for the <EOL>:
3125 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3126 'fileformat' is set to "dos".
3127 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003128 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003130 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3131 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003132 This means that "mac" is only chosen when:
3133 "unix" is not present or no <NL> is found in the file, and
3134 "dos" is not present or no <CR><NL> is found in the file.
3135 Except: if "unix" was chosen, but there is a <CR> before
3136 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003137 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 4. If 'fileformat' is still not set, the first name from
3139 'fileformats' is used.
3140 When reading a file into an existing buffer, the same is done, but
3141 this happens like 'fileformat' has been set appropriately for that
3142 file only, the option is not changed.
3143 When 'binary' is set, the value of 'fileformats' is not used.
3144
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003145 When Vim starts up with an empty buffer the first item is used. You
3146 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003147
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3149 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3150 done:
3151 - When 'fileformats' is empty, there is no automatic detection. Dos
3152 format will be used.
3153 - When 'fileformats' is set to one or more names, automatic detection
3154 is done. This is based on the first <NL> in the file: If there is a
3155 <CR> in front of it, Dos format is used, otherwise Unix format is
3156 used.
3157 Also see |file-formats|.
3158 For backwards compatibility: When this option is set to an empty
3159 string or one format (no comma is included), 'textauto' is reset,
3160 otherwise 'textauto' is set.
3161 NOTE: This option is set to the Vi default value when 'compatible' is
3162 set and to the Vim default value when 'compatible' is reset.
3163
Bram Moolenaarbf884932013-04-05 22:26:15 +02003164 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3165'fileignorecase' 'fic' boolean (default on for systems where case in file
3166 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003167 global
3168 {not in Vi}
3169 When set case is ignored when using file names and directories.
3170 See 'wildignorecase' for only ignoring case when doing completion.
3171
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 *'filetype'* *'ft'*
3173'filetype' 'ft' string (default: "")
3174 local to buffer
3175 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 When this option is set, the FileType autocommand event is triggered.
3177 All autocommands that match with the value of this option will be
3178 executed. Thus the value of 'filetype' is used in place of the file
3179 name.
3180 Otherwise this option does not always reflect the current file type.
3181 This option is normally set when the file type is detected. To enable
3182 this use the ":filetype on" command. |:filetype|
3183 Setting this option to a different value is most useful in a modeline,
3184 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003185 Example, for in an IDL file:
3186 /* vim: set filetype=idl : */ ~
3187 |FileType| |filetypes|
3188 When a dot appears in the value then this separates two filetype
3189 names. Example:
3190 /* vim: set filetype=c.doxygen : */ ~
3191 This will use the "c" filetype first, then the "doxygen" filetype.
3192 This works both for filetype plugins and for syntax files. More than
3193 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 This option is not copied to another buffer, independent of the 's' or
3195 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003196 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
3198 *'fillchars'* *'fcs'*
3199'fillchars' 'fcs' string (default "vert:|,fold:-")
3200 global
3201 {not in Vi}
3202 {not available when compiled without the |+windows|
3203 and |+folding| features}
3204 Characters to fill the statuslines and vertical separators.
3205 It is a comma separated list of items:
3206
3207 item default Used for ~
3208 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003209 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 vert:c '|' vertical separators |:vsplit|
3211 fold:c '-' filling 'foldtext'
3212 diff:c '-' deleted lines of the 'diff' option
3213
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003214 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003215 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 otherwise.
3217
3218 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003219 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220< This is similar to the default, except that these characters will also
3221 be used when there is highlighting.
3222
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003223 for "stl" and "stlnc" only single-byte values are supported.
3224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 The highlighting used for these items:
3226 item highlight group ~
3227 stl:c StatusLine |hl-StatusLine|
3228 stlnc:c StatusLineNC |hl-StatusLineNC|
3229 vert:c VertSplit |hl-VertSplit|
3230 fold:c Folded |hl-Folded|
3231 diff:c DiffDelete |hl-DiffDelete|
3232
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003233 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3234'fixendofline' 'fixeol' boolean (default on)
3235 local to buffer
3236 {not in Vi}
3237 When writing a file and this option is on, <EOL> at the end of file
3238 will be restored if missing. Turn this option off if you want to
3239 preserve the situation from the original file.
3240 When the 'binary' option is set the value of this option doesn't
3241 matter.
3242 See the 'endofline' option.
3243
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3245'fkmap' 'fk' boolean (default off) *E198*
3246 global
3247 {not in Vi}
3248 {only available when compiled with the |+rightleft|
3249 feature}
3250 When on, the keyboard is mapped for the Farsi character set.
3251 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003252 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253
3254 *'foldclose'* *'fcl'*
3255'foldclose' 'fcl' string (default "")
3256 global
3257 {not in Vi}
3258 {not available when compiled without the |+folding|
3259 feature}
3260 When set to "all", a fold is closed when the cursor isn't in it and
3261 its level is higher than 'foldlevel'. Useful if you want folds to
3262 automatically close when moving out of them.
3263
3264 *'foldcolumn'* *'fdc'*
3265'foldcolumn' 'fdc' number (default 0)
3266 local to window
3267 {not in Vi}
3268 {not available when compiled without the |+folding|
3269 feature}
3270 When non-zero, a column with the specified width is shown at the side
3271 of the window which indicates open and closed folds. The maximum
3272 value is 12.
3273 See |folding|.
3274
3275 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3276'foldenable' 'fen' boolean (default on)
3277 local to window
3278 {not in Vi}
3279 {not available when compiled without the |+folding|
3280 feature}
3281 When off, all folds are open. This option can be used to quickly
3282 switch between showing all text unfolded and viewing the text with
3283 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 'foldenable' is off.
3286 This option is set by commands that create a new fold or close a fold.
3287 See |folding|.
3288
3289 *'foldexpr'* *'fde'*
3290'foldexpr' 'fde' string (default: "0")
3291 local to window
3292 {not in Vi}
3293 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003294 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003296 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003297
Bram Moolenaar30b65812012-07-12 22:01:11 +02003298 The expression will be evaluated in the |sandbox| if set from a
3299 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003300 This option can't be set from a |modeline| when the 'diff' option is
3301 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003302
3303 It is not allowed to change text or jump to another window while
3304 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305
3306 *'foldignore'* *'fdi'*
3307'foldignore' 'fdi' string (default: "#")
3308 local to window
3309 {not in Vi}
3310 {not available when compiled without the |+folding|
3311 feature}
3312 Used only when 'foldmethod' is "indent". Lines starting with
3313 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003314 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 The default "#" works well for C programs. See |fold-indent|.
3316
3317 *'foldlevel'* *'fdl'*
3318'foldlevel' 'fdl' number (default: 0)
3319 local to window
3320 {not in Vi}
3321 {not available when compiled without the |+folding|
3322 feature}
3323 Sets the fold level: Folds with a higher level will be closed.
3324 Setting this option to zero will close all folds. Higher numbers will
3325 close fewer folds.
3326 This option is set by commands like |zm|, |zM| and |zR|.
3327 See |fold-foldlevel|.
3328
3329 *'foldlevelstart'* *'fdls'*
3330'foldlevelstart' 'fdls' number (default: -1)
3331 global
3332 {not in Vi}
3333 {not available when compiled without the |+folding|
3334 feature}
3335 Sets 'foldlevel' when starting to edit another buffer in a window.
3336 Useful to always start editing with all folds closed (value zero),
3337 some folds closed (one) or no folds closed (99).
3338 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003339 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 ignores this option and closes all folds.
3341 It is also done before BufReadPre autocommands, to allow an autocmd to
3342 overrule the 'foldlevel' value for specific files.
3343 When the value is negative, it is not used.
3344
3345 *'foldmarker'* *'fmr'* *E536*
3346'foldmarker' 'fmr' string (default: "{{{,}}}")
3347 local to window
3348 {not in Vi}
3349 {not available when compiled without the |+folding|
3350 feature}
3351 The start and end marker used when 'foldmethod' is "marker". There
3352 must be one comma, which separates the start and end marker. The
3353 marker is a literal string (a regular expression would be too slow).
3354 See |fold-marker|.
3355
3356 *'foldmethod'* *'fdm'*
3357'foldmethod' 'fdm' string (default: "manual")
3358 local to window
3359 {not in Vi}
3360 {not available when compiled without the |+folding|
3361 feature}
3362 The kind of folding used for the current window. Possible values:
3363 |fold-manual| manual Folds are created manually.
3364 |fold-indent| indent Lines with equal indent form a fold.
3365 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3366 |fold-marker| marker Markers are used to specify folds.
3367 |fold-syntax| syntax Syntax highlighting items specify folds.
3368 |fold-diff| diff Fold text that is not changed.
3369
3370 *'foldminlines'* *'fml'*
3371'foldminlines' 'fml' number (default: 1)
3372 local to window
3373 {not in Vi}
3374 {not available when compiled without the |+folding|
3375 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003376 Sets the number of screen lines above which a fold can be displayed
3377 closed. Also for manually closed folds. With the default value of
3378 one a fold can only be closed if it takes up two or more screen lines.
3379 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003380 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 "zc" to close a fold, which is displayed open because it's smaller
3382 than 'foldminlines', a following "zc" may close a containing fold.
3383
3384 *'foldnestmax'* *'fdn'*
3385'foldnestmax' 'fdn' number (default: 20)
3386 local to window
3387 {not in Vi}
3388 {not available when compiled without the |+folding|
3389 feature}
3390 Sets the maximum nesting of folds for the "indent" and "syntax"
3391 methods. This avoids that too many folds will be created. Using more
3392 than 20 doesn't work, because the internal limit is 20.
3393
3394 *'foldopen'* *'fdo'*
3395'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3396 search,tag,undo")
3397 global
3398 {not in Vi}
3399 {not available when compiled without the |+folding|
3400 feature}
3401 Specifies for which type of commands folds will be opened, if the
3402 command moves the cursor into a closed fold. It is a comma separated
3403 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003404 NOTE: When the command is part of a mapping this option is not used.
3405 Add the |zv| command to the mapping to get the same effect.
3406 (rationale: the mapping may want to control opening folds itself)
3407
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 item commands ~
3409 all any
3410 block "(", "{", "[[", "[{", etc.
3411 hor horizontal movements: "l", "w", "fx", etc.
3412 insert any command in Insert mode
3413 jump far jumps: "G", "gg", etc.
3414 mark jumping to a mark: "'m", CTRL-O, etc.
3415 percent "%"
3416 quickfix ":cn", ":crew", ":make", etc.
3417 search search for a pattern: "/", "n", "*", "gd", etc.
3418 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003419 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 tag jumping to a tag: ":ta", CTRL-T, etc.
3421 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 When a movement command is used for an operator (e.g., "dl" or "y%")
3423 this option is not used. This means the operator will include the
3424 whole closed fold.
3425 Note that vertical movements are not here, because it would make it
3426 very difficult to move onto a closed fold.
3427 In insert mode the folds containing the cursor will always be open
3428 when text is inserted.
3429 To close folds you can re-apply 'foldlevel' with the |zx| command or
3430 set the 'foldclose' option to "all".
3431
3432 *'foldtext'* *'fdt'*
3433'foldtext' 'fdt' string (default: "foldtext()")
3434 local to window
3435 {not in Vi}
3436 {not available when compiled without the |+folding|
3437 feature}
3438 An expression which is used to specify the text displayed for a closed
3439 fold. See |fold-foldtext|.
3440
Bram Moolenaar30b65812012-07-12 22:01:11 +02003441 The expression will be evaluated in the |sandbox| if set from a
3442 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003443
3444 It is not allowed to change text or jump to another window while
3445 evaluating 'foldtext' |textlock|.
3446
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003447 *'formatexpr'* *'fex'*
3448'formatexpr' 'fex' string (default "")
3449 local to buffer
3450 {not in Vi}
3451 {not available when compiled without the |+eval|
3452 feature}
3453 Expression which is evaluated to format a range of lines for the |gq|
3454 operator or automatic formatting (see 'formatoptions'). When this
3455 option is empty 'formatprg' is used.
3456
3457 The |v:lnum| variable holds the first line to be formatted.
3458 The |v:count| variable holds the number of lines to be formatted.
3459 The |v:char| variable holds the character that is going to be
3460 inserted if the expression is being evaluated due to
3461 automatic formatting. This can be empty. Don't insert
3462 it yet!
3463
3464 Example: >
3465 :set formatexpr=mylang#Format()
3466< This will invoke the mylang#Format() function in the
3467 autoload/mylang.vim file in 'runtimepath'. |autoload|
3468
3469 The expression is also evaluated when 'textwidth' is set and adding
3470 text beyond that limit. This happens under the same conditions as
3471 when internal formatting is used. Make sure the cursor is kept in the
3472 same spot relative to the text then! The |mode()| function will
3473 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003474
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003475 When the expression evaluates to non-zero Vim will fall back to using
3476 the internal format mechanism.
3477
3478 The expression will be evaluated in the |sandbox| when set from a
3479 modeline, see |sandbox-option|. That stops the option from working,
3480 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003481 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003482
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 *'formatoptions'* *'fo'*
3484'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3485 local to buffer
3486 {not in Vi}
3487 This is a sequence of letters which describes how automatic
3488 formatting is to be done. See |fo-table|. When the 'paste' option is
3489 on, no formatting is done (like 'formatoptions' is empty). Commas can
3490 be inserted for readability.
3491 To avoid problems with flags that are added in the future, use the
3492 "+=" and "-=" feature of ":set" |add-option-flags|.
3493 NOTE: This option is set to the Vi default value when 'compatible' is
3494 set and to the Vim default value when 'compatible' is reset.
3495
Bram Moolenaar86b68352004-12-27 21:59:20 +00003496 *'formatlistpat'* *'flp'*
3497'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3498 local to buffer
3499 {not in Vi}
3500 A pattern that is used to recognize a list header. This is used for
3501 the "n" flag in 'formatoptions'.
3502 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003503 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003504 while still checking more characters. There must be a character
3505 following the pattern, when it matches the whole line it is handled
3506 like there is no match.
3507 The default recognizes a number, followed by an optional punctuation
3508 character and white space.
3509
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 *'formatprg'* *'fp'*
3511'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003512 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 {not in Vi}
3514 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003515 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003517 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003518 If the 'formatexpr' option is not empty it will be used instead.
3519 Otherwise, if 'formatprg' option is an empty string, the internal
3520 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003521 Environment variables are expanded |:set_env|. See |option-backslash|
3522 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003523 This option cannot be set from a |modeline| or in the |sandbox|, for
3524 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
Bram Moolenaard94464e2015-11-02 15:28:18 +01003526 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003527'fsync' 'fs' boolean (default on)
3528 global
3529 {not in Vi}
3530 When on, the library function fsync() will be called after writing a
3531 file. This will flush a file to disk, ensuring that it is safely
3532 written even on filesystems which do metadata-only journaling. This
3533 will force the harddrive to spin up on Linux systems running in laptop
3534 mode, so it may be undesirable in some situations. Be warned that
3535 turning this off increases the chances of data loss after a crash. On
3536 systems without an fsync() implementation, this variable is always
3537 off.
3538 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003539 'fsync' also applies to |writefile()|, unless a flag is used to
3540 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003541
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3543'gdefault' 'gd' boolean (default off)
3544 global
3545 {not in Vi}
3546 When on, the ":substitute" flag 'g' is default on. This means that
3547 all matches in a line are substituted instead of one. When a 'g' flag
3548 is given to a ":substitute" command, this will toggle the substitution
3549 of all or one match. See |complex-change|.
3550
3551 command 'gdefault' on 'gdefault' off ~
3552 :s/// subst. all subst. one
3553 :s///g subst. one subst. all
3554 :s///gg subst. all subst. one
3555
3556 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003557 DEPRECATED: Setting this option may break plugins that are not aware
3558 of this option. Also, many users get confused that adding the /g flag
3559 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003562'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 global
3564 {not in Vi}
3565 Format to recognize for the ":grep" command output.
3566 This is a scanf-like string that uses the same format as the
3567 'errorformat' option: see |errorformat|.
3568
3569 *'grepprg'* *'gp'*
3570'grepprg' 'gp' string (default "grep -n ",
3571 Unix: "grep -n $* /dev/null",
3572 Win32: "findstr /n" or "grep -n",
3573 VMS: "SEARCH/NUMBERS ")
3574 global or local to buffer |global-local|
3575 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003576 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 and '#' characters, which are expanded like when used in a command-
3578 line. The placeholder "$*" is allowed to specify where the arguments
3579 will be included. Environment variables are expanded |:set_env|. See
3580 |option-backslash| about including spaces and backslashes.
3581 When your "grep" accepts the "-H" argument, use this to make ":grep"
3582 also work well with a single file: >
3583 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003584< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003585 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3586 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003587 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 apply equally to 'grepprg'.
3589 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3590 otherwise it's "grep -n".
3591 This option cannot be set from a |modeline| or in the |sandbox|, for
3592 security reasons.
3593
3594 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3595'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3596 ve:ver35-Cursor,
3597 o:hor50-Cursor,
3598 i-ci:ver25-Cursor/lCursor,
3599 r-cr:hor20-Cursor/lCursor,
3600 sm:block-Cursor
3601 -blinkwait175-blinkoff150-blinkon175",
3602 for MS-DOS and Win32 console:
3603 "n-v-c:block,o:hor50,i-ci:hor15,
3604 r-cr:hor30,sm:block")
3605 global
3606 {not in Vi}
3607 {only available when compiled with GUI enabled, and
3608 for MS-DOS and Win32 console}
3609 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003610 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 the height of the cursor can be changed. This can be done by
3612 specifying a block cursor, or a percentage for a vertical or
3613 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003614 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3615 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003617 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 mode-list and an argument-list:
3619 mode-list:argument-list,mode-list:argument-list,..
3620 The mode-list is a dash separated list of these modes:
3621 n Normal mode
3622 v Visual mode
3623 ve Visual mode with 'selection' "exclusive" (same as 'v',
3624 if not specified)
3625 o Operator-pending mode
3626 i Insert mode
3627 r Replace mode
3628 c Command-line Normal (append) mode
3629 ci Command-line Insert mode
3630 cr Command-line Replace mode
3631 sm showmatch in Insert mode
3632 a all modes
3633 The argument-list is a dash separated list of these arguments:
3634 hor{N} horizontal bar, {N} percent of the character height
3635 ver{N} vertical bar, {N} percent of the character width
3636 block block cursor, fills the whole character
3637 [only one of the above three should be present]
3638 blinkwait{N} *cursor-blinking*
3639 blinkon{N}
3640 blinkoff{N}
3641 blink times for cursor: blinkwait is the delay before
3642 the cursor starts blinking, blinkon is the time that
3643 the cursor is shown and blinkoff is the time that the
3644 cursor is not shown. The times are in msec. When one
3645 of the numbers is zero, there is no blinking. The
3646 default is: "blinkwait700-blinkon400-blinkoff250".
3647 These numbers are used for a missing entry. This
3648 means that blinking is enabled by default. To switch
3649 blinking off you can use "blinkon0". The cursor only
3650 blinks when Vim is waiting for input, not while
3651 executing a command.
3652 To make the cursor blink in an xterm, see
3653 |xterm-blink|.
3654 {group-name}
3655 a highlight group name, that sets the color and font
3656 for the cursor
3657 {group-name}/{group-name}
3658 Two highlight group names, the first is used when
3659 no language mappings are used, the other when they
3660 are. |language-mapping|
3661
3662 Examples of parts:
3663 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3664 block cursor with colors from the "nCursor"
3665 highlight group
3666 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3667 In Insert and Command-line Insert mode, use a
3668 30% vertical bar cursor with colors from the
3669 "iCursor" highlight group. Blink a bit
3670 faster.
3671
3672 The 'a' mode is different. It will set the given argument-list for
3673 all modes. It does not reset anything to defaults. This can be used
3674 to do a common setting for all modes. For example, to switch off
3675 blinking: "a:blinkon0"
3676
3677 Examples of cursor highlighting: >
3678 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3679 :highlight Cursor gui=NONE guifg=bg guibg=fg
3680<
3681 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003682 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683'guifont' 'gfn' string (default "")
3684 global
3685 {not in Vi}
3686 {only available when compiled with GUI enabled}
3687 This is a list of fonts which will be used for the GUI version of Vim.
3688 In its simplest form the value is just one font name. When
3689 the font cannot be found you will get an error message. To try other
3690 font names a list can be specified, font names separated with commas.
3691 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003692
Bram Moolenaar05159a02005-02-26 23:04:13 +00003693 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3694 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003695
Bram Moolenaar3df01732017-02-17 22:47:16 +01003696 Note: As to the GTK GUIs, no error is given against any invalid names,
3697 and the first element of the list is always picked up and made use of.
3698 This is because, instead of identifying a given name with a font, the
3699 GTK GUIs use it to construct a pattern and try to look up a font which
3700 best matches the pattern among available fonts, and this way, the
3701 matching never fails. An invalid name doesn't matter because a number
3702 of font properties other than name will do to get the matching done.
3703
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 Spaces after a comma are ignored. To include a comma in a font name
3705 precede it with a backslash. Setting an option requires an extra
3706 backslash before a space and a backslash. See also
3707 |option-backslash|. For example: >
3708 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003709< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003711
3712 If none of the fonts can be loaded, Vim will keep the current setting.
3713 If an empty font list is given, Vim will try using other resource
3714 settings (for X, it will use the Vim.font resource), and finally it
3715 will try some builtin default which should always be there ("7x13" in
3716 the case of X). The font names given should be "normal" fonts. Vim
3717 will try to find the related bold and italic fonts.
3718
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003719 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003720 :set guifont=*
3721< will bring up a font requester, where you can pick the font you want.
3722
3723 The font name depends on the GUI used. See |setting-guifont| for a
3724 way to set 'guifont' for various systems.
3725
Bram Moolenaar3df01732017-02-17 22:47:16 +01003726 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003728< That's all. XLFDs are not used. For Chinese this is reported to work
3729 well: >
3730 if has("gui_gtk2")
3731 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3732 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3733 endif
3734<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003735 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3736
Bram Moolenaar05159a02005-02-26 23:04:13 +00003737 For Mac OSX you can use something like this: >
3738 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003739< Also see 'macatsui', it can help fix display problems.
3740 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003742 width). An exception is GTK: all fonts are accepted, but mono-spaced
3743 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003744
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 To preview a font on X11, you might be able to use the "xfontsel"
3746 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003747
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 For the Win32 GUI *E244* *E245*
3749 - takes these options in the font name:
3750 hXX - height is XX (points, can be floating-point)
3751 wXX - width is XX (points, can be floating-point)
3752 b - bold
3753 i - italic
3754 u - underline
3755 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003756 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3758 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3759 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003760 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003761 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003762 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003763 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003764 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765
3766 Use a ':' to separate the options.
3767 - A '_' can be used in the place of a space, so you don't need to use
3768 backslashes to escape the spaces.
3769 - Examples: >
3770 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3771 :set guifont=Andale_Mono:h7.5:w4.5
3772< See also |font-sizes|.
3773
3774 *'guifontset'* *'gfs'*
3775 *E250* *E252* *E234* *E597* *E598*
3776'guifontset' 'gfs' string (default "")
3777 global
3778 {not in Vi}
3779 {only available when compiled with GUI enabled and
3780 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003781 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 When not empty, specifies two (or more) fonts to be used. The first
3783 one for normal English, the second one for your special language. See
3784 |xfontset|.
3785 Setting this option also means that all font names will be handled as
3786 a fontset name. Also the ones used for the "font" argument of the
3787 |:highlight| command.
3788 The fonts must match with the current locale. If fonts for the
3789 character sets that the current locale uses are not included, setting
3790 'guifontset' will fail.
3791 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3792 the comma-separated names are alternative names, one of which will be
3793 used. In 'guifontset' the whole string is one fontset name,
3794 including the commas. It is not possible to specify alternative
3795 fontset names.
3796 This example works on many X11 systems: >
3797 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3798<
3799 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3800'guifontwide' 'gfw' string (default "")
3801 global
3802 {not in Vi}
3803 {only available when compiled with GUI enabled}
3804 When not empty, specifies a comma-separated list of fonts to be used
3805 for double-width characters. The first font that can be loaded is
3806 used.
3807 Note: The size of these fonts must be exactly twice as wide as the one
3808 specified with 'guifont' and the same height.
3809
Bram Moolenaar3df01732017-02-17 22:47:16 +01003810 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811
3812 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3813 'guifontset' is empty or invalid.
3814 When 'guifont' is set and a valid font is found in it and
3815 'guifontwide' is empty Vim will attempt to find a matching
3816 double-width font and set 'guifontwide' to it.
3817
Bram Moolenaar3df01732017-02-17 22:47:16 +01003818 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819
3820 If set and valid, 'guifontwide' is always used for double width
3821 characters, even if 'encoding' is not set to "utf-8".
3822 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003823 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 font for characters not available in 'guifont'. Thus you do not need
3825 to set 'guifontwide' at all unless you want to override the choice
3826 made by Pango/Xft.
3827
Bram Moolenaar0f272122013-01-23 18:37:40 +01003828 Windows +multibyte only: *guifontwide_win_mbyte*
3829
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003830 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003831
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 *'guiheadroom'* *'ghr'*
3833'guiheadroom' 'ghr' number (default 50)
3834 global
3835 {not in Vi} {only for GTK and X11 GUI}
3836 The number of pixels subtracted from the screen height when fitting
3837 the GUI window on the screen. Set this before the GUI is started,
3838 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003839 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 lines will be left for window decorations and other items on the
3841 screen. Set it to a negative value to allow windows taller than the
3842 screen.
3843
3844 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003845'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3846 removed in |defaults.vim|),
3847 "aegimrLtT" (GTK, Motif and Athena),
3848 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 global
3850 {not in Vi}
3851 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003852 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 sequence of letters which describes what components and options of the
3854 GUI should be used.
3855 To avoid problems with flags that are added in the future, use the
3856 "+=" and "-=" feature of ":set" |add-option-flags|.
3857
Bram Moolenaar13568252018-03-16 20:46:58 +01003858 Valid characters are as follows:
3859 *'go-!'*
3860 '!' External commands are executed in a terminal window. Without
3861 this flag the MS-Windows GUI will open a console window to
3862 execute the command. The Unix GUI will simulate a dumb
3863 terminal to list the command output.
3864 The terminal window will be positioned at the bottom, and grow
3865 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003866 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 'a' Autoselect: If present, then whenever VISUAL mode is started,
3868 or the Visual area extended, Vim tries to become the owner of
3869 the windowing system's global selection. This means that the
3870 Visually highlighted text is available for pasting into other
3871 applications as well as into Vim itself. When the Visual mode
3872 ends, possibly due to an operation on the text, or when an
3873 application wants to paste the selection, the highlighted text
3874 is automatically yanked into the "* selection register.
3875 Thus the selection is still available for pasting into other
3876 applications after the VISUAL mode has ended.
3877 If not present, then Vim won't become the owner of the
3878 windowing system's global selection unless explicitly told to
3879 by a yank or delete operation for the "* register.
3880 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003881 *'go-P'*
3882 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003883 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003885 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 applies to the modeless selection.
3887
3888 'guioptions' autoselect Visual autoselect modeless ~
3889 "" - -
3890 "a" yes yes
3891 "A" - yes
3892 "aA" yes yes
3893
Bram Moolenaar02467872007-05-06 13:22:01 +00003894 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 'c' Use console dialogs instead of popup dialogs for simple
3896 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003897 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003898 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003899 'guitablabel' can be used to change the text in the labels.
3900 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003901 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003902 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003903 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 'f' Foreground: Don't use fork() to detach the GUI from the shell
3905 where it was started. Use this for programs that wait for the
3906 editor to finish (e.g., an e-mail program). Alternatively you
3907 can use "gvim -f" or ":gui -f" to start the GUI in the
3908 foreground. |gui-fork|
3909 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003910 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003911 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3913 corner of the window. It's black&white on non-GTK, because of
3914 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003915 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003917 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003918 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003920 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003922 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003923 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 'g' Grey menu items: Make menu items that are not active grey. If
3925 'g' is not included inactive menu items are not shown at all.
3926 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003927 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 't' Include tearoff menu items. Currently only works for Win32,
3929 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003930 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003931 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003932 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003933 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003935 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'R' Right-hand scrollbar is present when there is a vertically
3937 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003938 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003940 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 'L' Left-hand scrollbar is present when there is a vertically
3942 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003943 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3945 the longest visible line, or on the cursor line if the 'h'
3946 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003947 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'h' Limit horizontal scrollbar size to the length of the cursor
3949 line. Reduces computations. |gui-horiz-scroll|
3950
3951 And yes, you may even have scrollbars on the left AND the right if
3952 you really want to :-). See |gui-scrollbars| for more information.
3953
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003954 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 'v' Use a vertical button layout for dialogs. When not included,
3956 a horizontal layout is preferred, but when it doesn't fit a
3957 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003958 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 'p' Use Pointer callbacks for X11 GUI. This is required for some
3960 window managers. If the cursor is not blinking or hollow at
3961 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003962 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003964 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003965 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003966 *'go-k'*
3967 'k' Keep the GUI window size when adding/removing a scrollbar, or
3968 toolbar, tabline, etc. Instead, the behavior is similar to
3969 when the window is maximized and will adjust 'lines' and
3970 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003971 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003972 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003973
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 *'guipty'* *'noguipty'*
3975'guipty' boolean (default on)
3976 global
3977 {not in Vi}
3978 {only available when compiled with GUI enabled}
3979 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3980 I/O to/from shell commands. See |gui-pty|.
3981
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003982 *'guitablabel'* *'gtl'*
3983'guitablabel' 'gtl' string (default empty)
3984 global
3985 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003986 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003987 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003988 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003989 pages line. When empty and when the result is empty Vim will use a
3990 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003991
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003992 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003993 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003994 The expression will be evaluated in the |sandbox| when set from a
3995 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003996
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003997 Only used when the GUI tab pages line is displayed. 'e' must be
3998 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3999 used.
4000
Bram Moolenaar57657d82006-04-21 22:12:41 +00004001 *'guitabtooltip'* *'gtt'*
4002'guitabtooltip' 'gtt' string (default empty)
4003 global
4004 {not in Vi}
4005 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004006 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004007 When nonempty describes the text to use in a tooltip for the GUI tab
4008 pages line. When empty Vim will use a default tooltip.
4009 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004010 You can include a line break. Simplest method is to use |:let|: >
4011 :let &guitabtooltip = "line one\nline two"
4012<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004013
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 *'helpfile'* *'hf'*
4015'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4016 (others) "$VIMRUNTIME/doc/help.txt")
4017 global
4018 {not in Vi}
4019 Name of the main help file. All distributed help files should be
4020 placed together in one directory. Additionally, all "doc" directories
4021 in 'runtimepath' will be used.
4022 Environment variables are expanded |:set_env|. For example:
4023 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004024 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 spaces and backslashes.
4026 This option cannot be set from a |modeline| or in the |sandbox|, for
4027 security reasons.
4028
4029 *'helpheight'* *'hh'*
4030'helpheight' 'hh' number (default 20)
4031 global
4032 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004033 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 feature}
4035 Minimal initial height of the help window when it is opened with the
4036 ":help" command. The initial height of the help window is half of the
4037 current window, or (when the 'ea' option is on) the same as other
4038 windows. When the height is less than 'helpheight', the height is
4039 set to 'helpheight'. Set to zero to disable.
4040
4041 *'helplang'* *'hlg'*
4042'helplang' 'hlg' string (default: messages language or empty)
4043 global
4044 {only available when compiled with the |+multi_lang|
4045 feature}
4046 {not in Vi}
4047 Comma separated list of languages. Vim will use the first language
4048 for which the desired help can be found. The English help will always
4049 be used as a last resort. You can add "en" to prefer English over
4050 another language, but that will only find tags that exist in that
4051 language and not in the English help.
4052 Example: >
4053 :set helplang=de,it
4054< This will first search German, then Italian and finally English help
4055 files.
4056 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4057 try to find the tag in the current language before using this option.
4058 See |help-translated|.
4059
4060 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4061'hidden' 'hid' boolean (default off)
4062 global
4063 {not in Vi}
4064 When off a buffer is unloaded when it is |abandon|ed. When on a
4065 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4066 displayed in another window, it does not become hidden, of course.
4067 The commands that move through the buffer list sometimes make a buffer
4068 hidden although the 'hidden' option is off: When the buffer is
4069 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004070 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004071 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 This option is set for one command with ":hide {command}" |:hide|.
4073 WARNING: It's easy to forget that you have changes in hidden buffers.
4074 Think twice when using ":q!" or ":qa!".
4075
4076 *'highlight'* *'hl'*
4077'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004078 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4079 d:Directory,e:ErrorMsg,i:IncSearch,
4080 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4081 N:CursorLineNr,r:Question,s:StatusLine,
4082 S:StatusLineNC,c:VertSplit,t:Title,
4083 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4084 F:FoldColumn,A:DiffAdd,C:DiffChange,
4085 D:DiffDelete,T:DiffText,>:SignColumn,
4086 B:SpellBad,P:SpellCap,R:SpellRare,
4087 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004088 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4089 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004090 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004091 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 global
4093 {not in Vi}
4094 This option can be used to set highlighting mode for various
4095 occasions. It is a comma separated list of character pairs. The
4096 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004097 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004099 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4100 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 characters from 'showbreak'
4102 |hl-Directory| d directories in CTRL-D listing and other special
4103 things in listings
4104 |hl-ErrorMsg| e error messages
4105 h (obsolete, ignored)
4106 |hl-IncSearch| i 'incsearch' highlighting
4107 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4108 |hl-MoreMsg| m |more-prompt|
4109 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004110 |hl-LineNr| n line number for ":number" and ":#" commands, and
4111 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004112 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4113 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 |hl-Question| r |hit-enter| prompt and yes/no questions
4115 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004116 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4118 |hl-VertSplit| c column used to separate vertically split windows
4119 |hl-Visual| v Visual mode
4120 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4121 Selection" Only X11 Gui's |gui-x11| and
4122 |xterm-clipboard|.
4123 |hl-WarningMsg| w warning messages
4124 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4125 |hl-Folded| f line used for closed folds
4126 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004127 |hl-DiffAdd| A added line in diff mode
4128 |hl-DiffChange| C changed line in diff mode
4129 |hl-DiffDelete| D deleted line in diff mode
4130 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004132 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004133 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004134 |hl-SpellRare| R rare word |spell|
4135 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004136 |hl-Conceal| - the placeholders used for concealed characters
4137 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004138 |hl-Pmenu| + popup menu normal line
4139 |hl-PmenuSel| = popup menu normal line
4140 |hl-PmenuSbar| x popup menu scrollbar
4141 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142
4143 The display modes are:
4144 r reverse (termcap entry "mr" and "me")
4145 i italic (termcap entry "ZH" and "ZR")
4146 b bold (termcap entry "md" and "me")
4147 s standout (termcap entry "so" and "se")
4148 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004149 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004150 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 n no highlighting
4152 - no highlighting
4153 : use a highlight group
4154 The default is used for occasions that are not included.
4155 If you want to change what the display modes do, see |dos-colors|
4156 for an example.
4157 When using the ':' display mode, this must be followed by the name of
4158 a highlight group. A highlight group can be used to define any type
4159 of highlighting, including using color. See |:highlight| on how to
4160 define one. The default uses a different group for each occasion.
4161 See |highlight-default| for the default highlight groups.
4162
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004164'history' 'hi' number (Vim default: 50, Vi default: 0,
4165 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 global
4167 {not in Vi}
4168 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004169 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004171 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 NOTE: This option is set to the Vi default value when 'compatible' is
4173 set and to the Vim default value when 'compatible' is reset.
4174
4175 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4176'hkmap' 'hk' boolean (default off)
4177 global
4178 {not in Vi}
4179 {only available when compiled with the |+rightleft|
4180 feature}
4181 When on, the keyboard is mapped for the Hebrew character set.
4182 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4183 toggle this option. See |rileft.txt|.
4184 NOTE: This option is reset when 'compatible' is set.
4185
4186 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4187'hkmapp' 'hkp' boolean (default off)
4188 global
4189 {not in Vi}
4190 {only available when compiled with the |+rightleft|
4191 feature}
4192 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4193 This is useful if you have a non-Hebrew keyboard.
4194 See |rileft.txt|.
4195 NOTE: This option is reset when 'compatible' is set.
4196
Bram Moolenaar036986f2017-03-16 17:41:02 +01004197 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4198'hlsearch' 'hls' boolean (default off)
4199 global
4200 {not in Vi}
4201 {not available when compiled without the
4202 |+extra_search| feature}
4203 When there is a previous search pattern, highlight all its matches.
4204 The type of highlighting used can be set with the 'l' occasion in the
4205 'highlight' option. This uses the "Search" highlight group by
4206 default. Note that only the matching text is highlighted, any offsets
4207 are not applied.
4208 See also: 'incsearch' and |:match|.
4209 When you get bored looking at the highlighted matches, you can turn it
4210 off with |:nohlsearch|. This does not change the option value, as
4211 soon as you use a search command, the highlighting comes back.
4212 'redrawtime' specifies the maximum time spent on finding matches.
4213 When the search pattern can match an end-of-line, Vim will try to
4214 highlight all of the matched text. However, this depends on where the
4215 search starts. This will be the first line in the window or the first
4216 line below a closed fold. A match in a previous line which is not
4217 drawn may not continue in a newly drawn line.
4218 You can specify whether the highlight status is restored on startup
4219 with the 'h' flag in 'viminfo' |viminfo-h|.
4220 NOTE: This option is reset when 'compatible' is set.
4221
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 *'icon'* *'noicon'*
4223'icon' boolean (default off, on when title can be restored)
4224 global
4225 {not in Vi}
4226 {not available when compiled without the |+title|
4227 feature}
4228 When on, the icon text of the window will be set to the value of
4229 'iconstring' (if it is not empty), or to the name of the file
4230 currently being edited. Only the last part of the name is used.
4231 Overridden by the 'iconstring' option.
4232 Only works if the terminal supports setting window icons (currently
4233 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4234 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4235 builtin termcap).
4236 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004237 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004239 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240
4241 *'iconstring'*
4242'iconstring' string (default "")
4243 global
4244 {not in Vi}
4245 {not available when compiled without the |+title|
4246 feature}
4247 When this option is not empty, it will be used for the icon text of
4248 the window. This happens only when the 'icon' option is on.
4249 Only works if the terminal supports setting window icon text
4250 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4251 Does not work for MS Windows.
4252 When Vim was compiled with HAVE_X11 defined, the original icon will be
4253 restored if possible |X11|.
4254 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004255 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 'titlestring' for example settings.
4257 {not available when compiled without the |+statusline| feature}
4258
4259 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4260'ignorecase' 'ic' boolean (default off)
4261 global
4262 Ignore case in search patterns. Also used when searching in the tags
4263 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004264 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 Can be overruled by using "\c" or "\C" in the pattern, see
4266 |/ignorecase|.
4267
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004268 *'imactivatefunc'* *'imaf'*
4269'imactivatefunc' 'imaf' string (default "")
4270 global
4271 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004272 {only available when compiled with the |+multi_byte|
4273 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004274 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004275 activate or deactivate the Input Method.
4276 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004277
4278 Example: >
4279 function ImActivateFunc(active)
4280 if a:active
4281 ... do something
4282 else
4283 ... do something
4284 endif
4285 " return value is not used
4286 endfunction
4287 set imactivatefunc=ImActivateFunc
4288<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 *'imactivatekey'* *'imak'*
4290'imactivatekey' 'imak' string (default "")
4291 global
4292 {not in Vi}
4293 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004294 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 Specifies the key that your Input Method in X-Windows uses for
4296 activation. When this is specified correctly, vim can fully control
4297 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4298 You can't use this option to change the activation key, the option
4299 tells Vim what the key is.
4300 Format:
4301 [MODIFIER_FLAG-]KEY_STRING
4302
4303 These characters can be used for MODIFIER_FLAG (case is ignored):
4304 S Shift key
4305 L Lock key
4306 C Control key
4307 1 Mod1 key
4308 2 Mod2 key
4309 3 Mod3 key
4310 4 Mod4 key
4311 5 Mod5 key
4312 Combinations are allowed, for example "S-C-space" or "SC-space" are
4313 both shift+ctrl+space.
4314 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4315
4316 Example: >
4317 :set imactivatekey=S-space
4318< "S-space" means shift+space. This is the activation key for kinput2 +
4319 canna (Japanese), and ami (Korean).
4320
4321 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4322'imcmdline' 'imc' boolean (default off)
4323 global
4324 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004325 {only available when compiled with the |+multi_byte|
4326 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 When set the Input Method is always on when starting to edit a command
4328 line, unless entering a search pattern (see 'imsearch' for that).
4329 Setting this option is useful when your input method allows entering
4330 English characters directly, e.g., when it's used to type accented
4331 characters with dead keys.
4332
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004333 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4335 global
4336 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004337 {only available when compiled with the |+multi_byte|
4338 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 When set the Input Method is never used. This is useful to disable
4340 the IM when it doesn't work properly.
4341 Currently this option is on by default for SGI/IRIX machines. This
4342 may change in later releases.
4343
4344 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004345'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 local to buffer
4347 {not in Vi}
4348 Specifies whether :lmap or an Input Method (IM) is to be used in
4349 Insert mode. Valid values:
4350 0 :lmap is off and IM is off
4351 1 :lmap is ON and IM is off
4352 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 To always reset the option to zero when leaving Insert mode with <Esc>
4354 this can be used: >
4355 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4356< This makes :lmap and IM turn off automatically when leaving Insert
4357 mode.
4358 Note that this option changes when using CTRL-^ in Insert mode
4359 |i_CTRL-^|.
4360 The value is set to 1 when setting 'keymap' to a valid keymap name.
4361 It is also used for the argument of commands like "r" and "f".
4362 The value 0 may not work correctly with Athena and Motif with some XIM
4363 methods. Use 'imdisable' to disable XIM then.
4364
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004365 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4366 via external command if vim is not compiled with the |+xim|,
4367 |+multi_byte_ime| or |global-ime|.
4368
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004370'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 local to buffer
4372 {not in Vi}
4373 Specifies whether :lmap or an Input Method (IM) is to be used when
4374 entering a search pattern. Valid values:
4375 -1 the value of 'iminsert' is used, makes it look like
4376 'iminsert' is also used when typing a search pattern
4377 0 :lmap is off and IM is off
4378 1 :lmap is ON and IM is off
4379 2 :lmap is off and IM is ON
4380 Note that this option changes when using CTRL-^ in Command-line mode
4381 |c_CTRL-^|.
4382 The value is set to 1 when it is not -1 and setting the 'keymap'
4383 option to a valid keymap name.
4384 The value 0 may not work correctly with Athena and Motif with some XIM
4385 methods. Use 'imdisable' to disable XIM then.
4386
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004387 *'imstatusfunc'* *'imsf'*
4388'imstatusfunc' 'imsf' string (default "")
4389 global
4390 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004391 {only available when compiled with the |+multi_byte|
4392 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004393 This option specifies a function that is called to obtain the status
4394 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004395 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004396
4397 Example: >
4398 function ImStatusFunc()
4399 let is_active = ...do something
4400 return is_active ? 1 : 0
4401 endfunction
4402 set imstatusfunc=ImStatusFunc
4403<
4404 NOTE: This function is invoked very often. Keep it fast.
4405
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004406 *'imstyle'* *'imst'*
4407'imstyle' 'imst' number (default 1)
4408 global
4409 {not in Vi}
4410 {only available when compiled with |+xim| and
4411 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004412 This option specifies the input style of Input Method:
4413 0 use on-the-spot style
4414 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004415 See: |xim-input-style|
4416
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004417 For a long time on-the-spot style had been used in the GTK version of
4418 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004419 |single-repeat|, etc. Therefore over-the-spot style becomes the
4420 default now. This should work fine for most people, however if you
4421 have any problem with it, try using on-the-spot style.
4422
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 *'include'* *'inc'*
4424'include' 'inc' string (default "^\s*#\s*include")
4425 global or local to buffer |global-local|
4426 {not in Vi}
4427 {not available when compiled without the
4428 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004429 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 pattern, just like for the "/" command (See |pattern|). The default
4431 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004432 "]I", "[d", etc.
4433 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004434 comes after the matched pattern. But if "\zs" appears in the pattern
4435 then the text matched from "\zs" to the end, or until "\ze" if it
4436 appears, is used as the file name. Use this to include characters
4437 that are not in 'isfname', such as a space. You can then use
4438 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004439 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
4441 *'includeexpr'* *'inex'*
4442'includeexpr' 'inex' string (default "")
4443 local to buffer
4444 {not in Vi}
4445 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004446 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004448 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 :set includeexpr=substitute(v:fname,'\\.','/','g')
4450< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004451
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004453 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 Also used for |<cfile>|.
4455
Bram Moolenaar30b65812012-07-12 22:01:11 +02004456 The expression will be evaluated in the |sandbox| when set from a
4457 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004458
4459 It is not allowed to change text or jump to another window while
4460 evaluating 'includeexpr' |textlock|.
4461
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004463'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4464 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 global
4466 {not in Vi}
4467 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004468 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004469 While typing a search command, show where the pattern, as it was typed
4470 so far, matches. The matched string is highlighted. If the pattern
4471 is invalid or not found, nothing is shown. The screen will be updated
4472 often, this is only useful on fast terminals.
4473 Note that the match will be shown, but the cursor will return to its
4474 original position when no match is found and when pressing <Esc>. You
4475 still need to finish the search command with <Enter> to move the
4476 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004477 You can use the CTRL-G and CTRL-T keys to move to the next and
4478 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004479 When compiled with the |+reltime| feature Vim only searches for about
4480 half a second. With a complicated pattern and/or a lot of text the
4481 match may not be found. This is to avoid that Vim hangs while you
4482 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004483 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004484 When 'hlsearch' is on, all matched strings are highlighted too while
4485 typing a search command. See also: 'hlsearch'.
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004486 If you don't want turn 'hlsearch' on, but want to highlight all matches
4487 while searching, you can turn on and off 'hlsearch' with autocmd.
4488 Example: >
4489 augroup vimrc-incsearch-highlight
4490 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004491 autocmd CmdlineEnter /,\? :set hlsearch
4492 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004493 augroup END
4494<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004495 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004496 to the command line. If 'ignorecase' and 'smartcase' are set and the
4497 command line has no uppercase characters, the added character is
4498 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004499 CTRL-R CTRL-W can be used to add the word at the end of the current
4500 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 NOTE: This option is reset when 'compatible' is set.
4502
4503 *'indentexpr'* *'inde'*
4504'indentexpr' 'inde' string (default "")
4505 local to buffer
4506 {not in Vi}
4507 {not available when compiled without the |+cindent|
4508 or |+eval| features}
4509 Expression which is evaluated to obtain the proper indent for a line.
4510 It is used when a new line is created, for the |=| operator and
4511 in Insert mode as specified with the 'indentkeys' option.
4512 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004513 'smartindent' indenting. When 'lisp' is set, this option is
4514 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 When 'paste' is set this option is not used for indenting.
4516 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004517 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 when the expression is evaluated (but it may be moved around).
4519 The expression must return the number of spaces worth of indent. It
4520 can return "-1" to keep the current indent (this means 'autoindent' is
4521 used for the indent).
4522 Functions useful for computing the indent are |indent()|, |cindent()|
4523 and |lispindent()|.
4524 The evaluation of the expression must not have side effects! It must
4525 not change the text, jump to another window, etc. Afterwards the
4526 cursor position is always restored, thus the cursor may be moved.
4527 Normally this option would be set to call a function: >
4528 :set indentexpr=GetMyIndent()
4529< Error messages will be suppressed, unless the 'debug' option contains
4530 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004531 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004532 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533
Bram Moolenaar30b65812012-07-12 22:01:11 +02004534 The expression will be evaluated in the |sandbox| when set from a
4535 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004536
4537 It is not allowed to change text or jump to another window while
4538 evaluating 'indentexpr' |textlock|.
4539
4540
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 *'indentkeys'* *'indk'*
4542'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4543 local to buffer
4544 {not in Vi}
4545 {not available when compiled without the |+cindent|
4546 feature}
4547 A list of keys that, when typed in Insert mode, cause reindenting of
4548 the current line. Only happens if 'indentexpr' isn't empty.
4549 The format is identical to 'cinkeys', see |indentkeys-format|.
4550 See |C-indenting| and |indent-expression|.
4551
4552 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4553'infercase' 'inf' boolean (default off)
4554 local to buffer
4555 {not in Vi}
4556 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004557 'ignorecase' is also on, the case of the match is adjusted depending
4558 on the typed text. If the typed text contains a lowercase letter
4559 where the match has an upper case letter, the completed part is made
4560 lowercase. If the typed text has no lowercase letters and the match
4561 has a lowercase letter where the typed text has an uppercase letter,
4562 and there is a letter before it, the completed part is made uppercase.
4563 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564
4565 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4566'insertmode' 'im' boolean (default off)
4567 global
4568 {not in Vi}
4569 Makes Vim work in a way that Insert mode is the default mode. Useful
4570 if you want to use Vim as a modeless editor. Used for |evim|.
4571 These Insert mode commands will be useful:
4572 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004573 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 this is a mapping, it is executed as if 'insertmode' was off.
4575 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004577 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4578 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579
4580 These items change when 'insertmode' is set:
4581 - when starting to edit of a file, Vim goes to Insert mode.
4582 - <Esc> in Insert mode is a no-op and beeps.
4583 - <Esc> in Normal mode makes Vim go to Insert mode.
4584 - CTRL-L in Insert mode is a command, it is not inserted.
4585 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4586 However, when <Esc> is used inside a mapping, it behaves like
4587 'insertmode' was not set. This was done to be able to use the same
4588 mappings with 'insertmode' set or not set.
4589 When executing commands with |:normal| 'insertmode' is not used.
4590
4591 NOTE: This option is reset when 'compatible' is set.
4592
4593 *'isfname'* *'isf'*
4594'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4595 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4596 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4597 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4598 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4599 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4600 global
4601 {not in Vi}
4602 The characters specified by this option are included in file names and
4603 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 Multi-byte characters 256 and above are always included, only the
4606 characters up to 255 are specified with this option.
4607 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004608 Think twice before adding white space to this option. Although a
4609 space may appear inside a file name, the effect will be that Vim
4610 doesn't know where a file name starts or ends when doing completion.
4611 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612
4613 Note that on systems using a backslash as path separator, Vim tries to
4614 do its best to make it work as you would expect. That is a bit
4615 tricky, since Vi originally used the backslash to escape special
4616 characters. Vim will not remove a backslash in front of a normal file
4617 name character on these systems, but it will on Unix and alikes. The
4618 '&' and '^' are not included by default, because these are special for
4619 cmd.exe.
4620
4621 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004622 Each part can be a single character number or a range. A range is two
4623 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 decimal number between 0 and 255 or the ASCII character itself (does
4625 not work for digits). Example:
4626 "_,-,128-140,#-43" (include '_' and '-' and the range
4627 128 to 140 and '#' to 43)
4628 If a part starts with '^', the following character number or range
4629 will be excluded from the option. The option is interpreted from left
4630 to right. Put the excluded character after the range where it is
4631 included. To include '^' itself use it as the last character of the
4632 option or the end of a range. Example:
4633 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4634 If the character is '@', all characters where isalpha() returns TRUE
4635 are included. Normally these are the characters a to z and A to Z,
4636 plus accented characters. To include '@' itself use "@-@". Examples:
4637 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004638 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 "a-z,A-Z,@-@" All letters plus the '@' character.
4640 A comma can be included by using it where a character number is
4641 expected. Example:
4642 "48-57,,,_" Digits, comma and underscore.
4643 A comma can be excluded by prepending a '^'. Example:
4644 " -~,^,,9" All characters from space to '~', excluding
4645 comma, plus <Tab>.
4646 See |option-backslash| about including spaces and backslashes.
4647
4648 *'isident'* *'isi'*
4649'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4650 "@,48-57,_,128-167,224-235"
4651 otherwise: "@,48-57,_,192-255")
4652 global
4653 {not in Vi}
4654 The characters given by this option are included in identifiers.
4655 Identifiers are used in recognizing environment variables and after a
4656 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004657 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 option.
4659 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004660 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4662
4663 *'iskeyword'* *'isk'*
4664'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4665 "@,48-57,_,128-167,224-235"
4666 otherwise: "@,48-57,_,192-255"
4667 Vi default: "@,48-57,_")
4668 local to buffer
4669 {not in Vi}
4670 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004671 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 'isfname' for a description of the format of this option. For C
4673 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4674 For a help file it is set to all non-blank printable characters except
4675 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4676 command).
4677 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004678 This option also influences syntax highlighting, unless the syntax
4679 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 NOTE: This option is set to the Vi default value when 'compatible' is
4681 set and to the Vim default value when 'compatible' is reset.
4682
4683 *'isprint'* *'isp'*
4684'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4685 "@,~-255"; otherwise: "@,161-255")
4686 global
4687 {not in Vi}
4688 The characters given by this option are displayed directly on the
4689 screen. It is also used for "\p" in a |pattern|. The characters from
4690 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4691 even when they are not included in 'isprint' or excluded. See
4692 'isfname' for a description of the format of this option.
4693
4694 Non-printable characters are displayed with two characters:
4695 0 - 31 "^@" - "^_"
4696 32 - 126 always single characters
4697 127 "^?"
4698 128 - 159 "~@" - "~_"
4699 160 - 254 "| " - "|~"
4700 255 "~?"
4701 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4702 displayed as <xx>, with the hexadecimal value of the byte.
4703 When 'display' contains "uhex" all unprintable characters are
4704 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004705 The SpecialKey highlighting will be used for unprintable characters.
4706 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707
4708 Multi-byte characters 256 and above are always included, only the
4709 characters up to 255 are specified with this option. When a character
4710 is printable but it is not available in the current font, a
4711 replacement character will be shown.
4712 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4713 There is no option to specify these characters.
4714
4715 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4716'joinspaces' 'js' boolean (default on)
4717 global
4718 {not in Vi}
4719 Insert two spaces after a '.', '?' and '!' with a join command.
4720 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4721 Otherwise only one space is inserted.
4722 NOTE: This option is set when 'compatible' is set.
4723
4724 *'key'*
4725'key' string (default "")
4726 local to buffer
4727 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004728 {only available when compiled with the |+cryptv|
4729 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004731 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 Careful: Do not set the key value by hand, someone might see the typed
4733 key. Use the |:X| command. But you can make 'key' empty: >
4734 :set key=
4735< It is not possible to get the value of this option with ":set key" or
4736 "echo &key". This is to avoid showing it to someone who shouldn't
4737 know. It also means you cannot see it yourself once you have set it,
4738 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004739 You can use "&key" in an expression to detect whether encryption is
4740 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
4742 *'keymap'* *'kmp'* *E544*
4743'keymap' 'kmp' string (default "")
4744 local to buffer
4745 {not in Vi}
4746 {only available when compiled with the |+keymap|
4747 feature}
4748 Name of a keyboard mapping. See |mbyte-keymap|.
4749 Setting this option to a valid keymap name has the side effect of
4750 setting 'iminsert' to one, so that the keymap becomes effective.
4751 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004752 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
4754 *'keymodel'* *'km'*
4755'keymodel' 'km' string (default "")
4756 global
4757 {not in Vi}
4758 List of comma separated words, which enable special things that keys
4759 can do. These values can be used:
4760 startsel Using a shifted special key starts selection (either
4761 Select mode or Visual mode, depending on "key" being
4762 present in 'selectmode').
4763 stopsel Using a not-shifted special key stops selection.
4764 Special keys in this context are the cursor keys, <End>, <Home>,
4765 <PageUp> and <PageDown>.
4766 The 'keymodel' option is set by the |:behave| command.
4767
4768 *'keywordprg'* *'kp'*
4769'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004770 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 global or local to buffer |global-local|
4772 {not in Vi}
4773 Program to use for the |K| command. Environment variables are
4774 expanded |:set_env|. ":help" may be used to access the Vim internal
4775 help. (Note that previously setting the global option to the empty
4776 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004777 When the first character is ":", the command is invoked as a Vim
4778 Ex command prefixed with [count].
4779 When "man", "man -s" or an Ex command is used, Vim will automatically
4780 translate a count for the "K" command and pass it as the first
4781 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 See |option-backslash| about including spaces and backslashes.
4783 Example: >
4784 :set keywordprg=man\ -s
4785< This option cannot be set from a |modeline| or in the |sandbox|, for
4786 security reasons.
4787
4788 *'langmap'* *'lmap'* *E357* *E358*
4789'langmap' 'lmap' string (default "")
4790 global
4791 {not in Vi}
4792 {only available when compiled with the |+langmap|
4793 feature}
4794 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004795 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004796 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 care of translating these special characters to the original meaning
4798 of the key. This means you don't have to change the keyboard mode to
4799 be able to execute Normal mode commands.
4800 This is the opposite of the 'keymap' option, where characters are
4801 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004802 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004803 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004804 This option cannot be set from a |modeline| or in the |sandbox|, for
4805 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004807 Example (for Greek, in UTF-8): *greek* >
4808 :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 +00004809< Example (exchanges meaning of z and y for commands): >
4810 :set langmap=zy,yz,ZY,YZ
4811<
4812 The 'langmap' option is a list of parts, separated with commas. Each
4813 part can be in one of two forms:
4814 1. A list of pairs. Each pair is a "from" character immediately
4815 followed by the "to" character. Examples: "aA", "aAbBcC".
4816 2. A list of "from" characters, a semi-colon and a list of "to"
4817 characters. Example: "abc;ABC"
4818 Example: "aA,fgh;FGH,cCdDeE"
4819 Special characters need to be preceded with a backslash. These are
4820 ";", ',' and backslash itself.
4821
4822 This will allow you to activate vim actions without having to switch
4823 back and forth between the languages. Your language characters will
4824 be understood as normal vim English characters (according to the
4825 langmap mappings) in the following cases:
4826 o Normal/Visual mode (commands, buffer/register names, user mappings)
4827 o Insert/Replace Mode: Register names after CTRL-R
4828 o Insert/Replace Mode: Mappings
4829 Characters entered in Command-line mode will NOT be affected by
4830 this option. Note that this option can be changed at any time
4831 allowing to switch between mappings for different languages/encodings.
4832 Use a mapping to avoid having to type it each time!
4833
4834 *'langmenu'* *'lm'*
4835'langmenu' 'lm' string (default "")
4836 global
4837 {not in Vi}
4838 {only available when compiled with the |+menu| and
4839 |+multi_lang| features}
4840 Language to use for menu translation. Tells which file is loaded
4841 from the "lang" directory in 'runtimepath': >
4842 "lang/menu_" . &langmenu . ".vim"
4843< (without the spaces). For example, to always use the Dutch menus, no
4844 matter what $LANG is set to: >
4845 :set langmenu=nl_NL.ISO_8859-1
4846< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004847 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 If your $LANG is set to a non-English language but you do want to use
4849 the English menus: >
4850 :set langmenu=none
4851< This option must be set before loading menus, switching on filetype
4852 detection or syntax highlighting. Once the menus are defined setting
4853 this option has no effect. But you could do this: >
4854 :source $VIMRUNTIME/delmenu.vim
4855 :set langmenu=de_DE.ISO_8859-1
4856 :source $VIMRUNTIME/menu.vim
4857< Warning: This deletes all menus that you defined yourself!
4858
Bram Moolenaard94464e2015-11-02 15:28:18 +01004859 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004860'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004861 global
4862 {not in Vi}
4863 {only available when compiled with the |+langmap|
4864 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004865 This is just like 'langremap' but with the value inverted. It only
4866 exists for backwards compatibility. When setting 'langremap' then
4867 'langnoremap' is set to the inverted value, and the other way around.
4868
4869 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4870'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4871 global
4872 {not in Vi}
4873 {only available when compiled with the |+langmap|
4874 feature}
4875 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004876 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004877 'langmap' disables some of your mappings, try resetting this option.
4878 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004879 that works for you to avoid mappings to break.
4880
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 *'laststatus'* *'ls'*
4882'laststatus' 'ls' number (default 1)
4883 global
4884 {not in Vi}
4885 The value of this option influences when the last window will have a
4886 status line:
4887 0: never
4888 1: only if there are at least two windows
4889 2: always
4890 The screen looks nicer with a status line if you have several
4891 windows, but it takes another screen line. |status-line|
4892
4893 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4894'lazyredraw' 'lz' boolean (default off)
4895 global
4896 {not in Vi}
4897 When this option is set, the screen will not be redrawn while
4898 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004899 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 update use |:redraw|.
4901
4902 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4903'linebreak' 'lbr' boolean (default off)
4904 local to window
4905 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004906 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004908 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 than at the last character that fits on the screen. Unlike
4910 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004911 it only affects the way the file is displayed, not its contents.
4912 If 'breakindent' is set, line is visually indented. Then, the value
4913 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004914 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 Note that <Tab> characters after an <EOL> are mostly not displayed
4916 with the right amount of white space.
4917
4918 *'lines'* *E593*
4919'lines' number (default 24 or terminal height)
4920 global
4921 Number of lines of the Vim window.
4922 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004923 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 When Vim is running in the GUI or in a resizable window, setting this
4925 option will cause the window size to be changed. When you only want
4926 to use the size for the GUI, put the command in your |gvimrc| file.
4927 Vim limits the number of lines to what fits on the screen. You can
4928 use this command to get the tallest window possible: >
4929 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004930< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004931 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 When you set this option and Vim is unable to change the physical
4933 number of lines of the display, the display may be messed up.
4934
4935 *'linespace'* *'lsp'*
4936'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4937 global
4938 {not in Vi}
4939 {only in the GUI}
4940 Number of pixel lines inserted between characters. Useful if the font
4941 uses the full character cell height, making lines touch each other.
4942 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004943 With some fonts there can be too much room between lines (to have
4944 space for ascents and descents). Then it makes sense to set
4945 'linespace' to a negative value. This may cause display problems
4946 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
4948 *'lisp'* *'nolisp'*
4949'lisp' boolean (default off)
4950 local to buffer
4951 {not available when compiled without the |+lispindent|
4952 feature}
4953 Lisp mode: When <Enter> is typed in insert mode set the indent for
4954 the next line to Lisp standards (well, sort of). Also happens with
4955 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4956 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4957 better. Also see 'lispwords'.
4958 The '-' character is included in keyword characters. Redefines the
4959 "=" operator to use this same indentation algorithm rather than
4960 calling an external program if 'equalprg' is empty.
4961 This option is not used when 'paste' is set.
4962 {Vi: Does it a little bit differently}
4963
4964 *'lispwords'* *'lw'*
4965'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004966 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 {not in Vi}
4968 {not available when compiled without the |+lispindent|
4969 feature}
4970 Comma separated list of words that influence the Lisp indenting.
4971 |'lisp'|
4972
4973 *'list'* *'nolist'*
4974'list' boolean (default off)
4975 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004976 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4977 line. Useful to see the difference between tabs and spaces and for
4978 trailing blanks. Further changed by the 'listchars' option.
4979
4980 The cursor is displayed at the start of the space a Tab character
4981 occupies, not at the end as usual in Normal mode. To get this cursor
4982 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004983 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004984<
4985 Note that list mode will also affect formatting (set with 'textwidth'
4986 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 changing the way tabs are displayed.
4988
4989 *'listchars'* *'lcs'*
4990'listchars' 'lcs' string (default "eol:$")
4991 global
4992 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004993 Strings to use in 'list' mode and for the |:list| command. It is a
4994 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004995 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 eol:c Character to show at the end of each line. When
4997 omitted, there is no extra character at the end of the
4998 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004999 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005000 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005002 fill the space that the tab normally occupies.
5003 "tab:>-" will show a tab that takes four spaces as
5004 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005005 *lcs-space*
5006 space:c Character to show for a space. When omitted, spaces
5007 are left blank.
5008 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005009 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005010 trailing spaces are blank. Overrides the "space"
5011 setting for trailing spaces.
5012 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 extends:c Character to show in the last column, when 'wrap' is
5014 off and the line continues beyond the right of the
5015 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005016 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 precedes:c Character to show in the first column, when 'wrap'
5018 is off and there is text preceding the character
5019 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005020 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005021 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005022 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005023 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005024 nbsp:c Character to show for a non-breakable space character
5025 (0xA0 (160 decimal) and U+202F). Left blank when
5026 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005028 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005030 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031
5032 Examples: >
5033 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005034 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 :set lcs=extends:>,precedes:<
5036< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005037 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005038 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
5040 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5041'loadplugins' 'lpl' boolean (default on)
5042 global
5043 {not in Vi}
5044 When on the plugin scripts are loaded when starting up |load-plugins|.
5045 This option can be reset in your |vimrc| file to disable the loading
5046 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005047 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5048 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049
Bram Moolenaard94464e2015-11-02 15:28:18 +01005050 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005051'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005052 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005053 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005054 {only available when compiled with the |+lua/dyn|
5055 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005056 Specifies the name of the Lua shared library. The default is
5057 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005058 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005059 This option cannot be set from a |modeline| or in the |sandbox|, for
5060 security reasons.
5061
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005062 *'macatsui'* *'nomacatsui'*
5063'macatsui' boolean (default on)
5064 global
5065 {only available in Mac GUI version}
5066 This is a workaround for when drawing doesn't work properly. When set
5067 and compiled with multi-byte support ATSUI text drawing is used. When
5068 not set ATSUI text drawing is not used. Switch this option off when
5069 you experience drawing problems. In a future version the problems may
5070 be solved and this option becomes obsolete. Therefore use this method
5071 to unset it: >
5072 if exists('&macatsui')
5073 set nomacatsui
5074 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005075< Another option to check if you have drawing problems is
5076 'termencoding'.
5077
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 *'magic'* *'nomagic'*
5079'magic' boolean (default on)
5080 global
5081 Changes the special characters that can be used in search patterns.
5082 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005083 WARNING: Switching this option off most likely breaks plugins! That
5084 is because many patterns assume it's on and will fail when it's off.
5085 Only switch it off when working with old Vi scripts. In any other
5086 situation write patterns that work when 'magic' is on. Include "\M"
5087 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
5089 *'makeef'* *'mef'*
5090'makeef' 'mef' string (default: "")
5091 global
5092 {not in Vi}
5093 {not available when compiled without the |+quickfix|
5094 feature}
5095 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5096 and the |:grep| command.
5097 When it is empty, an internally generated temp file will be used.
5098 When "##" is included, it is replaced by a number to make the name
5099 unique. This makes sure that the ":make" command doesn't overwrite an
5100 existing file.
5101 NOT used for the ":cf" command. See 'errorfile' for that.
5102 Environment variables are expanded |:set_env|.
5103 See |option-backslash| about including spaces and backslashes.
5104 This option cannot be set from a |modeline| or in the |sandbox|, for
5105 security reasons.
5106
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005107 *'makeencoding'* *'menc'*
5108'makeencoding' 'menc' string (default "")
5109 global or local to buffer |global-local|
5110 {only available when compiled with the |+multi_byte|
5111 feature}
5112 {not in Vi}
5113 Encoding used for reading the output of external commands. When empty,
5114 encoding is not converted.
5115 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5116 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5117 and `:laddfile`.
5118
5119 This would be mostly useful when you use MS-Windows and set 'encoding'
5120 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5121 'makeencoding' to "char" has the same effect as setting to the system
5122 locale encoding. Example: >
5123 :set encoding=utf-8
5124 :set makeencoding=char " system locale is used
5125<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005126 *'makeprg'* *'mp'*
5127'makeprg' 'mp' string (default "make", VMS: "MMS")
5128 global or local to buffer |global-local|
5129 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005130 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005131 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5132 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005133 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005134 Environment variables are expanded |:set_env|. See |option-backslash|
5135 about including spaces and backslashes.
5136 Note that a '|' must be escaped twice: once for ":set" and once for
5137 the interpretation of a command. When you use a filter called
5138 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 :set makeprg=gmake\ \\\|\ myfilter
5140< The placeholder "$*" can be given (even multiple times) to specify
5141 where the arguments will be included, for example: >
5142 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5143< This option cannot be set from a |modeline| or in the |sandbox|, for
5144 security reasons.
5145
5146 *'matchpairs'* *'mps'*
5147'matchpairs' 'mps' string (default "(:),{:},[:]")
5148 local to buffer
5149 {not in Vi}
5150 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005151 other.
5152 Only character pairs are allowed that are different, thus you cannot
5153 jump between two double quotes.
5154 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005155 The pairs must be separated by a comma. Example for including '<' and
5156 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 :set mps+=<:>
5158
5159< A more exotic example, to jump between the '=' and ';' in an
5160 assignment, useful for languages like C and Java: >
5161 :au FileType c,cpp,java set mps+==:;
5162
5163< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005164 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165
5166 *'matchtime'* *'mat'*
5167'matchtime' 'mat' number (default 5)
5168 global
5169 {not in Vi}{in Nvi}
5170 Tenths of a second to show the matching paren, when 'showmatch' is
5171 set. Note that this is not in milliseconds, like other options that
5172 set a time. This is to be compatible with Nvi.
5173
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005174 *'maxcombine'* *'mco'*
5175'maxcombine' 'mco' number (default 2)
5176 global
5177 {not in Vi}
5178 {only available when compiled with the |+multi_byte|
5179 feature}
5180 The maximum number of combining characters supported for displaying.
5181 Only used when 'encoding' is "utf-8".
5182 The default is OK for most languages. Hebrew may require 4.
5183 Maximum value is 6.
5184 Even when this option is set to 2 you can still edit text with more
5185 combining characters, you just can't see them. Use |g8| or |ga|.
5186 See |mbyte-combining|.
5187
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 *'maxfuncdepth'* *'mfd'*
5189'maxfuncdepth' 'mfd' number (default 100)
5190 global
5191 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005192 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005193 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 Maximum depth of function calls for user functions. This normally
5195 catches endless recursion. When using a recursive function with
5196 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5197 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005198 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005199 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 See also |:function|.
5201
5202 *'maxmapdepth'* *'mmd'* *E223*
5203'maxmapdepth' 'mmd' number (default 1000)
5204 global
5205 {not in Vi}
5206 Maximum number of times a mapping is done without resulting in a
5207 character to be used. This normally catches endless mappings, like
5208 ":map x y" with ":map y x". It still does not catch ":map g wg",
5209 because the 'w' is used before the next mapping is done. See also
5210 |key-mapping|.
5211
5212 *'maxmem'* *'mm'*
5213'maxmem' 'mm' number (default between 256 to 5120 (system
5214 dependent) or half the amount of memory
5215 available)
5216 global
5217 {not in Vi}
5218 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5219 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005220 other memory to be freed.
5221 The maximum usable value is about 2000000. Use this to work without a
5222 limit.
5223 The value is ignored when 'swapfile' is off.
5224 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005226 *'maxmempattern'* *'mmp'*
5227'maxmempattern' 'mmp' number (default 1000)
5228 global
5229 {not in Vi}
5230 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005231 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005232 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005233 When Vim runs into the limit it gives an error message and mostly
5234 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005235 Running into the limit often means that the pattern is very
5236 inefficient or too complex. This may already happen with the pattern
5237 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005238 Might also happen on redraw, when syntax rules try to match a complex
5239 text structure.
5240 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5241 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005242
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 *'maxmemtot'* *'mmt'*
5244'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5245 dependent) or half the amount of memory
5246 available)
5247 global
5248 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005249 Maximum amount of memory in Kbyte to use for all buffers together.
5250 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005251 without a limit.
5252 On 64 bit machines higher values might work. But hey, do you really
5253 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005254 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005255 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005256 Buffers with 'swapfile' off still count to the total amount of memory
5257 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005258 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259
5260 *'menuitems'* *'mis'*
5261'menuitems' 'mis' number (default 25)
5262 global
5263 {not in Vi}
5264 {not available when compiled without the |+menu|
5265 feature}
5266 Maximum number of items to use in a menu. Used for menus that are
5267 generated from a list of items, e.g., the Buffers menu. Changing this
5268 option has no direct effect, the menu must be refreshed first.
5269
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005270 *'mkspellmem'* *'msm'*
5271'mkspellmem' 'msm' string (default "460000,2000,500")
5272 global
5273 {not in Vi}
5274 {not available when compiled without the |+syntax|
5275 feature}
5276 Parameters for |:mkspell|. This tunes when to start compressing the
5277 word tree. Compression can be slow when there are many words, but
5278 it's needed to avoid running out of memory. The amount of memory used
5279 per word depends very much on how similar the words are, that's why
5280 this tuning is complicated.
5281
5282 There are three numbers, separated by commas:
5283 {start},{inc},{added}
5284
5285 For most languages the uncompressed word tree fits in memory. {start}
5286 gives the amount of memory in Kbyte that can be used before any
5287 compression is done. It should be a bit smaller than the amount of
5288 memory that is available to Vim.
5289
5290 When going over the {start} limit the {inc} number specifies the
5291 amount of memory in Kbyte that can be allocated before another
5292 compression is done. A low number means compression is done after
5293 less words are added, which is slow. A high number means more memory
5294 will be allocated.
5295
5296 After doing compression, {added} times 1024 words can be added before
5297 the {inc} limit is ignored and compression is done when any extra
5298 amount of memory is needed. A low number means there is a smaller
5299 chance of hitting the {inc} limit, less memory is used but it's
5300 slower.
5301
5302 The languages for which these numbers are important are Italian and
5303 Hungarian. The default works for when you have about 512 Mbyte. If
5304 you have 1 Gbyte you could use: >
5305 :set mkspellmem=900000,3000,800
5306< If you have less than 512 Mbyte |:mkspell| may fail for some
5307 languages, no matter what you set 'mkspellmem' to.
5308
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005310'modeline' 'ml' boolean (Vim default: on (off for root),
5311 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 local to buffer
5313 *'modelines'* *'mls'*
5314'modelines' 'mls' number (default 5)
5315 global
5316 {not in Vi}
5317 If 'modeline' is on 'modelines' gives the number of lines that is
5318 checked for set commands. If 'modeline' is off or 'modelines' is zero
5319 no lines are checked. See |modeline|.
5320 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5321 set and to the Vim default value when 'compatible' is reset.
5322
5323 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5324'modifiable' 'ma' boolean (default on)
5325 local to buffer
5326 {not in Vi} *E21*
5327 When off the buffer contents cannot be changed. The 'fileformat' and
5328 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005329 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330
5331 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5332'modified' 'mod' boolean (default off)
5333 local to buffer
5334 {not in Vi}
5335 When on, the buffer is considered to be modified. This option is set
5336 when:
5337 1. A change was made to the text since it was last written. Using the
5338 |undo| command to go back to the original text will reset the
5339 option. But undoing changes that were made before writing the
5340 buffer will set the option again, since the text is different from
5341 when it was written.
5342 2. 'fileformat' or 'fileencoding' is different from its original
5343 value. The original value is set when the buffer is read or
5344 written. A ":set nomodified" command also resets the original
5345 values to the current values and the 'modified' option will be
5346 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005347 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005348 This option is not set when a change is made to the buffer as the
5349 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5350 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5351 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5353 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005354 Note that the text may actually be the same, e.g. 'modified' is set
5355 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
5357 *'more'* *'nomore'*
5358'more' boolean (Vim default: on, Vi default: off)
5359 global
5360 {not in Vi}
5361 When on, listings pause when the whole screen is filled. You will get
5362 the |more-prompt|. When this option is off there are no pauses, the
5363 listing continues until finished.
5364 NOTE: This option is set to the Vi default value when 'compatible' is
5365 set and to the Vim default value when 'compatible' is reset.
5366
5367 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005368'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5369 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 global
5371 {not in Vi}
5372 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005373 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5374 sysmouse and Linux console with gpm). For using the mouse in the
5375 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005377 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 v Visual mode
5379 i Insert mode
5380 c Command-line mode
5381 h all previous modes when editing a help file
5382 a all previous modes
5383 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 Normally you would enable the mouse in all four modes with: >
5385 :set mouse=a
5386< When the mouse is not enabled, the GUI will still use the mouse for
5387 modeless selection. This doesn't move the text cursor.
5388
5389 See |mouse-using|. Also see |'clipboard'|.
5390
5391 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005392 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 the mouse buttons can still be used by keeping the shift key pressed.
5394 Also see the 'clipboard' option.
5395
5396 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5397'mousefocus' 'mousef' boolean (default off)
5398 global
5399 {not in Vi}
5400 {only works in the GUI}
5401 The window that the mouse pointer is on is automatically activated.
5402 When changing the window layout or window focus in another way, the
5403 mouse pointer is moved to the window with keyboard focus. Off is the
5404 default because it makes using the pull down menus a little goofy, as
5405 a pointer transit may activate a window unintentionally.
5406
5407 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5408'mousehide' 'mh' boolean (default on)
5409 global
5410 {not in Vi}
5411 {only works in the GUI}
5412 When on, the mouse pointer is hidden when characters are typed.
5413 The mouse pointer is restored when the mouse is moved.
5414
5415 *'mousemodel'* *'mousem'*
5416'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5417 global
5418 {not in Vi}
5419 Sets the model to use for the mouse. The name mostly specifies what
5420 the right mouse button is used for:
5421 extend Right mouse button extends a selection. This works
5422 like in an xterm.
5423 popup Right mouse button pops up a menu. The shifted left
5424 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005425 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 popup_setpos Like "popup", but the cursor will be moved to the
5427 position where the mouse was clicked, and thus the
5428 selected operation will act upon the clicked object.
5429 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005430 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 course, that right clicking outside a selection will
5432 end Visual mode.
5433 Overview of what button does what for each model:
5434 mouse extend popup(_setpos) ~
5435 left click place cursor place cursor
5436 left drag start selection start selection
5437 shift-left search word extend selection
5438 right click extend selection popup menu (place cursor)
5439 right drag extend selection -
5440 middle click paste paste
5441
5442 In the "popup" model the right mouse button produces a pop-up menu.
5443 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005444 In a terminal the popup menu works if Vim is compiled with the
5445 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446
5447 Note that you can further refine the meaning of buttons with mappings.
5448 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5449 selection (because that's handled in the GUI code directly).
5450
5451 The 'mousemodel' option is set by the |:behave| command.
5452
5453 *'mouseshape'* *'mouses'* *E547*
5454'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005455 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456 global
5457 {not in Vi}
5458 {only available when compiled with the |+mouseshape|
5459 feature}
5460 This option tells Vim what the mouse pointer should look like in
5461 different modes. The option is a comma separated list of parts, much
5462 like used for 'guicursor'. Each part consist of a mode/location-list
5463 and an argument-list:
5464 mode-list:shape,mode-list:shape,..
5465 The mode-list is a dash separated list of these modes/locations:
5466 In a normal window: ~
5467 n Normal mode
5468 v Visual mode
5469 ve Visual mode with 'selection' "exclusive" (same as 'v',
5470 if not specified)
5471 o Operator-pending mode
5472 i Insert mode
5473 r Replace mode
5474
5475 Others: ~
5476 c appending to the command-line
5477 ci inserting in the command-line
5478 cr replacing in the command-line
5479 m at the 'Hit ENTER' or 'More' prompts
5480 ml idem, but cursor in the last line
5481 e any mode, pointer below last window
5482 s any mode, pointer on a status line
5483 sd any mode, while dragging a status line
5484 vs any mode, pointer on a vertical separator line
5485 vd any mode, while dragging a vertical separator line
5486 a everywhere
5487
5488 The shape is one of the following:
5489 avail name looks like ~
5490 w x arrow Normal mouse pointer
5491 w x blank no pointer at all (use with care!)
5492 w x beam I-beam
5493 w x updown up-down sizing arrows
5494 w x leftright left-right sizing arrows
5495 w x busy The system's usual busy pointer
5496 w x no The system's usual 'no input' pointer
5497 x udsizing indicates up-down resizing
5498 x lrsizing indicates left-right resizing
5499 x crosshair like a big thin +
5500 x hand1 black hand
5501 x hand2 white hand
5502 x pencil what you write with
5503 x question big ?
5504 x rightup-arrow arrow pointing right-up
5505 w x up-arrow arrow pointing up
5506 x <number> any X11 pointer number (see X11/cursorfont.h)
5507
5508 The "avail" column contains a 'w' if the shape is available for Win32,
5509 x for X11.
5510 Any modes not specified or shapes not available use the normal mouse
5511 pointer.
5512
5513 Example: >
5514 :set mouseshape=s:udsizing,m:no
5515< will make the mouse turn to a sizing arrow over the status lines and
5516 indicate no input when the hit-enter prompt is displayed (since
5517 clicking the mouse has no effect in this state.)
5518
5519 *'mousetime'* *'mouset'*
5520'mousetime' 'mouset' number (default 500)
5521 global
5522 {not in Vi}
5523 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5524 time in msec between two mouse clicks for the second click to be
5525 recognized as a multi click.
5526
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005527 *'mzschemedll'*
5528'mzschemedll' string (default depends on the build)
5529 global
5530 {not in Vi}
5531 {only available when compiled with the |+mzscheme/dyn|
5532 feature}
5533 Specifies the name of the MzScheme shared library. The default is
5534 DYNAMIC_MZSCH_DLL which was specified at compile time.
5535 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005536 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005537 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005538 This option cannot be set from a |modeline| or in the |sandbox|, for
5539 security reasons.
5540
5541 *'mzschemegcdll'*
5542'mzschemegcdll' string (default depends on the build)
5543 global
5544 {not in Vi}
5545 {only available when compiled with the |+mzscheme/dyn|
5546 feature}
5547 Specifies the name of the MzScheme GC shared library. The default is
5548 DYNAMIC_MZGC_DLL which was specified at compile time.
5549 The value can be equal to 'mzschemedll' if it includes the GC code.
5550 Environment variables are expanded |:set_env|.
5551 This option cannot be set from a |modeline| or in the |sandbox|, for
5552 security reasons.
5553
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005554 *'mzquantum'* *'mzq'*
5555'mzquantum' 'mzq' number (default 100)
5556 global
5557 {not in Vi}
5558 {not available when compiled without the |+mzscheme|
5559 feature}
5560 The number of milliseconds between polls for MzScheme threads.
5561 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005562 NOTE: This option is set to the Vim default value when 'compatible'
5563 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005564
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005566'nrformats' 'nf' string (default "bin,octal,hex",
5567 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 local to buffer
5569 {not in Vi}
5570 This defines what bases Vim will consider for numbers when using the
5571 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5572 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005573 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005575 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005576 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005578 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 considered to be hexadecimal. Example: Using CTRL-X on
5580 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005581 bin If included, numbers starting with "0b" or "0B" will be
5582 considered to be binary. Example: Using CTRL-X on
5583 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 Numbers which simply begin with a digit in the range 1-9 are always
5585 considered decimal. This also happens for numbers that are not
5586 recognized as octal or hex.
5587
5588 *'number'* *'nu'* *'nonumber'* *'nonu'*
5589'number' 'nu' boolean (default off)
5590 local to window
5591 Print the line number in front of each line. When the 'n' option is
5592 excluded from 'cpoptions' a wrapped line will not use the column of
5593 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005594 The 'numberwidth' option can be used to set the room used for the line
5595 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 When a long, wrapped line doesn't start with the first character, '-'
5597 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005598 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5599 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005600 *number_relativenumber*
5601 The 'relativenumber' option changes the displayed number to be
5602 relative to the cursor. Together with 'number' there are these
5603 four combinations (cursor in line 3):
5604
Bram Moolenaar3848e002016-03-19 18:42:29 +01005605 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005606 'nornu' 'nornu' 'rnu' 'rnu'
5607
5608 |apple | 1 apple | 2 apple | 2 apple
5609 |pear | 2 pear | 1 pear | 1 pear
5610 |nobody | 3 nobody | 0 nobody |3 nobody
5611 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005613 *'numberwidth'* *'nuw'*
5614'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5615 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005616 {not in Vi}
5617 {only available when compiled with the |+linebreak|
5618 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005619 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005620 when the 'number' or 'relativenumber' option is set or printing lines
5621 with a line number. Since one space is always between the number and
5622 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005623 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005624 fit the highest line number in the buffer respectively the number of
5625 rows in the window, depending on whether 'number' or 'relativenumber'
5626 is set. Thus with the Vim default of 4 there is room for a line number
5627 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005628 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005629 NOTE: This option is set to the Vi default value when 'compatible' is
5630 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005631
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005632 *'omnifunc'* *'ofu'*
5633'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005634 local to buffer
5635 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005636 {not available when compiled without the |+eval|
5637 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005638 This option specifies a function to be used for Insert mode omni
5639 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005640 See |complete-functions| for an explanation of how the function is
5641 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005642 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005643 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005644 This option cannot be set from a |modeline| or in the |sandbox|, for
5645 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005646
5647
Bram Moolenaar02467872007-05-06 13:22:01 +00005648 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005649'opendevice' 'odev' boolean (default off)
5650 global
5651 {not in Vi}
5652 {only for MS-DOS, MS-Windows and OS/2}
5653 Enable reading and writing from devices. This may get Vim stuck on a
5654 device that can be opened but doesn't actually do the I/O. Therefore
5655 it is off by default.
5656 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5657 result in editing a device.
5658
5659
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005660 *'operatorfunc'* *'opfunc'*
5661'operatorfunc' 'opfunc' string (default: empty)
5662 global
5663 {not in Vi}
5664 This option specifies a function to be called by the |g@| operator.
5665 See |:map-operator| for more info and an example.
5666
5667 This option cannot be set from a |modeline| or in the |sandbox|, for
5668 security reasons.
5669
5670
Bram Moolenaar251e1912011-06-19 05:09:16 +02005671 *'osfiletype'* *'oft'*
5672'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 local to buffer
5674 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005675 This option was supported on RISC OS, which has been removed.
5676
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005678 *'packpath'* *'pp'*
5679'packpath' 'pp' string (default: see 'runtimepath')
5680 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005681 Directories used to find packages. See |packages|.
5682
5683
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005685'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686 global
5687 Specifies the nroff macros that separate paragraphs. These are pairs
5688 of two letters (see |object-motions|).
5689
5690 *'paste'* *'nopaste'*
5691'paste' boolean (default off)
5692 global
5693 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005694 Put Vim in Paste mode. This is useful if you want to cut or copy
5695 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 unexpected effects.
5697 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005698 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 knows about pasting and will mostly do the right thing without 'paste'
5700 being set. The same is true for a terminal where Vim handles the
5701 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005702 This option is reset when starting the GUI. Thus if you set it in
5703 your .vimrc it will work in a terminal, but not in the GUI. Setting
5704 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5705 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 When the 'paste' option is switched on (also when it was already on):
5707 - mapping in Insert mode and Command-line mode is disabled
5708 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005710 - 'expandtab' is reset
5711 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 - 'revins' is reset
5713 - 'ruler' is reset
5714 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005715 - 'smartindent' is reset
5716 - 'smarttab' is reset
5717 - 'softtabstop' is set to 0
5718 - 'textwidth' is set to 0
5719 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005722 - 'indentexpr'
5723 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 NOTE: When you start editing another file while the 'paste' option is
5725 on, settings from the modelines or autocommands may change the
5726 settings again, causing trouble when pasting text. You might want to
5727 set the 'paste' option again.
5728 When the 'paste' option is reset the mentioned options are restored to
5729 the value before the moment 'paste' was switched from off to on.
5730 Resetting 'paste' before ever setting it does not have any effect.
5731 Since mapping doesn't work while 'paste' is active, you need to use
5732 the 'pastetoggle' option to toggle the 'paste' option with some key.
5733
5734 *'pastetoggle'* *'pt'*
5735'pastetoggle' 'pt' string (default "")
5736 global
5737 {not in Vi}
5738 When non-empty, specifies the key sequence that toggles the 'paste'
5739 option. This is like specifying a mapping: >
5740 :map {keys} :set invpaste<CR>
5741< Where {keys} is the value of 'pastetoggle'.
5742 The difference is that it will work even when 'paste' is set.
5743 'pastetoggle' works in Insert mode and Normal mode, but not in
5744 Command-line mode.
5745 Mappings are checked first, thus overrule 'pastetoggle'. However,
5746 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5747 this: >
5748 :map <F10> :set paste<CR>
5749 :map <F11> :set nopaste<CR>
5750 :imap <F10> <C-O>:set paste<CR>
5751 :imap <F11> <nop>
5752 :set pastetoggle=<F11>
5753< This will make <F10> start paste mode and <F11> stop paste mode.
5754 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5755 mode everything is inserted literally, except the 'pastetoggle' key
5756 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005757 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758
5759 *'pex'* *'patchexpr'*
5760'patchexpr' 'pex' string (default "")
5761 global
5762 {not in Vi}
5763 {not available when compiled without the |+diff|
5764 feature}
5765 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005766 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767
Bram Moolenaardbc28022014-07-26 13:40:44 +02005768 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769'patchmode' 'pm' string (default "")
5770 global
5771 {not in Vi}
5772 When non-empty the oldest version of a file is kept. This can be used
5773 to keep the original version of a file if you are changing files in a
5774 source distribution. Only the first time that a file is written a
5775 copy of the original file will be kept. The name of the copy is the
5776 name of the original file with the string in the 'patchmode' option
5777 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005778 ".orig" or ".org". 'backupdir' must not be empty for this to work
5779 (Detail: The backup file is renamed to the patchmode file after the
5780 new file has been successfully written, that's why it must be possible
5781 to write a backup file). If there was no file to be backed up, an
5782 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 When the 'backupskip' pattern matches, a patchmode file is not made.
5784 Using 'patchmode' for compressed files appends the extension at the
5785 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5786 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005787 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005789 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790'path' 'pa' string (default on Unix: ".,/usr/include,,"
5791 on OS/2: ".,/emx/include,,"
5792 other systems: ".,,")
5793 global or local to buffer |global-local|
5794 {not in Vi}
5795 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005796 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5797 provided that the file being searched for has a relative path (not
5798 starting with "/", "./" or "../"). The directories in the 'path'
5799 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 - Use commas to separate directory names: >
5801 :set path=.,/usr/local/include,/usr/include
5802< - Spaces can also be used to separate directory names (for backwards
5803 compatibility with version 3.0). To have a space in a directory
5804 name, precede it with an extra backslash, and escape the space: >
5805 :set path=.,/dir/with\\\ space
5806< - To include a comma in a directory name precede it with an extra
5807 backslash: >
5808 :set path=.,/dir/with\\,comma
5809< - To search relative to the directory of the current file, use: >
5810 :set path=.
5811< - To search in the current directory use an empty string between two
5812 commas: >
5813 :set path=,,
5814< - A directory name may end in a ':' or '/'.
5815 - Environment variables are expanded |:set_env|.
5816 - When using |netrw.vim| URLs can be used. For example, adding
5817 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005818 - Search upwards and downwards in a directory tree using "*", "**" and
5819 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820 {not available when compiled without the |+path_extra| feature}
5821 - Careful with '\' characters, type two to get one in the option: >
5822 :set path=.,c:\\include
5823< Or just use '/' instead: >
5824 :set path=.,c:/include
5825< Don't forget "." or files won't even be found in the same directory as
5826 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005827 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 it is something like 256 or 1024 characters.
5829 You can check if all the include files are found, using the value of
5830 'path', see |:checkpath|.
5831 The use of |:set+=| and |:set-=| is preferred when adding or removing
5832 directories from the list. This avoids problems when a future version
5833 uses another default. To remove the current directory use: >
5834 :set path-=
5835< To add the current directory use: >
5836 :set path+=
5837< To use an environment variable, you probably need to replace the
5838 separator. Here is an example to append $INCL, in which directory
5839 names are separated with a semi-colon: >
5840 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5841< Replace the ';' with a ':' or whatever separator is used. Note that
5842 this doesn't work when $INCL contains a comma or white space.
5843
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005844 *'perldll'*
5845'perldll' string (default depends on the build)
5846 global
5847 {not in Vi}
5848 {only available when compiled with the |+perl/dyn|
5849 feature}
5850 Specifies the name of the Perl shared library. The default is
5851 DYNAMIC_PERL_DLL, which was specified at compile time.
5852 Environment variables are expanded |:set_env|.
5853 This option cannot be set from a |modeline| or in the |sandbox|, for
5854 security reasons.
5855
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5857'preserveindent' 'pi' boolean (default off)
5858 local to buffer
5859 {not in Vi}
5860 When changing the indent of the current line, preserve as much of the
5861 indent structure as possible. Normally the indent is replaced by a
5862 series of tabs followed by spaces as required (unless |'expandtab'| is
5863 enabled, in which case only spaces are used). Enabling this option
5864 means the indent will preserve as many existing characters as possible
5865 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005866 'expandtab' does not apply to the preserved white space, a Tab remains
5867 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 NOTE: When using ">>" multiple times the resulting indent is a mix of
5869 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005870 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 Also see 'copyindent'.
5872 Use |:retab| to clean up white space.
5873
5874 *'previewheight'* *'pvh'*
5875'previewheight' 'pvh' number (default 12)
5876 global
5877 {not in Vi}
5878 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005879 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 Default height for a preview window. Used for |:ptag| and associated
5881 commands. Used for |CTRL-W_}| when no count is given.
5882
5883 *'previewwindow'* *'nopreviewwindow'*
5884 *'pvw'* *'nopvw'* *E590*
5885'previewwindow' 'pvw' boolean (default off)
5886 local to window
5887 {not in Vi}
5888 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005889 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005890 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 set. It's normally not set directly, but by using one of the commands
5892 |:ptag|, |:pedit|, etc.
5893
5894 *'printdevice'* *'pdev'*
5895'printdevice' 'pdev' string (default empty)
5896 global
5897 {not in Vi}
5898 {only available when compiled with the |+printer|
5899 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005900 The name of the printer to be used for |:hardcopy|.
5901 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005902 This option cannot be set from a |modeline| or in the |sandbox|, for
5903 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904
Bram Moolenaar8299df92004-07-10 09:47:34 +00005905 *'printencoding'* *'penc'*
5906'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 global
5908 {not in Vi}
5909 {only available when compiled with the |+printer|
5910 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005911 Sets the character encoding used when printing.
5912 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913
5914 *'printexpr'* *'pexpr'*
5915'printexpr' 'pexpr' String (default: see below)
5916 global
5917 {not in Vi}
5918 {only available when compiled with the |+printer|
5919 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005920 Expression used to print the PostScript produced with |:hardcopy|.
5921 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005922 This option cannot be set from a |modeline| or in the |sandbox|, for
5923 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924
Bram Moolenaar8299df92004-07-10 09:47:34 +00005925 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926'printfont' 'pfn' string (default "courier")
5927 global
5928 {not in Vi}
5929 {only available when compiled with the |+printer|
5930 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005931 The name of the font that will be used for |:hardcopy|.
5932 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933
5934 *'printheader'* *'pheader'*
5935'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5936 global
5937 {not in Vi}
5938 {only available when compiled with the |+printer|
5939 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005940 The format of the header produced in |:hardcopy| output.
5941 See |pheader-option|.
5942
5943 *'printmbcharset'* *'pmbcs'*
5944'printmbcharset' 'pmbcs' string (default "")
5945 global
5946 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005947 {only available when compiled with the |+printer|,
5948 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005949 The CJK character set to be used for CJK output from |:hardcopy|.
5950 See |pmbcs-option|.
5951
5952 *'printmbfont'* *'pmbfn'*
5953'printmbfont' 'pmbfn' string (default "")
5954 global
5955 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005956 {only available when compiled with the |+printer|,
5957 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005958 List of font names to be used for CJK output from |:hardcopy|.
5959 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960
5961 *'printoptions'* *'popt'*
5962'printoptions' 'popt' string (default "")
5963 global
5964 {not in Vi}
5965 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005966 List of items that control the format of the output of |:hardcopy|.
5967 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005969 *'prompt'* *'noprompt'*
5970'prompt' boolean (default on)
5971 global
5972 When on a ":" prompt is used in Ex mode.
5973
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005974 *'pumheight'* *'ph'*
5975'pumheight' 'ph' number (default 0)
5976 global
5977 {not available when compiled without the
5978 |+insert_expand| feature}
5979 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005980 Determines the maximum number of items to show in the popup menu for
5981 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005982 |ins-completion-menu|.
5983
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005984 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005985'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005986 global
5987 {not available when compiled without the
5988 |+insert_expand| feature}
5989 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005990 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005991 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005992
Bram Moolenaard94464e2015-11-02 15:28:18 +01005993 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005994'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005995 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005996 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005997 {only available when compiled with the |+python/dyn|
5998 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005999 Specifies the name of the Python 2.x shared library. The default is
6000 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006001 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006002 This option cannot be set from a |modeline| or in the |sandbox|, for
6003 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006004
Bram Moolenaar94073162018-01-31 21:49:05 +01006005 *'pythonhome'*
6006'pythonhome' string (default "")
6007 global
6008 {not in Vi}
6009 {only available when compiled with the |+python/dyn|
6010 feature}
6011 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6012 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6013 which was specified at compile time, will be used for the Python 2.x
6014 home directory.
6015 Environment variables are expanded |:set_env|.
6016 This option cannot be set from a |modeline| or in the |sandbox|, for
6017 security reasons.
6018
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006019 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006020'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006021 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006022 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006023 {only available when compiled with the |+python3/dyn|
6024 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006025 Specifies the name of the Python 3 shared library. The default is
6026 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006027 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006028 This option cannot be set from a |modeline| or in the |sandbox|, for
6029 security reasons.
6030
Bram Moolenaar94073162018-01-31 21:49:05 +01006031 *'pythonthreehome'*
6032'pythonthreehome' string (default "")
6033 global
6034 {not in Vi}
6035 {only available when compiled with the |+python3/dyn|
6036 feature}
6037 Specifies the name of the Python 3 home directory. When
6038 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6039 PYTHON3_HOME, which was specified at compile time, will be used for
6040 the Python 3 home directory.
6041 Environment variables are expanded |:set_env|.
6042 This option cannot be set from a |modeline| or in the |sandbox|, for
6043 security reasons.
6044
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006045 *'pyxversion'* *'pyx'*
6046'pyxversion' 'pyx' number (default depends on the build)
6047 global
6048 {not in Vi}
6049 {only available when compiled with the |+python| or
6050 the |+python3| feature}
6051 Specifies the python version used for pyx* functions and commands
6052 |python_x|. The default value is as follows:
6053
6054 Compiled with Default ~
6055 |+python| and |+python3| 0
6056 only |+python| 2
6057 only |+python3| 3
6058
6059 Available values are 0, 2 and 3.
6060 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6061 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6062 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6063 to 2 if Python 2 is available.
6064 See also: |has-pythonx|
6065
6066 If Vim is compiled with only |+python| or |+python3| setting
6067 'pyxversion' has no effect. The pyx* functions and commands are
6068 always the same as the compiled version.
6069
6070 This option cannot be set from a |modeline| or in the |sandbox|, for
6071 security reasons.
6072
Bram Moolenaar677ee682005-01-27 14:41:15 +00006073 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006074'quoteescape' 'qe' string (default "\")
6075 local to buffer
6076 {not in Vi}
6077 The characters that are used to escape quotes in a string. Used for
6078 objects like a', a" and a` |a'|.
6079 When one of the characters in this option is found inside a string,
6080 the following character will be skipped. The default value makes the
6081 text "foo\"bar\\" considered to be one string.
6082
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6084'readonly' 'ro' boolean (default off)
6085 local to buffer
6086 If on, writes fail unless you use a '!'. Protects you from
6087 accidentally overwriting a file. Default on when Vim is started
6088 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006089 When using ":w!" the 'readonly' option is reset for the current
6090 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006092 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006093 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006095 *'redrawtime'* *'rdt'*
6096'redrawtime' 'rdt' number (default 2000)
6097 global
6098 {not in Vi}
6099 {only available when compiled with the |+reltime|
6100 feature}
6101 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006102 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006103 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006104 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006105 matches will be highlighted.
6106 For syntax highlighting the time applies per window. When over the
6107 limit syntax highlighting is disabled until |CTRL-L| is used.
6108 This is used to avoid that Vim hangs when using a very complicated
6109 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006110
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006111 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006112'regexpengine' 're' number (default 0)
6113 global
6114 {not in Vi}
6115 This selects the default regexp engine. |two-engines|
6116 The possible values are:
6117 0 automatic selection
6118 1 old engine
6119 2 NFA engine
6120 Note that when using the NFA engine and the pattern contains something
6121 that is not supported the pattern will not match. This is only useful
6122 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006123 Using automatic selection enables Vim to switch the engine, if the
6124 default engine becomes too costly. E.g., when the NFA engine uses too
6125 many states. This should prevent Vim from hanging on a combination of
6126 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006127
Bram Moolenaar64486672010-05-16 15:46:46 +02006128 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6129'relativenumber' 'rnu' boolean (default off)
6130 local to window
6131 {not in Vi}
6132 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006133 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006134 precede some vertical motion commands (e.g. j k + -) with, without
6135 having to calculate it yourself. Especially useful in combination with
6136 other commands (e.g. y d c < > gq gw =).
6137 When the 'n' option is excluded from 'cpoptions' a wrapped
6138 line will not use the column of line numbers (this is the default when
6139 'compatible' isn't set).
6140 The 'numberwidth' option can be used to set the room used for the line
6141 number.
6142 When a long, wrapped line doesn't start with the first character, '-'
6143 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006144 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6145 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006146
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006147 The number in front of the cursor line also depends on the value of
6148 'number', see |number_relativenumber| for all combinations of the two
6149 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006150
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 *'remap'* *'noremap'*
6152'remap' boolean (default on)
6153 global
6154 Allows for mappings to work recursively. If you do not want this for
6155 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006156 NOTE: To avoid portability problems with Vim scripts, always keep
6157 this option at the default "on". Only switch it off when working with
6158 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006160 *'renderoptions'* *'rop'*
6161'renderoptions' 'rop' string (default: empty)
6162 global
6163 {not in Vi}
6164 {only available when compiled with GUI and DIRECTX on
6165 MS-Windows}
6166 Select a text renderer and set its options. The options depend on the
6167 renderer.
6168
6169 Syntax: >
6170 set rop=type:{renderer}(,{name}:{value})*
6171<
6172 Currently, only one optional renderer is available.
6173
6174 render behavior ~
6175 directx Vim will draw text using DirectX (DirectWrite). It makes
6176 drawn glyphs more beautiful than default GDI.
6177 It requires 'encoding' is "utf-8", and only works on
6178 MS-Windows Vista or newer version.
6179
6180 Options:
6181 name meaning type value ~
6182 gamma gamma float 1.0 - 2.2 (maybe)
6183 contrast enhancedContrast float (unknown)
6184 level clearTypeLevel float (unknown)
6185 geom pixelGeometry int 0 - 2 (see below)
6186 renmode renderingMode int 0 - 6 (see below)
6187 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006188 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006189
Bram Moolenaar92467d32017-12-05 13:22:16 +01006190 See this URL for detail (except for scrlines):
6191 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006192
6193 For geom: structure of a device pixel.
6194 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6195 1 - DWRITE_PIXEL_GEOMETRY_RGB
6196 2 - DWRITE_PIXEL_GEOMETRY_BGR
6197
6198 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006199 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006200
6201 For renmode: method of rendering glyphs.
6202 0 - DWRITE_RENDERING_MODE_DEFAULT
6203 1 - DWRITE_RENDERING_MODE_ALIASED
6204 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6205 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6206 4 - DWRITE_RENDERING_MODE_NATURAL
6207 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6208 6 - DWRITE_RENDERING_MODE_OUTLINE
6209
6210 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006211 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006212
6213 For taamode: antialiasing mode used for drawing text.
6214 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6215 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6216 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6217 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6218
6219 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006220 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6221
Bram Moolenaara338adc2018-01-31 20:51:47 +01006222 For scrlines:
6223 This was used for optimizing scrolling behavior, however this
6224 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006225
6226 Example: >
6227 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006228 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006229 set rop=type:directx
6230<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006231 If select a raster font (Courier, Terminal or FixedSys which
6232 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006233 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006234
6235 NOTE: It is known that some fonts and options combination
6236 causes trouble on drawing glyphs.
6237
Bram Moolenaar92467d32017-12-05 13:22:16 +01006238 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006239 special made fonts (True-Type fonts which includes only
6240 bitmap glyphs).
6241 - 'taamode:3' will not work with some vector fonts.
6242
6243 NOTE: With this option, you can display colored emoji
6244 (emoticon) in Windows 8.1 or later. To display colored emoji,
6245 there are some conditions which you should notice.
6246
6247 - If your font includes non-colored emoji already, it will
6248 be used.
6249 - If your font doesn't have emoji, the system chooses an
6250 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6251 will be used.
6252 - When this alternative font didn't have fixed width glyph,
6253 emoji might be rendered beyond the bounding box of drawing
6254 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006255
6256 Other render types are currently not supported.
6257
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 *'report'*
6259'report' number (default 2)
6260 global
6261 Threshold for reporting number of lines changed. When the number of
6262 changed lines is more than 'report' a message will be given for most
6263 ":" commands. If you want it always, set 'report' to 0.
6264 For the ":substitute" command the number of substitutions is used
6265 instead of the number of lines.
6266
6267 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6268'restorescreen' 'rs' boolean (default on)
6269 global
6270 {not in Vi} {only in Windows 95/NT console version}
6271 When set, the screen contents is restored when exiting Vim. This also
6272 happens when executing external commands.
6273
6274 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6275 options in your .vimrc. To disable restoring:
6276 set t_ti= t_te=
6277 To enable restoring (for an xterm):
6278 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6279 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6280
6281 *'revins'* *'ri'* *'norevins'* *'nori'*
6282'revins' 'ri' boolean (default off)
6283 global
6284 {not in Vi}
6285 {only available when compiled with the |+rightleft|
6286 feature}
6287 Inserting characters in Insert mode will work backwards. See "typing
6288 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6289 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006290 NOTE: This option is reset when 'compatible' is set.
6291 This option is reset when 'paste' is set and restored when 'paste' is
6292 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293
6294 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6295'rightleft' 'rl' boolean (default off)
6296 local to window
6297 {not in Vi}
6298 {only available when compiled with the |+rightleft|
6299 feature}
6300 When on, display orientation becomes right-to-left, i.e., characters
6301 that are stored in the file appear from the right to the left.
6302 Using this option, it is possible to edit files for languages that
6303 are written from the right to the left such as Hebrew and Arabic.
6304 This option is per window, so it is possible to edit mixed files
6305 simultaneously, or to view the same file in both ways (this is
6306 useful whenever you have a mixed text file with both right-to-left
6307 and left-to-right strings so that both sets are displayed properly
6308 in different windows). Also see |rileft.txt|.
6309
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006310 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006311'rightleftcmd' 'rlc' string (default "search")
6312 local to window
6313 {not in Vi}
6314 {only available when compiled with the |+rightleft|
6315 feature}
6316 Each word in this option enables the command line editing to work in
6317 right-to-left mode for a group of commands:
6318
6319 search "/" and "?" commands
6320
6321 This is useful for languages such as Hebrew, Arabic and Farsi.
6322 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6323
Bram Moolenaard94464e2015-11-02 15:28:18 +01006324 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006325'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006326 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006327 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006328 {only available when compiled with the |+ruby/dyn|
6329 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006330 Specifies the name of the Ruby shared library. The default is
6331 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006332 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006333 This option cannot be set from a |modeline| or in the |sandbox|, for
6334 security reasons.
6335
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006337'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 global
6339 {not in Vi}
6340 {not available when compiled without the
6341 |+cmdline_info| feature}
6342 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006343 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 text in the file is shown on the far right:
6345 Top first line is visible
6346 Bot last line is visible
6347 All first and last line are visible
6348 45% relative position in the file
6349 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006350 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006352 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 this option takes precedence over 'ruler' and 'rulerformat'
6354 If the number of characters displayed is different from the number of
6355 bytes in the text (e.g., for a TAB or a multi-byte character), both
6356 the text column (byte number) and the screen column are shown,
6357 separated with a dash.
6358 For an empty line "0-1" is shown.
6359 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006360 This option is reset when 'paste' is set and restored when 'paste' is
6361 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 If you don't want to see the ruler all the time but want to know where
6363 you are, use "g CTRL-G" |g_CTRL-G|.
6364 NOTE: This option is reset when 'compatible' is set.
6365
6366 *'rulerformat'* *'ruf'*
6367'rulerformat' 'ruf' string (default empty)
6368 global
6369 {not in Vi}
6370 {not available when compiled without the |+statusline|
6371 feature}
6372 When this option is not empty, it determines the content of the ruler
6373 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006374 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 The default ruler width is 17 characters. To make the ruler 15
6376 characters wide, put "%15(" at the start and "%)" at the end.
6377 Example: >
6378 :set rulerformat=%15(%c%V\ %p%%%)
6379<
6380 *'runtimepath'* *'rtp'* *vimfiles*
6381'runtimepath' 'rtp' string (default:
6382 Unix: "$HOME/.vim,
6383 $VIM/vimfiles,
6384 $VIMRUNTIME,
6385 $VIM/vimfiles/after,
6386 $HOME/.vim/after"
6387 Amiga: "home:vimfiles,
6388 $VIM/vimfiles,
6389 $VIMRUNTIME,
6390 $VIM/vimfiles/after,
6391 home:vimfiles/after"
6392 PC, OS/2: "$HOME/vimfiles,
6393 $VIM/vimfiles,
6394 $VIMRUNTIME,
6395 $VIM/vimfiles/after,
6396 $HOME/vimfiles/after"
6397 Macintosh: "$VIM:vimfiles,
6398 $VIMRUNTIME,
6399 $VIM:vimfiles:after"
6400 RISC-OS: "Choices:vimfiles,
6401 $VIMRUNTIME,
6402 Choices:vimfiles/after"
6403 VMS: "sys$login:vimfiles,
6404 $VIM/vimfiles,
6405 $VIMRUNTIME,
6406 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006407 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 global
6409 {not in Vi}
6410 This is a list of directories which will be searched for runtime
6411 files:
6412 filetype.vim filetypes by file name |new-filetype|
6413 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006414 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 colors/ color scheme files |:colorscheme|
6416 compiler/ compiler files |:compiler|
6417 doc/ documentation |write-local-help|
6418 ftplugin/ filetype plugins |write-filetype-plugin|
6419 indent/ indent scripts |indent-expression|
6420 keymap/ key mapping files |mbyte-keymap|
6421 lang/ menu translations |:menutrans|
6422 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006423 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 plugin/ plugin scripts |write-plugin|
6425 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006426 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 syntax/ syntax files |mysyntaxfile|
6428 tutor/ files for vimtutor |tutor|
6429
6430 And any other file searched for with the |:runtime| command.
6431
6432 The defaults for most systems are setup to search five locations:
6433 1. In your home directory, for your personal preferences.
6434 2. In a system-wide Vim directory, for preferences from the system
6435 administrator.
6436 3. In $VIMRUNTIME, for files distributed with Vim.
6437 *after-directory*
6438 4. In the "after" directory in the system-wide Vim directory. This is
6439 for the system administrator to overrule or add to the distributed
6440 defaults (rarely needed)
6441 5. In the "after" directory in your home directory. This is for
6442 personal preferences to overrule or add to the distributed defaults
6443 or system-wide settings (rarely needed).
6444
Bram Moolenaard0796902016-09-16 20:02:31 +02006445 More entries are added when using |packages|. If it gets very long
6446 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6447 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006448
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6450 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006451 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 wildcards.
6453 See |:runtime|.
6454 Example: >
6455 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6456< This will use the directory "~/vimruntime" first (containing your
6457 personal Vim runtime files), then "/mygroup/vim" (shared between a
6458 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6459 files).
6460 You probably should always include $VIMRUNTIME somewhere, to use the
6461 distributed runtime files. You can put a directory before $VIMRUNTIME
6462 to find files which replace a distributed runtime files. You can put
6463 a directory after $VIMRUNTIME to find files which add to distributed
6464 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006465 When Vim is started with |--clean| the home directory entries are not
6466 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 This option cannot be set from a |modeline| or in the |sandbox|, for
6468 security reasons.
6469
6470 *'scroll'* *'scr'*
6471'scroll' 'scr' number (default: half the window height)
6472 local to window
6473 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6474 set to half the number of lines in the window when the window size
6475 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006476 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6478 the number of screen lines instead of file lines, makes a difference
6479 when lines wrap}
6480
6481 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6482'scrollbind' 'scb' boolean (default off)
6483 local to window
6484 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 See also |scroll-binding|. When this option is set, the current
6486 window scrolls as other scrollbind windows (windows that also have
6487 this option set) scroll. This option is useful for viewing the
6488 differences between two versions of a file, see 'diff'.
6489 See |'scrollopt'| for options that determine how this option should be
6490 interpreted.
6491 This option is mostly reset when splitting a window to edit another
6492 file. This means that ":split | edit file" results in two windows
6493 with scroll-binding, but ":split file" does not.
6494
6495 *'scrolljump'* *'sj'*
6496'scrolljump' 'sj' number (default 1)
6497 global
6498 {not in Vi}
6499 Minimal number of lines to scroll when the cursor gets off the
6500 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6501 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006502 When set to a negative number from -1 to -100 this is used as the
6503 percentage of the window height. Thus -50 scrolls half the window
6504 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 NOTE: This option is set to 1 when 'compatible' is set.
6506
6507 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006508'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 global
6510 {not in Vi}
6511 Minimal number of screen lines to keep above and below the cursor.
6512 This will make some context visible around where you are working. If
6513 you set it to a very large value (999) the cursor line will always be
6514 in the middle of the window (except at the start or end of the file or
6515 when long lines wrap).
6516 For scrolling horizontally see 'sidescrolloff'.
6517 NOTE: This option is set to 0 when 'compatible' is set.
6518
6519 *'scrollopt'* *'sbo'*
6520'scrollopt' 'sbo' string (default "ver,jump")
6521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 {not in Vi}
6523 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006524 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6525 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 The following words are available:
6527 ver Bind vertical scrolling for 'scrollbind' windows
6528 hor Bind horizontal scrolling for 'scrollbind' windows
6529 jump Applies to the offset between two windows for vertical
6530 scrolling. This offset is the difference in the first
6531 displayed line of the bound windows. When moving
6532 around in a window, another 'scrollbind' window may
6533 reach a position before the start or after the end of
6534 the buffer. The offset is not changed though, when
6535 moving back the 'scrollbind' window will try to scroll
6536 to the desired position when possible.
6537 When now making that window the current one, two
6538 things can be done with the relative offset:
6539 1. When "jump" is not included, the relative offset is
6540 adjusted for the scroll position in the new current
6541 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006542 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 2. When "jump" is included, the other windows are
6544 scrolled to keep the same relative offset. When
6545 going back to the other window, it still uses the
6546 same relative offset.
6547 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006548 When 'diff' mode is active there always is vertical scroll binding,
6549 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550
6551 *'sections'* *'sect'*
6552'sections' 'sect' string (default "SHNHH HUnhsh")
6553 global
6554 Specifies the nroff macros that separate sections. These are pairs of
6555 two letters (See |object-motions|). The default makes a section start
6556 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6557
6558 *'secure'* *'nosecure'* *E523*
6559'secure' boolean (default off)
6560 global
6561 {not in Vi}
6562 When on, ":autocmd", shell and write commands are not allowed in
6563 ".vimrc" and ".exrc" in the current directory and map commands are
6564 displayed. Switch it off only if you know that you will not run into
6565 problems, or when the 'exrc' option is off. On Unix this option is
6566 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006567 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 'secure' at the end of your ~/.vimrc then.
6569 This option cannot be set from a |modeline| or in the |sandbox|, for
6570 security reasons.
6571
6572 *'selection'* *'sel'*
6573'selection' 'sel' string (default "inclusive")
6574 global
6575 {not in Vi}
6576 This option defines the behavior of the selection. It is only used
6577 in Visual and Select mode.
6578 Possible values:
6579 value past line inclusive ~
6580 old no yes
6581 inclusive yes yes
6582 exclusive yes no
6583 "past line" means that the cursor is allowed to be positioned one
6584 character past the line.
6585 "inclusive" means that the last character of the selection is included
6586 in an operation. For example, when "x" is used to delete the
6587 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006588 When "old" is used and 'virtualedit' allows the cursor to move past
6589 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 Note that when "exclusive" is used and selecting from the end
6591 backwards, you cannot include the last character of a line, when
6592 starting in Normal mode and 'virtualedit' empty.
6593
6594 The 'selection' option is set by the |:behave| command.
6595
6596 *'selectmode'* *'slm'*
6597'selectmode' 'slm' string (default "")
6598 global
6599 {not in Vi}
6600 This is a comma separated list of words, which specifies when to start
6601 Select mode instead of Visual mode, when a selection is started.
6602 Possible values:
6603 mouse when using the mouse
6604 key when using shifted special keys
6605 cmd when using "v", "V" or CTRL-V
6606 See |Select-mode|.
6607 The 'selectmode' option is set by the |:behave| command.
6608
6609 *'sessionoptions'* *'ssop'*
6610'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006611 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 global
6613 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006614 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 feature}
6616 Changes the effect of the |:mksession| command. It is a comma
6617 separated list of words. Each word enables saving and restoring
6618 something:
6619 word save and restore ~
6620 blank empty windows
6621 buffers hidden and unloaded buffers, not just those in windows
6622 curdir the current directory
6623 folds manually created folds, opened/closed folds and local
6624 fold options
6625 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006626 and contain at least one lowercase letter. Only
6627 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 help the help window
6629 localoptions options and mappings local to a window or buffer (not
6630 global values for local options)
6631 options all options and mappings (also global values for local
6632 options)
6633 resize size of the Vim window: 'lines' and 'columns'
6634 sesdir the directory in which the session file is located
6635 will become the current directory (useful with
6636 projects accessed over a network from different
6637 systems)
6638 slash backslashes in file names replaced with forward
6639 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006640 tabpages all tab pages; without this only the current tab page
6641 is restored, so that you can make a session for each
6642 tab page separately
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006643 terminal include terminal windows where the command can be restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 unix with Unix end-of-line format (single <NL>), even when
6645 on Windows or DOS
6646 winpos position of the whole Vim window
6647 winsize window sizes
6648
6649 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006650 When neither "curdir" nor "sesdir" is included, file names are stored
6651 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 "slash" and "unix" are useful on Windows when sharing session files
6653 with Unix. The Unix version of Vim cannot source dos format scripts,
6654 but the Windows version of Vim can source unix format scripts.
6655
6656 *'shell'* *'sh'* *E91*
6657'shell' 'sh' string (default $SHELL or "sh",
6658 MS-DOS and Win32: "command.com" or
6659 "cmd.exe", OS/2: "cmd")
6660 global
6661 Name of the shell to use for ! and :! commands. When changing the
6662 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6663 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 See |option-backslash| about including spaces and backslashes.
6666 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006667
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006669 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6671< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006672 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006674 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006676 Example with escaped space (Vim will do this when initializing the
6677 option from $SHELL): >
6678 :set shell=/bin/with\\\ space/sh
6679< The resulting value of 'shell' is "/bin/with\ space/sh", two
6680 backslashes are consumed by `:set`.
6681
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 Under MS-Windows, when the executable ends in ".com" it must be
6683 included. Thus setting the shell to "command.com" or "4dos.com"
6684 works, but "command" and "4dos" do not work for all commands (e.g.,
6685 filtering).
6686 For unknown reasons, when using "4dos.com" the current directory is
6687 changed to "C:\". To avoid this set 'shell' like this: >
6688 :set shell=command.com\ /c\ 4dos
6689< This option cannot be set from a |modeline| or in the |sandbox|, for
6690 security reasons.
6691
6692 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006693'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006694 MS-DOS and Win32, when 'shell' does not
6695 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 global
6697 {not in Vi}
6698 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6699 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6700 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006701 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006702 On Unix it can have more than one flag. Each white space separated
6703 part is passed as an argument to the shell command.
6704 See |option-backslash| about including spaces and backslashes.
6705 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 This option cannot be set from a |modeline| or in the |sandbox|, for
6707 security reasons.
6708
6709 *'shellpipe'* *'sp'*
6710'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6711 global
6712 {not in Vi}
6713 {not available when compiled without the |+quickfix|
6714 feature}
6715 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006716 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 including spaces and backslashes.
6718 The name of the temporary file can be represented by "%s" if necessary
6719 (the file name is appended automatically if no %s appears in the value
6720 of this option).
6721 For the Amiga and MS-DOS the default is ">". The output is directly
6722 saved in a file and not echoed to the screen.
6723 For Unix the default it "| tee". The stdout of the compiler is saved
6724 in a file and echoed to the screen. If the 'shell' option is "csh" or
6725 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006726 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6727 default becomes "2>&1| tee". This means that stderr is also included.
6728 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6729 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 The initialization of this option is done after reading the ".vimrc"
6731 and the other initializations, so that when the 'shell' option is set
6732 there, the 'shellpipe' option changes automatically, unless it was
6733 explicitly set before.
6734 When 'shellpipe' is set to an empty string, no redirection of the
6735 ":make" output will be done. This is useful if you use a 'makeprg'
6736 that writes to 'makeef' by itself. If you want no piping, but do
6737 want to include the 'makeef', set 'shellpipe' to a single space.
6738 Don't forget to precede the space with a backslash: ":set sp=\ ".
6739 In the future pipes may be used for filtering and this option will
6740 become obsolete (at least for Unix).
6741 This option cannot be set from a |modeline| or in the |sandbox|, for
6742 security reasons.
6743
6744 *'shellquote'* *'shq'*
6745'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6746 contains "sh" somewhere: "\"")
6747 global
6748 {not in Vi}
6749 Quoting character(s), put around the command passed to the shell, for
6750 the "!" and ":!" commands. The redirection is kept outside of the
6751 quoting. See 'shellxquote' to include the redirection. It's
6752 probably not useful to set both options.
6753 This is an empty string by default. Only known to be useful for
6754 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6755 or bash, where it should be "\"". The default is adjusted according
6756 the value of 'shell', to reduce the need to set this option by the
6757 user. See |dos-shell|.
6758 This option cannot be set from a |modeline| or in the |sandbox|, for
6759 security reasons.
6760
6761 *'shellredir'* *'srr'*
6762'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6763 global
6764 {not in Vi}
6765 String to be used to put the output of a filter command in a temporary
6766 file. See also |:!|. See |option-backslash| about including spaces
6767 and backslashes.
6768 The name of the temporary file can be represented by "%s" if necessary
6769 (the file name is appended automatically if no %s appears in the value
6770 of this option).
6771 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6772 or "zsh" during initializations, the default becomes ">&". If the
6773 'shell' option is "sh", "ksh" or "bash" the default becomes
6774 ">%s 2>&1". This means that stderr is also included.
6775 For Win32, the Unix checks are done and additionally "cmd" is checked
6776 for, which makes the default ">%s 2>&1". Also, the same names with
6777 ".exe" appended are checked for.
6778 The initialization of this option is done after reading the ".vimrc"
6779 and the other initializations, so that when the 'shell' option is set
6780 there, the 'shellredir' option changes automatically unless it was
6781 explicitly set before.
6782 In the future pipes may be used for filtering and this option will
6783 become obsolete (at least for Unix).
6784 This option cannot be set from a |modeline| or in the |sandbox|, for
6785 security reasons.
6786
6787 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6788'shellslash' 'ssl' boolean (default off)
6789 global
6790 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6791 When set, a forward slash is used when expanding file names. This is
6792 useful when a Unix-like shell is used instead of command.com or
6793 cmd.exe. Backward slashes can still be typed, but they are changed to
6794 forward slashes by Vim.
6795 Note that setting or resetting this option has no effect for some
6796 existing file names, thus this option needs to be set before opening
6797 any file for best results. This might change in the future.
6798 'shellslash' only works when a backslash can be used as a path
6799 separator. To test if this is so use: >
6800 if exists('+shellslash')
6801<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006802 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6803'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6804 global
6805 {not in Vi}
6806 When on, use temp files for shell commands. When off use a pipe.
6807 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006808 Currently a pipe is only supported on Unix and MS-Windows 2K and
6809 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006810 :if has("filterpipe")
6811< The advantage of using a pipe is that nobody can read the temp file
6812 and the 'shell' command does not need to support redirection.
6813 The advantage of using a temp file is that the file type and encoding
6814 can be detected.
6815 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6816 |FilterWritePost| autocommands event are not triggered when
6817 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006818 The `system()` function does not respect this option and always uses
6819 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006820 NOTE: This option is set to the Vim default value when 'compatible'
6821 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006822
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 *'shelltype'* *'st'*
6824'shelltype' 'st' number (default 0)
6825 global
6826 {not in Vi} {only for the Amiga}
6827 On the Amiga this option influences the way how the commands work
6828 which use a shell.
6829 0 and 1: always use the shell
6830 2 and 3: use the shell only to filter lines
6831 4 and 5: use shell only for ':sh' command
6832 When not using the shell, the command is executed directly.
6833
6834 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6835 1 and 3: use "shell cmd" to start external commands
6836
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006837 *'shellxescape'* *'sxe'*
6838'shellxescape' 'sxe' string (default: "";
6839 for MS-DOS and MS-Windows: "\"&|<>()@^")
6840 global
6841 {not in Vi}
6842 When 'shellxquote' is set to "(" then the characters listed in this
6843 option will be escaped with a '^' character. This makes it possible
6844 to execute most external commands with cmd.exe.
6845
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 *'shellxquote'* *'sxq'*
6847'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006848 for Win32, when 'shell' is cmd.exe: "("
6849 for Win32, when 'shell' contains "sh"
6850 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 for Unix, when using system(): "\"")
6852 global
6853 {not in Vi}
6854 Quoting character(s), put around the command passed to the shell, for
6855 the "!" and ":!" commands. Includes the redirection. See
6856 'shellquote' to exclude the redirection. It's probably not useful
6857 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006858 When the value is '(' then ')' is appended. When the value is '"('
6859 then ')"' is appended.
6860 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006861 This is an empty string by default on most systems, but is known to be
6862 useful for on Win32 version, either for cmd.exe which automatically
6863 strips off the first and last quote on a command, or 3rd-party shells
6864 such as the MKS Korn Shell or bash, where it should be "\"". The
6865 default is adjusted according the value of 'shell', to reduce the need
6866 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 This option cannot be set from a |modeline| or in the |sandbox|, for
6868 security reasons.
6869
6870 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6871'shiftround' 'sr' boolean (default off)
6872 global
6873 {not in Vi}
6874 Round indent to multiple of 'shiftwidth'. Applies to > and <
6875 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6876 a multiple of 'shiftwidth' (this is Vi compatible).
6877 NOTE: This option is reset when 'compatible' is set.
6878
6879 *'shiftwidth'* *'sw'*
6880'shiftwidth' 'sw' number (default 8)
6881 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006882 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006884 When zero the 'ts' value will be used. Use the |shiftwidth()|
6885 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886
6887 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006888'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6889 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 global
6891 {not in Vi}
6892 This option helps to avoid all the |hit-enter| prompts caused by file
6893 messages, for example with CTRL-G, and to avoid some other messages.
6894 It is a list of flags:
6895 flag meaning when present ~
6896 f use "(3 of 5)" instead of "(file 3 of 5)"
6897 i use "[noeol]" instead of "[Incomplete last line]"
6898 l use "999L, 888C" instead of "999 lines, 888 characters"
6899 m use "[+]" instead of "[Modified]"
6900 n use "[New]" instead of "[New File]"
6901 r use "[RO]" instead of "[readonly]"
6902 w use "[w]" instead of "written" for file write message
6903 and "[a]" instead of "appended" for ':w >> file' command
6904 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6905 "[unix format]" and "[mac]" instead of "[mac format]".
6906 a all of the above abbreviations
6907
6908 o overwrite message for writing a file with subsequent message
6909 for reading a file (useful for ":wn" or when 'autowrite' on)
6910 O message for reading a file overwrites any previous message.
6911 Also for quickfix message (e.g., ":cn").
6912 s don't give "search hit BOTTOM, continuing at TOP" or "search
6913 hit TOP, continuing at BOTTOM" messages
6914 t truncate file message at the start if it is too long to fit
6915 on the command-line, "<" will appear in the left most column.
6916 Ignored in Ex mode.
6917 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006918 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 Ignored in Ex mode.
6920 W don't give "written" or "[w]" when writing a file
6921 A don't give the "ATTENTION" message when an existing swap file
6922 is found.
6923 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006924 c don't give |ins-completion-menu| messages. For example,
6925 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6926 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006927 q use "recording" instead of "recording @a"
6928 F don't give the file info when editing a file, like `:silent`
6929 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930
6931 This gives you the opportunity to avoid that a change between buffers
6932 requires you to hit <Enter>, but still gives as useful a message as
6933 possible for the space available. To get the whole message that you
6934 would have got with 'shm' empty, use ":file!"
6935 Useful values:
6936 shm= No abbreviation of message.
6937 shm=a Abbreviation, but no loss of information.
6938 shm=at Abbreviation, and truncate message when necessary.
6939
6940 NOTE: This option is set to the Vi default value when 'compatible' is
6941 set and to the Vim default value when 'compatible' is reset.
6942
6943 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6944'shortname' 'sn' boolean (default off)
6945 local to buffer
6946 {not in Vi, not in MS-DOS versions}
6947 Filenames are assumed to be 8 characters plus one extension of 3
6948 characters. Multiple dots in file names are not allowed. When this
6949 option is on, dots in file names are replaced with underscores when
6950 adding an extension (".~" or ".swp"). This option is not available
6951 for MS-DOS, because then it would always be on. This option is useful
6952 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6953 or crossdos. When running the Win32 GUI version under Win32s, this
6954 option is always on by default.
6955
6956 *'showbreak'* *'sbr'* *E595*
6957'showbreak' 'sbr' string (default "")
6958 global
6959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006960 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 feature}
6962 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006963 values are "> " or "+++ ": >
6964 :set showbreak=>\
6965< Note the backslash to escape the trailing space. It's easier like
6966 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006967 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006968< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 comma (in a future version the comma might be used to separate the
6970 part that is shown at the end and at the start of a line).
6971 The characters are highlighted according to the '@' flag in
6972 'highlight'.
6973 Note that tabs after the showbreak will be displayed differently.
6974 If you want the 'showbreak' to appear in between line numbers, add the
6975 "n" flag to 'cpoptions'.
6976
6977 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006978'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6979 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 global
6981 {not in Vi}
6982 {not available when compiled without the
6983 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006984 Show (partial) command in the last line of the screen. Set this
6985 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 In Visual mode the size of the selected area is shown:
6987 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006988 If the number of bytes is different it is also displayed: "2-6"
6989 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006991 - When selecting a block, the size in screen characters:
6992 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 NOTE: This option is set to the Vi default value when 'compatible' is
6994 set and to the Vim default value when 'compatible' is reset.
6995
6996 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6997'showfulltag' 'sft' boolean (default off)
6998 global
6999 {not in Vi}
7000 When completing a word in insert mode (see |ins-completion|) from the
7001 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007002 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 matched a C function, you can see a template for what arguments are
7004 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007005 Note that this doesn't work well together with having "longest" in
7006 'completeopt', because the completion from the search pattern may not
7007 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008
7009 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7010'showmatch' 'sm' boolean (default off)
7011 global
7012 When a bracket is inserted, briefly jump to the matching one. The
7013 jump is only done if the match can be seen on the screen. The time to
7014 show the match can be set with 'matchtime'.
7015 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007016 seen or not).
7017 This option is reset when 'paste' is set and restored when 'paste' is
7018 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 When the 'm' flag is not included in 'cpoptions', typing a character
7020 will immediately move the cursor back to where it belongs.
7021 See the "sm" field in 'guicursor' for setting the cursor shape and
7022 blinking when showing the match.
7023 The 'matchpairs' option can be used to specify the characters to show
7024 matches for. 'rightleft' and 'revins' are used to look for opposite
7025 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007026 Also see the matchparen plugin for highlighting the match when moving
7027 around |pi_paren.txt|.
7028 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029
7030 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7031'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7032 global
7033 If in Insert, Replace or Visual mode put a message on the last line.
7034 Use the 'M' flag in 'highlight' to set the type of highlighting for
7035 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007036 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 doesn't mean XIM is really active, especially when 'imactivatekey' is
7038 not set.
7039 NOTE: This option is set to the Vi default value when 'compatible' is
7040 set and to the Vim default value when 'compatible' is reset.
7041
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007042 *'showtabline'* *'stal'*
7043'showtabline' 'stal' number (default 1)
7044 global
7045 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007046 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007047 feature}
7048 The value of this option specifies when the line with tab page labels
7049 will be displayed:
7050 0: never
7051 1: only if there are at least two tab pages
7052 2: always
7053 This is both for the GUI and non-GUI implementation of the tab pages
7054 line.
7055 See |tab-page| for more information about tab pages.
7056
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 *'sidescroll'* *'ss'*
7058'sidescroll' 'ss' number (default 0)
7059 global
7060 {not in Vi}
7061 The minimal number of columns to scroll horizontally. Used only when
7062 the 'wrap' option is off and the cursor is moved off of the screen.
7063 When it is zero the cursor will be put in the middle of the screen.
7064 When using a slow terminal set it to a large number or 0. When using
7065 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7066 commands.
7067
7068 *'sidescrolloff'* *'siso'*
7069'sidescrolloff' 'siso' number (default 0)
7070 global
7071 {not in Vi}
7072 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007073 right of the cursor if 'nowrap' is set. Setting this option to a
7074 value greater than 0 while having |'sidescroll'| also at a non-zero
7075 value makes some context visible in the line you are scrolling in
7076 horizontally (except at beginning of the line). Setting this option
7077 to a large value (like 999) has the effect of keeping the cursor
7078 horizontally centered in the window, as long as one does not come too
7079 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 NOTE: This option is set to 0 when 'compatible' is set.
7081
7082 Example: Try this together with 'sidescroll' and 'listchars' as
7083 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007084 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007085
7086 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7087 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007088<
7089 *'signcolumn'* *'scl'*
7090'signcolumn' 'scl' string (default "auto")
7091 local to window
7092 {not in Vi}
7093 {not available when compiled without the |+signs|
7094 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007095 Whether or not to draw the signcolumn. Valid values are:
7096 "auto" only when there is a sign to display
7097 "no" never
7098 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099
7100
7101 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7102'smartcase' 'scs' boolean (default off)
7103 global
7104 {not in Vi}
7105 Override the 'ignorecase' option if the search pattern contains upper
7106 case characters. Only used when the search pattern is typed and
7107 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007108 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7110 recalling the search pattern from history and hitting <Enter>.
7111 NOTE: This option is reset when 'compatible' is set.
7112
7113 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7114'smartindent' 'si' boolean (default off)
7115 local to buffer
7116 {not in Vi}
7117 {not available when compiled without the
7118 |+smartindent| feature}
7119 Do smart autoindenting when starting a new line. Works for C-like
7120 programs, but can also be used for other languages. 'cindent' does
7121 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007122 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007123 setting 'si' has no effect. 'indentexpr' is a more advanced
7124 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 Normally 'autoindent' should also be on when using 'smartindent'.
7126 An indent is automatically inserted:
7127 - After a line ending in '{'.
7128 - After a line starting with a keyword from 'cinwords'.
7129 - Before a line starting with '}' (only with the "O" command).
7130 When typing '}' as the first character in a new line, that line is
7131 given the same indent as the matching '{'.
7132 When typing '#' as the first character in a new line, the indent for
7133 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007134 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7136 When using the ">>" command, lines starting with '#' are not shifted
7137 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007138 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007139 This option is reset when 'paste' is set and restored when 'paste' is
7140 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
7142 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7143'smarttab' 'sta' boolean (default off)
7144 global
7145 {not in Vi}
7146 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007147 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7148 <BS> will delete a 'shiftwidth' worth of space at the start of the
7149 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007150 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007151 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7152 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007153 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007155 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007156 This option is reset when 'paste' is set and restored when 'paste' is
7157 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 NOTE: This option is reset when 'compatible' is set.
7159
7160 *'softtabstop'* *'sts'*
7161'softtabstop' 'sts' number (default 0)
7162 local to buffer
7163 {not in Vi}
7164 Number of spaces that a <Tab> counts for while performing editing
7165 operations, like inserting a <Tab> or using <BS>. It "feels" like
7166 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7167 used. This is useful to keep the 'ts' setting at its standard value
7168 of 8, while being able to edit like it is set to 'sts'. However,
7169 commands like "x" still work on the actual characters.
7170 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007171 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007172 'softtabstop' is set to 0 when the 'paste' option is set and restored
7173 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7175 spaces is minimized by using <Tab>s.
7176 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7177 set.
7178 NOTE: This option is set to 0 when 'compatible' is set.
7179
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007180 If Vim is compiled with the |+vartabs| feature then the value of
7181 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7182 anything other than an empty string.
7183
Bram Moolenaar217ad922005-03-20 22:37:15 +00007184 *'spell'* *'nospell'*
7185'spell' boolean (default off)
7186 local to window
7187 {not in Vi}
7188 {not available when compiled without the |+syntax|
7189 feature}
7190 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007191 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007192
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007193 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007194'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007195 local to buffer
7196 {not in Vi}
7197 {not available when compiled without the |+syntax|
7198 feature}
7199 Pattern to locate the end of a sentence. The following word will be
7200 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007201 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007202 When this check is not wanted make this option empty.
7203 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007204 Be careful with special characters, see |option-backslash| about
7205 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007206 To set this option automatically depending on the language, see
7207 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007208
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007209 *'spellfile'* *'spf'*
7210'spellfile' 'spf' string (default empty)
7211 local to buffer
7212 {not in Vi}
7213 {not available when compiled without the |+syntax|
7214 feature}
7215 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007216 commands. It must end in ".{encoding}.add". You need to include the
7217 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007218 *E765*
7219 It may also be a comma separated list of names. A count before the
7220 |zg| and |zw| commands can be used to access each. This allows using
7221 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007222 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007223 you: Using the first directory in 'runtimepath' that is writable. If
7224 there is no "spell" directory yet it will be created. For the file
7225 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007226 ignoring the region.
7227 The resulting ".spl" file will be used for spell checking, it does not
7228 have to appear in 'spelllang'.
7229 Normally one file is used for all regions, but you can add the region
7230 name if you want to. However, it will then only be used when
7231 'spellfile' is set to it, for entries in 'spelllang' only files
7232 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007233 This option cannot be set from a |modeline| or in the |sandbox|, for
7234 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007235
Bram Moolenaar217ad922005-03-20 22:37:15 +00007236 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007237'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007238 local to buffer
7239 {not in Vi}
7240 {not available when compiled without the |+syntax|
7241 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007242 A comma separated list of word list names. When the 'spell' option is
7243 on spellchecking will be done for these languages. Example: >
7244 set spelllang=en_us,nl,medical
7245< This means US English, Dutch and medical words are recognized. Words
7246 that are not recognized will be highlighted.
7247 The word list name must not include a comma or dot. Using a dash is
7248 recommended to separate the two letter language name from a
7249 specification. Thus "en-rare" is used for rare English words.
7250 A region name must come last and have the form "_xx", where "xx" is
7251 the two-letter, lower case region name. You can use more than one
7252 region by listing them: "en_us,en_ca" supports both US and Canadian
7253 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007254 Britain. (Note: currently en_au and en_nz dictionaries are older than
7255 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007256 If the name "cjk" is included East Asian characters are excluded from
7257 spell checking. This is useful when editing text that also has Asian
7258 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007259 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007260 As a special case the name of a .spl file can be given as-is. The
7261 first "_xx" in the name is removed and used as the region name
7262 (_xx is an underscore, two letters and followed by a non-letter).
7263 This is mainly for testing purposes. You must make sure the correct
7264 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007265 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007266 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7267 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007268 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007269
Bram Moolenaar98692072006-02-04 00:57:42 +00007270 If the |spellfile.vim| plugin is active and you use a language name
7271 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7272 will ask you if you want to download the file.
7273
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007274 After this option has been set successfully, Vim will source the files
7275 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007276 up to the first comma, dot or underscore.
7277 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007278
7279
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007280 *'spellsuggest'* *'sps'*
7281'spellsuggest' 'sps' string (default "best")
7282 global
7283 {not in Vi}
7284 {not available when compiled without the |+syntax|
7285 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007286 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007287 the |spellsuggest()| function. This is a comma-separated list of
7288 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007289
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007290 best Internal method that works best for English. Finds
7291 changes like "fast" and uses a bit of sound-a-like
7292 scoring to improve the ordering.
7293
7294 double Internal method that uses two methods and mixes the
7295 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007296 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007297 word. That only works when the language specifies
7298 sound folding. Can be slow and doesn't always give
7299 better results.
7300
7301 fast Internal method that only checks for simple changes:
7302 character inserts/deletes/swaps. Works well for
7303 simple typing mistakes.
7304
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007305 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007306 Not used for |spellsuggest()|. The number of
7307 suggestions is never more than the value of 'lines'
7308 minus two.
7309
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007310 file:{filename} Read file {filename}, which must have two columns,
7311 separated by a slash. The first column contains the
7312 bad word, the second column the suggested good word.
7313 Example:
7314 theribal/terrible ~
7315 Use this for common mistakes that do not appear at the
7316 top of the suggestion list with the internal methods.
7317 Lines without a slash are ignored, use this for
7318 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007319 The word in the second column must be correct,
7320 otherwise it will not be used. Add the word to an
7321 ".add" file if it is currently flagged as a spelling
7322 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007323 The file is used for all languages.
7324
7325 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7326 trouble with spaces. |v:val| holds the badly spelled
7327 word. The expression must evaluate to a List of
7328 Lists, each with a suggestion and a score.
7329 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007330 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007331 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007332 internal methods use. A lower score is better.
7333 This may invoke |spellsuggest()| if you temporarily
7334 set 'spellsuggest' to exclude the "expr:" part.
7335 Errors are silently ignored, unless you set the
7336 'verbose' option to a non-zero value.
7337
7338 Only one of "best", "double" or "fast" may be used. The others may
7339 appear several times in any order. Example: >
7340 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7341<
7342 This option cannot be set from a |modeline| or in the |sandbox|, for
7343 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007344
7345
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7347'splitbelow' 'sb' boolean (default off)
7348 global
7349 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007350 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 feature}
7352 When on, splitting a window will put the new window below the current
7353 one. |:split|
7354
7355 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7356'splitright' 'spr' boolean (default off)
7357 global
7358 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007359 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 feature}
7361 When on, splitting a window will put the new window right of the
7362 current one. |:vsplit|
7363
7364 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7365'startofline' 'sol' boolean (default on)
7366 global
7367 {not in Vi}
7368 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007369 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007370 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007371 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 with a linewise operator, with "%" with a count and to buffer changing
7373 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7374 only has a line number, e.g., ":25" or ":+".
7375 In case of buffer changing commands the cursor is placed at the column
7376 where it was the last time the buffer was edited.
7377 NOTE: This option is set when 'compatible' is set.
7378
Bram Moolenaar00654022011-02-25 14:42:19 +01007379 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007381 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 {not in Vi}
7383 {not available when compiled without the |+statusline|
7384 feature}
7385 When nonempty, this option determines the content of the status line.
7386 Also see |status-line|.
7387
7388 The option consists of printf style '%' items interspersed with
7389 normal text. Each status line item is of the form:
7390 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007391 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007392 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393
Bram Moolenaar238a5642006-02-21 22:12:05 +00007394 When the option starts with "%!" then it is used as an expression,
7395 evaluated and the result is used as the option value. Example: >
7396 :set statusline=%!MyStatusLine()
7397< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007398 Note that the "%!" expression is evaluated in the context of the
7399 current window and buffer, while %{} items are evaluated in the
7400 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007401
7402 When there is error while evaluating the option then it will be made
7403 empty to avoid further errors. Otherwise screen updating would loop.
7404
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 Note that the only effect of 'ruler' when this option is set (and
7406 'laststatus' is 2) is controlling the output of |CTRL-G|.
7407
7408 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007409 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007411 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 minwid Minimum width of the item, padding as set by '-' & '0'.
7413 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007414 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 on the left for text items. Numeric items will be
7416 shifted down to maxwid-2 digits followed by '>'number
7417 where number is the amount of missing digits, much like
7418 an exponential notation.
7419 item A one letter code as described below.
7420
7421 Following is a description of the possible statusline items. The
7422 second character in "item" is the type:
7423 N for number
7424 S for string
7425 F for flags as described below
7426 - not applicable
7427
7428 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007429 f S Path to the file in the buffer, as typed or relative to current
7430 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 F S Full path to the file in the buffer.
7432 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007433 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007435 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007437 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007439 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007440 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007441 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007443 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7445 being used: "<keymap>"
7446 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007447 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 B N As above, in hexadecimal.
7449 o N Byte number in file of byte under cursor, first byte is 1.
7450 Mnemonic: Offset from start of file (with one added)
7451 {not available when compiled without |+byte_offset| feature}
7452 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007453 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 l N Line number.
7455 L N Number of lines in buffer.
7456 c N Column number.
7457 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007458 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459 p N Percentage through file in lines as in |CTRL-G|.
7460 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007461 percentage described for 'ruler'. Always 3 in length, unless
7462 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007463 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007465 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007466 Note that there is no '%' before the closing '}'. The
7467 expression cannot contain a '}' character, call a function to
7468 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 ( - Start of item group. Can be used for setting the width and
7470 alignment of a section. Must be followed by %) somewhere.
7471 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007472 T N For 'tabline': start of tab page N label. Use %T after the last
7473 label. This information is used for mouse clicks.
7474 X N For 'tabline': start of close tab N label. Use %X after the
7475 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7476 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 < - Where to truncate line if too long. Default is at the start.
7478 No width fields allowed.
7479 = - Separation point between left and right aligned items.
7480 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007481 # - Set highlight group. The name must follow and then a # again.
7482 Thus use %#HLname# for highlight group HLname. The same
7483 highlighting is used, also for the statusline of non-current
7484 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007486 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 The difference between User{N} and StatusLine will be applied
7488 to StatusLineNC for the statusline of non-current windows.
7489 The number N must be between 1 and 9. See |hl-User1..9|
7490
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007491 When displaying a flag, Vim removes the leading comma, if any, when
7492 that flag comes right after plaintext. This will make a nice display
7493 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494
Bram Moolenaar582fd852005-03-28 20:58:01 +00007495 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 not set) and a minwid is not set for the group, the whole group will
7497 become empty. This will make a group like the following disappear
7498 completely from the statusline when none of the flags are set. >
7499 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007500< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 Beware that an expression is evaluated each and every time the status
7502 line is displayed. The current buffer and current window will be set
7503 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007504 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007506 real current buffer.
7507
Bram Moolenaar30b65812012-07-12 22:01:11 +02007508 The 'statusline' option will be evaluated in the |sandbox| if set from
7509 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007510
7511 It is not allowed to change text or jump to another window while
7512 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513
7514 If the statusline is not updated when you want it (e.g., after setting
7515 a variable that's used in an expression), you can force an update by
7516 setting an option without changing its value. Example: >
7517 :let &ro = &ro
7518
7519< A result of all digits is regarded a number for display purposes.
7520 Otherwise the result is taken as flag text and applied to the rules
7521 described above.
7522
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007523 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007524 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007525 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526
7527 Examples:
7528 Emulate standard status line with 'ruler' set >
7529 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7530< Similar, but add ASCII value of char under the cursor (like "ga") >
7531 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7532< Display byte count and byte value, modified flag in red. >
7533 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7534 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7535< Display a ,GZ flag if a compressed file is loaded >
7536 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7537< In the |:autocmd|'s: >
7538 :let b:gzflag = 1
7539< And: >
7540 :unlet b:gzflag
7541< And define this function: >
7542 :function VarExists(var, val)
7543 : if exists(a:var) | return a:val | else | return '' | endif
7544 :endfunction
7545<
7546 *'suffixes'* *'su'*
7547'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7548 global
7549 {not in Vi}
7550 Files with these suffixes get a lower priority when multiple files
7551 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007552 suffixes. Spaces after the comma are ignored. A dot is also seen as
7553 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 separator, precede it with a backslash (see |option-backslash| about
7555 including spaces and backslashes).
7556 See 'wildignore' for completely ignoring files.
7557 The use of |:set+=| and |:set-=| is preferred when adding or removing
7558 suffixes from the list. This avoids problems when a future version
7559 uses another default.
7560
7561 *'suffixesadd'* *'sua'*
7562'suffixesadd' 'sua' string (default "")
7563 local to buffer
7564 {not in Vi}
7565 {not available when compiled without the
7566 |+file_in_path| feature}
7567 Comma separated list of suffixes, which are used when searching for a
7568 file for the "gf", "[I", etc. commands. Example: >
7569 :set suffixesadd=.java
7570<
7571 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7572'swapfile' 'swf' boolean (default on)
7573 local to buffer
7574 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007575 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 swapfile is not wanted for a specific buffer. For example, with
7577 confidential information that even root must not be able to access.
7578 Careful: All text will be in memory:
7579 - Don't use this for big files.
7580 - Recovery will be impossible!
7581 A swapfile will only be present when |'updatecount'| is non-zero and
7582 'swapfile' is set.
7583 When 'swapfile' is reset, the swap file for the current buffer is
7584 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7585 non-zero, a swap file is immediately created.
7586 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007587 If you want to open a new buffer without creating a swap file for it,
7588 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007589 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590
7591 This option is used together with 'bufhidden' and 'buftype' to
7592 specify special kinds of buffers. See |special-buffers|.
7593
7594 *'swapsync'* *'sws'*
7595'swapsync' 'sws' string (default "fsync")
7596 global
7597 {not in Vi}
7598 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 When this option is empty parts of the swap file may be in memory and
7601 not written to disk. When the system crashes you may lose more work.
7602 On Unix the system does a sync now and then without Vim asking for it,
7603 so the disadvantage of setting this option off is small. On some
7604 systems the swap file will not be written at all. For a unix system
7605 setting it to "sync" will use the sync() call instead of the default
7606 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007607 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608
7609 *'switchbuf'* *'swb'*
7610'switchbuf' 'swb' string (default "")
7611 global
7612 {not in Vi}
7613 This option controls the behavior when switching between buffers.
7614 Possible values (comma separated list):
7615 useopen If included, jump to the first open window that
7616 contains the specified buffer (if there is one).
7617 Otherwise: Do not examine other windows.
7618 This setting is checked with |quickfix| commands, when
7619 jumping to errors (":cc", ":cn", "cp", etc.). It is
7620 also used in all buffer related split commands, for
7621 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007622 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007623 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007625 a buffer for a |quickfix| command that display errors.
7626 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007627 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007628 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007629 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007631 *'synmaxcol'* *'smc'*
7632'synmaxcol' 'smc' number (default 3000)
7633 local to buffer
7634 {not in Vi}
7635 {not available when compiled without the |+syntax|
7636 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007637 Maximum column in which to search for syntax items. In long lines the
7638 text after this column is not highlighted and following lines may not
7639 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007640 This helps to avoid very slow redrawing for an XML file that is one
7641 long line.
7642 Set to zero to remove the limit.
7643
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 *'syntax'* *'syn'*
7645'syntax' 'syn' string (default empty)
7646 local to buffer
7647 {not in Vi}
7648 {not available when compiled without the |+syntax|
7649 feature}
7650 When this option is set, the syntax with this name is loaded, unless
7651 syntax highlighting has been switched off with ":syntax off".
7652 Otherwise this option does not always reflect the current syntax (the
7653 b:current_syntax variable does).
7654 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007655 not automatically recognized. Example, in an IDL file:
7656 /* vim: set syntax=idl : */ ~
7657 When a dot appears in the value then this separates two filetype
7658 names. Example:
7659 /* vim: set syntax=c.doxygen : */ ~
7660 This will use the "c" syntax first, then the "doxygen" syntax.
7661 Note that the second one must be prepared to be loaded as an addition,
7662 otherwise it will be skipped. More than one dot may appear.
7663 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 :set syntax=OFF
7665< To switch syntax highlighting on according to the current value of the
7666 'filetype' option: >
7667 :set syntax=ON
7668< What actually happens when setting the 'syntax' option is that the
7669 Syntax autocommand event is triggered with the value as argument.
7670 This option is not copied to another buffer, independent of the 's' or
7671 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007672 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007674 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007675'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007676 global
7677 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007678 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007679 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007680 When nonempty, this option determines the content of the tab pages
7681 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007682 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007683
7684 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007685 option and only when there is no GUI tab line. When 'e' is in
7686 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007687 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007688
7689 The value is evaluated like with 'statusline'. You can use
7690 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007691 the text to be displayed. Use "%1T" for the first label, "%2T" for
7692 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007693
7694 Keep in mind that only one of the tab pages is the current one, others
7695 are invisible and you can't jump to their windows.
7696
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007697
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007698 *'tabpagemax'* *'tpm'*
7699'tabpagemax' 'tpm' number (default 10)
7700 global
7701 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007702 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007703 feature}
7704 Maximum number of tab pages to be opened by the |-p| command line
7705 argument or the ":tab all" command. |tabpage|
7706
7707
7708 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709'tabstop' 'ts' number (default 8)
7710 local to buffer
7711 Number of spaces that a <Tab> in the file counts for. Also see
7712 |:retab| command, and 'softtabstop' option.
7713
7714 Note: Setting 'tabstop' to any other value than 8 can make your file
7715 appear wrong in many places (e.g., when printing it).
7716
7717 There are four main ways to use tabs in Vim:
7718 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7719 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007720 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721 behave like a tab appears every 4 (or 3) characters.
7722 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7723 'expandtab'. This way you will always insert spaces. The
7724 formatting will never be messed up when 'tabstop' is changed.
7725 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007726 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 works when using Vim to edit the file.
7728 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7729 'noexpandtab'. This should then work (for initial indents only)
7730 for any tabstop setting that people use. It might be nice to have
7731 tabs after the first non-blank inserted as spaces if you do this
7732 though. Otherwise aligned comments will be wrong when 'tabstop' is
7733 changed.
7734
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007735 If Vim is compiled with the |+vartabs| feature then the value of
7736 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7737 than an empty string.
7738
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7740'tagbsearch' 'tbs' boolean (default on)
7741 global
7742 {not in Vi}
7743 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007744 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 searching makes searching for a tag a LOT faster, but a linear search
7746 will find more tags if the tags file wasn't properly sorted.
7747 Vim normally assumes that your tags files are sorted, or indicate that
7748 they are not sorted. Only when this is not the case does the
7749 'tagbsearch' option need to be switched off.
7750
7751 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007752 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 certain files, or retry all files with a linear search. When
7754 'tagbsearch' is off, only a linear search is done.
7755
7756 Linear searching is done anyway, for one file, when Vim finds a line
7757 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007758 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759< [The whitespace before and after the '0' must be a single <Tab>]
7760
7761 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007762 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 instead of a normal tag name, a retry is done with a linear search.
7764 Tags in unsorted tags files, and matches with different case will only
7765 be found in the retry.
7766
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007767 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007768 linear search can be avoided when case is ignored. Use a value of '2'
7769 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7770 sorted with the -f switch to "sort" in most unices, as in the command:
7771 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7772 (at least 5.5) the --sort=foldcase switch can be used for this as
7773 well. Note that case must be folded to uppercase for this to work.
7774
7775 By default, tag searches are case-sensitive. Case is ignored when
7776 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7777 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007778 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7779 'tagcase' is "smart", and the pattern contains only lowercase
7780 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781
7782 When 'tagbsearch' is off, tags searching is slower when a full match
7783 exists, but faster when no full match exists. Tags in unsorted tags
7784 files may only be found with 'tagbsearch' off.
7785 When the tags file is not sorted, or sorted in a wrong way (not on
7786 ASCII byte value), 'tagbsearch' should be off, or the line given above
7787 must be included in the tags file.
7788 This option doesn't affect commands that find all matching tags (e.g.,
7789 command-line completion and ":help").
7790 {Vi: always uses binary search in some versions}
7791
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007792 *'tagcase'* *'tc'*
7793'tagcase' 'tc' string (default "followic")
7794 global or local to buffer |global-local|
7795 {not in Vi}
7796 This option specifies how case is handled when searching the tags
7797 file:
7798 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007799 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007800 ignore Ignore case
7801 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007802 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007803 NOTE: This option is set to the Vi default value when 'compatible' is
7804 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007805
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 *'taglength'* *'tl'*
7807'taglength' 'tl' number (default 0)
7808 global
7809 If non-zero, tags are significant up to this number of characters.
7810
7811 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7812'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7813 global
7814 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007815 If on and using a tags file in another directory, file names in that
7816 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 NOTE: This option is set to the Vi default value when 'compatible' is
7818 set and to the Vim default value when 'compatible' is reset.
7819
7820 *'tags'* *'tag'* *E433*
7821'tags' 'tag' string (default "./tags,tags", when compiled with
7822 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7823 global or local to buffer |global-local|
7824 Filenames for the tag command, separated by spaces or commas. To
7825 include a space or comma in a file name, precede it with a backslash
7826 (see |option-backslash| about including spaces and backslashes).
7827 When a file name starts with "./", the '.' is replaced with the path
7828 of the current file. But only when the 'd' flag is not included in
7829 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7830 |tags-option|.
7831 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007832 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7833 find all files named "tags" below "/lib". The filename itself cannot
7834 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7835 files called "tags?". {not available when compiled without the
7836 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007837 The |tagfiles()| function can be used to get a list of the file names
7838 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7840 files are also supported. They are automatically recognized. The
7841 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7842 differences are ignored (MS-Windows). |emacs-tags|
7843 The use of |:set+=| and |:set-=| is preferred when adding or removing
7844 file names from the list. This avoids problems when a future version
7845 uses another default.
7846 {Vi: default is "tags /usr/lib/tags"}
7847
7848 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7849'tagstack' 'tgst' boolean (default on)
7850 global
7851 {not in all versions of Vi}
7852 When on, the |tagstack| is used normally. When off, a ":tag" or
7853 ":tselect" command with an argument will not push the tag onto the
7854 tagstack. A following ":tag" without an argument, a ":pop" command or
7855 any other command that uses the tagstack will use the unmodified
7856 tagstack, but does change the pointer to the active entry.
7857 Resetting this option is useful when using a ":tag" command in a
7858 mapping which should not change the tagstack.
7859
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007860 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007861'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007862 global
7863 {not in Vi}
7864 {only available when compiled with the |+tcl/dyn|
7865 feature}
7866 Specifies the name of the Tcl shared library. The default is
7867 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007868 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007869 This option cannot be set from a |modeline| or in the |sandbox|, for
7870 security reasons.
7871
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 *'term'* *E529* *E530* *E531*
7873'term' string (default is $TERM, if that fails:
7874 in the GUI: "builtin_gui"
7875 on Amiga: "amiga"
7876 on BeOS: "beos-ansi"
7877 on Mac: "mac-ansi"
7878 on MiNT: "vt52"
7879 on MS-DOS: "pcterm"
7880 on OS/2: "os2ansi"
7881 on Unix: "ansi"
7882 on VMS: "ansi"
7883 on Win 32: "win32")
7884 global
7885 Name of the terminal. Used for choosing the terminal control
7886 characters. Environment variables are expanded |:set_env|.
7887 For example: >
7888 :set term=$TERM
7889< See |termcap|.
7890
7891 *'termbidi'* *'tbidi'*
7892 *'notermbidi'* *'notbidi'*
7893'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7894 global
7895 {not in Vi}
7896 {only available when compiled with the |+arabic|
7897 feature}
7898 The terminal is in charge of Bi-directionality of text (as specified
7899 by Unicode). The terminal is also expected to do the required shaping
7900 that some languages (such as Arabic) require.
7901 Setting this option implies that 'rightleft' will not be set when
7902 'arabic' is set and the value of 'arabicshape' will be ignored.
7903 Note that setting 'termbidi' has the immediate effect that
7904 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7905 This option is reset when the GUI is started.
7906 For further details see |arabic.txt|.
7907
7908 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007909'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 Macintosh GUI: "macroman")
7911 global
7912 {only available when compiled with the |+multi_byte|
7913 feature}
7914 {not in Vi}
7915 Encoding used for the terminal. This specifies what character
7916 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007917 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007918 display). Except for the Mac when 'macatsui' is off, then
7919 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007921 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7923 Any attempts to set a different value will be rejected, and an error
7924 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007925 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 because the Win32 system always passes Unicode characters.
7927 When empty, the same encoding is used as for the 'encoding' option.
7928 This is the normal value.
7929 Not all combinations for 'termencoding' and 'encoding' are valid. See
7930 |encoding-table|.
7931 The value for this option must be supported by internal conversions or
7932 iconv(). When this is not possible no conversion will be done and you
7933 will probably experience problems with non-ASCII characters.
7934 Example: You are working with the locale set to euc-jp (Japanese) and
7935 want to edit a UTF-8 file: >
7936 :let &termencoding = &encoding
7937 :set encoding=utf-8
7938< You need to do this when your system has no locale support for UTF-8.
7939
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007940 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007941'termguicolors' 'tgc' boolean (default off)
7942 global
7943 {not in Vi}
7944 {not available when compiled without the
7945 |+termguicolors| feature}
7946 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007947 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007948
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007949 Requires a ISO-8613-3 compatible terminal. If setting this option
7950 does not work (produces a colorless UI) reading |xterm-true-color|
7951 might help.
7952
7953 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7954 is required. Use this check to find out: >
7955 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007956< This requires Vim to be built with the |+vtp| feature.
7957
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007958 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007959 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007960
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007961 *'termwinscroll'* *'twsl'*
7962'termwinscroll' 'twsl' number (default 10000)
7963 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02007964 {not in Vi}
7965 {not available when compiled without the
7966 |+terminal| feature}
7967 Number of scrollback lines to keep. When going over this limit the
7968 first 10% of the scrollback lines are deleted. This is just to reduce
7969 the memory usage. See |Terminal-Normal|.
7970
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007971 *'termwinkey'* *'twk'*
7972'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007973 local to window
7974 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007975 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007976 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007977 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007978 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007979< The string must be one key stroke but can be multiple bytes.
7980 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007981 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007982 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007983
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007984 *'termwinsize'* *'tws'*
7985'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007986 local to window
7987 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02007988 Size of the |terminal| window. Format: {rows}x{columns} or
7989 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007990 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007991 - When set with a "x" (e.g., "24x80") the terminal size is not
7992 adjusted to the window size. If the window is smaller only the
7993 top-left part is displayed.
7994 - When set with a "*" (e.g., "10*50") the terminal size follows the
7995 window size, but will not be smaller than the specified rows and/or
7996 columns.
7997 - When rows is zero then use the height of the window.
7998 - When columns is zero then use the width of the window.
7999 - Using "0x0" or "0*0" is the same as empty.
8000
8001 Examples:
8002 "30x0" uses 30 rows and the current window width.
8003 "20*0" uses at least 20 rows and the current window width.
8004 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008005 Note that the command running in the terminal window may still change
8006 the size of the terminal. In that case the Vim window will be
8007 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008008
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 *'terse'* *'noterse'*
8010'terse' boolean (default off)
8011 global
8012 When set: Add 's' flag to 'shortmess' option (this makes the message
8013 for a search that hits the start or end of the file not being
8014 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8015 shortens a lot of messages}
8016
8017 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8018'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8019 global
8020 {not in Vi}
8021 This option is obsolete. Use 'fileformats'.
8022 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8023 set to the default value for the current system. When 'textauto' is
8024 reset, 'fileformats' is made empty.
8025 NOTE: This option is set to the Vi default value when 'compatible' is
8026 set and to the Vim default value when 'compatible' is reset.
8027
8028 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8029'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8030 others: default off)
8031 local to buffer
8032 {not in Vi}
8033 This option is obsolete. Use 'fileformat'.
8034 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8035 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8036 "unix".
8037
8038 *'textwidth'* *'tw'*
8039'textwidth' 'tw' number (default 0)
8040 local to buffer
8041 {not in Vi}
8042 Maximum width of text that is being inserted. A longer line will be
8043 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008044 this.
8045 'textwidth' is set to 0 when the 'paste' option is set and restored
8046 when 'paste' is reset.
8047 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008049 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 NOTE: This option is set to 0 when 'compatible' is set.
8051
8052 *'thesaurus'* *'tsr'*
8053'thesaurus' 'tsr' string (default "")
8054 global or local to buffer |global-local|
8055 {not in Vi}
8056 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008057 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 the file should contain words with similar meaning, separated by
8059 non-keyword characters (white space is preferred). Maximum line
8060 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008061 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008062 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008063 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008064 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 after a comma are ignored, otherwise spaces are included in the file
8066 name. See |option-backslash| about using backslashes.
8067 The use of |:set+=| and |:set-=| is preferred when adding or removing
8068 directories from the list. This avoids problems when a future version
8069 uses another default.
8070 Backticks cannot be used in this option for security reasons.
8071
8072 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8073'tildeop' 'top' boolean (default off)
8074 global
8075 {not in Vi}
8076 When on: The tilde command "~" behaves like an operator.
8077 NOTE: This option is reset when 'compatible' is set.
8078
8079 *'timeout'* *'to'* *'notimeout'* *'noto'*
8080'timeout' 'to' boolean (default on)
8081 global
8082 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008083'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 global
8085 {not in Vi}
8086 These two options together determine the behavior when part of a
8087 mapped key sequence or keyboard code has been received:
8088
8089 'timeout' 'ttimeout' action ~
8090 off off do not time out
8091 on on or off time out on :mappings and key codes
8092 off on time out on key codes
8093
8094 If both options are off, Vim will wait until either the complete
8095 mapping or key sequence has been received, or it is clear that there
8096 is no mapping or key sequence for the received characters. For
8097 example: if you have mapped "vl" and Vim has received 'v', the next
8098 character is needed to see if the 'v' is followed by an 'l'.
8099 When one of the options is on, Vim will wait for about 1 second for
8100 the next character to arrive. After that the already received
8101 characters are interpreted as single characters. The waiting time can
8102 be changed with the 'timeoutlen' option.
8103 On slow terminals or very busy systems timing out may cause
8104 malfunctioning cursor keys. If both options are off, Vim waits
8105 forever after an entered <Esc> if there are key codes that start
8106 with <Esc>. You will have to type <Esc> twice. If you do not have
8107 problems with key codes, but would like to have :mapped key
8108 sequences not timing out in 1 second, set the 'ttimeout' option and
8109 reset the 'timeout' option.
8110
8111 NOTE: 'ttimeout' is reset when 'compatible' is set.
8112
8113 *'timeoutlen'* *'tm'*
8114'timeoutlen' 'tm' number (default 1000)
8115 global
8116 {not in all versions of Vi}
8117 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008118'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119 global
8120 {not in Vi}
8121 The time in milliseconds that is waited for a key code or mapped key
8122 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8123 when part of a command has been typed.
8124 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8125 different timeout value for key codes is desired set 'ttimeoutlen' to
8126 a non-negative number.
8127
8128 ttimeoutlen mapping delay key code delay ~
8129 < 0 'timeoutlen' 'timeoutlen'
8130 >= 0 'timeoutlen' 'ttimeoutlen'
8131
8132 The timeout only happens when the 'timeout' and 'ttimeout' options
8133 tell so. A useful setting would be >
8134 :set timeout timeoutlen=3000 ttimeoutlen=100
8135< (time out on mapping after three seconds, time out on key codes after
8136 a tenth of a second).
8137
8138 *'title'* *'notitle'*
8139'title' boolean (default off, on when title can be restored)
8140 global
8141 {not in Vi}
8142 {not available when compiled without the |+title|
8143 feature}
8144 When on, the title of the window will be set to the value of
8145 'titlestring' (if it is not empty), or to:
8146 filename [+=-] (path) - VIM
8147 Where:
8148 filename the name of the file being edited
8149 - indicates the file cannot be modified, 'ma' off
8150 + indicates the file was modified
8151 = indicates the file is read-only
8152 =+ indicates the file is read-only and modified
8153 (path) is the path of the file being edited
8154 - VIM the server name |v:servername| or "VIM"
8155 Only works if the terminal supports setting window titles
8156 (currently Amiga console, Win32 console, all GUI versions and
8157 terminals with a non- empty 't_ts' option - these are Unix xterm and
8158 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8159 *X11*
8160 When Vim was compiled with HAVE_X11 defined, the original title will
8161 be restored if possible. The output of ":version" will include "+X11"
8162 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8163 works for the icon name |'icon'|.
8164 But: When Vim was started with the |-X| argument, restoring the title
8165 will not work (except in the GUI).
8166 If the title cannot be restored, it is set to the value of 'titleold'.
8167 You might want to restore the title outside of Vim then.
8168 When using an xterm from a remote machine you can use this command:
8169 rsh machine_name xterm -display $DISPLAY &
8170 then the WINDOWID environment variable should be inherited and the
8171 title of the window should change back to what it should be after
8172 exiting Vim.
8173
8174 *'titlelen'*
8175'titlelen' number (default 85)
8176 global
8177 {not in Vi}
8178 {not available when compiled without the |+title|
8179 feature}
8180 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008181 title. When the title is longer, only the end of the path name is
8182 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 Using a percentage makes this adapt to the width of the window. But
8184 it won't work perfectly, because the actual number of characters
8185 available also depends on the font used and other things in the title
8186 bar. When 'titlelen' is zero the full path is used. Otherwise,
8187 values from 1 to 30000 percent can be used.
8188 'titlelen' is also used for the 'titlestring' option.
8189
8190 *'titleold'*
8191'titleold' string (default "Thanks for flying Vim")
8192 global
8193 {not in Vi}
8194 {only available when compiled with the |+title|
8195 feature}
8196 This option will be used for the window title when exiting Vim if the
8197 original title cannot be restored. Only happens if 'title' is on or
8198 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008199 This option cannot be set from a |modeline| or in the |sandbox|, for
8200 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 *'titlestring'*
8202'titlestring' string (default "")
8203 global
8204 {not in Vi}
8205 {not available when compiled without the |+title|
8206 feature}
8207 When this option is not empty, it will be used for the title of the
8208 window. This happens only when the 'title' option is on.
8209 Only works if the terminal supports setting window titles (currently
8210 Amiga console, Win32 console, all GUI versions and terminals with a
8211 non-empty 't_ts' option).
8212 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008213 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 When this option contains printf-style '%' items, they will be
8215 expanded according to the rules used for 'statusline'.
8216 Example: >
8217 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8218 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8219< The value of 'titlelen' is used to align items in the middle or right
8220 of the available space.
8221 Some people prefer to have the file name first: >
8222 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8223< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008224 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 separating space only when needed.
8226 NOTE: Use of special characters in 'titlestring' may cause the display
8227 to be garbled (e.g., when it contains a CR or NL character).
8228 {not available when compiled without the |+statusline| feature}
8229
8230 *'toolbar'* *'tb'*
8231'toolbar' 'tb' string (default "icons,tooltips")
8232 global
8233 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8234 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008235 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 possible values are:
8237 icons Toolbar buttons are shown with icons.
8238 text Toolbar buttons shown with text.
8239 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008240 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 tooltips Tooltips are active for toolbar buttons.
8242 Tooltips refer to the popup help text which appears after the mouse
8243 cursor is placed over a toolbar button for a brief moment.
8244
8245 If you want the toolbar to be shown with icons as well as text, do the
8246 following: >
8247 :set tb=icons,text
8248< Motif and Athena cannot display icons and text at the same time. They
8249 will show icons if both are requested.
8250
8251 If none of the strings specified in 'toolbar' are valid or if
8252 'toolbar' is empty, this option is ignored. If you want to disable
8253 the toolbar, you need to set the 'guioptions' option. For example: >
8254 :set guioptions-=T
8255< Also see |gui-toolbar|.
8256
8257 *'toolbariconsize'* *'tbis'*
8258'toolbariconsize' 'tbis' string (default "small")
8259 global
8260 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008261 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008263 tiny Use tiny icons.
8264 small Use small icons (default).
8265 medium Use medium-sized icons.
8266 large Use large icons.
8267 huge Use even larger icons.
8268 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008270 the current theme. Common dimensions are giant=48x48, huge=32x32,
8271 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272
8273 If 'toolbariconsize' is empty, the global default size as determined
8274 by user preferences or the current theme is used.
8275
8276 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8277'ttybuiltin' 'tbi' boolean (default on)
8278 global
8279 {not in Vi}
8280 When on, the builtin termcaps are searched before the external ones.
8281 When off the builtin termcaps are searched after the external ones.
8282 When this option is changed, you should set the 'term' option next for
8283 the change to take effect, for example: >
8284 :set notbi term=$TERM
8285< See also |termcap|.
8286 Rationale: The default for this option is "on", because the builtin
8287 termcap entries are generally better (many systems contain faulty
8288 xterm entries...).
8289
8290 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8291'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8292 sun-cmd, screen, rxvt, dtterm or
8293 iris-ansi; also on when running Vim in
8294 a DOS console)
8295 global
8296 {not in Vi}
8297 Indicates a fast terminal connection. More characters will be sent to
8298 the screen for redrawing, instead of using insert/delete line
8299 commands. Improves smoothness of redrawing when there are multiple
8300 windows and the terminal does not support a scrolling region.
8301 Also enables the extra writing of characters at the end of each screen
8302 line for lines that wrap. This helps when using copy/paste with the
8303 mouse in an xterm and other terminals.
8304
8305 *'ttymouse'* *'ttym'*
8306'ttymouse' 'ttym' string (default depends on 'term')
8307 global
8308 {not in Vi}
8309 {only in Unix and VMS, doesn't work in the GUI; not
8310 available when compiled without |+mouse|}
8311 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008312 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 *xterm-mouse*
8314 xterm xterm-like mouse handling. The mouse generates
8315 "<Esc>[Mscr", where "scr" is three bytes:
8316 "s" = button state
8317 "c" = column plus 33
8318 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008319 This only works up to 223 columns! See "dec",
8320 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 xterm2 Works like "xterm", but with the xterm reporting the
8322 mouse position while the mouse is dragged. This works
8323 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008324 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 work. See below for how Vim detects this
8326 automatically.
8327 *netterm-mouse*
8328 netterm NetTerm mouse handling. The mouse generates
8329 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8330 for the row and column.
8331 *dec-mouse*
8332 dec DEC terminal mouse handling. The mouse generates a
8333 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008334 This is also available for an Xterm, if it was
8335 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 *jsbterm-mouse*
8337 jsbterm JSB term mouse handling.
8338 *pterm-mouse*
8339 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008340 *urxvt-mouse*
8341 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008342 The mouse works only if the terminal supports this
8343 encoding style, but it does not have 223 columns limit
8344 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008345 *sgr-mouse*
8346 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008347 mouse reporting. The mouse works even in columns
8348 beyond 223. This option is backward compatible with
8349 "xterm2" because it can also decode "xterm2" style
8350 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351
8352 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008353 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8354 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8356 recognized, if enabled at compile time. DEC terminal mouse codes
8357 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008358 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8359 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008361 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8362 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8363 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008364 Additionally, if vim is compiled with the |+termresponse| feature and
8365 |t_RV| is set to the escape sequence to request the xterm version
8366 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008368 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008369 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008370 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8371 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 :set t_RV=
8373<
8374 *'ttyscroll'* *'tsl'*
8375'ttyscroll' 'tsl' number (default 999)
8376 global
8377 Maximum number of lines to scroll the screen. If there are more lines
8378 to scroll the window is redrawn. For terminals where scrolling is
8379 very slow and redrawing is not slow this can be set to a small number,
8380 e.g., 3, to speed up displaying.
8381
8382 *'ttytype'* *'tty'*
8383'ttytype' 'tty' string (default from $TERM)
8384 global
8385 Alias for 'term', see above.
8386
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008387 *'undodir'* *'udir'*
8388'undodir' 'udir' string (default ".")
8389 global
8390 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008391 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008392 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008393 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008394 "." means using the directory of the file. The undo file name for
8395 "file.txt" is ".file.txt.un~".
8396 For other directories the file name is the full path of the edited
8397 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008398 When writing: The first directory that exists is used. "." always
8399 works, no directories after "." will be used for writing.
8400 When reading all entries are tried to find an undo file. The first
8401 undo file that exists is used. When it cannot be read an error is
8402 given, no further entry is used.
8403 See |undo-persistence|.
8404
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008405 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008406'undofile' 'udf' boolean (default off)
8407 local to buffer
8408 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008409 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008410 When on, Vim automatically saves undo history to an undo file when
8411 writing a buffer to a file, and restores undo history from the same
8412 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008413 The directory where the undo file is stored is specified by 'undodir'.
8414 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008415 The undo file is not read when 'undoreload' causes the buffer from
8416 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008417 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008418 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008419
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420 *'undolevels'* *'ul'*
8421'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8422 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008423 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424 {not in Vi}
8425 Maximum number of changes that can be undone. Since undo information
8426 is kept in memory, higher numbers will cause more memory to be used
8427 (nevertheless, a single change can use an unlimited amount of memory).
8428 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8429 itself: >
8430 set ul=0
8431< But you can also get Vi compatibility by including the 'u' flag in
8432 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008433 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008434 Set to -1 for no undo at all. You might want to do this only for the
8435 current buffer: >
8436 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008438
8439 The local value is set to -123456 when the global value is to be used.
8440
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008441 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008443 *'undoreload'* *'ur'*
8444'undoreload' 'ur' number (default 10000)
8445 global
8446 {not in Vi}
8447 Save the whole buffer for undo when reloading it. This applies to the
8448 ":e!" command and reloading for when the buffer changed outside of
8449 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008450 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008451 of lines is smaller than the value of this option.
8452 Set this option to zero to disable undo for a reload.
8453
8454 When saving undo for a reload, any undo file is not read.
8455
8456 Note that this causes the whole buffer to be stored in memory. Set
8457 this option to a lower value if you run out of memory.
8458
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 *'updatecount'* *'uc'*
8460'updatecount' 'uc' number (default: 200)
8461 global
8462 {not in Vi}
8463 After typing this many characters the swap file will be written to
8464 disk. When zero, no swap file will be created at all (see chapter on
8465 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8466 Vim with the "-n" option, see |startup|. When editing in readonly
8467 mode this option will be initialized to 10000.
8468 The swapfile can be disabled per buffer with |'swapfile'|.
8469 When 'updatecount' is set from zero to non-zero, swap files are
8470 created for all buffers that have 'swapfile' set. When 'updatecount'
8471 is set to zero, existing swap files are not deleted.
8472 Also see |'swapsync'|.
8473 This option has no meaning in buffers where |'buftype'| is "nofile"
8474 or "nowrite".
8475
8476 *'updatetime'* *'ut'*
8477'updatetime' 'ut' number (default 4000)
8478 global
8479 {not in Vi}
8480 If this many milliseconds nothing is typed the swap file will be
8481 written to disk (see |crash-recovery|). Also used for the
8482 |CursorHold| autocommand event.
8483
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008484 *'varsofttabstop'* *'vsts'*
8485'varsofttabstop' 'vsts' string (default "")
8486 local to buffer
8487 {only available when compiled with the |+vartabs|
8488 feature}
8489 {not in Vi}
8490 A list of the number of spaces that a <Tab> counts for while editing,
8491 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8492 width <Tab>s are being inserted, while in fact a mixture of spaces
8493 and <Tab>s is used. Tab widths are separated with commas, with the
8494 final value applying to all subsequent tabs.
8495
8496 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008497 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008498 to use the following: >
8499 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008500< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8501 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008502
8503 Note that the value of |'softtabstop'| will be ignored while
8504 'varsofttabstop' is set.
8505
8506 *'vartabstop'* *'vts'*
8507'vartabstop' 'vts' string (default "")
8508 local to buffer
8509 {only available when compiled with the |+vartabs|
8510 feature}
8511 {not in Vi}
8512 A list of the number of spaces that a <Tab> in the file counts for,
8513 separated by commas. Each value corresponds to one tab, with the
8514 final value applying to all subsequent tabs. For example: >
8515 :set vartabstop=4,20,10,8
8516< This will make the first tab 4 spaces wide, the second 20 spaces,
8517 the third 10 spaces, and all following tabs 8 spaces.
8518
8519 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8520 is set.
8521
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 *'verbose'* *'vbs'*
8523'verbose' 'vbs' number (default 0)
8524 global
8525 {not in Vi, although some versions have a boolean
8526 verbose option}
8527 When bigger than zero, Vim will give messages about what it is doing.
8528 Currently, these messages are given:
8529 >= 1 When the viminfo file is read or written.
8530 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008531 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 >= 8 Files for which a group of autocommands is executed.
8533 >= 9 Every executed autocommand.
8534 >= 12 Every executed function.
8535 >= 13 When an exception is thrown, caught, finished, or discarded.
8536 >= 14 Anything pending in a ":finally" clause.
8537 >= 15 Every executed Ex command (truncated at 200 characters).
8538
8539 This option can also be set with the "-V" argument. See |-V|.
8540 This option is also set by the |:verbose| command.
8541
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008542 When the 'verbosefile' option is set then the verbose messages are not
8543 displayed.
8544
8545 *'verbosefile'* *'vfile'*
8546'verbosefile' 'vfile' string (default empty)
8547 global
8548 {not in Vi}
8549 When not empty all messages are written in a file with this name.
8550 When the file exists messages are appended.
8551 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008552 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008553 Setting 'verbosefile' to a new value is like making it empty first.
8554 The difference with |:redir| is that verbose messages are not
8555 displayed when 'verbosefile' is set.
8556
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 *'viewdir'* *'vdir'*
8558'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8559 "$VIM/vimfiles/view",
8560 for Unix: "~/.vim/view",
8561 for Macintosh: "$VIM:vimfiles:view"
8562 for VMS: "sys$login:vimfiles/view"
8563 for RiscOS: "Choices:vimfiles/view")
8564 global
8565 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008566 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 feature}
8568 Name of the directory where to store files for |:mkview|.
8569 This option cannot be set from a |modeline| or in the |sandbox|, for
8570 security reasons.
8571
8572 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008573'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 global
8575 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008576 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 feature}
8578 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008579 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 word save and restore ~
8581 cursor cursor position in file and in window
8582 folds manually created folds, opened/closed folds and local
8583 fold options
8584 options options and mappings local to a window or buffer (not
8585 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008586 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 slash backslashes in file names replaced with forward
8588 slashes
8589 unix with Unix end-of-line format (single <NL>), even when
8590 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008591 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592
8593 "slash" and "unix" are useful on Windows when sharing view files
8594 with Unix. The Unix version of Vim cannot source dos format scripts,
8595 but the Windows version of Vim can source unix format scripts.
8596
8597 *'viminfo'* *'vi'* *E526* *E527* *E528*
8598'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008599 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8600 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8601 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 global
8603 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008604 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 feature}
8606 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008607 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8608 "NONE".
8609 The string should be a comma separated list of parameters, each
8610 consisting of a single character identifying the particular parameter,
8611 followed by a number or string which specifies the value of that
8612 parameter. If a particular character is left out, then the default
8613 value is used for that parameter. The following is a list of the
8614 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008616 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 ! When included, save and restore global variables that start
8618 with an uppercase letter, and don't contain a lowercase
8619 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008620 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008621 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008622 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008623 " Maximum number of lines saved for each register. Old name of
8624 the '<' item, with the disadvantage that you need to put a
8625 backslash before the ", otherwise it will be recognized as the
8626 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008627 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 % When included, save and restore the buffer list. If Vim is
8629 started with a file name argument, the buffer list is not
8630 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008631 buffer list is restored from the viminfo file. Quickfix
8632 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8633 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008634 When followed by a number, the number specifies the maximum
8635 number of buffers that are stored. Without a number all
8636 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008637 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 ' Maximum number of previously edited files for which the marks
8639 are remembered. This parameter must always be included when
8640 'viminfo' is non-empty.
8641 Including this item also means that the |jumplist| and the
8642 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008643 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008645 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 patterns are also saved. When not included, the value of
8647 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008648 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008650 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008651 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 < Maximum number of lines saved for each register. If zero then
8653 registers are not saved. When not included, all lines are
8654 saved. '"' is the old name for this item.
8655 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008656 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008658 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008659 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 c When included, convert the text in the viminfo file from the
8661 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008662 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008663 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 f Whether file marks need to be stored. If zero, file marks ('0
8665 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008666 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008668 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 h Disable the effect of 'hlsearch' when loading the viminfo
8670 file. When not included, it depends on whether ":nohlsearch"
8671 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008672 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008674 the 'n'. Must be at the end of the option! If the
8675 'viminfofile' option is set, that file name overrides the one
8676 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008677 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008678 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 r Removable media. The argument is a string (up to the next
8680 ','). This parameter can be given several times. Each
8681 specifies the start of a path for which no marks will be
8682 stored. This is to avoid removable media. For MS-DOS you
8683 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8684 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8685 ignored. Maximum length of each 'r' argument is 50
8686 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008687 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 s Maximum size of an item in Kbyte. If zero then registers are
8689 not saved. Currently only applies to registers. The default
8690 "s10" will exclude registers with more than 10 Kbyte of text.
8691 Also see the '<' item above: line count limit.
8692
8693 Example: >
8694 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8695<
8696 '50 Marks will be remembered for the last 50 files you
8697 edited.
8698 <1000 Contents of registers (up to 1000 lines each) will be
8699 remembered.
8700 s100 Registers with more than 100 Kbyte text are skipped.
8701 :0 Command-line history will not be saved.
8702 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8703 no / Since '/' is not specified, the default will be used,
8704 that is, save all of the search history, and also the
8705 previous search and substitute patterns.
8706 no % The buffer list will not be saved nor read back.
8707 no h 'hlsearch' highlighting will be restored.
8708
8709 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8710 load the contents of the file, this is not done automatically.
8711
8712 This option cannot be set from a |modeline| or in the |sandbox|, for
8713 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008714 NOTE: This option is set to the Vim default value when 'compatible'
8715 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008717 *'viminfofile'* *'vif'*
8718'viminfofile' 'vif' string (default: "")
8719 global
8720 {not in Vi}
8721 {not available when compiled without the |+viminfo|
8722 feature}
8723 When non-empty, overrides the file name used for viminfo.
8724 When equal to "NONE" no viminfo file will be read or written.
8725 This option can be set with the |-i| command line flag. The |--clean|
8726 command line flag sets it to "NONE".
8727
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728 *'virtualedit'* *'ve'*
8729'virtualedit' 've' string (default "")
8730 global
8731 {not in Vi}
8732 {not available when compiled without the
8733 |+virtualedit| feature}
8734 A comma separated list of these words:
8735 block Allow virtual editing in Visual block mode.
8736 insert Allow virtual editing in Insert mode.
8737 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008738 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008739
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008741 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 of the line. Useful for selecting a rectangle in Visual mode and
8743 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008744 "onemore" is not the same, it will only allow moving the cursor just
8745 after the last character of the line. This makes some commands more
8746 consistent. Previously the cursor was always past the end of the line
8747 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008748 break some plugins or Vim scripts. For example because |l| can move
8749 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008750 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008751 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008752 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008753 It doesn't make sense to combine "all" with "onemore", but you will
8754 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008755 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756
8757 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8758'visualbell' 'vb' boolean (default off)
8759 global
8760 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008761 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008762 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008763 use: >
8764 :set vb t_vb=
8765< If you want a short flash, you can use this on many terminals: >
8766 :set vb t_vb=[?5h$<100>[?5l
8767< Here $<100> specifies the time, you can use a smaller or bigger value
8768 to get a shorter or longer flash.
8769
8770 Note: Vim will limit the bell to once per half a second. This avoids
8771 having to wait for the flashing to finish when there are lots of
8772 bells, e.g. on key repeat. This also happens without 'visualbell'
8773 set.
8774
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8776 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8777 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008778
8779 Note: When the GUI starts, 't_vb' is reset to its default value. You
8780 might want to set it again in your |gvimrc|.
8781
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 Does not work on the Amiga, you always get a screen flash.
8783 Also see 'errorbells'.
8784
8785 *'warn'* *'nowarn'*
8786'warn' boolean (default on)
8787 global
8788 Give a warning message when a shell command is used while the buffer
8789 has been changed.
8790
8791 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8792'weirdinvert' 'wiv' boolean (default off)
8793 global
8794 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008795 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 It is provided for backwards compatibility with version 4.x.
8797 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8798 vice versa. Has no effect when the GUI is running.
8799
8800 *'whichwrap'* *'ww'*
8801'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8802 global
8803 {not in Vi}
8804 Allow specified keys that move the cursor left/right to move to the
8805 previous/next line when the cursor is on the first/last character in
8806 the line. Concatenate characters to allow this for these keys:
8807 char key mode ~
8808 b <BS> Normal and Visual
8809 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008810 h "h" Normal and Visual (not recommended)
8811 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 < <Left> Normal and Visual
8813 > <Right> Normal and Visual
8814 ~ "~" Normal
8815 [ <Left> Insert and Replace
8816 ] <Right> Insert and Replace
8817 For example: >
8818 :set ww=<,>,[,]
8819< allows wrap only when cursor keys are used.
8820 When the movement keys are used in combination with a delete or change
8821 operator, the <EOL> also counts for a character. This makes "3h"
8822 different from "3dh" when the cursor crosses the end of a line. This
8823 is also true for "x" and "X", because they do the same as "dl" and
8824 "dh". If you use this, you may also want to use the mapping
8825 ":map <BS> X" to make backspace delete the character in front of the
8826 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008827 When 'l' is included and it is used after an operator at the end of a
8828 line then it will not move to the next line. This makes "dl", "cl",
8829 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830 NOTE: This option is set to the Vi default value when 'compatible' is
8831 set and to the Vim default value when 'compatible' is reset.
8832
8833 *'wildchar'* *'wc'*
8834'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8835 global
8836 {not in Vi}
8837 Character you have to type to start wildcard expansion in the
8838 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008839 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 The character is not recognized when used inside a macro. See
8841 'wildcharm' for that.
8842 Although 'wc' is a number option, you can set it to a special key: >
8843 :set wc=<Esc>
8844< NOTE: This option is set to the Vi default value when 'compatible' is
8845 set and to the Vim default value when 'compatible' is reset.
8846
8847 *'wildcharm'* *'wcm'*
8848'wildcharm' 'wcm' number (default: none (0))
8849 global
8850 {not in Vi}
8851 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008852 recognized when used inside a macro. You can find "spare" command-line
8853 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 you'll never actually type 'wildcharm', just use it in mappings that
8855 automatically invoke completion mode, e.g.: >
8856 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008857 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008858< Then after typing :ss you can use CTRL-P & CTRL-N.
8859
8860 *'wildignore'* *'wig'*
8861'wildignore' 'wig' string (default "")
8862 global
8863 {not in Vi}
8864 {not available when compiled without the |+wildignore|
8865 feature}
8866 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008867 patterns is ignored when expanding |wildcards|, completing file or
8868 directory names, and influences the result of |expand()|, |glob()| and
8869 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8871 Also see 'suffixes'.
8872 Example: >
8873 :set wildignore=*.o,*.obj
8874< The use of |:set+=| and |:set-=| is preferred when adding or removing
8875 a pattern from the list. This avoids problems when a future version
8876 uses another default.
8877
Bram Moolenaar94950a92010-12-02 16:01:29 +01008878
Bram Moolenaar81af9252010-12-10 20:35:50 +01008879 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008880'wildignorecase' 'wic' boolean (default off)
8881 global
8882 {not in Vi}
8883 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008884 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008885 Does not apply when the shell is used to expand wildcards, which
8886 happens when there are special characters.
8887
8888
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008890'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 global
8892 {not in Vi}
8893 {not available if compiled without the |+wildmenu|
8894 feature}
8895 When 'wildmenu' is on, command-line completion operates in an enhanced
8896 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8897 the possible matches are shown just above the command line, with the
8898 first match highlighted (overwriting the status line, if there is
8899 one). Keys that show the previous/next match, such as <Tab> or
8900 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8901 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8902 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008903 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 If there are more matches than can fit in the line, a ">" is shown on
8905 the right and/or a "<" is shown on the left. The status line scrolls
8906 as needed.
8907 The "wildmenu" mode is abandoned when a key is hit that is not used
8908 for selecting a completion.
8909 While the "wildmenu" is active the following keys have special
8910 meanings:
8911
8912 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8913 <Down> - in filename/menu name completion: move into a
8914 subdirectory or submenu.
8915 <CR> - in menu completion, when the cursor is just after a
8916 dot: move into a submenu.
8917 <Up> - in filename/menu name completion: move up into
8918 parent directory or parent menu.
8919
8920 This makes the menus accessible from the console |console-menus|.
8921
8922 If you prefer the <Left> and <Right> keys to move the cursor instead
8923 of selecting a different match, use this: >
8924 :cnoremap <Left> <Space><BS><Left>
8925 :cnoremap <Right> <Space><BS><Right>
8926<
8927 The "WildMenu" highlighting is used for displaying the current match
8928 |hl-WildMenu|.
8929
8930 *'wildmode'* *'wim'*
8931'wildmode' 'wim' string (Vim default: "full")
8932 global
8933 {not in Vi}
8934 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008935 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008936 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008937 first part specifies the behavior for the first use of 'wildchar',
8938 The second part for the second use, etc.
8939 These are the possible values for each part:
8940 "" Complete only the first match.
8941 "full" Complete the next full match. After the last match,
8942 the original string is used and then the first match
8943 again.
8944 "longest" Complete till longest common string. If this doesn't
8945 result in a longer string, use the next part.
8946 "longest:full" Like "longest", but also start 'wildmenu' if it is
8947 enabled.
8948 "list" When more than one match, list all matches.
8949 "list:full" When more than one match, list all matches and
8950 complete first match.
8951 "list:longest" When more than one match, list all matches and
8952 complete till longest common string.
8953 When there is only a single match, it is fully completed in all cases.
8954
8955 Examples: >
8956 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008957< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008958 :set wildmode=longest,full
8959< Complete longest common string, then each full match >
8960 :set wildmode=list:full
8961< List all matches and complete each full match >
8962 :set wildmode=list,full
8963< List all matches without completing, then each full match >
8964 :set wildmode=longest,list
8965< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008966 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008967
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008968 *'wildoptions'* *'wop'*
8969'wildoptions' 'wop' string (default "")
8970 global
8971 {not in Vi}
8972 {not available when compiled without the |+wildignore|
8973 feature}
8974 A list of words that change how command line completion is done.
8975 Currently only one word is allowed:
8976 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008977 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008978 is displayed per line. Often used tag kinds are:
8979 d #define
8980 f function
8981 Also see |cmdline-completion|.
8982
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 *'winaltkeys'* *'wak'*
8984'winaltkeys' 'wak' string (default "menu")
8985 global
8986 {not in Vi}
8987 {only used in Win32, Motif, GTK and Photon GUI}
8988 Some GUI versions allow the access to menu entries by using the ALT
8989 key in combination with a character that appears underlined in the
8990 menu. This conflicts with the use of the ALT key for mappings and
8991 entering special characters. This option tells what to do:
8992 no Don't use ALT keys for menus. ALT key combinations can be
8993 mapped, but there is no automatic handling. This can then be
8994 done with the |:simalt| command.
8995 yes ALT key handling is done by the windowing system. ALT key
8996 combinations cannot be mapped.
8997 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008998 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 keys can be mapped.
9000 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9001 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009002 This option is not used for <F10>; on Win32 and with GTK <F10> will
9003 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009004
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009005 *'window'* *'wi'*
9006'window' 'wi' number (default screen height - 1)
9007 global
9008 Window height. Do not confuse this with the height of the Vim window,
9009 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009010 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9011 value is smaller than 'lines' minus one. The screen will scroll
9012 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009013 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9014 in a much smarter way, taking care of wrapping lines.
9015 When resizing the Vim window, the value is smaller than 1 or more than
9016 or equal to 'lines' it will be set to 'lines' minus 1.
9017 {Vi also uses the option to specify the number of displayed lines}
9018
Bram Moolenaar071d4272004-06-13 20:20:40 +00009019 *'winheight'* *'wh'* *E591*
9020'winheight' 'wh' number (default 1)
9021 global
9022 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009023 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009024 feature}
9025 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009026 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009027 focus goes to a window that is smaller, its size is increased, at the
9028 cost of the height of other windows.
9029 Set 'winheight' to a small number for normal editing.
9030 Set it to 999 to make the current window fill most of the screen.
9031 Other windows will be only 'winminheight' high. This has the drawback
9032 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9033 to create only two windows, set the option after startup is done,
9034 using the |VimEnter| event: >
9035 au VimEnter * set winheight=999
9036< Minimum value is 1.
9037 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009038 height of the current window.
9039 'winheight' applies to the current window. Use 'winminheight' to set
9040 the minimal height for other windows.
9041
9042 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9043'winfixheight' 'wfh' boolean (default off)
9044 local to window
9045 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009046 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009047 feature}
9048 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009049 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9050 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 The height may be changed anyway when running out of room.
9052
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009053 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9054'winfixwidth' 'wfw' boolean (default off)
9055 local to window
9056 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009057 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009058 feature}
9059 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009060 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009061 The width may be changed anyway when running out of room.
9062
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 *'winminheight'* *'wmh'*
9064'winminheight' 'wmh' number (default 1)
9065 global
9066 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009067 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009068 feature}
9069 The minimal height of a window, when it's not the current window.
9070 This is a hard minimum, windows will never become smaller.
9071 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9072 status bar) if necessary. They will return to at least one line when
9073 they become active (since the cursor has to have somewhere to go.)
9074 Use 'winheight' to set the minimal height of the current window.
9075 This option is only checked when making a window smaller. Don't use a
9076 large number, it will cause errors when opening more than a few
9077 windows. A value of 0 to 3 is reasonable.
9078
9079 *'winminwidth'* *'wmw'*
9080'winminwidth' 'wmw' number (default 1)
9081 global
9082 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009083 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 feature}
9085 The minimal width of a window, when it's not the current window.
9086 This is a hard minimum, windows will never become smaller.
9087 When set to zero, windows may be "squashed" to zero columns (i.e. just
9088 a vertical separator) if necessary. They will return to at least one
9089 line when they become active (since the cursor has to have somewhere
9090 to go.)
9091 Use 'winwidth' to set the minimal width of the current window.
9092 This option is only checked when making a window smaller. Don't use a
9093 large number, it will cause errors when opening more than a few
9094 windows. A value of 0 to 12 is reasonable.
9095
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009096 *'winptydll'*
9097'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9098 global
9099 {not in Vi}
9100 {only available when compiled with the |terminal|
9101 feature on MS-Windows}
9102 Specifies the name of the winpty shared library, used for the
9103 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009104 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009105 a fallback.
9106 Environment variables are expanded |:set_env|.
9107 This option cannot be set from a |modeline| or in the |sandbox|, for
9108 security reasons.
9109
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110 *'winwidth'* *'wiw'* *E592*
9111'winwidth' 'wiw' number (default 20)
9112 global
9113 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009114 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 feature}
9116 Minimal number of columns for the current window. This is not a hard
9117 minimum, Vim will use fewer columns if there is not enough room. If
9118 the current window is smaller, its size is increased, at the cost of
9119 the width of other windows. Set it to 999 to make the current window
9120 always fill the screen. Set it to a small number for normal editing.
9121 The width is not adjusted after one of the commands to change the
9122 width of the current window.
9123 'winwidth' applies to the current window. Use 'winminwidth' to set
9124 the minimal width for other windows.
9125
9126 *'wrap'* *'nowrap'*
9127'wrap' boolean (default on)
9128 local to window
9129 {not in Vi}
9130 This option changes how text is displayed. It doesn't change the text
9131 in the buffer, see 'textwidth' for that.
9132 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009133 displaying continues on the next line. When off lines will not wrap
9134 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009135 moved to a part that is not shown, the screen will scroll
9136 horizontally.
9137 The line will be broken in the middle of a word if necessary. See
9138 'linebreak' to get the break at a word boundary.
9139 To make scrolling horizontally a bit more useful, try this: >
9140 :set sidescroll=5
9141 :set listchars+=precedes:<,extends:>
9142< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009143 This option can't be set from a |modeline| when the 'diff' option is
9144 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009145
9146 *'wrapmargin'* *'wm'*
9147'wrapmargin' 'wm' number (default 0)
9148 local to buffer
9149 Number of characters from the right window border where wrapping
9150 starts. When typing text beyond this limit, an <EOL> will be inserted
9151 and inserting continues on the next line.
9152 Options that add a margin, such as 'number' and 'foldcolumn', cause
9153 the text width to be further reduced. This is Vi compatible.
9154 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009155 This option is set to 0 when 'paste' is set and restored when 'paste'
9156 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9158 and less usefully}
9159
9160 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9161'wrapscan' 'ws' boolean (default on) *E384* *E385*
9162 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009163 Searches wrap around the end of the file. Also applies to |]s| and
9164 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165
9166 *'write'* *'nowrite'*
9167'write' boolean (default on)
9168 global
9169 {not in Vi}
9170 Allows writing files. When not set, writing a file is not allowed.
9171 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009172 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009173 argument. Filtering text is still possible, even though this requires
9174 writing a temporary file.
9175
9176 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9177'writeany' 'wa' boolean (default off)
9178 global
9179 Allows writing to any file with no need for "!" override.
9180
9181 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9182'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9183 otherwise)
9184 global
9185 {not in Vi}
9186 Make a backup before overwriting a file. The backup is removed after
9187 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009188 also on.
9189 WARNING: Switching this option off means that when Vim fails to write
9190 your buffer correctly and then, for whatever reason, Vim exits, you
9191 lose both the original file and what you were writing. Only reset
9192 this option if your file system is almost full and it makes the write
9193 fail (and make sure not to exit Vim until the write was successful).
9194 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009195 When the 'backupskip' pattern matches, a backup is not made anyway.
9196 NOTE: This option is set to the default value when 'compatible' is
9197 set.
9198
9199 *'writedelay'* *'wd'*
9200'writedelay' 'wd' number (default 0)
9201 global
9202 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009203 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009204 screen. When non-zero, characters are sent to the terminal one by
9205 one. For MS-DOS pcterm this does not work. For debugging purposes.
9206
9207 vim:tw=78:ts=8:ft=help:norl: