blob: 2343d634251f8aa1ac06f241647a8b255a6e1ef0 [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 '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001057 - For Unix and Win32, if a directory ends in two path separators "//",
1058 the swap file name will be built from the complete path to the file
1059 with all path separators changed to percent '%' signs. This will
1060 ensure file name uniqueness in the backup directory.
1061 On Win32, it is also possible to end with "\\". However, When a
1062 separating comma is following, you must use "//", since "\\" will
1063 include the comma in the file name. Therefore it is recommended to
1064 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 - Environment variables are expanded |:set_env|.
1066 - Careful with '\' characters, type one before a space, type two to
1067 get one in the option (see |option-backslash|), for example: >
1068 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1069< - For backwards compatibility with Vim version 3.0 a '>' at the start
1070 of the option is removed.
1071 See also 'backup' and 'writebackup' options.
1072 If you want to hide your backup files on Unix, consider this value: >
1073 :set backupdir=./.backup,~/.backup,.,/tmp
1074< You must create a ".backup" directory in each directory and in your
1075 home directory for this to work properly.
1076 The use of |:set+=| and |:set-=| is preferred when adding or removing
1077 directories from the list. This avoids problems when a future version
1078 uses another default.
1079 This option cannot be set from a |modeline| or in the |sandbox|, for
1080 security reasons.
1081
1082 *'backupext'* *'bex'* *E589*
1083'backupext' 'bex' string (default "~", for VMS: "_")
1084 global
1085 {not in Vi}
1086 String which is appended to a file name to make the name of the
1087 backup file. The default is quite unusual, because this avoids
1088 accidentally overwriting existing files with a backup file. You might
1089 prefer using ".bak", but make sure that you don't have files with
1090 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001091 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001093 If you like to keep a lot of backups, you could use a BufWritePre
1094 autocommand to change 'backupext' just before writing the file to
1095 include a timestamp. >
1096 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1097< Use 'backupdir' to put the backup in a different directory.
1098
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001100'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1101 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1102 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001103 global
1104 {not in Vi}
1105 {not available when compiled without the |+wildignore|
1106 feature}
1107 A list of file patterns. When one of the patterns matches with the
1108 name of the file which is written, no backup file is created. Both
1109 the specified file name and the full path name of the file are used.
1110 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1111 Watch out for special characters, see |option-backslash|.
1112 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001113 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001114
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001115 WARNING: Not having a backup file means that when Vim fails to write
1116 your buffer correctly and then, for whatever reason, Vim exits, you
1117 lose both the original file and what you were writing. Only disable
1118 backups if you don't care about losing the file.
1119
Bram Moolenaar02467872007-05-06 13:22:01 +00001120 Note that environment variables are not expanded. If you want to use
1121 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001122 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001123
1124< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001125 backup would be made by renaming the original file crontab won't see
1126 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127
1128 *'balloondelay'* *'bdlay'*
1129'balloondelay' 'bdlay' number (default: 600)
1130 global
1131 {not in Vi}
1132 {only available when compiled with the |+balloon_eval|
1133 feature}
1134 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1135
1136 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1137'ballooneval' 'beval' boolean (default off)
1138 global
1139 {not in Vi}
1140 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001142 Switch on the |balloon-eval| functionality for the GUI.
1143
1144 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1145 *'nobevalterm'*
1146'balloonevalterm' 'bevalterm' boolean (default off)
1147 global
1148 {not in Vi}
1149 {only available when compiled with the
1150 |+balloon_eval_term| feature}
1151 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 *'balloonexpr'* *'bexpr'*
1154'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001155 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156 {not in Vi}
1157 {only available when compiled with the |+balloon_eval|
1158 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001159 Expression for text to show in evaluation balloon. It is only used
1160 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161
1162 v:beval_bufnr number of the buffer in which balloon is going to show
1163 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001164 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 v:beval_lnum line number
1166 v:beval_col column number (byte index)
1167 v:beval_text word under or after the mouse pointer
1168
1169 The evaluation of the expression must not have side effects!
1170 Example: >
1171 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001172 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001173 \', column ' . v:beval_col .
1174 \ ' of file ' . bufname(v:beval_bufnr) .
1175 \ ' on word "' . v:beval_text . '"'
1176 endfunction
1177 set bexpr=MyBalloonExpr()
1178 set ballooneval
1179<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001180 Also see |balloon_show()|, can be used if the content of the balloon
1181 is to be fetched asynchronously.
1182
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001183 NOTE: The balloon is displayed only if the cursor is on a text
1184 character. If the result of evaluating 'balloonexpr' is not empty,
1185 Vim does not try to send a message to an external debugger (Netbeans
1186 or Sun Workshop).
1187
Bram Moolenaar30b65812012-07-12 22:01:11 +02001188 The expression will be evaluated in the |sandbox| when set from a
1189 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001190
1191 It is not allowed to change text or jump to another window while
1192 evaluating 'balloonexpr' |textlock|.
1193
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001194 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001195 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001196< When they are supported "\n" characters will start a new line. If the
1197 expression evaluates to a |List| this is equal to using each List item
1198 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001199 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001200
Bram Moolenaar165bc692015-07-21 17:53:25 +02001201 *'belloff'* *'bo'*
1202'belloff' 'bo' string (default "")
1203 global
1204 {not in Vi}
1205 Specifies for which events the bell will not be rung. It is a comma
1206 separated list of items. For each item that is present, the bell
1207 will be silenced. This is most useful to specify specific events in
1208 insert mode to be silenced.
1209
1210 item meaning when present ~
1211 all All events.
1212 backspace When hitting <BS> or <Del> and deleting results in an
1213 error.
1214 cursor Fail to move around using the cursor keys or
1215 <PageUp>/<PageDown> in |Insert-mode|.
1216 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1217 |i_CTRL-X_CTRL-T|.
1218 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1219 |i_CTRL-E|.
1220 ctrlg Unknown Char after <C-G> in Insert mode.
1221 error Other Error occurred (e.g. try to join last line)
1222 (mostly used in |Normal-mode| or |Cmdline-mode|).
1223 esc hitting <Esc> in |Normal-mode|.
1224 ex In |Visual-mode|, hitting |Q| results in an error.
1225 hangul Error occurred when using hangul input.
1226 insertmode Pressing <Esc> in 'insertmode'.
1227 lang Calling the beep module for Lua/Mzscheme/TCL.
1228 mess No output available for |g<|.
1229 showmatch Error occurred for 'showmatch' function.
1230 operator Empty region error |cpo-E|.
1231 register Unknown register after <C-R> in |Insert-mode|.
1232 shell Bell from shell output |:!|.
1233 spell Error happened on spell suggest.
1234 wildmode More matches in |cmdline-completion| available
1235 (depends on the 'wildmode' setting).
1236
Bram Moolenaar036986f2017-03-16 17:41:02 +01001237 This is most useful to fine tune when in Insert mode the bell should
1238 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001239 indicate that an error occurred. It can be silenced by adding the
1240 "error" keyword.
1241
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1243'binary' 'bin' boolean (default off)
1244 local to buffer
1245 {not in Vi}
1246 This option should be set before editing a binary file. You can also
1247 use the |-b| Vim argument. When this option is switched on a few
1248 options will be changed (also when it already was on):
1249 'textwidth' will be set to 0
1250 'wrapmargin' will be set to 0
1251 'modeline' will be off
1252 'expandtab' will be off
1253 Also, 'fileformat' and 'fileformats' options will not be used, the
1254 file is read and written like 'fileformat' was "unix" (a single <NL>
1255 separates lines).
1256 The 'fileencoding' and 'fileencodings' options will not be used, the
1257 file is read without conversion.
1258 NOTE: When you start editing a(nother) file while the 'bin' option is
1259 on, settings from autocommands may change the settings again (e.g.,
1260 'textwidth'), causing trouble when editing. You might want to set
1261 'bin' again when the file has been loaded.
1262 The previous values of these options are remembered and restored when
1263 'bin' is switched from on to off. Each buffer has its own set of
1264 saved option values.
1265 To edit a file with 'binary' set you can use the |++bin| argument.
1266 This avoids you have to do ":set bin", which would have effect for all
1267 files you edit.
1268 When writing a file the <EOL> for the last line is only written if
1269 there was one in the original file (normally Vim appends an <EOL> to
1270 the last line if there is none; this would make the file longer). See
1271 the 'endofline' option.
1272
1273 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1274'bioskey' 'biosk' boolean (default on)
1275 global
1276 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001277 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
1279 *'bomb'* *'nobomb'*
1280'bomb' boolean (default off)
1281 local to buffer
1282 {not in Vi}
1283 {only available when compiled with the |+multi_byte|
1284 feature}
1285 When writing a file and the following conditions are met, a BOM (Byte
1286 Order Mark) is prepended to the file:
1287 - this option is on
1288 - the 'binary' option is off
1289 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1290 endian variants.
1291 Some applications use the BOM to recognize the encoding of the file.
1292 Often used for UCS-2 files on MS-Windows. For other applications it
1293 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001294 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1296 check for the presence of the BOM is done and 'bomb' set accordingly.
1297 Unless 'binary' is set, it is removed from the first line, so that you
1298 don't see it when editing. When you don't change the options, the BOM
1299 will be restored when writing the file.
1300
1301 *'breakat'* *'brk'*
1302'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1303 global
1304 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001305 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 feature}
1307 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001308 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1309 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001311 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001312'breakindent' 'bri' boolean (default off)
1313 local to window
1314 {not in Vi}
1315 {not available when compiled without the |+linebreak|
1316 feature}
1317 Every wrapped line will continue visually indented (same amount of
1318 space as the beginning of that line), thus preserving horizontal blocks
1319 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001320 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001321
1322 *'breakindentopt'* *'briopt'*
1323'breakindentopt' 'briopt' string (default empty)
1324 local to window
1325 {not in Vi}
1326 {not available when compiled without the |+linebreak|
1327 feature}
1328 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001329 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001330 min:{n} Minimum text width that will be kept after
1331 applying 'breakindent', even if the resulting
1332 text should normally be narrower. This prevents
1333 text indented almost to the right window border
1334 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001335 shift:{n} After applying 'breakindent', the wrapped line's
1336 beginning will be shifted by the given number of
1337 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001338 indentation (negative) or emphasizing the line
1339 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001340 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001341 additional indent.
1342 The default value for min is 20 and shift is 0.
1343
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001345'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001347 {not in Vi} {only for Motif, Athena, GTK, Mac and
1348 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001350 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001351 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352 buffer Use the directory of the related buffer.
1353 current Use the current directory.
1354 {path} Use the specified directory
1355
1356 *'bufhidden'* *'bh'*
1357'bufhidden' 'bh' string (default: "")
1358 local to buffer
1359 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360 This option specifies what happens when a buffer is no longer
1361 displayed in a window:
1362 <empty> follow the global 'hidden' option
1363 hide hide the buffer (don't unload it), also when 'hidden'
1364 is not set
1365 unload unload the buffer, also when 'hidden' is set or using
1366 |:hide|
1367 delete delete the buffer from the buffer list, also when
1368 'hidden' is set or using |:hide|, like using
1369 |:bdelete|
1370 wipe wipe out the buffer from the buffer list, also when
1371 'hidden' is set or using |:hide|, like using
1372 |:bwipeout|
1373
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001374 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001375 are lost without a warning. Also, these values may break autocommands
1376 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377 This option is used together with 'buftype' and 'swapfile' to specify
1378 special kinds of buffers. See |special-buffers|.
1379
1380 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1381'buflisted' 'bl' boolean (default: on)
1382 local to buffer
1383 {not in Vi}
1384 When this option is set, the buffer shows up in the buffer list. If
1385 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1386 This option is reset by Vim for buffers that are only used to remember
1387 a file name or marks. Vim sets it when starting to edit a buffer.
1388 But not when moving to a buffer with ":buffer".
1389
1390 *'buftype'* *'bt'* *E382*
1391'buftype' 'bt' string (default: "")
1392 local to buffer
1393 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 The value of this option specifies the type of a buffer:
1395 <empty> normal buffer
1396 nofile buffer which is not related to a file and will not be
1397 written
1398 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001399 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001400 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001402 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 help help buffer (you are not supposed to set this
1404 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001405 terminal buffer for a |terminal| (you are not supposed to set
1406 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001407 prompt buffer where only the last line can be edited, meant
1408 to be used by a plugin, see |prompt-buffer|
1409 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410
1411 This option is used together with 'bufhidden' and 'swapfile' to
1412 specify special kinds of buffers. See |special-buffers|.
1413
1414 Be careful with changing this option, it can have many side effects!
1415
Bram Moolenaar280f1262006-01-30 00:14:18 +00001416 A "quickfix" buffer is only used for the error list and the location
1417 list. This value is set by the |:cwindow| and |:lwindow| commands and
1418 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419
1420 "nofile" and "nowrite" buffers are similar:
1421 both: The buffer is not to be written to disk, ":w" doesn't
1422 work (":w filename" does work though).
1423 both: The buffer is never considered to be |'modified'|.
1424 There is no warning when the changes will be lost, for
1425 example when you quit Vim.
1426 both: A swap file is only created when using too much memory
1427 (when 'swapfile' has been reset there is never a swap
1428 file).
1429 nofile only: The buffer name is fixed, it is not handled like a
1430 file name. It is not modified in response to a |:cd|
1431 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001432 both: When using ":e bufname" and already editing "bufname"
1433 the buffer is made empty and autocommands are
1434 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001435 *E676*
1436 "acwrite" implies that the buffer name is not related to a file, like
1437 "nofile", but it will be written. Thus, in contrast to "nofile" and
1438 "nowrite", ":w" does work and a modified buffer can't be abandoned
1439 without saving. For writing there must be matching |BufWriteCmd|,
1440 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441
1442 *'casemap'* *'cmp'*
1443'casemap' 'cmp' string (default: "internal,keepascii")
1444 global
1445 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001446 {only available when compiled with the |+multi_byte|
1447 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 Specifies details about changing the case of letters. It may contain
1449 these words, separated by a comma:
1450 internal Use internal case mapping functions, the current
1451 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001452 matters when 'encoding' is a Unicode encoding,
1453 "latin1" or "iso-8859-15". When "internal" is
1454 omitted, the towupper() and towlower() system library
1455 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1457 case mapping, the current locale is not effective.
1458 This probably only matters for Turkish.
1459
1460 *'cdpath'* *'cd'* *E344* *E346*
1461'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1462 global
1463 {not in Vi}
1464 {not available when compiled without the
1465 |+file_in_path| feature}
1466 This is a list of directories which will be searched when using the
1467 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001468 for has a relative path, not an absolute part starting with "/", "./"
1469 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 The 'cdpath' option's value has the same form and semantics as
1471 |'path'|. Also see |file-searching|.
1472 The default value is taken from $CDPATH, with a "," prepended to look
1473 in the current directory first.
1474 If the default value taken from $CDPATH is not what you want, include
1475 a modified version of the following command in your vimrc file to
1476 override it: >
1477 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1478< This option cannot be set from a |modeline| or in the |sandbox|, for
1479 security reasons.
1480 (parts of 'cdpath' can be passed to the shell to expand file names).
1481
1482 *'cedit'*
1483'cedit' string (Vi default: "", Vim default: CTRL-F)
1484 global
1485 {not in Vi}
1486 {not available when compiled without the |+vertsplit|
1487 feature}
1488 The key used in Command-line Mode to open the command-line window.
1489 The default is CTRL-F when 'compatible' is off.
1490 Only non-printable keys are allowed.
1491 The key can be specified as a single character, but it is difficult to
1492 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001493 :exe "set cedit=\<C-Y>"
1494 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495< |Nvi| also has this option, but it only uses the first character.
1496 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001497 NOTE: This option is set to the Vim default value when 'compatible'
1498 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1501'charconvert' 'ccv' string (default "")
1502 global
1503 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001504 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 {not in Vi}
1506 An expression that is used for character encoding conversion. It is
1507 evaluated when a file that is to be read or has been written has a
1508 different encoding from what is desired.
1509 'charconvert' is not used when the internal iconv() function is
1510 supported and is able to do the conversion. Using iconv() is
1511 preferred, because it is much faster.
1512 'charconvert' is not used when reading stdin |--|, because there is no
1513 file to convert from. You will have to save the text in a file first.
1514 The expression must return zero or an empty string for success,
1515 non-zero for failure.
1516 The possible encoding names encountered are in 'encoding'.
1517 Additionally, names given in 'fileencodings' and 'fileencoding' are
1518 used.
1519 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1520 is done internally by Vim, 'charconvert' is not used for this.
1521 'charconvert' is also used to convert the viminfo file, if the 'c'
1522 flag is present in 'viminfo'. Also used for Unicode conversion.
1523 Example: >
1524 set charconvert=CharConvert()
1525 fun CharConvert()
1526 system("recode "
1527 \ . v:charconvert_from . ".." . v:charconvert_to
1528 \ . " <" . v:fname_in . " >" v:fname_out)
1529 return v:shell_error
1530 endfun
1531< The related Vim variables are:
1532 v:charconvert_from name of the current encoding
1533 v:charconvert_to name of the desired encoding
1534 v:fname_in name of the input file
1535 v:fname_out name of the output file
1536 Note that v:fname_in and v:fname_out will never be the same.
1537 Note that v:charconvert_from and v:charconvert_to may be different
1538 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1539 Encryption is not done by Vim when using 'charconvert'. If you want
1540 to encrypt the file after conversion, 'charconvert' should take care
1541 of this.
1542 This option cannot be set from a |modeline| or in the |sandbox|, for
1543 security reasons.
1544
1545 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1546'cindent' 'cin' boolean (default off)
1547 local to buffer
1548 {not in Vi}
1549 {not available when compiled without the |+cindent|
1550 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001551 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 that trigger reindenting in insert mode and 'cinoptions' to set your
1553 preferred indent style.
1554 If 'indentexpr' is not empty, it overrules 'cindent'.
1555 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1556 the "=" operator indents using this algorithm rather than calling an
1557 external program.
1558 See |C-indenting|.
1559 When you don't like the way 'cindent' works, try the 'smartindent'
1560 option or 'indentexpr'.
1561 This option is not used when 'paste' is set.
1562 NOTE: This option is reset when 'compatible' is set.
1563
1564 *'cinkeys'* *'cink'*
1565'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1566 local to buffer
1567 {not in Vi}
1568 {not available when compiled without the |+cindent|
1569 feature}
1570 A list of keys that, when typed in Insert mode, cause reindenting of
1571 the current line. Only used if 'cindent' is on and 'indentexpr' is
1572 empty.
1573 For the format of this option see |cinkeys-format|.
1574 See |C-indenting|.
1575
1576 *'cinoptions'* *'cino'*
1577'cinoptions' 'cino' string (default "")
1578 local to buffer
1579 {not in Vi}
1580 {not available when compiled without the |+cindent|
1581 feature}
1582 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1583 program. See |cinoptions-values| for the values of this option, and
1584 |C-indenting| for info on C indenting in general.
1585
1586
1587 *'cinwords'* *'cinw'*
1588'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1589 local to buffer
1590 {not in Vi}
1591 {not available when compiled without both the
1592 |+cindent| and the |+smartindent| features}
1593 These keywords start an extra indent in the next line when
1594 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1595 an appropriate place (inside {}).
1596 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1597 matter, include the keyword both the uppercase and lowercase:
1598 "if,If,IF".
1599
1600 *'clipboard'* *'cb'*
1601'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1602 for X-windows, "" otherwise)
1603 global
1604 {not in Vi}
1605 {only in GUI versions or when the |+xterm_clipboard|
1606 feature is included}
1607 This option is a list of comma separated names.
1608 These names are recognized:
1609
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001610 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 unnamed When included, Vim will use the clipboard register '*'
1612 for all yank, delete, change and put operations which
1613 would normally go to the unnamed register. When a
1614 register is explicitly specified, it will always be
1615 used regardless of whether "unnamed" is in 'clipboard'
1616 or not. The clipboard register can always be
1617 explicitly accessed using the "* notation. Also see
1618 |gui-clipboard|.
1619
Bram Moolenaar30b65812012-07-12 22:01:11 +02001620 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001621 unnamedplus A variant of the "unnamed" flag which uses the
1622 clipboard register '+' (|quoteplus|) instead of
1623 register '*' for all yank, delete, change and put
1624 operations which would normally go to the unnamed
1625 register. When "unnamed" is also included to the
1626 option, yank operations (but not delete, change or
1627 put) will additionally copy the text into register
1628 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001629 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001630 Availability can be checked with: >
1631 if has('unnamedplus')
1632<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001633 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 autoselect Works like the 'a' flag in 'guioptions': If present,
1635 then whenever Visual mode is started, or the Visual
1636 area extended, Vim tries to become the owner of the
1637 windowing system's global selection or put the
1638 selected text on the clipboard used by the selection
1639 register "*. See |guioptions_a| and |quotestar| for
1640 details. When the GUI is active, the 'a' flag in
1641 'guioptions' is used, when the GUI is not active, this
1642 "autoselect" flag is used.
1643 Also applies to the modeless selection.
1644
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001645 *clipboard-autoselectplus*
1646 autoselectplus Like "autoselect" but using the + register instead of
1647 the * register. Compare to the 'P' flag in
1648 'guioptions'.
1649
1650 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 autoselectml Like "autoselect", but for the modeless selection
1652 only. Compare to the 'A' flag in 'guioptions'.
1653
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001654 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001655 html When the clipboard contains HTML, use this when
1656 pasting. When putting text on the clipboard, mark it
1657 as HTML. This works to copy rendered HTML from
1658 Firefox, paste it as raw HTML in Vim, select the HTML
1659 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001660 You probably want to add this only temporarily,
1661 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001662 Only supported for GTK version 2 and later.
1663 Only available with the |+multi_byte| feature.
1664
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001665 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 exclude:{pattern}
1667 Defines a pattern that is matched against the name of
1668 the terminal 'term'. If there is a match, no
1669 connection will be made to the X server. This is
1670 useful in this situation:
1671 - Running Vim in a console.
1672 - $DISPLAY is set to start applications on another
1673 display.
1674 - You do not want to connect to the X server in the
1675 console, but do want this in a terminal emulator.
1676 To never connect to the X server use: >
1677 exclude:.*
1678< This has the same effect as using the |-X| argument.
1679 Note that when there is no connection to the X server
1680 the window title won't be restored and the clipboard
1681 cannot be accessed.
1682 The value of 'magic' is ignored, {pattern} is
1683 interpreted as if 'magic' was on.
1684 The rest of the option value will be used for
1685 {pattern}, this must be the last entry.
1686
1687 *'cmdheight'* *'ch'*
1688'cmdheight' 'ch' number (default 1)
1689 global
1690 {not in Vi}
1691 Number of screen lines to use for the command-line. Helps avoiding
1692 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001693 The value of this option is stored with the tab page, so that each tab
1694 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695
1696 *'cmdwinheight'* *'cwh'*
1697'cmdwinheight' 'cwh' number (default 7)
1698 global
1699 {not in Vi}
1700 {not available when compiled without the |+vertsplit|
1701 feature}
1702 Number of screen lines to use for the command-line window. |cmdwin|
1703
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001704 *'colorcolumn'* *'cc'*
1705'colorcolumn' 'cc' string (default "")
1706 local to window
1707 {not in Vi}
1708 {not available when compiled without the |+syntax|
1709 feature}
1710 'colorcolumn' is a comma separated list of screen columns that are
1711 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1712 text. Will make screen redrawing slower.
1713 The screen column can be an absolute number, or a number preceded with
1714 '+' or '-', which is added to or subtracted from 'textwidth'. >
1715
1716 :set cc=+1 " highlight column after 'textwidth'
1717 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1718 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1719<
1720 When 'textwidth' is zero then the items with '-' and '+' are not used.
1721 A maximum of 256 columns are highlighted.
1722
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 *'columns'* *'co'* *E594*
1724'columns' 'co' number (default 80 or terminal width)
1725 global
1726 {not in Vi}
1727 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001728 initialization and does not have to be set by hand. Also see
1729 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 When Vim is running in the GUI or in a resizable window, setting this
1731 option will cause the window size to be changed. When you only want
1732 to use the size for the GUI, put the command in your |gvimrc| file.
1733 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001734 number of columns of the display, the display may be messed up. For
1735 the GUI it is always possible and Vim limits the number of columns to
1736 what fits on the screen. You can use this command to get the widest
1737 window possible: >
1738 :set columns=9999
1739< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740
1741 *'comments'* *'com'* *E524* *E525*
1742'comments' 'com' string (default
1743 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1744 local to buffer
1745 {not in Vi}
1746 {not available when compiled without the |+comments|
1747 feature}
1748 A comma separated list of strings that can start a comment line. See
1749 |format-comments|. See |option-backslash| about using backslashes to
1750 insert a space.
1751
1752 *'commentstring'* *'cms'* *E537*
1753'commentstring' 'cms' string (default "/*%s*/")
1754 local to buffer
1755 {not in Vi}
1756 {not available when compiled without the |+folding|
1757 feature}
1758 A template for a comment. The "%s" in the value is replaced with the
1759 comment text. Currently only used to add markers for folding, see
1760 |fold-marker|.
1761
1762 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001763'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001764 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 global
1766 {not in Vi}
1767 This option has the effect of making Vim either more Vi-compatible, or
1768 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001769
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771 other options are also changed as a side effect.
1772 NOTE: Setting or resetting this option can have a lot of unexpected
1773 effects: Mappings are interpreted in another way, undo behaves
1774 differently, etc. If you set this option in your vimrc file, you
1775 should probably put it at the very start.
1776
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 By default this option is on and the Vi defaults are used for the
1778 options. This default was chosen for those people who want to use Vim
1779 just like Vi, and don't even (want to) know about the 'compatible'
1780 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001781 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001782 this option is switched off, and all options that have not been
1783 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001784 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001785 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001786 happen for the system-wide vimrc or gvimrc file, nor for a file given
1787 with the |-u| argument). Also see |compatible-default| and
1788 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 You can also set this option with the "-C" argument, and reset it with
1790 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001791 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 When this option is set, numerous other options are set to make Vim as
1794 Vi-compatible as possible. When this option is unset, various options
1795 are set to make Vim more useful. The table below lists all the
1796 options affected.
1797 The {?} column indicates when the options are affected:
1798 + Means that the option is set to the value given in {set value} when
1799 'compatible' is set.
1800 & Means that the option is set to the value given in {set value} when
1801 'compatible' is set AND is set to its Vim default value when
1802 'compatible' is unset.
1803 - Means the option is NOT changed when setting 'compatible' but IS
1804 set to its Vim default when 'compatible' is unset.
1805 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
Bram Moolenaar036986f2017-03-16 17:41:02 +01001807 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001808
1809 'allowrevins' + off no CTRL-_ command
1810 'antialias' + off don't use antialiased fonts
1811 'arabic' + off reset arabic-related options
1812 'arabicshape' + on correct character shapes
1813 'backspace' + "" normal backspace
1814 'backup' + off no backup file
1815 'backupcopy' & Unix: "yes" backup file is a copy
1816 else: "auto" copy or rename backup file
1817 'balloonexpr' + "" text to show in evaluation balloon
1818 'breakindent' + off don't indent when wrapping lines
1819 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1820 'cindent' + off no C code indentation
1821 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1822 'copyindent' + off don't copy indent structure
1823 'cpoptions' & (all flags) Vi-compatible flags
1824 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001825 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001826 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001827 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001828 'cscopeverbose' + off see |cscopeverbose|
1829 'delcombine' + off unicode: delete whole char combination
1830 'digraph' + off no digraphs
1831 'esckeys' & off no <Esc>-keys in Insert mode
1832 'expandtab' + off tabs not expanded to spaces
1833 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001835 'formatexpr' + "" use 'formatprg' for auto-formatting
1836 'formatoptions' & "vt" Vi compatible formatting
1837 'gdefault' + off no default 'g' flag for ":s"
1838 'history' & 0 no commandline history
1839 'hkmap' + off no Hebrew keyboard mapping
1840 'hkmapp' + off no phonetic Hebrew keyboard mapping
1841 'hlsearch' + off no highlighting of search matches
1842 'incsearch' + off no incremental searching
1843 'indentexpr' + "" no indenting by expression
1844 'insertmode' + off do not start in Insert mode
1845 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001847 'joinspaces' + on insert 2 spaces after period
1848 'modeline' & off no modelines
1849 'more' & off no pauses in listings
1850 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1851 'numberwidth' & 8 min number of columns for line number
1852 'preserveindent'+ off don't preserve current indent structure
1853 when changing it
1854 'revins' + off no reverse insert
1855 'ruler' + off no ruler
1856 'scrolljump' + 1 no jump scroll
1857 'scrolloff' + 0 no scroll offset
1858 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1859 'shiftround' + off indent not rounded to shiftwidth
1860 'shortmess' & "" no shortening of messages
1861 'showcmd' & off command characters not shown
1862 'showmode' & off current mode not shown
1863 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1864 'smartcase' + off no automatic ignore case switch
1865 'smartindent' + off no smart indentation
1866 'smarttab' + off no smart tab size
1867 'softtabstop' + 0 tabs are always 'tabstop' positions
1868 'startofline' + on goto startofline with some commands
1869 'tagcase' & "followic" 'ignorecase' when searching tags file
1870 'tagrelative' & off tag file names are not relative
1871 'termguicolors' + off don't use highlight-(guifg|guibg)
1872 'textauto' & off no automatic textmode detection
1873 'textwidth' + 0 no automatic line wrap
1874 'tildeop' + off tilde is not an operator
1875 'ttimeout' + off no terminal timeout
1876 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001877 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001878 'virtualedit' + "" cursor can only be placed on characters
1879 'whichwrap' & "" left-right movements don't wrap
1880 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001882 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883
1884 *'complete'* *'cpt'* *E535*
1885'complete' 'cpt' string (default: ".,w,b,u,t,i")
1886 local to buffer
1887 {not in Vi}
1888 This option specifies how keyword completion |ins-completion| works
1889 when CTRL-P or CTRL-N are used. It is also used for whole-line
1890 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1891 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001892 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 w scan buffers from other windows
1894 b scan other loaded buffers that are in the buffer list
1895 u scan the unloaded buffers that are in the buffer list
1896 U scan the buffers that are not in the buffer list
1897 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001898 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 k{dict} scan the file {dict}. Several "k" flags can be given,
1900 patterns are valid too. For example: >
1901 :set cpt=k/usr/dict/*,k~/spanish
1902< s scan the files given with the 'thesaurus' option
1903 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1904 are valid too.
1905 i scan current and included files
1906 d scan current and included files for defined name or macro
1907 |i_CTRL-X_CTRL-D|
1908 ] tag completion
1909 t same as "]"
1910
1911 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1912 not executed, this may lead to unexpected completions from some files
1913 (gzipped files for example). Unloaded buffers are not scanned for
1914 whole-line completion.
1915
1916 The default is ".,w,b,u,t,i", which means to scan:
1917 1. the current buffer
1918 2. buffers in other windows
1919 3. other loaded buffers
1920 4. unloaded buffers
1921 5. tags
1922 6. included files
1923
1924 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001925 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1926 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001928 *'completefunc'* *'cfu'*
1929'completefunc' 'cfu' string (default: empty)
1930 local to buffer
1931 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001932 {not available when compiled without the |+eval|
1933 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001934 This option specifies a function to be used for Insert mode completion
1935 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001936 See |complete-functions| for an explanation of how the function is
1937 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001938 This option cannot be set from a |modeline| or in the |sandbox|, for
1939 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001940
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001941 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001942'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001943 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001944 {not available when compiled without the
1945 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001946 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001947 A comma separated list of options for Insert mode completion
1948 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001949
1950 menu Use a popup menu to show the possible completions. The
1951 menu is only shown when there is more than one match and
1952 sufficient colors are available. |ins-completion-menu|
1953
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001954 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001955 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001956 match, e.g., what file it comes from.
1957
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001958 longest Only insert the longest common text of the matches. If
1959 the menu is displayed you can use CTRL-L to add more
1960 characters. Whether case is ignored depends on the kind
1961 of completion. For buffer text the 'ignorecase' option is
1962 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001963
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001964 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001965 completion in the preview window. Only works in
1966 combination with "menu" or "menuone".
1967
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001968 noinsert Do not insert any text for a match until the user selects
1969 a match from the menu. Only works in combination with
1970 "menu" or "menuone". No effect if "longest" is present.
1971
1972 noselect Do not select a match in the menu, force the user to
1973 select one from the menu. Only works in combination with
1974 "menu" or "menuone".
1975
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001976
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001977 *'concealcursor'* *'cocu'*
1978'concealcursor' 'cocu' string (default: "")
1979 local to window
1980 {not in Vi}
1981 {not available when compiled without the |+conceal|
1982 feature}
1983 Sets the modes in which text in the cursor line can also be concealed.
1984 When the current mode is listed then concealing happens just like in
1985 other lines.
1986 n Normal mode
1987 v Visual mode
1988 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001989 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001990
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001991 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001992 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001993 are moving around text is concealed, but when starting to insert text
1994 or selecting a Visual area the concealed text is displayed, so that
1995 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001996 Keep in mind that the cursor position is not always where it's
1997 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001998
1999
2000'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001 number (default 0)
2002 local to window
2003 {not in Vi}
2004 {not available when compiled without the |+conceal|
2005 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002006 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2007 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002008
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002009 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002011 1 Each block of concealed text is replaced with one
2012 character. If the syntax item does not have a custom
2013 replacement character defined (see |:syn-cchar|) the
2014 character defined in 'listchars' is used (default is a
2015 space).
2016 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002017 2 Concealed text is completely hidden unless it has a
2018 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002019 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002020 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002021
Bram Moolenaara7781e02010-07-19 20:13:22 +02002022 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002023 edit and copy the text. This can be changed with the 'concealcursor'
2024 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002025
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2027'confirm' 'cf' boolean (default off)
2028 global
2029 {not in Vi}
2030 When 'confirm' is on, certain operations that would normally
2031 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2032 instead raise a |dialog| asking if you wish to save the current
2033 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2034 If 'confirm' is off you can still activate confirmation for one
2035 command only (this is most useful in mappings) with the |:confirm|
2036 command.
2037 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2038
2039 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2040'conskey' 'consk' boolean (default off)
2041 global
2042 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002043 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
2045 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2046'copyindent' 'ci' boolean (default off)
2047 local to buffer
2048 {not in Vi}
2049 Copy the structure of the existing lines indent when autoindenting a
2050 new line. Normally the new indent is reconstructed by a series of
2051 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2052 in which case only spaces are used). Enabling this option makes the
2053 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002054 existing line. 'expandtab' has no effect on these characters, a Tab
2055 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002057 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 Also see 'preserveindent'.
2059
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002060 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061'cpoptions' 'cpo' string (Vim default: "aABceFs",
2062 Vi default: all flags)
2063 global
2064 {not in Vi}
2065 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002066 this indicates Vi-compatible behavior. This is used for things where
2067 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 'cpoptions' stands for "compatible-options".
2069 Commas can be added for readability.
2070 To avoid problems with flags that are added in the future, use the
2071 "+=" and "-=" feature of ":set" |add-option-flags|.
2072 NOTE: This option is set to the Vi default value when 'compatible' is
2073 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002074 NOTE: This option is set to the POSIX default value at startup when
2075 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002076 variable exists |posix|. This means Vim tries to behave like the
2077 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078
2079 contains behavior ~
2080 *cpo-a*
2081 a When included, a ":read" command with a file name
2082 argument will set the alternate file name for the
2083 current window.
2084 *cpo-A*
2085 A When included, a ":write" command with a file name
2086 argument will set the alternate file name for the
2087 current window.
2088 *cpo-b*
2089 b "\|" in a ":map" command is recognized as the end of
2090 the map command. The '\' is included in the mapping,
2091 the text after the '|' is interpreted as the next
2092 command. Use a CTRL-V instead of a backslash to
2093 include the '|' in the mapping. Applies to all
2094 mapping, abbreviation, menu and autocmd commands.
2095 See also |map_bar|.
2096 *cpo-B*
2097 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002098 abbreviations, user commands and the "to" part of the
2099 menu commands. Remove this flag to be able to use a
2100 backslash like a CTRL-V. For example, the command
2101 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 'B' included: "\^[" (^[ is a real <Esc>)
2103 'B' excluded: "<Esc>" (5 characters)
2104 ('<' excluded in both cases)
2105 *cpo-c*
2106 c Searching continues at the end of any match at the
2107 cursor position, but not further than the start of the
2108 next line. When not present searching continues
2109 one character from the cursor position. With 'c'
2110 "abababababab" only gets three matches when repeating
2111 "/abab", without 'c' there are five matches.
2112 *cpo-C*
2113 C Do not concatenate sourced lines that start with a
2114 backslash. See |line-continuation|.
2115 *cpo-d*
2116 d Using "./" in the 'tags' option doesn't mean to use
2117 the tags file relative to the current file, but the
2118 tags file in the current directory.
2119 *cpo-D*
2120 D Can't use CTRL-K to enter a digraph after Normal mode
2121 commands with a character argument, like |r|, |f| and
2122 |t|.
2123 *cpo-e*
2124 e When executing a register with ":@r", always add a
2125 <CR> to the last line, also when the register is not
2126 linewise. If this flag is not present, the register
2127 is not linewise and the last line does not end in a
2128 <CR>, then the last line is put on the command-line
2129 and can be edited before hitting <CR>.
2130 *cpo-E*
2131 E It is an error when using "y", "d", "c", "g~", "gu" or
2132 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002133 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 This makes "y0" fail in the first column.
2135 *cpo-f*
2136 f When included, a ":read" command with a file name
2137 argument will set the file name for the current buffer,
2138 if the current buffer doesn't have a file name yet.
2139 *cpo-F*
2140 F When included, a ":write" command with a file name
2141 argument will set the file name for the current
2142 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002143 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 *cpo-g*
2145 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002146 *cpo-H*
2147 H When using "I" on a line with only blanks, insert
2148 before the last blank. Without this flag insert after
2149 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 *cpo-i*
2151 i When included, interrupting the reading of a file will
2152 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002153 *cpo-I*
2154 I When moving the cursor up or down just after inserting
2155 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 *cpo-j*
2157 j When joining lines, only add two spaces after a '.',
2158 not after '!' or '?'. Also see 'joinspaces'.
2159 *cpo-J*
2160 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002161 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 white space.
2163 *cpo-k*
2164 k Disable the recognition of raw key codes in
2165 mappings, abbreviations, and the "to" part of menu
2166 commands. For example, if <Key> sends ^[OA (where ^[
2167 is <Esc>), the command ":map X ^[OA" results in X
2168 being mapped to:
2169 'k' included: "^[OA" (3 characters)
2170 'k' excluded: "<Key>" (one key code)
2171 Also see the '<' flag below.
2172 *cpo-K*
2173 K Don't wait for a key code to complete when it is
2174 halfway a mapping. This breaks mapping <F1><F1> when
2175 only part of the second <F1> has been read. It
2176 enables cancelling the mapping by typing <F1><Esc>.
2177 *cpo-l*
2178 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002179 literally, only "\]", "\^", "\-" and "\\" are special.
2180 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2182 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002183 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 *cpo-L*
2185 L When the 'list' option is set, 'wrapmargin',
2186 'textwidth', 'softtabstop' and Virtual Replace mode
2187 (see |gR|) count a <Tab> as two characters, instead of
2188 the normal behavior of a <Tab>.
2189 *cpo-m*
2190 m When included, a showmatch will always wait half a
2191 second. When not included, a showmatch will wait half
2192 a second or until a character is typed. |'showmatch'|
2193 *cpo-M*
2194 M When excluded, "%" matching will take backslashes into
2195 account. Thus in "( \( )" and "\( ( \)" the outer
2196 parenthesis match. When included "%" ignores
2197 backslashes, which is Vi compatible.
2198 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002199 n When included, the column used for 'number' and
2200 'relativenumber' will also be used for text of wrapped
2201 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002202 *cpo-o*
2203 o Line offset to search command is not remembered for
2204 next search.
2205 *cpo-O*
2206 O Don't complain if a file is being overwritten, even
2207 when it didn't exist when editing it. This is a
2208 protection against a file unexpectedly created by
2209 someone else. Vi didn't complain about this.
2210 *cpo-p*
2211 p Vi compatible Lisp indenting. When not present, a
2212 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002213 *cpo-P*
2214 P When included, a ":write" command that appends to a
2215 file will set the file name for the current buffer, if
2216 the current buffer doesn't have a file name yet and
2217 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002218 *cpo-q*
2219 q When joining multiple lines leave the cursor at the
2220 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 *cpo-r*
2222 r Redo ("." command) uses "/" to repeat a search
2223 command, instead of the actually used search string.
2224 *cpo-R*
2225 R Remove marks from filtered lines. Without this flag
2226 marks are kept like |:keepmarks| was used.
2227 *cpo-s*
2228 s Set buffer options when entering the buffer for the
2229 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002230 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 set when the buffer is created.
2232 *cpo-S*
2233 S Set buffer options always when entering a buffer
2234 (except 'readonly', 'fileformat', 'filetype' and
2235 'syntax'). This is the (most) Vi compatible setting.
2236 The options are set to the values in the current
2237 buffer. When you change an option and go to another
2238 buffer, the value is copied. Effectively makes the
2239 buffer options global to all buffers.
2240
2241 's' 'S' copy buffer options
2242 no no when buffer created
2243 yes no when buffer first entered (default)
2244 X yes each time when buffer entered (vi comp.)
2245 *cpo-t*
2246 t Search pattern for the tag command is remembered for
2247 "n" command. Otherwise Vim only puts the pattern in
2248 the history for search pattern, but doesn't change the
2249 last used search pattern.
2250 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002251 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 *cpo-v*
2253 v Backspaced characters remain visible on the screen in
2254 Insert mode. Without this flag the characters are
2255 erased from the screen right away. With this flag the
2256 screen newly typed text overwrites backspaced
2257 characters.
2258 *cpo-w*
2259 w When using "cw" on a blank character, only change one
2260 character and not all blanks until the start of the
2261 next word.
2262 *cpo-W*
2263 W Don't overwrite a readonly file. When omitted, ":w!"
2264 overwrites a readonly file, if possible.
2265 *cpo-x*
2266 x <Esc> on the command-line executes the command-line.
2267 The default in Vim is to abandon the command-line,
2268 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002269 *cpo-X*
2270 X When using a count with "R" the replaced text is
2271 deleted only once. Also when repeating "R" with "."
2272 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 *cpo-y*
2274 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002275 *cpo-Z*
2276 Z When using "w!" while the 'readonly' option is set,
2277 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *cpo-!*
2279 ! When redoing a filter command, use the last used
2280 external command, whatever it was. Otherwise the last
2281 used -filter- command is used.
2282 *cpo-$*
2283 $ When making a change to one line, don't redisplay the
2284 line, but put a '$' at the end of the changed text.
2285 The changed text will be overwritten when you type the
2286 new text. The line is redisplayed if you type any
2287 command that moves the cursor from the insertion
2288 point.
2289 *cpo-%*
2290 % Vi-compatible matching is done for the "%" command.
2291 Does not recognize "#if", "#endif", etc.
2292 Does not recognize "/*" and "*/".
2293 Parens inside single and double quotes are also
2294 counted, causing a string that contains a paren to
2295 disturb the matching. For example, in a line like
2296 "if (strcmp("foo(", s))" the first paren does not
2297 match the last one. When this flag is not included,
2298 parens inside single and double quotes are treated
2299 specially. When matching a paren outside of quotes,
2300 everything inside quotes is ignored. When matching a
2301 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002302 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002303 This flag is also used for other features, such as
2304 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002305 *cpo--*
2306 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002307 it would go above the first line or below the last
2308 line. Without it the cursor moves to the first or
2309 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002310 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002311 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002312 *cpo-+*
2313 + When included, a ":write file" command will reset the
2314 'modified' flag of the buffer, even though the buffer
2315 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002316 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 * Use ":*" in the same way as ":@". When not included,
2318 ":*" is an alias for ":'<,'>", select the Visual area.
2319 *cpo-<*
2320 < Disable the recognition of special key codes in |<>|
2321 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002322 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 ":map X <Tab>" results in X being mapped to:
2324 '<' included: "<Tab>" (5 characters)
2325 '<' excluded: "^I" (^I is a real <Tab>)
2326 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 *cpo->*
2328 > When appending to a register, put a line break before
2329 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002330 *cpo-;*
2331 ; When using |,| or |;| to repeat the last |t| search
2332 and the cursor is right in front of the searched
2333 character, the cursor won't move. When not included,
2334 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002335 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002336
2337 POSIX flags. These are not included in the Vi default value, except
2338 when $VIM_POSIX was set on startup. |posix|
2339
2340 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002341 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002342 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002343 *cpo-&*
2344 & When ":preserve" was used keep the swap file when
2345 exiting normally while this buffer is still loaded.
2346 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002347 *cpo-\*
2348 \ Backslash in a [] range in a search pattern is taken
2349 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002350 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2351 '\' excluded: "/[ \-]" finds <Space> and '-'
2352 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002353 *cpo-/*
2354 / When "%" is used as the replacement string in a |:s|
2355 command, use the previous replacement string. |:s%|
2356 *cpo-{*
2357 { The |{| and |}| commands also stop at a "{" character
2358 at the start of a line.
2359 *cpo-.*
2360 . The ":chdir" and ":cd" commands fail if the current
2361 buffer is modified, unless ! is used. Vim doesn't
2362 need this, since it remembers the full path of an
2363 opened file.
2364 *cpo-bar*
2365 | The value of the $LINES and $COLUMNS environment
2366 variables overrule the terminal size values obtained
2367 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002371'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002373 {not in Vi}
2374 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002375 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002376 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002377 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002378 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002379 blowfish Blowfish method. Medium strong encryption but it has
2380 an implementation flaw. Requires Vim 7.3 or later,
2381 files can NOT be read by Vim 7.2 and older. This adds
2382 a "seed" to the file, every time you write the file
2383 the encrypted bytes will be different.
2384 *blowfish2*
2385 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002386 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002387 and older. This adds a "seed" to the file, every time
2388 you write the file the encrypted bytes will be
2389 different. The whole undo file is encrypted, not just
2390 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002391
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002392 You should use "blowfish2", also to re-encrypt older files.
2393
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002394 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002395 to the detected method of the file being read. Thus if you write it
2396 without changing 'cryptmethod' the same method will be used.
2397 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002398 explicitly write it, you don't get a warning unless there are other
2399 modifications. Also see |:X|.
2400
2401 When setting the global value to an empty string, it will end up with
2402 the value "zip". When setting the local value to an empty string the
2403 buffer will use the global value.
2404
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002405 When a new encryption method is added in a later version of Vim, and
2406 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002407 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002408
2409
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *'cscopepathcomp'* *'cspc'*
2411'cscopepathcomp' 'cspc' number (default 0)
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
2415 {not in Vi}
2416 Determines how many components of the path to show in a list of tags.
2417 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002418 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419
2420 *'cscopeprg'* *'csprg'*
2421'cscopeprg' 'csprg' string (default "cscope")
2422 global
2423 {not available when compiled without the |+cscope|
2424 feature}
2425 {not in Vi}
2426 Specifies the command to execute cscope. See |cscopeprg|.
2427 This option cannot be set from a |modeline| or in the |sandbox|, for
2428 security reasons.
2429
2430 *'cscopequickfix'* *'csqf'*
2431'cscopequickfix' 'csqf' string (default "")
2432 global
2433 {not available when compiled without the |+cscope|
2434 or |+quickfix| features}
2435 {not in Vi}
2436 Specifies whether to use quickfix window to show cscope results.
2437 See |cscopequickfix|.
2438
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002439 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002440'cscoperelative' 'csre' boolean (default off)
2441 global
2442 {not available when compiled without the |+cscope|
2443 feature}
2444 {not in Vi}
2445 In the absence of a prefix (-P) for cscope. setting this option enables
2446 to use the basename of cscope.out path as the prefix.
2447 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002448 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002449
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2451'cscopetag' 'cst' boolean (default off)
2452 global
2453 {not available when compiled without the |+cscope|
2454 feature}
2455 {not in Vi}
2456 Use cscope for tag commands. See |cscope-options|.
2457 NOTE: This option is reset when 'compatible' is set.
2458
2459 *'cscopetagorder'* *'csto'*
2460'cscopetagorder' 'csto' number (default 0)
2461 global
2462 {not available when compiled without the |+cscope|
2463 feature}
2464 {not in Vi}
2465 Determines the order in which ":cstag" performs a search. See
2466 |cscopetagorder|.
2467 NOTE: This option is set to 0 when 'compatible' is set.
2468
2469 *'cscopeverbose'* *'csverb'*
2470 *'nocscopeverbose'* *'nocsverb'*
2471'cscopeverbose' 'csverb' boolean (default off)
2472 global
2473 {not available when compiled without the |+cscope|
2474 feature}
2475 {not in Vi}
2476 Give messages when adding a cscope database. See |cscopeverbose|.
2477 NOTE: This option is reset when 'compatible' is set.
2478
Bram Moolenaar860cae12010-06-05 23:22:07 +02002479 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2480'cursorbind' 'crb' boolean (default off)
2481 local to window
2482 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002483 When this option is set, as the cursor in the current
2484 window moves other cursorbound windows (windows that also have
2485 this option set) move their cursors to the corresponding line and
2486 column. This option is useful for viewing the
2487 differences between two versions of a file (see 'diff'); in diff mode,
2488 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002489 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002490
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002491
2492 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2493'cursorcolumn' 'cuc' boolean (default off)
2494 local to window
2495 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002496 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002497 feature}
2498 Highlight the screen column of the cursor with CursorColumn
2499 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2500 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002501 If you only want the highlighting in the current window you can use
2502 these autocommands: >
2503 au WinLeave * set nocursorline nocursorcolumn
2504 au WinEnter * set cursorline cursorcolumn
2505<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002506
2507 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2508'cursorline' 'cul' boolean (default off)
2509 local to window
2510 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002511 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002512 feature}
2513 Highlight the screen line of the cursor with CursorLine
2514 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2515 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002516 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002517 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002518
2519
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 *'debug'*
2521'debug' string (default "")
2522 global
2523 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002524 These values can be used:
2525 msg Error messages that would otherwise be omitted will be given
2526 anyway.
2527 throw Error messages that would otherwise be omitted will be given
2528 anyway and also throw an exception and set |v:errmsg|.
2529 beep A message will be given when otherwise only a beep would be
2530 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002531 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002532 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2533 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534
2535 *'define'* *'def'*
2536'define' 'def' string (default "^\s*#\s*define")
2537 global or local to buffer |global-local|
2538 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 pattern, just like for the "/" command. This option is used for the
2541 commands like "[i" and "[d" |include-search|. The 'isident' option is
2542 used to recognize the defined name after the match:
2543 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2544 See |option-backslash| about inserting backslashes to include a space
2545 or backslash.
2546 The default value is for C programs. For C++ this value would be
2547 useful, to include const type declarations: >
2548 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2549< When using the ":set" command, you need to double the backslashes!
2550
2551 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2552'delcombine' 'deco' boolean (default off)
2553 global
2554 {not in Vi}
2555 {only available when compiled with the |+multi_byte|
2556 feature}
2557 If editing Unicode and this option is set, backspace and Normal mode
2558 "x" delete each combining character on its own. When it is off (the
2559 default) the character along with its combining characters are
2560 deleted.
2561 Note: When 'delcombine' is set "xx" may work different from "2x"!
2562
2563 This is useful for Arabic, Hebrew and many other languages where one
2564 may have combining characters overtop of base characters, and want
2565 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002566 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567
2568 *'dictionary'* *'dict'*
2569'dictionary' 'dict' string (default "")
2570 global or local to buffer |global-local|
2571 {not in Vi}
2572 List of file names, separated by commas, that are used to lookup words
2573 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2574 contain a list of words. This can be one word per line, or several
2575 words per line, separated by non-keyword characters (white space is
2576 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002577
2578 When this option is empty or an entry "spell" is present, and spell
2579 checking is enabled, words in the word lists for the currently active
2580 'spelllang' are used. See |spell|.
2581
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002582 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 after a comma are ignored, otherwise spaces are included in the file
2584 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002585 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 Where to find a list of words?
2587 - On FreeBSD, there is the file "/usr/share/dict/words".
2588 - In the Simtel archive, look in the "msdos/linguist" directory.
2589 - In "miscfiles" of the GNU collection.
2590 The use of |:set+=| and |:set-=| is preferred when adding or removing
2591 directories from the list. This avoids problems when a future version
2592 uses another default.
2593 Backticks cannot be used in this option for security reasons.
2594
2595 *'diff'* *'nodiff'*
2596'diff' boolean (default off)
2597 local to window
2598 {not in Vi}
2599 {not available when compiled without the |+diff|
2600 feature}
2601 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002602 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603
2604 *'dex'* *'diffexpr'*
2605'diffexpr' 'dex' string (default "")
2606 global
2607 {not in Vi}
2608 {not available when compiled without the |+diff|
2609 feature}
2610 Expression which is evaluated to obtain an ed-style diff file from two
2611 versions of a file. See |diff-diffexpr|.
2612 This option cannot be set from a |modeline| or in the |sandbox|, for
2613 security reasons.
2614
2615 *'dip'* *'diffopt'*
2616'diffopt' 'dip' string (default "filler")
2617 global
2618 {not in Vi}
2619 {not available when compiled without the |+diff|
2620 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 All are optional. Items must be separated by a comma.
2623
2624 filler Show filler lines, to keep the text
2625 synchronized with a window that has inserted
2626 lines at the same position. Mostly useful
2627 when windows are side-by-side and 'scrollbind'
2628 is set.
2629
2630 context:{n} Use a context of {n} lines between a change
2631 and a fold that contains unchanged lines.
2632 When omitted a context of six lines is used.
2633 See |fold-diff|.
2634
2635 icase Ignore changes in case of text. "a" and "A"
2636 are considered the same. Adds the "-i" flag
2637 to the "diff" command if 'diffexpr' is empty.
2638
2639 iwhite Ignore changes in amount of white space. Adds
2640 the "-b" flag to the "diff" command if
2641 'diffexpr' is empty. Check the documentation
2642 of the "diff" command for what this does
2643 exactly. It should ignore adding trailing
2644 white space, but not leading white space.
2645
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002646 horizontal Start diff mode with horizontal splits (unless
2647 explicitly specified otherwise).
2648
2649 vertical Start diff mode with vertical splits (unless
2650 explicitly specified otherwise).
2651
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002652 hiddenoff Do not use diff mode for a buffer when it
2653 becomes hidden.
2654
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002655 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2656 starting diff mode. Without this 2 is used.
2657
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 Examples: >
2659
2660 :set diffopt=filler,context:4
2661 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002662 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663<
2664 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2665'digraph' 'dg' boolean (default off)
2666 global
2667 {not in Vi}
2668 {not available when compiled without the |+digraphs|
2669 feature}
2670 Enable the entering of digraphs in Insert mode with {char1} <BS>
2671 {char2}. See |digraphs|.
2672 NOTE: This option is reset when 'compatible' is set.
2673
2674 *'directory'* *'dir'*
2675'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002676 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 for Unix: ".,~/tmp,/var/tmp,/tmp")
2678 global
2679 List of directory names for the swap file, separated with commas.
2680 - The swap file will be created in the first directory where this is
2681 possible.
2682 - Empty means that no swap file will be used (recovery is
2683 impossible!).
2684 - A directory "." means to put the swap file in the same directory as
2685 the edited file. On Unix, a dot is prepended to the file name, so
2686 it doesn't show in a directory listing. On MS-Windows the "hidden"
2687 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002688 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689 put the swap file relative to where the edited file is. The leading
2690 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002691 - For Unix and Win32, if a directory ends in two path separators "//",
2692 the swap file name will be built from the complete path to the file
2693 with all path separators substituted to percent '%' signs. This will
2694 ensure file name uniqueness in the preserve directory.
2695 On Win32, it is also possible to end with "\\". However, When a
2696 separating comma is following, you must use "//", since "\\" will
2697 include the comma in the file name. Therefore it is recommended to
2698 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 - Spaces after the comma are ignored, other spaces are considered part
2700 of the directory name. To have a space at the start of a directory
2701 name, precede it with a backslash.
2702 - To include a comma in a directory name precede it with a backslash.
2703 - A directory name may end in an ':' or '/'.
2704 - Environment variables are expanded |:set_env|.
2705 - Careful with '\' characters, type one before a space, type two to
2706 get one in the option (see |option-backslash|), for example: >
2707 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2708< - For backwards compatibility with Vim version 3.0 a '>' at the start
2709 of the option is removed.
2710 Using "." first in the list is recommended. This means that editing
2711 the same file twice will result in a warning. Using "/tmp" on Unix is
2712 discouraged: When the system crashes you lose the swap file.
2713 "/var/tmp" is often not cleared when rebooting, thus is a better
2714 choice than "/tmp". But it can contain a lot of files, your swap
2715 files get lost in the crowd. That is why a "tmp" directory in your
2716 home directory is tried first.
2717 The use of |:set+=| and |:set-=| is preferred when adding or removing
2718 directories from the list. This avoids problems when a future version
2719 uses another default.
2720 This option cannot be set from a |modeline| or in the |sandbox|, for
2721 security reasons.
2722 {Vi: directory to put temp file in, defaults to "/tmp"}
2723
2724 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002725'display' 'dy' string (default "", set to "truncate" in
2726 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 global
2728 {not in Vi}
2729 Change the way text is displayed. This is comma separated list of
2730 flags:
2731 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002732 in a window will be displayed. "@@@" is put in the
2733 last columns of the last screen line to indicate the
2734 rest of the line is not displayed.
2735 truncate Like "lastline", but "@@@" is displayed in the first
2736 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 uhex Show unprintable characters hexadecimal as <xx>
2738 instead of using ^C and ~C.
2739
Bram Moolenaard0796902016-09-16 20:02:31 +02002740 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002741 doesn't fit is replaced with "@" lines.
2742
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 *'eadirection'* *'ead'*
2744'eadirection' 'ead' string (default "both")
2745 global
2746 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002747 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 feature}
2749 Tells when the 'equalalways' option applies:
2750 ver vertically, width of windows is not affected
2751 hor horizontally, height of windows is not affected
2752 both width and height of windows is affected
2753
2754 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2755'edcompatible' 'ed' boolean (default off)
2756 global
2757 Makes the 'g' and 'c' flags of the ":substitute" command to be
2758 toggled each time the flag is given. See |complex-change|. See
2759 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002760 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761
Bram Moolenaar03413f42016-04-12 21:07:15 +02002762 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002763'emoji' 'emo' boolean (default: on)
2764 global
2765 {not in Vi}
2766 {only available when compiled with the |+multi_byte|
2767 feature}
2768 When on all Unicode emoji characters are considered to be full width.
2769
2770
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 *'encoding'* *'enc'* *E543*
2772'encoding' 'enc' string (default: "latin1" or value from $LANG)
2773 global
2774 {only available when compiled with the |+multi_byte|
2775 feature}
2776 {not in Vi}
2777 Sets the character encoding used inside Vim. It applies to text in
2778 the buffers, registers, Strings in expressions, text stored in the
2779 viminfo file, etc. It sets the kind of characters which Vim can work
2780 with. See |encoding-names| for the possible values.
2781
2782 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002783 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002785 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786
Bram Moolenaar865242e2010-07-14 21:12:05 +02002787 This option cannot be set from a |modeline|. It would most likely
2788 corrupt the text.
2789
Bram Moolenaar3df01732017-02-17 22:47:16 +01002790 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2791 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 'encoding', "utf-8" is the natural choice for the environment and
2793 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002794 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 versions, and to avoid changing the encoding of newly created files
2796 without your knowledge (in case 'fileencodings' is empty).
2797
2798 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 iconv() or as specified with 'charconvert'.
2801
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002802 If you need to know whether 'encoding' is a multi-byte encoding, you
2803 can use: >
2804 if has("multi_byte_encoding")
2805<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 Normally 'encoding' will be equal to your current locale. This will
2807 be the default if Vim recognizes your environment settings. If
2808 'encoding' is not set to the current locale, 'termencoding' must be
2809 set to convert typed and displayed text. See |encoding-table|.
2810
2811 When you set this option, it fires the |EncodingChanged| autocommand
2812 event so that you can set up fonts if necessary.
2813
2814 When the option is set, the value is converted to lowercase. Thus
2815 you can set it with uppercase values too. Underscores are translated
2816 to '-' signs.
2817 When the encoding is recognized, it is changed to the standard name.
2818 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2819 "iso-8859-2" and "utf8" becomes "utf-8".
2820
2821 Note: "latin1" is also used when the encoding could not be detected.
2822 This only works when editing files in the same encoding! When the
2823 actual character set is not latin1, make sure 'fileencoding' and
2824 'fileencodings' are empty. When conversion is needed, switch to using
2825 utf-8.
2826
2827 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2828 You don't notice this while editing, but it does matter for the
2829 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2830 setting 'encoding' to one of these values instead of utf-8 only has
2831 effect for encoding used for files when 'fileencoding' is empty.
2832
Bram Moolenaar661b1822005-07-28 22:36:45 +00002833 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2834 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835
2836 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2837'endofline' 'eol' boolean (default on)
2838 local to buffer
2839 {not in Vi}
2840 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002841 is on, or 'fixeol' option is off, no <EOL> will be written for the
2842 last line in the file. This option is automatically set or reset when
2843 starting to edit a new file, depending on whether file has an <EOL>
2844 for the last line in the file. Normally you don't have to set or
2845 reset this option.
2846 When 'binary' is off and 'fixeol' is on the value is not used when
2847 writing the file. When 'binary' is on or 'fixeol' is off it is used
2848 to remember the presence of a <EOL> for the last line in the file, so
2849 that when you write the file the situation from the original file can
2850 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851
2852 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2853'equalalways' 'ea' boolean (default on)
2854 global
2855 {not in Vi}
2856 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002857 splitting or closing a window. This also happens the moment the
2858 option is switched on. When off, splitting a window will reduce the
2859 size of the current window and leave the other windows the same. When
2860 closing a window the extra lines are given to the window next to it
2861 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 When mixing vertically and horizontally split windows, a minimal size
2863 is computed and some windows may be larger if there is room. The
2864 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002865 Changing the height and width of a window can be avoided by setting
2866 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002867 If a window size is specified when creating a new window sizes are
2868 currently not equalized (it's complicated, but may be implemented in
2869 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870
2871 *'equalprg'* *'ep'*
2872'equalprg' 'ep' string (default "")
2873 global or local to buffer |global-local|
2874 {not in Vi}
2875 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002876 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002877 or 'indentexpr'. When Vim was compiled without internal formatting,
2878 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002879 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 about including spaces and backslashes.
2881 This option cannot be set from a |modeline| or in the |sandbox|, for
2882 security reasons.
2883
2884 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2885'errorbells' 'eb' boolean (default off)
2886 global
2887 Ring the bell (beep or screen flash) for error messages. This only
2888 makes a difference for error messages, the bell will be used always
2889 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002891 screen flash or do nothing. See 'belloff' to finetune when to ring the
2892 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893
2894 *'errorfile'* *'ef'*
2895'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2896 others: "errors.err")
2897 global
2898 {not in Vi}
2899 {not available when compiled without the |+quickfix|
2900 feature}
2901 Name of the errorfile for the QuickFix mode (see |:cf|).
2902 When the "-q" command-line argument is used, 'errorfile' is set to the
2903 following argument. See |-q|.
2904 NOT used for the ":make" command. See 'makeef' for that.
2905 Environment variables are expanded |:set_env|.
2906 See |option-backslash| about including spaces and backslashes.
2907 This option cannot be set from a |modeline| or in the |sandbox|, for
2908 security reasons.
2909
2910 *'errorformat'* *'efm'*
2911'errorformat' 'efm' string (default is very long)
2912 global or local to buffer |global-local|
2913 {not in Vi}
2914 {not available when compiled without the |+quickfix|
2915 feature}
2916 Scanf-like description of the format for the lines in the error file
2917 (see |errorformat|).
2918
2919 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2920'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2921 global
2922 {not in Vi}
2923 Function keys that start with an <Esc> are recognized in Insert
2924 mode. When this option is off, the cursor and function keys cannot be
2925 used in Insert mode if they start with an <Esc>. The advantage of
2926 this is that the single <Esc> is recognized immediately, instead of
2927 after one second. Instead of resetting this option, you might want to
2928 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2929 when 'esckeys' is off, you can still map anything, but the cursor keys
2930 won't work by default.
2931 NOTE: This option is set to the Vi default value when 'compatible' is
2932 set and to the Vim default value when 'compatible' is reset.
2933
2934 *'eventignore'* *'ei'*
2935'eventignore' 'ei' string (default "")
2936 global
2937 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002939 When set to "all" or when "all" is one of the items, all autocommand
2940 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 Otherwise this is a comma separated list of event names. Example: >
2942 :set ei=WinEnter,WinLeave
2943<
2944 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2945'expandtab' 'et' boolean (default off)
2946 local to buffer
2947 {not in Vi}
2948 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2951 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002952 This option is reset when the 'paste' option is set and restored when
2953 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 NOTE: This option is reset when 'compatible' is set.
2955
2956 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2957'exrc' 'ex' boolean (default off)
2958 global
2959 {not in Vi}
2960 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002961 directory.
2962
2963 Setting this option is a potential security leak. E.g., consider
2964 unpacking a package or fetching files from github, a .vimrc in there
2965 might be a trojan horse. BETTER NOT SET THIS OPTION!
2966 Instead, define an autocommand in your .vimrc to set options for a
2967 matching directory.
2968
2969 If you do switch this option on you should also consider setting the
2970 'secure' option (see |initialization|).
2971 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 This option cannot be set from a |modeline| or in the |sandbox|, for
2973 security reasons.
2974
2975 *'fileencoding'* *'fenc'* *E213*
2976'fileencoding' 'fenc' string (default: "")
2977 local to buffer
2978 {only available when compiled with the |+multi_byte|
2979 feature}
2980 {not in Vi}
2981 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002982
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002984 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 When 'fileencoding' is empty, the same value as 'encoding' will be
2986 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002987 No error will be given when the value is set, only when it is used,
2988 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002989 Conversion will also be done when 'encoding' and 'fileencoding' are
2990 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2991 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002993 'encoding' is "utf-8" or another Unicode encoding, conversion
2994 is most likely done in a way that the reverse conversion
2995 results in the same text. When 'encoding' is not "utf-8" some
2996 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002997
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 See 'encoding' for the possible values. Additionally, values may be
2999 specified that can be handled by the converter, see
3000 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003001
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 When reading a file 'fileencoding' will be set from 'fileencodings'.
3003 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003004 'fileencoding', use the |++enc| argument. One exception: when
3005 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003006 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003007
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3009 When the option is set, the value is converted to lowercase. Thus
3010 you can set it with uppercase values too. '_' characters are
3011 replaced with '-'. If a name is recognized from the list for
3012 'encoding', it is replaced by the standard name. For example
3013 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003014
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 When this option is set, after starting to edit a file, the 'modified'
3016 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003017
3018 Keep in mind that changing 'fenc' from a modeline happens
3019 AFTER the text has been read, thus it applies to when the file will be
3020 written. If you do set 'fenc' in a modeline, you might want to set
3021 'nomodified' to avoid not being able to ":q".
3022
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 This option can not be changed when 'modifiable' is off.
3024
3025 *'fe'*
3026 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003027 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 old short name was 'fe', which is no longer used.
3029
3030 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003031'fileencodings' 'fencs' string (default: "ucs-bom",
3032 "ucs-bom,utf-8,default,latin1" when
3033 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 global
3035 {only available when compiled with the |+multi_byte|
3036 feature}
3037 {not in Vi}
3038 This is a list of character encodings considered when starting to edit
3039 an existing file. When a file is read, Vim tries to use the first
3040 mentioned character encoding. If an error is detected, the next one
3041 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003042 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 an empty string, which means the value of 'encoding' is used.
3044 WARNING: Conversion can cause loss of information! When
3045 'encoding' is "utf-8" (or one of the other Unicode variants)
3046 conversion is most likely done in a way that the reverse
3047 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003048 "utf-8" some non-ASCII characters may be lost! You can use
3049 the |++bad| argument to specify what is done with characters
3050 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 For an empty file or a file with only ASCII characters most encodings
3052 will work and the first entry of 'fileencodings' will be used (except
3053 "ucs-bom", which requires the BOM to be present). If you prefer
3054 another encoding use an BufReadPost autocommand event to test if your
3055 preferred encoding is to be used. Example: >
3056 au BufReadPost * if search('\S', 'w') == 0 |
3057 \ set fenc=iso-2022-jp | endif
3058< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3059 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003060 When the |++enc| argument is used then the value of 'fileencodings' is
3061 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003062 Note that 'fileencodings' is not used for a new file, the global value
3063 of 'fileencoding' is used instead. You can set it with: >
3064 :setglobal fenc=iso-8859-2
3065< This means that a non-existing file may get a different encoding than
3066 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 The special value "ucs-bom" can be used to check for a Unicode BOM
3068 (Byte Order Mark) at the start of the file. It must not be preceded
3069 by "utf-8" or another Unicode encoding for this to work properly.
3070 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3071 because Vim cannot detect an error, thus the encoding is always
3072 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003073 The special value "default" can be used for the encoding from the
3074 environment. This is the default value for 'encoding'. It is useful
3075 when 'encoding' is set to "utf-8" and your environment uses a
3076 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003077 When 'encoding' is "utf-8" and a file contains an illegal byte
3078 sequence it won't be recognized as UTF-8. You can use the |8g8|
3079 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 WRONG VALUES: WHAT'S WRONG:
3081 latin1,utf-8 "latin1" will always be used
3082 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3083 file
3084 cp1250,latin1 "cp1250" will always be used
3085 If 'fileencodings' is empty, 'fileencoding' is not modified.
3086 See 'fileencoding' for the possible values.
3087 Setting this option does not have an effect until the next time a file
3088 is read.
3089
3090 *'fileformat'* *'ff'*
3091'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3092 Unix default: "unix",
3093 Macintosh default: "mac")
3094 local to buffer
3095 {not in Vi}
3096 This gives the <EOL> of the current buffer, which is used for
3097 reading/writing the buffer from/to a file:
3098 dos <CR> <NL>
3099 unix <NL>
3100 mac <CR>
3101 When "dos" is used, CTRL-Z at the end of a file is ignored.
3102 See |file-formats| and |file-read|.
3103 For the character encoding of the file see 'fileencoding'.
3104 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003105 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 This option is set automatically when starting to edit a file and
3107 'fileformats' is not empty and 'binary' is off.
3108 When this option is set, after starting to edit a file, the 'modified'
3109 option is set, because the file would be different when written.
3110 This option can not be changed when 'modifiable' is off.
3111 For backwards compatibility: When this option is set to "dos",
3112 'textmode' is set, otherwise 'textmode' is reset.
3113
3114 *'fileformats'* *'ffs'*
3115'fileformats' 'ffs' string (default:
3116 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3117 Vim Unix: "unix,dos",
3118 Vim Mac: "mac,unix,dos",
3119 Vi Cygwin: "unix,dos",
3120 Vi others: "")
3121 global
3122 {not in Vi}
3123 This gives the end-of-line (<EOL>) formats that will be tried when
3124 starting to edit a new buffer and when reading a file into an existing
3125 buffer:
3126 - When empty, the format defined with 'fileformat' will be used
3127 always. It is not set automatically.
3128 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003129 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 'fileformats' name will be used when a file is read into an existing
3131 buffer, no matter what 'fileformat' for that buffer is set to.
3132 - When more than one name is present, separated by commas, automatic
3133 <EOL> detection will be done when reading a file. When starting to
3134 edit a file, a check is done for the <EOL>:
3135 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3136 'fileformat' is set to "dos".
3137 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003138 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003140 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3141 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003142 This means that "mac" is only chosen when:
3143 "unix" is not present or no <NL> is found in the file, and
3144 "dos" is not present or no <CR><NL> is found in the file.
3145 Except: if "unix" was chosen, but there is a <CR> before
3146 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003147 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 4. If 'fileformat' is still not set, the first name from
3149 'fileformats' is used.
3150 When reading a file into an existing buffer, the same is done, but
3151 this happens like 'fileformat' has been set appropriately for that
3152 file only, the option is not changed.
3153 When 'binary' is set, the value of 'fileformats' is not used.
3154
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003155 When Vim starts up with an empty buffer the first item is used. You
3156 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3159 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3160 done:
3161 - When 'fileformats' is empty, there is no automatic detection. Dos
3162 format will be used.
3163 - When 'fileformats' is set to one or more names, automatic detection
3164 is done. This is based on the first <NL> in the file: If there is a
3165 <CR> in front of it, Dos format is used, otherwise Unix format is
3166 used.
3167 Also see |file-formats|.
3168 For backwards compatibility: When this option is set to an empty
3169 string or one format (no comma is included), 'textauto' is reset,
3170 otherwise 'textauto' is set.
3171 NOTE: This option is set to the Vi default value when 'compatible' is
3172 set and to the Vim default value when 'compatible' is reset.
3173
Bram Moolenaarbf884932013-04-05 22:26:15 +02003174 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3175'fileignorecase' 'fic' boolean (default on for systems where case in file
3176 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003177 global
3178 {not in Vi}
3179 When set case is ignored when using file names and directories.
3180 See 'wildignorecase' for only ignoring case when doing completion.
3181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 *'filetype'* *'ft'*
3183'filetype' 'ft' string (default: "")
3184 local to buffer
3185 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 When this option is set, the FileType autocommand event is triggered.
3187 All autocommands that match with the value of this option will be
3188 executed. Thus the value of 'filetype' is used in place of the file
3189 name.
3190 Otherwise this option does not always reflect the current file type.
3191 This option is normally set when the file type is detected. To enable
3192 this use the ":filetype on" command. |:filetype|
3193 Setting this option to a different value is most useful in a modeline,
3194 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003195 Example, for in an IDL file:
3196 /* vim: set filetype=idl : */ ~
3197 |FileType| |filetypes|
3198 When a dot appears in the value then this separates two filetype
3199 names. Example:
3200 /* vim: set filetype=c.doxygen : */ ~
3201 This will use the "c" filetype first, then the "doxygen" filetype.
3202 This works both for filetype plugins and for syntax files. More than
3203 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 This option is not copied to another buffer, independent of the 's' or
3205 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003206 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207
3208 *'fillchars'* *'fcs'*
3209'fillchars' 'fcs' string (default "vert:|,fold:-")
3210 global
3211 {not in Vi}
3212 {not available when compiled without the |+windows|
3213 and |+folding| features}
3214 Characters to fill the statuslines and vertical separators.
3215 It is a comma separated list of items:
3216
3217 item default Used for ~
3218 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003219 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 vert:c '|' vertical separators |:vsplit|
3221 fold:c '-' filling 'foldtext'
3222 diff:c '-' deleted lines of the 'diff' option
3223
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003224 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003225 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 otherwise.
3227
3228 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003229 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230< This is similar to the default, except that these characters will also
3231 be used when there is highlighting.
3232
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003233 for "stl" and "stlnc" only single-byte values are supported.
3234
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 The highlighting used for these items:
3236 item highlight group ~
3237 stl:c StatusLine |hl-StatusLine|
3238 stlnc:c StatusLineNC |hl-StatusLineNC|
3239 vert:c VertSplit |hl-VertSplit|
3240 fold:c Folded |hl-Folded|
3241 diff:c DiffDelete |hl-DiffDelete|
3242
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003243 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3244'fixendofline' 'fixeol' boolean (default on)
3245 local to buffer
3246 {not in Vi}
3247 When writing a file and this option is on, <EOL> at the end of file
3248 will be restored if missing. Turn this option off if you want to
3249 preserve the situation from the original file.
3250 When the 'binary' option is set the value of this option doesn't
3251 matter.
3252 See the 'endofline' option.
3253
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3255'fkmap' 'fk' boolean (default off) *E198*
3256 global
3257 {not in Vi}
3258 {only available when compiled with the |+rightleft|
3259 feature}
3260 When on, the keyboard is mapped for the Farsi character set.
3261 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263
3264 *'foldclose'* *'fcl'*
3265'foldclose' 'fcl' string (default "")
3266 global
3267 {not in Vi}
3268 {not available when compiled without the |+folding|
3269 feature}
3270 When set to "all", a fold is closed when the cursor isn't in it and
3271 its level is higher than 'foldlevel'. Useful if you want folds to
3272 automatically close when moving out of them.
3273
3274 *'foldcolumn'* *'fdc'*
3275'foldcolumn' 'fdc' number (default 0)
3276 local to window
3277 {not in Vi}
3278 {not available when compiled without the |+folding|
3279 feature}
3280 When non-zero, a column with the specified width is shown at the side
3281 of the window which indicates open and closed folds. The maximum
3282 value is 12.
3283 See |folding|.
3284
3285 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3286'foldenable' 'fen' boolean (default on)
3287 local to window
3288 {not in Vi}
3289 {not available when compiled without the |+folding|
3290 feature}
3291 When off, all folds are open. This option can be used to quickly
3292 switch between showing all text unfolded and viewing the text with
3293 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003294 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 'foldenable' is off.
3296 This option is set by commands that create a new fold or close a fold.
3297 See |folding|.
3298
3299 *'foldexpr'* *'fde'*
3300'foldexpr' 'fde' string (default: "0")
3301 local to window
3302 {not in Vi}
3303 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003304 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003306 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003307
Bram Moolenaar30b65812012-07-12 22:01:11 +02003308 The expression will be evaluated in the |sandbox| if set from a
3309 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003310 This option can't be set from a |modeline| when the 'diff' option is
3311 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003312
3313 It is not allowed to change text or jump to another window while
3314 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315
3316 *'foldignore'* *'fdi'*
3317'foldignore' 'fdi' string (default: "#")
3318 local to window
3319 {not in Vi}
3320 {not available when compiled without the |+folding|
3321 feature}
3322 Used only when 'foldmethod' is "indent". Lines starting with
3323 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003324 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 The default "#" works well for C programs. See |fold-indent|.
3326
3327 *'foldlevel'* *'fdl'*
3328'foldlevel' 'fdl' number (default: 0)
3329 local to window
3330 {not in Vi}
3331 {not available when compiled without the |+folding|
3332 feature}
3333 Sets the fold level: Folds with a higher level will be closed.
3334 Setting this option to zero will close all folds. Higher numbers will
3335 close fewer folds.
3336 This option is set by commands like |zm|, |zM| and |zR|.
3337 See |fold-foldlevel|.
3338
3339 *'foldlevelstart'* *'fdls'*
3340'foldlevelstart' 'fdls' number (default: -1)
3341 global
3342 {not in Vi}
3343 {not available when compiled without the |+folding|
3344 feature}
3345 Sets 'foldlevel' when starting to edit another buffer in a window.
3346 Useful to always start editing with all folds closed (value zero),
3347 some folds closed (one) or no folds closed (99).
3348 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003349 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 ignores this option and closes all folds.
3351 It is also done before BufReadPre autocommands, to allow an autocmd to
3352 overrule the 'foldlevel' value for specific files.
3353 When the value is negative, it is not used.
3354
3355 *'foldmarker'* *'fmr'* *E536*
3356'foldmarker' 'fmr' string (default: "{{{,}}}")
3357 local to window
3358 {not in Vi}
3359 {not available when compiled without the |+folding|
3360 feature}
3361 The start and end marker used when 'foldmethod' is "marker". There
3362 must be one comma, which separates the start and end marker. The
3363 marker is a literal string (a regular expression would be too slow).
3364 See |fold-marker|.
3365
3366 *'foldmethod'* *'fdm'*
3367'foldmethod' 'fdm' string (default: "manual")
3368 local to window
3369 {not in Vi}
3370 {not available when compiled without the |+folding|
3371 feature}
3372 The kind of folding used for the current window. Possible values:
3373 |fold-manual| manual Folds are created manually.
3374 |fold-indent| indent Lines with equal indent form a fold.
3375 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3376 |fold-marker| marker Markers are used to specify folds.
3377 |fold-syntax| syntax Syntax highlighting items specify folds.
3378 |fold-diff| diff Fold text that is not changed.
3379
3380 *'foldminlines'* *'fml'*
3381'foldminlines' 'fml' number (default: 1)
3382 local to window
3383 {not in Vi}
3384 {not available when compiled without the |+folding|
3385 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003386 Sets the number of screen lines above which a fold can be displayed
3387 closed. Also for manually closed folds. With the default value of
3388 one a fold can only be closed if it takes up two or more screen lines.
3389 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003390 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 "zc" to close a fold, which is displayed open because it's smaller
3392 than 'foldminlines', a following "zc" may close a containing fold.
3393
3394 *'foldnestmax'* *'fdn'*
3395'foldnestmax' 'fdn' number (default: 20)
3396 local to window
3397 {not in Vi}
3398 {not available when compiled without the |+folding|
3399 feature}
3400 Sets the maximum nesting of folds for the "indent" and "syntax"
3401 methods. This avoids that too many folds will be created. Using more
3402 than 20 doesn't work, because the internal limit is 20.
3403
3404 *'foldopen'* *'fdo'*
3405'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3406 search,tag,undo")
3407 global
3408 {not in Vi}
3409 {not available when compiled without the |+folding|
3410 feature}
3411 Specifies for which type of commands folds will be opened, if the
3412 command moves the cursor into a closed fold. It is a comma separated
3413 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003414 NOTE: When the command is part of a mapping this option is not used.
3415 Add the |zv| command to the mapping to get the same effect.
3416 (rationale: the mapping may want to control opening folds itself)
3417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 item commands ~
3419 all any
3420 block "(", "{", "[[", "[{", etc.
3421 hor horizontal movements: "l", "w", "fx", etc.
3422 insert any command in Insert mode
3423 jump far jumps: "G", "gg", etc.
3424 mark jumping to a mark: "'m", CTRL-O, etc.
3425 percent "%"
3426 quickfix ":cn", ":crew", ":make", etc.
3427 search search for a pattern: "/", "n", "*", "gd", etc.
3428 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003429 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 tag jumping to a tag: ":ta", CTRL-T, etc.
3431 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 When a movement command is used for an operator (e.g., "dl" or "y%")
3433 this option is not used. This means the operator will include the
3434 whole closed fold.
3435 Note that vertical movements are not here, because it would make it
3436 very difficult to move onto a closed fold.
3437 In insert mode the folds containing the cursor will always be open
3438 when text is inserted.
3439 To close folds you can re-apply 'foldlevel' with the |zx| command or
3440 set the 'foldclose' option to "all".
3441
3442 *'foldtext'* *'fdt'*
3443'foldtext' 'fdt' string (default: "foldtext()")
3444 local to window
3445 {not in Vi}
3446 {not available when compiled without the |+folding|
3447 feature}
3448 An expression which is used to specify the text displayed for a closed
3449 fold. See |fold-foldtext|.
3450
Bram Moolenaar30b65812012-07-12 22:01:11 +02003451 The expression will be evaluated in the |sandbox| if set from a
3452 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003453
3454 It is not allowed to change text or jump to another window while
3455 evaluating 'foldtext' |textlock|.
3456
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003457 *'formatexpr'* *'fex'*
3458'formatexpr' 'fex' string (default "")
3459 local to buffer
3460 {not in Vi}
3461 {not available when compiled without the |+eval|
3462 feature}
3463 Expression which is evaluated to format a range of lines for the |gq|
3464 operator or automatic formatting (see 'formatoptions'). When this
3465 option is empty 'formatprg' is used.
3466
3467 The |v:lnum| variable holds the first line to be formatted.
3468 The |v:count| variable holds the number of lines to be formatted.
3469 The |v:char| variable holds the character that is going to be
3470 inserted if the expression is being evaluated due to
3471 automatic formatting. This can be empty. Don't insert
3472 it yet!
3473
3474 Example: >
3475 :set formatexpr=mylang#Format()
3476< This will invoke the mylang#Format() function in the
3477 autoload/mylang.vim file in 'runtimepath'. |autoload|
3478
3479 The expression is also evaluated when 'textwidth' is set and adding
3480 text beyond that limit. This happens under the same conditions as
3481 when internal formatting is used. Make sure the cursor is kept in the
3482 same spot relative to the text then! The |mode()| function will
3483 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003484
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003485 When the expression evaluates to non-zero Vim will fall back to using
3486 the internal format mechanism.
3487
3488 The expression will be evaluated in the |sandbox| when set from a
3489 modeline, see |sandbox-option|. That stops the option from working,
3490 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003491 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003492
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 *'formatoptions'* *'fo'*
3494'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3495 local to buffer
3496 {not in Vi}
3497 This is a sequence of letters which describes how automatic
3498 formatting is to be done. See |fo-table|. When the 'paste' option is
3499 on, no formatting is done (like 'formatoptions' is empty). Commas can
3500 be inserted for readability.
3501 To avoid problems with flags that are added in the future, use the
3502 "+=" and "-=" feature of ":set" |add-option-flags|.
3503 NOTE: This option is set to the Vi default value when 'compatible' is
3504 set and to the Vim default value when 'compatible' is reset.
3505
Bram Moolenaar86b68352004-12-27 21:59:20 +00003506 *'formatlistpat'* *'flp'*
3507'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3508 local to buffer
3509 {not in Vi}
3510 A pattern that is used to recognize a list header. This is used for
3511 the "n" flag in 'formatoptions'.
3512 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003513 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003514 while still checking more characters. There must be a character
3515 following the pattern, when it matches the whole line it is handled
3516 like there is no match.
3517 The default recognizes a number, followed by an optional punctuation
3518 character and white space.
3519
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 *'formatprg'* *'fp'*
3521'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003522 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 {not in Vi}
3524 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003525 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003527 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003528 If the 'formatexpr' option is not empty it will be used instead.
3529 Otherwise, if 'formatprg' option is an empty string, the internal
3530 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003531 Environment variables are expanded |:set_env|. See |option-backslash|
3532 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003533 This option cannot be set from a |modeline| or in the |sandbox|, for
3534 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
Bram Moolenaard94464e2015-11-02 15:28:18 +01003536 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003537'fsync' 'fs' boolean (default on)
3538 global
3539 {not in Vi}
3540 When on, the library function fsync() will be called after writing a
3541 file. This will flush a file to disk, ensuring that it is safely
3542 written even on filesystems which do metadata-only journaling. This
3543 will force the harddrive to spin up on Linux systems running in laptop
3544 mode, so it may be undesirable in some situations. Be warned that
3545 turning this off increases the chances of data loss after a crash. On
3546 systems without an fsync() implementation, this variable is always
3547 off.
3548 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003549 'fsync' also applies to |writefile()|, unless a flag is used to
3550 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003551
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3553'gdefault' 'gd' boolean (default off)
3554 global
3555 {not in Vi}
3556 When on, the ":substitute" flag 'g' is default on. This means that
3557 all matches in a line are substituted instead of one. When a 'g' flag
3558 is given to a ":substitute" command, this will toggle the substitution
3559 of all or one match. See |complex-change|.
3560
3561 command 'gdefault' on 'gdefault' off ~
3562 :s/// subst. all subst. one
3563 :s///g subst. one subst. all
3564 :s///gg subst. all subst. one
3565
3566 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003567 DEPRECATED: Setting this option may break plugins that are not aware
3568 of this option. Also, many users get confused that adding the /g flag
3569 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570
3571 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003572'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 global
3574 {not in Vi}
3575 Format to recognize for the ":grep" command output.
3576 This is a scanf-like string that uses the same format as the
3577 'errorformat' option: see |errorformat|.
3578
3579 *'grepprg'* *'gp'*
3580'grepprg' 'gp' string (default "grep -n ",
3581 Unix: "grep -n $* /dev/null",
3582 Win32: "findstr /n" or "grep -n",
3583 VMS: "SEARCH/NUMBERS ")
3584 global or local to buffer |global-local|
3585 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003586 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 and '#' characters, which are expanded like when used in a command-
3588 line. The placeholder "$*" is allowed to specify where the arguments
3589 will be included. Environment variables are expanded |:set_env|. See
3590 |option-backslash| about including spaces and backslashes.
3591 When your "grep" accepts the "-H" argument, use this to make ":grep"
3592 also work well with a single file: >
3593 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003594< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003595 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3596 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003597 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 apply equally to 'grepprg'.
3599 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3600 otherwise it's "grep -n".
3601 This option cannot be set from a |modeline| or in the |sandbox|, for
3602 security reasons.
3603
3604 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3605'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3606 ve:ver35-Cursor,
3607 o:hor50-Cursor,
3608 i-ci:ver25-Cursor/lCursor,
3609 r-cr:hor20-Cursor/lCursor,
3610 sm:block-Cursor
3611 -blinkwait175-blinkoff150-blinkon175",
3612 for MS-DOS and Win32 console:
3613 "n-v-c:block,o:hor50,i-ci:hor15,
3614 r-cr:hor30,sm:block")
3615 global
3616 {not in Vi}
3617 {only available when compiled with GUI enabled, and
3618 for MS-DOS and Win32 console}
3619 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003620 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 the height of the cursor can be changed. This can be done by
3622 specifying a block cursor, or a percentage for a vertical or
3623 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003624 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3625 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003627 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 mode-list and an argument-list:
3629 mode-list:argument-list,mode-list:argument-list,..
3630 The mode-list is a dash separated list of these modes:
3631 n Normal mode
3632 v Visual mode
3633 ve Visual mode with 'selection' "exclusive" (same as 'v',
3634 if not specified)
3635 o Operator-pending mode
3636 i Insert mode
3637 r Replace mode
3638 c Command-line Normal (append) mode
3639 ci Command-line Insert mode
3640 cr Command-line Replace mode
3641 sm showmatch in Insert mode
3642 a all modes
3643 The argument-list is a dash separated list of these arguments:
3644 hor{N} horizontal bar, {N} percent of the character height
3645 ver{N} vertical bar, {N} percent of the character width
3646 block block cursor, fills the whole character
3647 [only one of the above three should be present]
3648 blinkwait{N} *cursor-blinking*
3649 blinkon{N}
3650 blinkoff{N}
3651 blink times for cursor: blinkwait is the delay before
3652 the cursor starts blinking, blinkon is the time that
3653 the cursor is shown and blinkoff is the time that the
3654 cursor is not shown. The times are in msec. When one
3655 of the numbers is zero, there is no blinking. The
3656 default is: "blinkwait700-blinkon400-blinkoff250".
3657 These numbers are used for a missing entry. This
3658 means that blinking is enabled by default. To switch
3659 blinking off you can use "blinkon0". The cursor only
3660 blinks when Vim is waiting for input, not while
3661 executing a command.
3662 To make the cursor blink in an xterm, see
3663 |xterm-blink|.
3664 {group-name}
3665 a highlight group name, that sets the color and font
3666 for the cursor
3667 {group-name}/{group-name}
3668 Two highlight group names, the first is used when
3669 no language mappings are used, the other when they
3670 are. |language-mapping|
3671
3672 Examples of parts:
3673 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3674 block cursor with colors from the "nCursor"
3675 highlight group
3676 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3677 In Insert and Command-line Insert mode, use a
3678 30% vertical bar cursor with colors from the
3679 "iCursor" highlight group. Blink a bit
3680 faster.
3681
3682 The 'a' mode is different. It will set the given argument-list for
3683 all modes. It does not reset anything to defaults. This can be used
3684 to do a common setting for all modes. For example, to switch off
3685 blinking: "a:blinkon0"
3686
3687 Examples of cursor highlighting: >
3688 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3689 :highlight Cursor gui=NONE guifg=bg guibg=fg
3690<
3691 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003692 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693'guifont' 'gfn' string (default "")
3694 global
3695 {not in Vi}
3696 {only available when compiled with GUI enabled}
3697 This is a list of fonts which will be used for the GUI version of Vim.
3698 In its simplest form the value is just one font name. When
3699 the font cannot be found you will get an error message. To try other
3700 font names a list can be specified, font names separated with commas.
3701 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003702
Bram Moolenaar05159a02005-02-26 23:04:13 +00003703 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3704 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003705
Bram Moolenaar3df01732017-02-17 22:47:16 +01003706 Note: As to the GTK GUIs, no error is given against any invalid names,
3707 and the first element of the list is always picked up and made use of.
3708 This is because, instead of identifying a given name with a font, the
3709 GTK GUIs use it to construct a pattern and try to look up a font which
3710 best matches the pattern among available fonts, and this way, the
3711 matching never fails. An invalid name doesn't matter because a number
3712 of font properties other than name will do to get the matching done.
3713
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 Spaces after a comma are ignored. To include a comma in a font name
3715 precede it with a backslash. Setting an option requires an extra
3716 backslash before a space and a backslash. See also
3717 |option-backslash|. For example: >
3718 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003719< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003721
3722 If none of the fonts can be loaded, Vim will keep the current setting.
3723 If an empty font list is given, Vim will try using other resource
3724 settings (for X, it will use the Vim.font resource), and finally it
3725 will try some builtin default which should always be there ("7x13" in
3726 the case of X). The font names given should be "normal" fonts. Vim
3727 will try to find the related bold and italic fonts.
3728
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003729 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003730 :set guifont=*
3731< will bring up a font requester, where you can pick the font you want.
3732
3733 The font name depends on the GUI used. See |setting-guifont| for a
3734 way to set 'guifont' for various systems.
3735
Bram Moolenaar3df01732017-02-17 22:47:16 +01003736 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003738< That's all. XLFDs are not used. For Chinese this is reported to work
3739 well: >
3740 if has("gui_gtk2")
3741 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3742 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3743 endif
3744<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003745 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3746
Bram Moolenaar05159a02005-02-26 23:04:13 +00003747 For Mac OSX you can use something like this: >
3748 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003749< Also see 'macatsui', it can help fix display problems.
3750 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003752 width). An exception is GTK: all fonts are accepted, but mono-spaced
3753 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003754
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 To preview a font on X11, you might be able to use the "xfontsel"
3756 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003757
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 For the Win32 GUI *E244* *E245*
3759 - takes these options in the font name:
3760 hXX - height is XX (points, can be floating-point)
3761 wXX - width is XX (points, can be floating-point)
3762 b - bold
3763 i - italic
3764 u - underline
3765 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003766 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3768 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3769 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003770 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003771 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003772 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003773 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003774 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775
3776 Use a ':' to separate the options.
3777 - A '_' can be used in the place of a space, so you don't need to use
3778 backslashes to escape the spaces.
3779 - Examples: >
3780 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3781 :set guifont=Andale_Mono:h7.5:w4.5
3782< See also |font-sizes|.
3783
3784 *'guifontset'* *'gfs'*
3785 *E250* *E252* *E234* *E597* *E598*
3786'guifontset' 'gfs' string (default "")
3787 global
3788 {not in Vi}
3789 {only available when compiled with GUI enabled and
3790 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003791 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 When not empty, specifies two (or more) fonts to be used. The first
3793 one for normal English, the second one for your special language. See
3794 |xfontset|.
3795 Setting this option also means that all font names will be handled as
3796 a fontset name. Also the ones used for the "font" argument of the
3797 |:highlight| command.
3798 The fonts must match with the current locale. If fonts for the
3799 character sets that the current locale uses are not included, setting
3800 'guifontset' will fail.
3801 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3802 the comma-separated names are alternative names, one of which will be
3803 used. In 'guifontset' the whole string is one fontset name,
3804 including the commas. It is not possible to specify alternative
3805 fontset names.
3806 This example works on many X11 systems: >
3807 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3808<
3809 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3810'guifontwide' 'gfw' string (default "")
3811 global
3812 {not in Vi}
3813 {only available when compiled with GUI enabled}
3814 When not empty, specifies a comma-separated list of fonts to be used
3815 for double-width characters. The first font that can be loaded is
3816 used.
3817 Note: The size of these fonts must be exactly twice as wide as the one
3818 specified with 'guifont' and the same height.
3819
Bram Moolenaar3df01732017-02-17 22:47:16 +01003820 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821
3822 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3823 'guifontset' is empty or invalid.
3824 When 'guifont' is set and a valid font is found in it and
3825 'guifontwide' is empty Vim will attempt to find a matching
3826 double-width font and set 'guifontwide' to it.
3827
Bram Moolenaar3df01732017-02-17 22:47:16 +01003828 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829
3830 If set and valid, 'guifontwide' is always used for double width
3831 characters, even if 'encoding' is not set to "utf-8".
3832 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 font for characters not available in 'guifont'. Thus you do not need
3835 to set 'guifontwide' at all unless you want to override the choice
3836 made by Pango/Xft.
3837
Bram Moolenaar0f272122013-01-23 18:37:40 +01003838 Windows +multibyte only: *guifontwide_win_mbyte*
3839
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003840 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003841
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 *'guiheadroom'* *'ghr'*
3843'guiheadroom' 'ghr' number (default 50)
3844 global
3845 {not in Vi} {only for GTK and X11 GUI}
3846 The number of pixels subtracted from the screen height when fitting
3847 the GUI window on the screen. Set this before the GUI is started,
3848 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003849 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 lines will be left for window decorations and other items on the
3851 screen. Set it to a negative value to allow windows taller than the
3852 screen.
3853
3854 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003855'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3856 removed in |defaults.vim|),
3857 "aegimrLtT" (GTK, Motif and Athena),
3858 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 global
3860 {not in Vi}
3861 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003862 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 sequence of letters which describes what components and options of the
3864 GUI should be used.
3865 To avoid problems with flags that are added in the future, use the
3866 "+=" and "-=" feature of ":set" |add-option-flags|.
3867
Bram Moolenaar13568252018-03-16 20:46:58 +01003868 Valid characters are as follows:
3869 *'go-!'*
3870 '!' External commands are executed in a terminal window. Without
3871 this flag the MS-Windows GUI will open a console window to
3872 execute the command. The Unix GUI will simulate a dumb
3873 terminal to list the command output.
3874 The terminal window will be positioned at the bottom, and grow
3875 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003876 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 'a' Autoselect: If present, then whenever VISUAL mode is started,
3878 or the Visual area extended, Vim tries to become the owner of
3879 the windowing system's global selection. This means that the
3880 Visually highlighted text is available for pasting into other
3881 applications as well as into Vim itself. When the Visual mode
3882 ends, possibly due to an operation on the text, or when an
3883 application wants to paste the selection, the highlighted text
3884 is automatically yanked into the "* selection register.
3885 Thus the selection is still available for pasting into other
3886 applications after the VISUAL mode has ended.
3887 If not present, then Vim won't become the owner of the
3888 windowing system's global selection unless explicitly told to
3889 by a yank or delete operation for the "* register.
3890 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003891 *'go-P'*
3892 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003893 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003894 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 applies to the modeless selection.
3897
3898 'guioptions' autoselect Visual autoselect modeless ~
3899 "" - -
3900 "a" yes yes
3901 "A" - yes
3902 "aA" yes yes
3903
Bram Moolenaar02467872007-05-06 13:22:01 +00003904 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 'c' Use console dialogs instead of popup dialogs for simple
3906 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003907 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003908 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003909 'guitablabel' can be used to change the text in the labels.
3910 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003911 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003912 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003913 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 'f' Foreground: Don't use fork() to detach the GUI from the shell
3915 where it was started. Use this for programs that wait for the
3916 editor to finish (e.g., an e-mail program). Alternatively you
3917 can use "gvim -f" or ":gui -f" to start the GUI in the
3918 foreground. |gui-fork|
3919 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003920 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003921 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3923 corner of the window. It's black&white on non-GTK, because of
3924 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003925 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003928 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003930 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003932 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003933 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'g' Grey menu items: Make menu items that are not active grey. If
3935 'g' is not included inactive menu items are not shown at all.
3936 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003937 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 't' Include tearoff menu items. Currently only works for Win32,
3939 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003940 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003941 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003942 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003943 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'R' Right-hand scrollbar is present when there is a vertically
3947 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003948 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003950 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'L' Left-hand scrollbar is present when there is a vertically
3952 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003953 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3955 the longest visible line, or on the cursor line if the 'h'
3956 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003957 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 'h' Limit horizontal scrollbar size to the length of the cursor
3959 line. Reduces computations. |gui-horiz-scroll|
3960
3961 And yes, you may even have scrollbars on the left AND the right if
3962 you really want to :-). See |gui-scrollbars| for more information.
3963
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003964 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 'v' Use a vertical button layout for dialogs. When not included,
3966 a horizontal layout is preferred, but when it doesn't fit a
3967 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003968 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'p' Use Pointer callbacks for X11 GUI. This is required for some
3970 window managers. If the cursor is not blinking or hollow at
3971 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003972 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003974 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003975 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003976 *'go-k'*
3977 'k' Keep the GUI window size when adding/removing a scrollbar, or
3978 toolbar, tabline, etc. Instead, the behavior is similar to
3979 when the window is maximized and will adjust 'lines' and
3980 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003981 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003982 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003983
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 *'guipty'* *'noguipty'*
3985'guipty' boolean (default on)
3986 global
3987 {not in Vi}
3988 {only available when compiled with GUI enabled}
3989 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3990 I/O to/from shell commands. See |gui-pty|.
3991
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003992 *'guitablabel'* *'gtl'*
3993'guitablabel' 'gtl' string (default empty)
3994 global
3995 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003996 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003997 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003998 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003999 pages line. When empty and when the result is empty Vim will use a
4000 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004001
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004002 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004003 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004004 The expression will be evaluated in the |sandbox| when set from a
4005 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004006
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004007 Only used when the GUI tab pages line is displayed. 'e' must be
4008 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4009 used.
4010
Bram Moolenaar57657d82006-04-21 22:12:41 +00004011 *'guitabtooltip'* *'gtt'*
4012'guitabtooltip' 'gtt' string (default empty)
4013 global
4014 {not in Vi}
4015 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004016 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004017 When nonempty describes the text to use in a tooltip for the GUI tab
4018 pages line. When empty Vim will use a default tooltip.
4019 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004020 You can include a line break. Simplest method is to use |:let|: >
4021 :let &guitabtooltip = "line one\nline two"
4022<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004023
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 *'helpfile'* *'hf'*
4025'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4026 (others) "$VIMRUNTIME/doc/help.txt")
4027 global
4028 {not in Vi}
4029 Name of the main help file. All distributed help files should be
4030 placed together in one directory. Additionally, all "doc" directories
4031 in 'runtimepath' will be used.
4032 Environment variables are expanded |:set_env|. For example:
4033 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004034 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 spaces and backslashes.
4036 This option cannot be set from a |modeline| or in the |sandbox|, for
4037 security reasons.
4038
4039 *'helpheight'* *'hh'*
4040'helpheight' 'hh' number (default 20)
4041 global
4042 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004043 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 feature}
4045 Minimal initial height of the help window when it is opened with the
4046 ":help" command. The initial height of the help window is half of the
4047 current window, or (when the 'ea' option is on) the same as other
4048 windows. When the height is less than 'helpheight', the height is
4049 set to 'helpheight'. Set to zero to disable.
4050
4051 *'helplang'* *'hlg'*
4052'helplang' 'hlg' string (default: messages language or empty)
4053 global
4054 {only available when compiled with the |+multi_lang|
4055 feature}
4056 {not in Vi}
4057 Comma separated list of languages. Vim will use the first language
4058 for which the desired help can be found. The English help will always
4059 be used as a last resort. You can add "en" to prefer English over
4060 another language, but that will only find tags that exist in that
4061 language and not in the English help.
4062 Example: >
4063 :set helplang=de,it
4064< This will first search German, then Italian and finally English help
4065 files.
4066 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4067 try to find the tag in the current language before using this option.
4068 See |help-translated|.
4069
4070 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4071'hidden' 'hid' boolean (default off)
4072 global
4073 {not in Vi}
4074 When off a buffer is unloaded when it is |abandon|ed. When on a
4075 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4076 displayed in another window, it does not become hidden, of course.
4077 The commands that move through the buffer list sometimes make a buffer
4078 hidden although the 'hidden' option is off: When the buffer is
4079 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004080 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004081 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 This option is set for one command with ":hide {command}" |:hide|.
4083 WARNING: It's easy to forget that you have changes in hidden buffers.
4084 Think twice when using ":q!" or ":qa!".
4085
4086 *'highlight'* *'hl'*
4087'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004088 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4089 d:Directory,e:ErrorMsg,i:IncSearch,
4090 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4091 N:CursorLineNr,r:Question,s:StatusLine,
4092 S:StatusLineNC,c:VertSplit,t:Title,
4093 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4094 F:FoldColumn,A:DiffAdd,C:DiffChange,
4095 D:DiffDelete,T:DiffText,>:SignColumn,
4096 B:SpellBad,P:SpellCap,R:SpellRare,
4097 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004098 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4099 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004100 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004101 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 global
4103 {not in Vi}
4104 This option can be used to set highlighting mode for various
4105 occasions. It is a comma separated list of character pairs. The
4106 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004107 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004109 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4110 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 characters from 'showbreak'
4112 |hl-Directory| d directories in CTRL-D listing and other special
4113 things in listings
4114 |hl-ErrorMsg| e error messages
4115 h (obsolete, ignored)
4116 |hl-IncSearch| i 'incsearch' highlighting
4117 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4118 |hl-MoreMsg| m |more-prompt|
4119 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004120 |hl-LineNr| n line number for ":number" and ":#" commands, and
4121 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004122 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4123 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 |hl-Question| r |hit-enter| prompt and yes/no questions
4125 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004126 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4128 |hl-VertSplit| c column used to separate vertically split windows
4129 |hl-Visual| v Visual mode
4130 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4131 Selection" Only X11 Gui's |gui-x11| and
4132 |xterm-clipboard|.
4133 |hl-WarningMsg| w warning messages
4134 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4135 |hl-Folded| f line used for closed folds
4136 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004137 |hl-DiffAdd| A added line in diff mode
4138 |hl-DiffChange| C changed line in diff mode
4139 |hl-DiffDelete| D deleted line in diff mode
4140 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004142 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004143 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004144 |hl-SpellRare| R rare word |spell|
4145 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004146 |hl-Conceal| - the placeholders used for concealed characters
4147 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004148 |hl-Pmenu| + popup menu normal line
4149 |hl-PmenuSel| = popup menu normal line
4150 |hl-PmenuSbar| x popup menu scrollbar
4151 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152
4153 The display modes are:
4154 r reverse (termcap entry "mr" and "me")
4155 i italic (termcap entry "ZH" and "ZR")
4156 b bold (termcap entry "md" and "me")
4157 s standout (termcap entry "so" and "se")
4158 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004159 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004160 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 n no highlighting
4162 - no highlighting
4163 : use a highlight group
4164 The default is used for occasions that are not included.
4165 If you want to change what the display modes do, see |dos-colors|
4166 for an example.
4167 When using the ':' display mode, this must be followed by the name of
4168 a highlight group. A highlight group can be used to define any type
4169 of highlighting, including using color. See |:highlight| on how to
4170 define one. The default uses a different group for each occasion.
4171 See |highlight-default| for the default highlight groups.
4172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004174'history' 'hi' number (Vim default: 50, Vi default: 0,
4175 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 global
4177 {not in Vi}
4178 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004179 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004181 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 NOTE: This option is set to the Vi default value when 'compatible' is
4183 set and to the Vim default value when 'compatible' is reset.
4184
4185 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4186'hkmap' 'hk' boolean (default off)
4187 global
4188 {not in Vi}
4189 {only available when compiled with the |+rightleft|
4190 feature}
4191 When on, the keyboard is mapped for the Hebrew character set.
4192 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4193 toggle this option. See |rileft.txt|.
4194 NOTE: This option is reset when 'compatible' is set.
4195
4196 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4197'hkmapp' 'hkp' boolean (default off)
4198 global
4199 {not in Vi}
4200 {only available when compiled with the |+rightleft|
4201 feature}
4202 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4203 This is useful if you have a non-Hebrew keyboard.
4204 See |rileft.txt|.
4205 NOTE: This option is reset when 'compatible' is set.
4206
Bram Moolenaar036986f2017-03-16 17:41:02 +01004207 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4208'hlsearch' 'hls' boolean (default off)
4209 global
4210 {not in Vi}
4211 {not available when compiled without the
4212 |+extra_search| feature}
4213 When there is a previous search pattern, highlight all its matches.
4214 The type of highlighting used can be set with the 'l' occasion in the
4215 'highlight' option. This uses the "Search" highlight group by
4216 default. Note that only the matching text is highlighted, any offsets
4217 are not applied.
4218 See also: 'incsearch' and |:match|.
4219 When you get bored looking at the highlighted matches, you can turn it
4220 off with |:nohlsearch|. This does not change the option value, as
4221 soon as you use a search command, the highlighting comes back.
4222 'redrawtime' specifies the maximum time spent on finding matches.
4223 When the search pattern can match an end-of-line, Vim will try to
4224 highlight all of the matched text. However, this depends on where the
4225 search starts. This will be the first line in the window or the first
4226 line below a closed fold. A match in a previous line which is not
4227 drawn may not continue in a newly drawn line.
4228 You can specify whether the highlight status is restored on startup
4229 with the 'h' flag in 'viminfo' |viminfo-h|.
4230 NOTE: This option is reset when 'compatible' is set.
4231
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 *'icon'* *'noicon'*
4233'icon' boolean (default off, on when title can be restored)
4234 global
4235 {not in Vi}
4236 {not available when compiled without the |+title|
4237 feature}
4238 When on, the icon text of the window will be set to the value of
4239 'iconstring' (if it is not empty), or to the name of the file
4240 currently being edited. Only the last part of the name is used.
4241 Overridden by the 'iconstring' option.
4242 Only works if the terminal supports setting window icons (currently
4243 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4244 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4245 builtin termcap).
4246 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004247 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004249 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250
4251 *'iconstring'*
4252'iconstring' string (default "")
4253 global
4254 {not in Vi}
4255 {not available when compiled without the |+title|
4256 feature}
4257 When this option is not empty, it will be used for the icon text of
4258 the window. This happens only when the 'icon' option is on.
4259 Only works if the terminal supports setting window icon text
4260 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4261 Does not work for MS Windows.
4262 When Vim was compiled with HAVE_X11 defined, the original icon will be
4263 restored if possible |X11|.
4264 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004265 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 'titlestring' for example settings.
4267 {not available when compiled without the |+statusline| feature}
4268
4269 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4270'ignorecase' 'ic' boolean (default off)
4271 global
4272 Ignore case in search patterns. Also used when searching in the tags
4273 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004274 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 Can be overruled by using "\c" or "\C" in the pattern, see
4276 |/ignorecase|.
4277
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004278 *'imactivatefunc'* *'imaf'*
4279'imactivatefunc' 'imaf' string (default "")
4280 global
4281 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004282 {only available when compiled with the |+multi_byte|
4283 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004284 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004285 activate or deactivate the Input Method.
4286 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004287
4288 Example: >
4289 function ImActivateFunc(active)
4290 if a:active
4291 ... do something
4292 else
4293 ... do something
4294 endif
4295 " return value is not used
4296 endfunction
4297 set imactivatefunc=ImActivateFunc
4298<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 *'imactivatekey'* *'imak'*
4300'imactivatekey' 'imak' string (default "")
4301 global
4302 {not in Vi}
4303 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004304 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 Specifies the key that your Input Method in X-Windows uses for
4306 activation. When this is specified correctly, vim can fully control
4307 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4308 You can't use this option to change the activation key, the option
4309 tells Vim what the key is.
4310 Format:
4311 [MODIFIER_FLAG-]KEY_STRING
4312
4313 These characters can be used for MODIFIER_FLAG (case is ignored):
4314 S Shift key
4315 L Lock key
4316 C Control key
4317 1 Mod1 key
4318 2 Mod2 key
4319 3 Mod3 key
4320 4 Mod4 key
4321 5 Mod5 key
4322 Combinations are allowed, for example "S-C-space" or "SC-space" are
4323 both shift+ctrl+space.
4324 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4325
4326 Example: >
4327 :set imactivatekey=S-space
4328< "S-space" means shift+space. This is the activation key for kinput2 +
4329 canna (Japanese), and ami (Korean).
4330
4331 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4332'imcmdline' 'imc' boolean (default off)
4333 global
4334 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004335 {only available when compiled with the |+multi_byte|
4336 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 When set the Input Method is always on when starting to edit a command
4338 line, unless entering a search pattern (see 'imsearch' for that).
4339 Setting this option is useful when your input method allows entering
4340 English characters directly, e.g., when it's used to type accented
4341 characters with dead keys.
4342
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004343 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4345 global
4346 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004347 {only available when compiled with the |+multi_byte|
4348 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 When set the Input Method is never used. This is useful to disable
4350 the IM when it doesn't work properly.
4351 Currently this option is on by default for SGI/IRIX machines. This
4352 may change in later releases.
4353
4354 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004355'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 local to buffer
4357 {not in Vi}
4358 Specifies whether :lmap or an Input Method (IM) is to be used in
4359 Insert mode. Valid values:
4360 0 :lmap is off and IM is off
4361 1 :lmap is ON and IM is off
4362 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 To always reset the option to zero when leaving Insert mode with <Esc>
4364 this can be used: >
4365 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4366< This makes :lmap and IM turn off automatically when leaving Insert
4367 mode.
4368 Note that this option changes when using CTRL-^ in Insert mode
4369 |i_CTRL-^|.
4370 The value is set to 1 when setting 'keymap' to a valid keymap name.
4371 It is also used for the argument of commands like "r" and "f".
4372 The value 0 may not work correctly with Athena and Motif with some XIM
4373 methods. Use 'imdisable' to disable XIM then.
4374
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004375 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004376 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004377 |+multi_byte_ime| or |global-ime|.
4378
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004380'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 local to buffer
4382 {not in Vi}
4383 Specifies whether :lmap or an Input Method (IM) is to be used when
4384 entering a search pattern. Valid values:
4385 -1 the value of 'iminsert' is used, makes it look like
4386 'iminsert' is also used when typing a search pattern
4387 0 :lmap is off and IM is off
4388 1 :lmap is ON and IM is off
4389 2 :lmap is off and IM is ON
4390 Note that this option changes when using CTRL-^ in Command-line mode
4391 |c_CTRL-^|.
4392 The value is set to 1 when it is not -1 and setting the 'keymap'
4393 option to a valid keymap name.
4394 The value 0 may not work correctly with Athena and Motif with some XIM
4395 methods. Use 'imdisable' to disable XIM then.
4396
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004397 *'imstatusfunc'* *'imsf'*
4398'imstatusfunc' 'imsf' string (default "")
4399 global
4400 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004401 {only available when compiled with the |+multi_byte|
4402 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004403 This option specifies a function that is called to obtain the status
4404 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004405 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004406
4407 Example: >
4408 function ImStatusFunc()
4409 let is_active = ...do something
4410 return is_active ? 1 : 0
4411 endfunction
4412 set imstatusfunc=ImStatusFunc
4413<
4414 NOTE: This function is invoked very often. Keep it fast.
4415
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004416 *'imstyle'* *'imst'*
4417'imstyle' 'imst' number (default 1)
4418 global
4419 {not in Vi}
4420 {only available when compiled with |+xim| and
4421 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004422 This option specifies the input style of Input Method:
4423 0 use on-the-spot style
4424 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004425 See: |xim-input-style|
4426
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004427 For a long time on-the-spot style had been used in the GTK version of
4428 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004429 |single-repeat|, etc. Therefore over-the-spot style becomes the
4430 default now. This should work fine for most people, however if you
4431 have any problem with it, try using on-the-spot style.
4432
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 *'include'* *'inc'*
4434'include' 'inc' string (default "^\s*#\s*include")
4435 global or local to buffer |global-local|
4436 {not in Vi}
4437 {not available when compiled without the
4438 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 pattern, just like for the "/" command (See |pattern|). The default
4441 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004442 "]I", "[d", etc.
4443 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004444 comes after the matched pattern. But if "\zs" appears in the pattern
4445 then the text matched from "\zs" to the end, or until "\ze" if it
4446 appears, is used as the file name. Use this to include characters
4447 that are not in 'isfname', such as a space. You can then use
4448 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004449 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450
4451 *'includeexpr'* *'inex'*
4452'includeexpr' 'inex' string (default "")
4453 local to buffer
4454 {not in Vi}
4455 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004456 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004458 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 :set includeexpr=substitute(v:fname,'\\.','/','g')
4460< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004461
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004463 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 Also used for |<cfile>|.
4465
Bram Moolenaar30b65812012-07-12 22:01:11 +02004466 The expression will be evaluated in the |sandbox| when set from a
4467 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004468
4469 It is not allowed to change text or jump to another window while
4470 evaluating 'includeexpr' |textlock|.
4471
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004473'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4474 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 global
4476 {not in Vi}
4477 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004478 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004479 While typing a search command, show where the pattern, as it was typed
4480 so far, matches. The matched string is highlighted. If the pattern
4481 is invalid or not found, nothing is shown. The screen will be updated
4482 often, this is only useful on fast terminals.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004483 Also applies to the `:s`, `:g` and `:v` commands.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004484 Note that the match will be shown, but the cursor will return to its
4485 original position when no match is found and when pressing <Esc>. You
4486 still need to finish the search command with <Enter> to move the
4487 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004488 You can use the CTRL-G and CTRL-T keys to move to the next and
4489 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004490 When compiled with the |+reltime| feature Vim only searches for about
4491 half a second. With a complicated pattern and/or a lot of text the
4492 match may not be found. This is to avoid that Vim hangs while you
4493 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004494 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004495 When 'hlsearch' is on, all matched strings are highlighted too while
4496 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004497 If you don't want to turn 'hlsearch' on, but want to highlight all
4498 matches while searching, you can turn on and off 'hlsearch' with
4499 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004500 augroup vimrc-incsearch-highlight
4501 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004502 autocmd CmdlineEnter /,\? :set hlsearch
4503 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004504 augroup END
4505<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004506 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004507 to the command line. If 'ignorecase' and 'smartcase' are set and the
4508 command line has no uppercase characters, the added character is
4509 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004510 CTRL-R CTRL-W can be used to add the word at the end of the current
4511 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 NOTE: This option is reset when 'compatible' is set.
4513
4514 *'indentexpr'* *'inde'*
4515'indentexpr' 'inde' string (default "")
4516 local to buffer
4517 {not in Vi}
4518 {not available when compiled without the |+cindent|
4519 or |+eval| features}
4520 Expression which is evaluated to obtain the proper indent for a line.
4521 It is used when a new line is created, for the |=| operator and
4522 in Insert mode as specified with the 'indentkeys' option.
4523 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004524 'smartindent' indenting. When 'lisp' is set, this option is
4525 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 When 'paste' is set this option is not used for indenting.
4527 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004528 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 when the expression is evaluated (but it may be moved around).
4530 The expression must return the number of spaces worth of indent. It
4531 can return "-1" to keep the current indent (this means 'autoindent' is
4532 used for the indent).
4533 Functions useful for computing the indent are |indent()|, |cindent()|
4534 and |lispindent()|.
4535 The evaluation of the expression must not have side effects! It must
4536 not change the text, jump to another window, etc. Afterwards the
4537 cursor position is always restored, thus the cursor may be moved.
4538 Normally this option would be set to call a function: >
4539 :set indentexpr=GetMyIndent()
4540< Error messages will be suppressed, unless the 'debug' option contains
4541 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004542 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004543 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544
Bram Moolenaar30b65812012-07-12 22:01:11 +02004545 The expression will be evaluated in the |sandbox| when set from a
4546 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004547
4548 It is not allowed to change text or jump to another window while
4549 evaluating 'indentexpr' |textlock|.
4550
4551
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 *'indentkeys'* *'indk'*
4553'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4554 local to buffer
4555 {not in Vi}
4556 {not available when compiled without the |+cindent|
4557 feature}
4558 A list of keys that, when typed in Insert mode, cause reindenting of
4559 the current line. Only happens if 'indentexpr' isn't empty.
4560 The format is identical to 'cinkeys', see |indentkeys-format|.
4561 See |C-indenting| and |indent-expression|.
4562
4563 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4564'infercase' 'inf' boolean (default off)
4565 local to buffer
4566 {not in Vi}
4567 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004568 'ignorecase' is also on, the case of the match is adjusted depending
4569 on the typed text. If the typed text contains a lowercase letter
4570 where the match has an upper case letter, the completed part is made
4571 lowercase. If the typed text has no lowercase letters and the match
4572 has a lowercase letter where the typed text has an uppercase letter,
4573 and there is a letter before it, the completed part is made uppercase.
4574 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575
4576 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4577'insertmode' 'im' boolean (default off)
4578 global
4579 {not in Vi}
4580 Makes Vim work in a way that Insert mode is the default mode. Useful
4581 if you want to use Vim as a modeless editor. Used for |evim|.
4582 These Insert mode commands will be useful:
4583 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004584 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 this is a mapping, it is executed as if 'insertmode' was off.
4586 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004588 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4589 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590
4591 These items change when 'insertmode' is set:
4592 - when starting to edit of a file, Vim goes to Insert mode.
4593 - <Esc> in Insert mode is a no-op and beeps.
4594 - <Esc> in Normal mode makes Vim go to Insert mode.
4595 - CTRL-L in Insert mode is a command, it is not inserted.
4596 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4597 However, when <Esc> is used inside a mapping, it behaves like
4598 'insertmode' was not set. This was done to be able to use the same
4599 mappings with 'insertmode' set or not set.
4600 When executing commands with |:normal| 'insertmode' is not used.
4601
4602 NOTE: This option is reset when 'compatible' is set.
4603
4604 *'isfname'* *'isf'*
4605'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4606 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4607 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4608 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4609 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4610 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4611 global
4612 {not in Vi}
4613 The characters specified by this option are included in file names and
4614 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004615 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Multi-byte characters 256 and above are always included, only the
4617 characters up to 255 are specified with this option.
4618 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004619 Think twice before adding white space to this option. Although a
4620 space may appear inside a file name, the effect will be that Vim
4621 doesn't know where a file name starts or ends when doing completion.
4622 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623
4624 Note that on systems using a backslash as path separator, Vim tries to
4625 do its best to make it work as you would expect. That is a bit
4626 tricky, since Vi originally used the backslash to escape special
4627 characters. Vim will not remove a backslash in front of a normal file
4628 name character on these systems, but it will on Unix and alikes. The
4629 '&' and '^' are not included by default, because these are special for
4630 cmd.exe.
4631
4632 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004633 Each part can be a single character number or a range. A range is two
4634 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 decimal number between 0 and 255 or the ASCII character itself (does
4636 not work for digits). Example:
4637 "_,-,128-140,#-43" (include '_' and '-' and the range
4638 128 to 140 and '#' to 43)
4639 If a part starts with '^', the following character number or range
4640 will be excluded from the option. The option is interpreted from left
4641 to right. Put the excluded character after the range where it is
4642 included. To include '^' itself use it as the last character of the
4643 option or the end of a range. Example:
4644 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4645 If the character is '@', all characters where isalpha() returns TRUE
4646 are included. Normally these are the characters a to z and A to Z,
4647 plus accented characters. To include '@' itself use "@-@". Examples:
4648 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004649 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 "a-z,A-Z,@-@" All letters plus the '@' character.
4651 A comma can be included by using it where a character number is
4652 expected. Example:
4653 "48-57,,,_" Digits, comma and underscore.
4654 A comma can be excluded by prepending a '^'. Example:
4655 " -~,^,,9" All characters from space to '~', excluding
4656 comma, plus <Tab>.
4657 See |option-backslash| about including spaces and backslashes.
4658
4659 *'isident'* *'isi'*
4660'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4661 "@,48-57,_,128-167,224-235"
4662 otherwise: "@,48-57,_,192-255")
4663 global
4664 {not in Vi}
4665 The characters given by this option are included in identifiers.
4666 Identifiers are used in recognizing environment variables and after a
4667 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004668 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 option.
4670 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004671 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4673
4674 *'iskeyword'* *'isk'*
4675'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4676 "@,48-57,_,128-167,224-235"
4677 otherwise: "@,48-57,_,192-255"
4678 Vi default: "@,48-57,_")
4679 local to buffer
4680 {not in Vi}
4681 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004682 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 'isfname' for a description of the format of this option. For C
4684 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4685 For a help file it is set to all non-blank printable characters except
4686 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4687 command).
4688 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004689 This option also influences syntax highlighting, unless the syntax
4690 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 NOTE: This option is set to the Vi default value when 'compatible' is
4692 set and to the Vim default value when 'compatible' is reset.
4693
4694 *'isprint'* *'isp'*
4695'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4696 "@,~-255"; otherwise: "@,161-255")
4697 global
4698 {not in Vi}
4699 The characters given by this option are displayed directly on the
4700 screen. It is also used for "\p" in a |pattern|. The characters from
4701 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4702 even when they are not included in 'isprint' or excluded. See
4703 'isfname' for a description of the format of this option.
4704
4705 Non-printable characters are displayed with two characters:
4706 0 - 31 "^@" - "^_"
4707 32 - 126 always single characters
4708 127 "^?"
4709 128 - 159 "~@" - "~_"
4710 160 - 254 "| " - "|~"
4711 255 "~?"
4712 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4713 displayed as <xx>, with the hexadecimal value of the byte.
4714 When 'display' contains "uhex" all unprintable characters are
4715 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004716 The SpecialKey highlighting will be used for unprintable characters.
4717 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718
4719 Multi-byte characters 256 and above are always included, only the
4720 characters up to 255 are specified with this option. When a character
4721 is printable but it is not available in the current font, a
4722 replacement character will be shown.
4723 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4724 There is no option to specify these characters.
4725
4726 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4727'joinspaces' 'js' boolean (default on)
4728 global
4729 {not in Vi}
4730 Insert two spaces after a '.', '?' and '!' with a join command.
4731 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4732 Otherwise only one space is inserted.
4733 NOTE: This option is set when 'compatible' is set.
4734
4735 *'key'*
4736'key' string (default "")
4737 local to buffer
4738 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004739 {only available when compiled with the |+cryptv|
4740 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004742 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 Careful: Do not set the key value by hand, someone might see the typed
4744 key. Use the |:X| command. But you can make 'key' empty: >
4745 :set key=
4746< It is not possible to get the value of this option with ":set key" or
4747 "echo &key". This is to avoid showing it to someone who shouldn't
4748 know. It also means you cannot see it yourself once you have set it,
4749 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004750 You can use "&key" in an expression to detect whether encryption is
4751 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752
4753 *'keymap'* *'kmp'* *E544*
4754'keymap' 'kmp' string (default "")
4755 local to buffer
4756 {not in Vi}
4757 {only available when compiled with the |+keymap|
4758 feature}
4759 Name of a keyboard mapping. See |mbyte-keymap|.
4760 Setting this option to a valid keymap name has the side effect of
4761 setting 'iminsert' to one, so that the keymap becomes effective.
4762 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004763 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
4765 *'keymodel'* *'km'*
4766'keymodel' 'km' string (default "")
4767 global
4768 {not in Vi}
4769 List of comma separated words, which enable special things that keys
4770 can do. These values can be used:
4771 startsel Using a shifted special key starts selection (either
4772 Select mode or Visual mode, depending on "key" being
4773 present in 'selectmode').
4774 stopsel Using a not-shifted special key stops selection.
4775 Special keys in this context are the cursor keys, <End>, <Home>,
4776 <PageUp> and <PageDown>.
4777 The 'keymodel' option is set by the |:behave| command.
4778
4779 *'keywordprg'* *'kp'*
4780'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004781 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 global or local to buffer |global-local|
4783 {not in Vi}
4784 Program to use for the |K| command. Environment variables are
4785 expanded |:set_env|. ":help" may be used to access the Vim internal
4786 help. (Note that previously setting the global option to the empty
4787 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004788 When the first character is ":", the command is invoked as a Vim
4789 Ex command prefixed with [count].
4790 When "man", "man -s" or an Ex command is used, Vim will automatically
4791 translate a count for the "K" command and pass it as the first
4792 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 See |option-backslash| about including spaces and backslashes.
4794 Example: >
4795 :set keywordprg=man\ -s
4796< This option cannot be set from a |modeline| or in the |sandbox|, for
4797 security reasons.
4798
4799 *'langmap'* *'lmap'* *E357* *E358*
4800'langmap' 'lmap' string (default "")
4801 global
4802 {not in Vi}
4803 {only available when compiled with the |+langmap|
4804 feature}
4805 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004806 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004807 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 care of translating these special characters to the original meaning
4809 of the key. This means you don't have to change the keyboard mode to
4810 be able to execute Normal mode commands.
4811 This is the opposite of the 'keymap' option, where characters are
4812 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004813 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004814 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004815 This option cannot be set from a |modeline| or in the |sandbox|, for
4816 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004818 Example (for Greek, in UTF-8): *greek* >
4819 :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 +00004820< Example (exchanges meaning of z and y for commands): >
4821 :set langmap=zy,yz,ZY,YZ
4822<
4823 The 'langmap' option is a list of parts, separated with commas. Each
4824 part can be in one of two forms:
4825 1. A list of pairs. Each pair is a "from" character immediately
4826 followed by the "to" character. Examples: "aA", "aAbBcC".
4827 2. A list of "from" characters, a semi-colon and a list of "to"
4828 characters. Example: "abc;ABC"
4829 Example: "aA,fgh;FGH,cCdDeE"
4830 Special characters need to be preceded with a backslash. These are
4831 ";", ',' and backslash itself.
4832
4833 This will allow you to activate vim actions without having to switch
4834 back and forth between the languages. Your language characters will
4835 be understood as normal vim English characters (according to the
4836 langmap mappings) in the following cases:
4837 o Normal/Visual mode (commands, buffer/register names, user mappings)
4838 o Insert/Replace Mode: Register names after CTRL-R
4839 o Insert/Replace Mode: Mappings
4840 Characters entered in Command-line mode will NOT be affected by
4841 this option. Note that this option can be changed at any time
4842 allowing to switch between mappings for different languages/encodings.
4843 Use a mapping to avoid having to type it each time!
4844
4845 *'langmenu'* *'lm'*
4846'langmenu' 'lm' string (default "")
4847 global
4848 {not in Vi}
4849 {only available when compiled with the |+menu| and
4850 |+multi_lang| features}
4851 Language to use for menu translation. Tells which file is loaded
4852 from the "lang" directory in 'runtimepath': >
4853 "lang/menu_" . &langmenu . ".vim"
4854< (without the spaces). For example, to always use the Dutch menus, no
4855 matter what $LANG is set to: >
4856 :set langmenu=nl_NL.ISO_8859-1
4857< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004858 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 If your $LANG is set to a non-English language but you do want to use
4860 the English menus: >
4861 :set langmenu=none
4862< This option must be set before loading menus, switching on filetype
4863 detection or syntax highlighting. Once the menus are defined setting
4864 this option has no effect. But you could do this: >
4865 :source $VIMRUNTIME/delmenu.vim
4866 :set langmenu=de_DE.ISO_8859-1
4867 :source $VIMRUNTIME/menu.vim
4868< Warning: This deletes all menus that you defined yourself!
4869
Bram Moolenaard94464e2015-11-02 15:28:18 +01004870 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004871'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004872 global
4873 {not in Vi}
4874 {only available when compiled with the |+langmap|
4875 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004876 This is just like 'langremap' but with the value inverted. It only
4877 exists for backwards compatibility. When setting 'langremap' then
4878 'langnoremap' is set to the inverted value, and the other way around.
4879
4880 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4881'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4882 global
4883 {not in Vi}
4884 {only available when compiled with the |+langmap|
4885 feature}
4886 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004887 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004888 'langmap' disables some of your mappings, try resetting this option.
4889 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004890 that works for you to avoid mappings to break.
4891
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 *'laststatus'* *'ls'*
4893'laststatus' 'ls' number (default 1)
4894 global
4895 {not in Vi}
4896 The value of this option influences when the last window will have a
4897 status line:
4898 0: never
4899 1: only if there are at least two windows
4900 2: always
4901 The screen looks nicer with a status line if you have several
4902 windows, but it takes another screen line. |status-line|
4903
4904 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4905'lazyredraw' 'lz' boolean (default off)
4906 global
4907 {not in Vi}
4908 When this option is set, the screen will not be redrawn while
4909 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004910 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 update use |:redraw|.
4912
4913 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4914'linebreak' 'lbr' boolean (default off)
4915 local to window
4916 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004917 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004919 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 than at the last character that fits on the screen. Unlike
4921 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004922 it only affects the way the file is displayed, not its contents.
4923 If 'breakindent' is set, line is visually indented. Then, the value
4924 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004925 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 Note that <Tab> characters after an <EOL> are mostly not displayed
4927 with the right amount of white space.
4928
4929 *'lines'* *E593*
4930'lines' number (default 24 or terminal height)
4931 global
4932 Number of lines of the Vim window.
4933 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004934 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 When Vim is running in the GUI or in a resizable window, setting this
4936 option will cause the window size to be changed. When you only want
4937 to use the size for the GUI, put the command in your |gvimrc| file.
4938 Vim limits the number of lines to what fits on the screen. You can
4939 use this command to get the tallest window possible: >
4940 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004941< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004942 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 When you set this option and Vim is unable to change the physical
4944 number of lines of the display, the display may be messed up.
4945
4946 *'linespace'* *'lsp'*
4947'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4948 global
4949 {not in Vi}
4950 {only in the GUI}
4951 Number of pixel lines inserted between characters. Useful if the font
4952 uses the full character cell height, making lines touch each other.
4953 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004954 With some fonts there can be too much room between lines (to have
4955 space for ascents and descents). Then it makes sense to set
4956 'linespace' to a negative value. This may cause display problems
4957 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958
4959 *'lisp'* *'nolisp'*
4960'lisp' boolean (default off)
4961 local to buffer
4962 {not available when compiled without the |+lispindent|
4963 feature}
4964 Lisp mode: When <Enter> is typed in insert mode set the indent for
4965 the next line to Lisp standards (well, sort of). Also happens with
4966 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4967 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4968 better. Also see 'lispwords'.
4969 The '-' character is included in keyword characters. Redefines the
4970 "=" operator to use this same indentation algorithm rather than
4971 calling an external program if 'equalprg' is empty.
4972 This option is not used when 'paste' is set.
4973 {Vi: Does it a little bit differently}
4974
4975 *'lispwords'* *'lw'*
4976'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004977 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 {not in Vi}
4979 {not available when compiled without the |+lispindent|
4980 feature}
4981 Comma separated list of words that influence the Lisp indenting.
4982 |'lisp'|
4983
4984 *'list'* *'nolist'*
4985'list' boolean (default off)
4986 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004987 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4988 line. Useful to see the difference between tabs and spaces and for
4989 trailing blanks. Further changed by the 'listchars' option.
4990
4991 The cursor is displayed at the start of the space a Tab character
4992 occupies, not at the end as usual in Normal mode. To get this cursor
4993 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004994 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004995<
4996 Note that list mode will also affect formatting (set with 'textwidth'
4997 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 changing the way tabs are displayed.
4999
5000 *'listchars'* *'lcs'*
5001'listchars' 'lcs' string (default "eol:$")
5002 global
5003 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005004 Strings to use in 'list' mode and for the |:list| command. It is a
5005 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005006 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 eol:c Character to show at the end of each line. When
5008 omitted, there is no extra character at the end of the
5009 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005010 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005011 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005013 fill the space that the tab normally occupies.
5014 "tab:>-" will show a tab that takes four spaces as
5015 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005016 *lcs-space*
5017 space:c Character to show for a space. When omitted, spaces
5018 are left blank.
5019 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005020 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005021 trailing spaces are blank. Overrides the "space"
5022 setting for trailing spaces.
5023 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 extends:c Character to show in the last column, when 'wrap' is
5025 off and the line continues beyond the right of the
5026 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005027 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 precedes:c Character to show in the first column, when 'wrap'
5029 is off and there is text preceding the character
5030 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005031 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005032 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005033 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005034 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005035 nbsp:c Character to show for a non-breakable space character
5036 (0xA0 (160 decimal) and U+202F). Left blank when
5037 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005039 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005041 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
5043 Examples: >
5044 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005045 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 :set lcs=extends:>,precedes:<
5047< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005048 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005049 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050
5051 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5052'loadplugins' 'lpl' boolean (default on)
5053 global
5054 {not in Vi}
5055 When on the plugin scripts are loaded when starting up |load-plugins|.
5056 This option can be reset in your |vimrc| file to disable the loading
5057 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005058 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5059 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060
Bram Moolenaard94464e2015-11-02 15:28:18 +01005061 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005062'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005063 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005064 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005065 {only available when compiled with the |+lua/dyn|
5066 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005067 Specifies the name of the Lua shared library. The default is
5068 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005069 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005070 This option cannot be set from a |modeline| or in the |sandbox|, for
5071 security reasons.
5072
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005073 *'macatsui'* *'nomacatsui'*
5074'macatsui' boolean (default on)
5075 global
5076 {only available in Mac GUI version}
5077 This is a workaround for when drawing doesn't work properly. When set
5078 and compiled with multi-byte support ATSUI text drawing is used. When
5079 not set ATSUI text drawing is not used. Switch this option off when
5080 you experience drawing problems. In a future version the problems may
5081 be solved and this option becomes obsolete. Therefore use this method
5082 to unset it: >
5083 if exists('&macatsui')
5084 set nomacatsui
5085 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005086< Another option to check if you have drawing problems is
5087 'termencoding'.
5088
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 *'magic'* *'nomagic'*
5090'magic' boolean (default on)
5091 global
5092 Changes the special characters that can be used in search patterns.
5093 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005094 WARNING: Switching this option off most likely breaks plugins! That
5095 is because many patterns assume it's on and will fail when it's off.
5096 Only switch it off when working with old Vi scripts. In any other
5097 situation write patterns that work when 'magic' is on. Include "\M"
5098 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099
5100 *'makeef'* *'mef'*
5101'makeef' 'mef' string (default: "")
5102 global
5103 {not in Vi}
5104 {not available when compiled without the |+quickfix|
5105 feature}
5106 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5107 and the |:grep| command.
5108 When it is empty, an internally generated temp file will be used.
5109 When "##" is included, it is replaced by a number to make the name
5110 unique. This makes sure that the ":make" command doesn't overwrite an
5111 existing file.
5112 NOT used for the ":cf" command. See 'errorfile' for that.
5113 Environment variables are expanded |:set_env|.
5114 See |option-backslash| about including spaces and backslashes.
5115 This option cannot be set from a |modeline| or in the |sandbox|, for
5116 security reasons.
5117
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005118 *'makeencoding'* *'menc'*
5119'makeencoding' 'menc' string (default "")
5120 global or local to buffer |global-local|
5121 {only available when compiled with the |+multi_byte|
5122 feature}
5123 {not in Vi}
5124 Encoding used for reading the output of external commands. When empty,
5125 encoding is not converted.
5126 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5127 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5128 and `:laddfile`.
5129
5130 This would be mostly useful when you use MS-Windows and set 'encoding'
5131 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5132 'makeencoding' to "char" has the same effect as setting to the system
5133 locale encoding. Example: >
5134 :set encoding=utf-8
5135 :set makeencoding=char " system locale is used
5136<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 *'makeprg'* *'mp'*
5138'makeprg' 'mp' string (default "make", VMS: "MMS")
5139 global or local to buffer |global-local|
5140 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005141 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005142 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5143 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005144 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005145 Environment variables are expanded |:set_env|. See |option-backslash|
5146 about including spaces and backslashes.
5147 Note that a '|' must be escaped twice: once for ":set" and once for
5148 the interpretation of a command. When you use a filter called
5149 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 :set makeprg=gmake\ \\\|\ myfilter
5151< The placeholder "$*" can be given (even multiple times) to specify
5152 where the arguments will be included, for example: >
5153 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5154< This option cannot be set from a |modeline| or in the |sandbox|, for
5155 security reasons.
5156
5157 *'matchpairs'* *'mps'*
5158'matchpairs' 'mps' string (default "(:),{:},[:]")
5159 local to buffer
5160 {not in Vi}
5161 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005162 other.
5163 Only character pairs are allowed that are different, thus you cannot
5164 jump between two double quotes.
5165 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005166 The pairs must be separated by a comma. Example for including '<' and
5167 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 :set mps+=<:>
5169
5170< A more exotic example, to jump between the '=' and ';' in an
5171 assignment, useful for languages like C and Java: >
5172 :au FileType c,cpp,java set mps+==:;
5173
5174< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005175 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176
5177 *'matchtime'* *'mat'*
5178'matchtime' 'mat' number (default 5)
5179 global
5180 {not in Vi}{in Nvi}
5181 Tenths of a second to show the matching paren, when 'showmatch' is
5182 set. Note that this is not in milliseconds, like other options that
5183 set a time. This is to be compatible with Nvi.
5184
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005185 *'maxcombine'* *'mco'*
5186'maxcombine' 'mco' number (default 2)
5187 global
5188 {not in Vi}
5189 {only available when compiled with the |+multi_byte|
5190 feature}
5191 The maximum number of combining characters supported for displaying.
5192 Only used when 'encoding' is "utf-8".
5193 The default is OK for most languages. Hebrew may require 4.
5194 Maximum value is 6.
5195 Even when this option is set to 2 you can still edit text with more
5196 combining characters, you just can't see them. Use |g8| or |ga|.
5197 See |mbyte-combining|.
5198
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 *'maxfuncdepth'* *'mfd'*
5200'maxfuncdepth' 'mfd' number (default 100)
5201 global
5202 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005203 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005204 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 Maximum depth of function calls for user functions. This normally
5206 catches endless recursion. When using a recursive function with
5207 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5208 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005209 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005210 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 See also |:function|.
5212
5213 *'maxmapdepth'* *'mmd'* *E223*
5214'maxmapdepth' 'mmd' number (default 1000)
5215 global
5216 {not in Vi}
5217 Maximum number of times a mapping is done without resulting in a
5218 character to be used. This normally catches endless mappings, like
5219 ":map x y" with ":map y x". It still does not catch ":map g wg",
5220 because the 'w' is used before the next mapping is done. See also
5221 |key-mapping|.
5222
5223 *'maxmem'* *'mm'*
5224'maxmem' 'mm' number (default between 256 to 5120 (system
5225 dependent) or half the amount of memory
5226 available)
5227 global
5228 {not in Vi}
5229 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5230 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005231 other memory to be freed.
5232 The maximum usable value is about 2000000. Use this to work without a
5233 limit.
5234 The value is ignored when 'swapfile' is off.
5235 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005237 *'maxmempattern'* *'mmp'*
5238'maxmempattern' 'mmp' number (default 1000)
5239 global
5240 {not in Vi}
5241 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005242 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005243 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005244 When Vim runs into the limit it gives an error message and mostly
5245 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005246 Running into the limit often means that the pattern is very
5247 inefficient or too complex. This may already happen with the pattern
5248 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005249 Might also happen on redraw, when syntax rules try to match a complex
5250 text structure.
5251 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5252 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005253
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 *'maxmemtot'* *'mmt'*
5255'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5256 dependent) or half the amount of memory
5257 available)
5258 global
5259 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005260 Maximum amount of memory in Kbyte to use for all buffers together.
5261 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005262 without a limit.
5263 On 64 bit machines higher values might work. But hey, do you really
5264 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005265 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005266 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005267 Buffers with 'swapfile' off still count to the total amount of memory
5268 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005269 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270
5271 *'menuitems'* *'mis'*
5272'menuitems' 'mis' number (default 25)
5273 global
5274 {not in Vi}
5275 {not available when compiled without the |+menu|
5276 feature}
5277 Maximum number of items to use in a menu. Used for menus that are
5278 generated from a list of items, e.g., the Buffers menu. Changing this
5279 option has no direct effect, the menu must be refreshed first.
5280
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005281 *'mkspellmem'* *'msm'*
5282'mkspellmem' 'msm' string (default "460000,2000,500")
5283 global
5284 {not in Vi}
5285 {not available when compiled without the |+syntax|
5286 feature}
5287 Parameters for |:mkspell|. This tunes when to start compressing the
5288 word tree. Compression can be slow when there are many words, but
5289 it's needed to avoid running out of memory. The amount of memory used
5290 per word depends very much on how similar the words are, that's why
5291 this tuning is complicated.
5292
5293 There are three numbers, separated by commas:
5294 {start},{inc},{added}
5295
5296 For most languages the uncompressed word tree fits in memory. {start}
5297 gives the amount of memory in Kbyte that can be used before any
5298 compression is done. It should be a bit smaller than the amount of
5299 memory that is available to Vim.
5300
5301 When going over the {start} limit the {inc} number specifies the
5302 amount of memory in Kbyte that can be allocated before another
5303 compression is done. A low number means compression is done after
5304 less words are added, which is slow. A high number means more memory
5305 will be allocated.
5306
5307 After doing compression, {added} times 1024 words can be added before
5308 the {inc} limit is ignored and compression is done when any extra
5309 amount of memory is needed. A low number means there is a smaller
5310 chance of hitting the {inc} limit, less memory is used but it's
5311 slower.
5312
5313 The languages for which these numbers are important are Italian and
5314 Hungarian. The default works for when you have about 512 Mbyte. If
5315 you have 1 Gbyte you could use: >
5316 :set mkspellmem=900000,3000,800
5317< If you have less than 512 Mbyte |:mkspell| may fail for some
5318 languages, no matter what you set 'mkspellmem' to.
5319
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005321'modeline' 'ml' boolean (Vim default: on (off for root),
5322 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 local to buffer
5324 *'modelines'* *'mls'*
5325'modelines' 'mls' number (default 5)
5326 global
5327 {not in Vi}
5328 If 'modeline' is on 'modelines' gives the number of lines that is
5329 checked for set commands. If 'modeline' is off or 'modelines' is zero
5330 no lines are checked. See |modeline|.
5331 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5332 set and to the Vim default value when 'compatible' is reset.
5333
5334 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5335'modifiable' 'ma' boolean (default on)
5336 local to buffer
5337 {not in Vi} *E21*
5338 When off the buffer contents cannot be changed. The 'fileformat' and
5339 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005340 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341
5342 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5343'modified' 'mod' boolean (default off)
5344 local to buffer
5345 {not in Vi}
5346 When on, the buffer is considered to be modified. This option is set
5347 when:
5348 1. A change was made to the text since it was last written. Using the
5349 |undo| command to go back to the original text will reset the
5350 option. But undoing changes that were made before writing the
5351 buffer will set the option again, since the text is different from
5352 when it was written.
5353 2. 'fileformat' or 'fileencoding' is different from its original
5354 value. The original value is set when the buffer is read or
5355 written. A ":set nomodified" command also resets the original
5356 values to the current values and the 'modified' option will be
5357 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005358 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005359 This option is not set when a change is made to the buffer as the
5360 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5361 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5362 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5364 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005365 Note that the text may actually be the same, e.g. 'modified' is set
5366 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367
5368 *'more'* *'nomore'*
5369'more' boolean (Vim default: on, Vi default: off)
5370 global
5371 {not in Vi}
5372 When on, listings pause when the whole screen is filled. You will get
5373 the |more-prompt|. When this option is off there are no pauses, the
5374 listing continues until finished.
5375 NOTE: This option is set to the Vi default value when 'compatible' is
5376 set and to the Vim default value when 'compatible' is reset.
5377
5378 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005379'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5380 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 global
5382 {not in Vi}
5383 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005384 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5385 sysmouse and Linux console with gpm). For using the mouse in the
5386 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005388 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 v Visual mode
5390 i Insert mode
5391 c Command-line mode
5392 h all previous modes when editing a help file
5393 a all previous modes
5394 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 Normally you would enable the mouse in all four modes with: >
5396 :set mouse=a
5397< When the mouse is not enabled, the GUI will still use the mouse for
5398 modeless selection. This doesn't move the text cursor.
5399
5400 See |mouse-using|. Also see |'clipboard'|.
5401
5402 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005403 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 the mouse buttons can still be used by keeping the shift key pressed.
5405 Also see the 'clipboard' option.
5406
5407 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5408'mousefocus' 'mousef' boolean (default off)
5409 global
5410 {not in Vi}
5411 {only works in the GUI}
5412 The window that the mouse pointer is on is automatically activated.
5413 When changing the window layout or window focus in another way, the
5414 mouse pointer is moved to the window with keyboard focus. Off is the
5415 default because it makes using the pull down menus a little goofy, as
5416 a pointer transit may activate a window unintentionally.
5417
5418 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5419'mousehide' 'mh' boolean (default on)
5420 global
5421 {not in Vi}
5422 {only works in the GUI}
5423 When on, the mouse pointer is hidden when characters are typed.
5424 The mouse pointer is restored when the mouse is moved.
5425
5426 *'mousemodel'* *'mousem'*
5427'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5428 global
5429 {not in Vi}
5430 Sets the model to use for the mouse. The name mostly specifies what
5431 the right mouse button is used for:
5432 extend Right mouse button extends a selection. This works
5433 like in an xterm.
5434 popup Right mouse button pops up a menu. The shifted left
5435 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005436 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 popup_setpos Like "popup", but the cursor will be moved to the
5438 position where the mouse was clicked, and thus the
5439 selected operation will act upon the clicked object.
5440 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005441 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 course, that right clicking outside a selection will
5443 end Visual mode.
5444 Overview of what button does what for each model:
5445 mouse extend popup(_setpos) ~
5446 left click place cursor place cursor
5447 left drag start selection start selection
5448 shift-left search word extend selection
5449 right click extend selection popup menu (place cursor)
5450 right drag extend selection -
5451 middle click paste paste
5452
5453 In the "popup" model the right mouse button produces a pop-up menu.
5454 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005455 In a terminal the popup menu works if Vim is compiled with the
5456 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457
5458 Note that you can further refine the meaning of buttons with mappings.
5459 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5460 selection (because that's handled in the GUI code directly).
5461
5462 The 'mousemodel' option is set by the |:behave| command.
5463
5464 *'mouseshape'* *'mouses'* *E547*
5465'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005466 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 global
5468 {not in Vi}
5469 {only available when compiled with the |+mouseshape|
5470 feature}
5471 This option tells Vim what the mouse pointer should look like in
5472 different modes. The option is a comma separated list of parts, much
5473 like used for 'guicursor'. Each part consist of a mode/location-list
5474 and an argument-list:
5475 mode-list:shape,mode-list:shape,..
5476 The mode-list is a dash separated list of these modes/locations:
5477 In a normal window: ~
5478 n Normal mode
5479 v Visual mode
5480 ve Visual mode with 'selection' "exclusive" (same as 'v',
5481 if not specified)
5482 o Operator-pending mode
5483 i Insert mode
5484 r Replace mode
5485
5486 Others: ~
5487 c appending to the command-line
5488 ci inserting in the command-line
5489 cr replacing in the command-line
5490 m at the 'Hit ENTER' or 'More' prompts
5491 ml idem, but cursor in the last line
5492 e any mode, pointer below last window
5493 s any mode, pointer on a status line
5494 sd any mode, while dragging a status line
5495 vs any mode, pointer on a vertical separator line
5496 vd any mode, while dragging a vertical separator line
5497 a everywhere
5498
5499 The shape is one of the following:
5500 avail name looks like ~
5501 w x arrow Normal mouse pointer
5502 w x blank no pointer at all (use with care!)
5503 w x beam I-beam
5504 w x updown up-down sizing arrows
5505 w x leftright left-right sizing arrows
5506 w x busy The system's usual busy pointer
5507 w x no The system's usual 'no input' pointer
5508 x udsizing indicates up-down resizing
5509 x lrsizing indicates left-right resizing
5510 x crosshair like a big thin +
5511 x hand1 black hand
5512 x hand2 white hand
5513 x pencil what you write with
5514 x question big ?
5515 x rightup-arrow arrow pointing right-up
5516 w x up-arrow arrow pointing up
5517 x <number> any X11 pointer number (see X11/cursorfont.h)
5518
5519 The "avail" column contains a 'w' if the shape is available for Win32,
5520 x for X11.
5521 Any modes not specified or shapes not available use the normal mouse
5522 pointer.
5523
5524 Example: >
5525 :set mouseshape=s:udsizing,m:no
5526< will make the mouse turn to a sizing arrow over the status lines and
5527 indicate no input when the hit-enter prompt is displayed (since
5528 clicking the mouse has no effect in this state.)
5529
5530 *'mousetime'* *'mouset'*
5531'mousetime' 'mouset' number (default 500)
5532 global
5533 {not in Vi}
5534 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5535 time in msec between two mouse clicks for the second click to be
5536 recognized as a multi click.
5537
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005538 *'mzschemedll'*
5539'mzschemedll' string (default depends on the build)
5540 global
5541 {not in Vi}
5542 {only available when compiled with the |+mzscheme/dyn|
5543 feature}
5544 Specifies the name of the MzScheme shared library. The default is
5545 DYNAMIC_MZSCH_DLL which was specified at compile time.
5546 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005547 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005548 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005549 This option cannot be set from a |modeline| or in the |sandbox|, for
5550 security reasons.
5551
5552 *'mzschemegcdll'*
5553'mzschemegcdll' string (default depends on the build)
5554 global
5555 {not in Vi}
5556 {only available when compiled with the |+mzscheme/dyn|
5557 feature}
5558 Specifies the name of the MzScheme GC shared library. The default is
5559 DYNAMIC_MZGC_DLL which was specified at compile time.
5560 The value can be equal to 'mzschemedll' if it includes the GC code.
5561 Environment variables are expanded |:set_env|.
5562 This option cannot be set from a |modeline| or in the |sandbox|, for
5563 security reasons.
5564
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005565 *'mzquantum'* *'mzq'*
5566'mzquantum' 'mzq' number (default 100)
5567 global
5568 {not in Vi}
5569 {not available when compiled without the |+mzscheme|
5570 feature}
5571 The number of milliseconds between polls for MzScheme threads.
5572 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005573 NOTE: This option is set to the Vim default value when 'compatible'
5574 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005575
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005577'nrformats' 'nf' string (default "bin,octal,hex",
5578 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 local to buffer
5580 {not in Vi}
5581 This defines what bases Vim will consider for numbers when using the
5582 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5583 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005584 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005586 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005587 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005589 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 considered to be hexadecimal. Example: Using CTRL-X on
5591 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005592 bin If included, numbers starting with "0b" or "0B" will be
5593 considered to be binary. Example: Using CTRL-X on
5594 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 Numbers which simply begin with a digit in the range 1-9 are always
5596 considered decimal. This also happens for numbers that are not
5597 recognized as octal or hex.
5598
5599 *'number'* *'nu'* *'nonumber'* *'nonu'*
5600'number' 'nu' boolean (default off)
5601 local to window
5602 Print the line number in front of each line. When the 'n' option is
5603 excluded from 'cpoptions' a wrapped line will not use the column of
5604 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005605 The 'numberwidth' option can be used to set the room used for the line
5606 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 When a long, wrapped line doesn't start with the first character, '-'
5608 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005609 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5610 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005611 *number_relativenumber*
5612 The 'relativenumber' option changes the displayed number to be
5613 relative to the cursor. Together with 'number' there are these
5614 four combinations (cursor in line 3):
5615
Bram Moolenaar3848e002016-03-19 18:42:29 +01005616 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005617 'nornu' 'nornu' 'rnu' 'rnu'
5618
5619 |apple | 1 apple | 2 apple | 2 apple
5620 |pear | 2 pear | 1 pear | 1 pear
5621 |nobody | 3 nobody | 0 nobody |3 nobody
5622 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005624 *'numberwidth'* *'nuw'*
5625'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5626 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005627 {not in Vi}
5628 {only available when compiled with the |+linebreak|
5629 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005630 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005631 when the 'number' or 'relativenumber' option is set or printing lines
5632 with a line number. Since one space is always between the number and
5633 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005634 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005635 fit the highest line number in the buffer respectively the number of
5636 rows in the window, depending on whether 'number' or 'relativenumber'
5637 is set. Thus with the Vim default of 4 there is room for a line number
5638 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005639 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005640 NOTE: This option is set to the Vi default value when 'compatible' is
5641 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005642
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005643 *'omnifunc'* *'ofu'*
5644'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005645 local to buffer
5646 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005647 {not available when compiled without the |+eval|
5648 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005649 This option specifies a function to be used for Insert mode omni
5650 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005651 See |complete-functions| for an explanation of how the function is
5652 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005653 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005654 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005655 This option cannot be set from a |modeline| or in the |sandbox|, for
5656 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005657
5658
Bram Moolenaar02467872007-05-06 13:22:01 +00005659 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005660'opendevice' 'odev' boolean (default off)
5661 global
5662 {not in Vi}
5663 {only for MS-DOS, MS-Windows and OS/2}
5664 Enable reading and writing from devices. This may get Vim stuck on a
5665 device that can be opened but doesn't actually do the I/O. Therefore
5666 it is off by default.
5667 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5668 result in editing a device.
5669
5670
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005671 *'operatorfunc'* *'opfunc'*
5672'operatorfunc' 'opfunc' string (default: empty)
5673 global
5674 {not in Vi}
5675 This option specifies a function to be called by the |g@| operator.
5676 See |:map-operator| for more info and an example.
5677
5678 This option cannot be set from a |modeline| or in the |sandbox|, for
5679 security reasons.
5680
5681
Bram Moolenaar251e1912011-06-19 05:09:16 +02005682 *'osfiletype'* *'oft'*
5683'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 local to buffer
5685 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005686 This option was supported on RISC OS, which has been removed.
5687
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005689 *'packpath'* *'pp'*
5690'packpath' 'pp' string (default: see 'runtimepath')
5691 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005692 Directories used to find packages. See |packages|.
5693
5694
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005696'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 global
5698 Specifies the nroff macros that separate paragraphs. These are pairs
5699 of two letters (see |object-motions|).
5700
5701 *'paste'* *'nopaste'*
5702'paste' boolean (default off)
5703 global
5704 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005705 Put Vim in Paste mode. This is useful if you want to cut or copy
5706 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 unexpected effects.
5708 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005709 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 knows about pasting and will mostly do the right thing without 'paste'
5711 being set. The same is true for a terminal where Vim handles the
5712 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005713 This option is reset when starting the GUI. Thus if you set it in
5714 your .vimrc it will work in a terminal, but not in the GUI. Setting
5715 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5716 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 When the 'paste' option is switched on (also when it was already on):
5718 - mapping in Insert mode and Command-line mode is disabled
5719 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005721 - 'expandtab' is reset
5722 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 - 'revins' is reset
5724 - 'ruler' is reset
5725 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005726 - 'smartindent' is reset
5727 - 'smarttab' is reset
5728 - 'softtabstop' is set to 0
5729 - 'textwidth' is set to 0
5730 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005733 - 'indentexpr'
5734 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 NOTE: When you start editing another file while the 'paste' option is
5736 on, settings from the modelines or autocommands may change the
5737 settings again, causing trouble when pasting text. You might want to
5738 set the 'paste' option again.
5739 When the 'paste' option is reset the mentioned options are restored to
5740 the value before the moment 'paste' was switched from off to on.
5741 Resetting 'paste' before ever setting it does not have any effect.
5742 Since mapping doesn't work while 'paste' is active, you need to use
5743 the 'pastetoggle' option to toggle the 'paste' option with some key.
5744
5745 *'pastetoggle'* *'pt'*
5746'pastetoggle' 'pt' string (default "")
5747 global
5748 {not in Vi}
5749 When non-empty, specifies the key sequence that toggles the 'paste'
5750 option. This is like specifying a mapping: >
5751 :map {keys} :set invpaste<CR>
5752< Where {keys} is the value of 'pastetoggle'.
5753 The difference is that it will work even when 'paste' is set.
5754 'pastetoggle' works in Insert mode and Normal mode, but not in
5755 Command-line mode.
5756 Mappings are checked first, thus overrule 'pastetoggle'. However,
5757 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5758 this: >
5759 :map <F10> :set paste<CR>
5760 :map <F11> :set nopaste<CR>
5761 :imap <F10> <C-O>:set paste<CR>
5762 :imap <F11> <nop>
5763 :set pastetoggle=<F11>
5764< This will make <F10> start paste mode and <F11> stop paste mode.
5765 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5766 mode everything is inserted literally, except the 'pastetoggle' key
5767 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005768 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769
5770 *'pex'* *'patchexpr'*
5771'patchexpr' 'pex' string (default "")
5772 global
5773 {not in Vi}
5774 {not available when compiled without the |+diff|
5775 feature}
5776 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005777 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778
Bram Moolenaardbc28022014-07-26 13:40:44 +02005779 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780'patchmode' 'pm' string (default "")
5781 global
5782 {not in Vi}
5783 When non-empty the oldest version of a file is kept. This can be used
5784 to keep the original version of a file if you are changing files in a
5785 source distribution. Only the first time that a file is written a
5786 copy of the original file will be kept. The name of the copy is the
5787 name of the original file with the string in the 'patchmode' option
5788 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005789 ".orig" or ".org". 'backupdir' must not be empty for this to work
5790 (Detail: The backup file is renamed to the patchmode file after the
5791 new file has been successfully written, that's why it must be possible
5792 to write a backup file). If there was no file to be backed up, an
5793 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794 When the 'backupskip' pattern matches, a patchmode file is not made.
5795 Using 'patchmode' for compressed files appends the extension at the
5796 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5797 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005798 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005799
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005800 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801'path' 'pa' string (default on Unix: ".,/usr/include,,"
5802 on OS/2: ".,/emx/include,,"
5803 other systems: ".,,")
5804 global or local to buffer |global-local|
5805 {not in Vi}
5806 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005807 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5808 provided that the file being searched for has a relative path (not
5809 starting with "/", "./" or "../"). The directories in the 'path'
5810 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 - Use commas to separate directory names: >
5812 :set path=.,/usr/local/include,/usr/include
5813< - Spaces can also be used to separate directory names (for backwards
5814 compatibility with version 3.0). To have a space in a directory
5815 name, precede it with an extra backslash, and escape the space: >
5816 :set path=.,/dir/with\\\ space
5817< - To include a comma in a directory name precede it with an extra
5818 backslash: >
5819 :set path=.,/dir/with\\,comma
5820< - To search relative to the directory of the current file, use: >
5821 :set path=.
5822< - To search in the current directory use an empty string between two
5823 commas: >
5824 :set path=,,
5825< - A directory name may end in a ':' or '/'.
5826 - Environment variables are expanded |:set_env|.
5827 - When using |netrw.vim| URLs can be used. For example, adding
5828 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005829 - Search upwards and downwards in a directory tree using "*", "**" and
5830 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 {not available when compiled without the |+path_extra| feature}
5832 - Careful with '\' characters, type two to get one in the option: >
5833 :set path=.,c:\\include
5834< Or just use '/' instead: >
5835 :set path=.,c:/include
5836< Don't forget "." or files won't even be found in the same directory as
5837 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005838 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 it is something like 256 or 1024 characters.
5840 You can check if all the include files are found, using the value of
5841 'path', see |:checkpath|.
5842 The use of |:set+=| and |:set-=| is preferred when adding or removing
5843 directories from the list. This avoids problems when a future version
5844 uses another default. To remove the current directory use: >
5845 :set path-=
5846< To add the current directory use: >
5847 :set path+=
5848< To use an environment variable, you probably need to replace the
5849 separator. Here is an example to append $INCL, in which directory
5850 names are separated with a semi-colon: >
5851 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5852< Replace the ';' with a ':' or whatever separator is used. Note that
5853 this doesn't work when $INCL contains a comma or white space.
5854
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005855 *'perldll'*
5856'perldll' string (default depends on the build)
5857 global
5858 {not in Vi}
5859 {only available when compiled with the |+perl/dyn|
5860 feature}
5861 Specifies the name of the Perl shared library. The default is
5862 DYNAMIC_PERL_DLL, which was specified at compile time.
5863 Environment variables are expanded |:set_env|.
5864 This option cannot be set from a |modeline| or in the |sandbox|, for
5865 security reasons.
5866
Bram Moolenaar071d4272004-06-13 20:20:40 +00005867 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5868'preserveindent' 'pi' boolean (default off)
5869 local to buffer
5870 {not in Vi}
5871 When changing the indent of the current line, preserve as much of the
5872 indent structure as possible. Normally the indent is replaced by a
5873 series of tabs followed by spaces as required (unless |'expandtab'| is
5874 enabled, in which case only spaces are used). Enabling this option
5875 means the indent will preserve as many existing characters as possible
5876 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005877 'expandtab' does not apply to the preserved white space, a Tab remains
5878 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 NOTE: When using ">>" multiple times the resulting indent is a mix of
5880 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005881 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 Also see 'copyindent'.
5883 Use |:retab| to clean up white space.
5884
5885 *'previewheight'* *'pvh'*
5886'previewheight' 'pvh' number (default 12)
5887 global
5888 {not in Vi}
5889 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005890 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 Default height for a preview window. Used for |:ptag| and associated
5892 commands. Used for |CTRL-W_}| when no count is given.
5893
5894 *'previewwindow'* *'nopreviewwindow'*
5895 *'pvw'* *'nopvw'* *E590*
5896'previewwindow' 'pvw' boolean (default off)
5897 local to window
5898 {not in Vi}
5899 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005900 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005901 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 set. It's normally not set directly, but by using one of the commands
5903 |:ptag|, |:pedit|, etc.
5904
5905 *'printdevice'* *'pdev'*
5906'printdevice' 'pdev' string (default empty)
5907 global
5908 {not in Vi}
5909 {only available when compiled with the |+printer|
5910 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005911 The name of the printer to be used for |:hardcopy|.
5912 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005913 This option cannot be set from a |modeline| or in the |sandbox|, for
5914 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915
Bram Moolenaar8299df92004-07-10 09:47:34 +00005916 *'printencoding'* *'penc'*
5917'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 global
5919 {not in Vi}
5920 {only available when compiled with the |+printer|
5921 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005922 Sets the character encoding used when printing.
5923 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924
5925 *'printexpr'* *'pexpr'*
5926'printexpr' 'pexpr' String (default: see below)
5927 global
5928 {not in Vi}
5929 {only available when compiled with the |+printer|
5930 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005931 Expression used to print the PostScript produced with |:hardcopy|.
5932 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005933 This option cannot be set from a |modeline| or in the |sandbox|, for
5934 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935
Bram Moolenaar8299df92004-07-10 09:47:34 +00005936 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937'printfont' 'pfn' string (default "courier")
5938 global
5939 {not in Vi}
5940 {only available when compiled with the |+printer|
5941 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005942 The name of the font that will be used for |:hardcopy|.
5943 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944
5945 *'printheader'* *'pheader'*
5946'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5947 global
5948 {not in Vi}
5949 {only available when compiled with the |+printer|
5950 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005951 The format of the header produced in |:hardcopy| output.
5952 See |pheader-option|.
5953
5954 *'printmbcharset'* *'pmbcs'*
5955'printmbcharset' 'pmbcs' string (default "")
5956 global
5957 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005958 {only available when compiled with the |+printer|,
5959 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005960 The CJK character set to be used for CJK output from |:hardcopy|.
5961 See |pmbcs-option|.
5962
5963 *'printmbfont'* *'pmbfn'*
5964'printmbfont' 'pmbfn' string (default "")
5965 global
5966 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005967 {only available when compiled with the |+printer|,
5968 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005969 List of font names to be used for CJK output from |:hardcopy|.
5970 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971
5972 *'printoptions'* *'popt'*
5973'printoptions' 'popt' string (default "")
5974 global
5975 {not in Vi}
5976 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005977 List of items that control the format of the output of |:hardcopy|.
5978 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005980 *'prompt'* *'noprompt'*
5981'prompt' boolean (default on)
5982 global
5983 When on a ":" prompt is used in Ex mode.
5984
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005985 *'pumheight'* *'ph'*
5986'pumheight' 'ph' number (default 0)
5987 global
5988 {not available when compiled without the
5989 |+insert_expand| feature}
5990 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005991 Determines the maximum number of items to show in the popup menu for
5992 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005993 |ins-completion-menu|.
5994
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005995 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005996'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005997 global
5998 {not available when compiled without the
5999 |+insert_expand| feature}
6000 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006001 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006002 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006003
Bram Moolenaard94464e2015-11-02 15:28:18 +01006004 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006005'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006006 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006007 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006008 {only available when compiled with the |+python/dyn|
6009 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006010 Specifies the name of the Python 2.x shared library. The default is
6011 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006012 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006013 This option cannot be set from a |modeline| or in the |sandbox|, for
6014 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006015
Bram Moolenaar94073162018-01-31 21:49:05 +01006016 *'pythonhome'*
6017'pythonhome' string (default "")
6018 global
6019 {not in Vi}
6020 {only available when compiled with the |+python/dyn|
6021 feature}
6022 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6023 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6024 which was specified at compile time, will be used for the Python 2.x
6025 home directory.
6026 Environment variables are expanded |:set_env|.
6027 This option cannot be set from a |modeline| or in the |sandbox|, for
6028 security reasons.
6029
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006030 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006031'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006032 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006033 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006034 {only available when compiled with the |+python3/dyn|
6035 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006036 Specifies the name of the Python 3 shared library. The default is
6037 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006038 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006039 This option cannot be set from a |modeline| or in the |sandbox|, for
6040 security reasons.
6041
Bram Moolenaar94073162018-01-31 21:49:05 +01006042 *'pythonthreehome'*
6043'pythonthreehome' string (default "")
6044 global
6045 {not in Vi}
6046 {only available when compiled with the |+python3/dyn|
6047 feature}
6048 Specifies the name of the Python 3 home directory. When
6049 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6050 PYTHON3_HOME, which was specified at compile time, will be used for
6051 the Python 3 home directory.
6052 Environment variables are expanded |:set_env|.
6053 This option cannot be set from a |modeline| or in the |sandbox|, for
6054 security reasons.
6055
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006056 *'pyxversion'* *'pyx'*
6057'pyxversion' 'pyx' number (default depends on the build)
6058 global
6059 {not in Vi}
6060 {only available when compiled with the |+python| or
6061 the |+python3| feature}
6062 Specifies the python version used for pyx* functions and commands
6063 |python_x|. The default value is as follows:
6064
6065 Compiled with Default ~
6066 |+python| and |+python3| 0
6067 only |+python| 2
6068 only |+python3| 3
6069
6070 Available values are 0, 2 and 3.
6071 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6072 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6073 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6074 to 2 if Python 2 is available.
6075 See also: |has-pythonx|
6076
6077 If Vim is compiled with only |+python| or |+python3| setting
6078 'pyxversion' has no effect. The pyx* functions and commands are
6079 always the same as the compiled version.
6080
6081 This option cannot be set from a |modeline| or in the |sandbox|, for
6082 security reasons.
6083
Bram Moolenaar677ee682005-01-27 14:41:15 +00006084 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006085'quoteescape' 'qe' string (default "\")
6086 local to buffer
6087 {not in Vi}
6088 The characters that are used to escape quotes in a string. Used for
6089 objects like a', a" and a` |a'|.
6090 When one of the characters in this option is found inside a string,
6091 the following character will be skipped. The default value makes the
6092 text "foo\"bar\\" considered to be one string.
6093
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6095'readonly' 'ro' boolean (default off)
6096 local to buffer
6097 If on, writes fail unless you use a '!'. Protects you from
6098 accidentally overwriting a file. Default on when Vim is started
6099 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006100 When using ":w!" the 'readonly' option is reset for the current
6101 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006103 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006104 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006106 *'redrawtime'* *'rdt'*
6107'redrawtime' 'rdt' number (default 2000)
6108 global
6109 {not in Vi}
6110 {only available when compiled with the |+reltime|
6111 feature}
6112 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006113 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006114 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006115 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006116 matches will be highlighted.
6117 For syntax highlighting the time applies per window. When over the
6118 limit syntax highlighting is disabled until |CTRL-L| is used.
6119 This is used to avoid that Vim hangs when using a very complicated
6120 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006121
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006122 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006123'regexpengine' 're' number (default 0)
6124 global
6125 {not in Vi}
6126 This selects the default regexp engine. |two-engines|
6127 The possible values are:
6128 0 automatic selection
6129 1 old engine
6130 2 NFA engine
6131 Note that when using the NFA engine and the pattern contains something
6132 that is not supported the pattern will not match. This is only useful
6133 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006134 Using automatic selection enables Vim to switch the engine, if the
6135 default engine becomes too costly. E.g., when the NFA engine uses too
6136 many states. This should prevent Vim from hanging on a combination of
6137 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006138
Bram Moolenaar64486672010-05-16 15:46:46 +02006139 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6140'relativenumber' 'rnu' boolean (default off)
6141 local to window
6142 {not in Vi}
6143 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006144 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006145 precede some vertical motion commands (e.g. j k + -) with, without
6146 having to calculate it yourself. Especially useful in combination with
6147 other commands (e.g. y d c < > gq gw =).
6148 When the 'n' option is excluded from 'cpoptions' a wrapped
6149 line will not use the column of line numbers (this is the default when
6150 'compatible' isn't set).
6151 The 'numberwidth' option can be used to set the room used for the line
6152 number.
6153 When a long, wrapped line doesn't start with the first character, '-'
6154 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006155 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6156 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006157
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006158 The number in front of the cursor line also depends on the value of
6159 'number', see |number_relativenumber| for all combinations of the two
6160 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006161
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 *'remap'* *'noremap'*
6163'remap' boolean (default on)
6164 global
6165 Allows for mappings to work recursively. If you do not want this for
6166 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006167 NOTE: To avoid portability problems with Vim scripts, always keep
6168 this option at the default "on". Only switch it off when working with
6169 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006171 *'renderoptions'* *'rop'*
6172'renderoptions' 'rop' string (default: empty)
6173 global
6174 {not in Vi}
6175 {only available when compiled with GUI and DIRECTX on
6176 MS-Windows}
6177 Select a text renderer and set its options. The options depend on the
6178 renderer.
6179
6180 Syntax: >
6181 set rop=type:{renderer}(,{name}:{value})*
6182<
6183 Currently, only one optional renderer is available.
6184
6185 render behavior ~
6186 directx Vim will draw text using DirectX (DirectWrite). It makes
6187 drawn glyphs more beautiful than default GDI.
6188 It requires 'encoding' is "utf-8", and only works on
6189 MS-Windows Vista or newer version.
6190
6191 Options:
6192 name meaning type value ~
6193 gamma gamma float 1.0 - 2.2 (maybe)
6194 contrast enhancedContrast float (unknown)
6195 level clearTypeLevel float (unknown)
6196 geom pixelGeometry int 0 - 2 (see below)
6197 renmode renderingMode int 0 - 6 (see below)
6198 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006199 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006200
Bram Moolenaar92467d32017-12-05 13:22:16 +01006201 See this URL for detail (except for scrlines):
6202 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006203
6204 For geom: structure of a device pixel.
6205 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6206 1 - DWRITE_PIXEL_GEOMETRY_RGB
6207 2 - DWRITE_PIXEL_GEOMETRY_BGR
6208
6209 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006210 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006211
6212 For renmode: method of rendering glyphs.
6213 0 - DWRITE_RENDERING_MODE_DEFAULT
6214 1 - DWRITE_RENDERING_MODE_ALIASED
6215 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6216 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6217 4 - DWRITE_RENDERING_MODE_NATURAL
6218 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6219 6 - DWRITE_RENDERING_MODE_OUTLINE
6220
6221 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006222 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006223
6224 For taamode: antialiasing mode used for drawing text.
6225 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6226 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6227 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6228 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6229
6230 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006231 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6232
Bram Moolenaara338adc2018-01-31 20:51:47 +01006233 For scrlines:
6234 This was used for optimizing scrolling behavior, however this
6235 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006236
6237 Example: >
6238 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006239 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006240 set rop=type:directx
6241<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006242 If select a raster font (Courier, Terminal or FixedSys which
6243 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006244 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006245
6246 NOTE: It is known that some fonts and options combination
6247 causes trouble on drawing glyphs.
6248
Bram Moolenaar92467d32017-12-05 13:22:16 +01006249 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006250 special made fonts (True-Type fonts which includes only
6251 bitmap glyphs).
6252 - 'taamode:3' will not work with some vector fonts.
6253
6254 NOTE: With this option, you can display colored emoji
6255 (emoticon) in Windows 8.1 or later. To display colored emoji,
6256 there are some conditions which you should notice.
6257
6258 - If your font includes non-colored emoji already, it will
6259 be used.
6260 - If your font doesn't have emoji, the system chooses an
6261 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6262 will be used.
6263 - When this alternative font didn't have fixed width glyph,
6264 emoji might be rendered beyond the bounding box of drawing
6265 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006266
6267 Other render types are currently not supported.
6268
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 *'report'*
6270'report' number (default 2)
6271 global
6272 Threshold for reporting number of lines changed. When the number of
6273 changed lines is more than 'report' a message will be given for most
6274 ":" commands. If you want it always, set 'report' to 0.
6275 For the ":substitute" command the number of substitutions is used
6276 instead of the number of lines.
6277
6278 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6279'restorescreen' 'rs' boolean (default on)
6280 global
6281 {not in Vi} {only in Windows 95/NT console version}
6282 When set, the screen contents is restored when exiting Vim. This also
6283 happens when executing external commands.
6284
6285 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6286 options in your .vimrc. To disable restoring:
6287 set t_ti= t_te=
6288 To enable restoring (for an xterm):
6289 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6290 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6291
6292 *'revins'* *'ri'* *'norevins'* *'nori'*
6293'revins' 'ri' boolean (default off)
6294 global
6295 {not in Vi}
6296 {only available when compiled with the |+rightleft|
6297 feature}
6298 Inserting characters in Insert mode will work backwards. See "typing
6299 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6300 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006301 NOTE: This option is reset when 'compatible' is set.
6302 This option is reset when 'paste' is set and restored when 'paste' is
6303 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304
6305 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6306'rightleft' 'rl' boolean (default off)
6307 local to window
6308 {not in Vi}
6309 {only available when compiled with the |+rightleft|
6310 feature}
6311 When on, display orientation becomes right-to-left, i.e., characters
6312 that are stored in the file appear from the right to the left.
6313 Using this option, it is possible to edit files for languages that
6314 are written from the right to the left such as Hebrew and Arabic.
6315 This option is per window, so it is possible to edit mixed files
6316 simultaneously, or to view the same file in both ways (this is
6317 useful whenever you have a mixed text file with both right-to-left
6318 and left-to-right strings so that both sets are displayed properly
6319 in different windows). Also see |rileft.txt|.
6320
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006321 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322'rightleftcmd' 'rlc' string (default "search")
6323 local to window
6324 {not in Vi}
6325 {only available when compiled with the |+rightleft|
6326 feature}
6327 Each word in this option enables the command line editing to work in
6328 right-to-left mode for a group of commands:
6329
6330 search "/" and "?" commands
6331
6332 This is useful for languages such as Hebrew, Arabic and Farsi.
6333 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6334
Bram Moolenaard94464e2015-11-02 15:28:18 +01006335 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006336'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006337 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006338 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006339 {only available when compiled with the |+ruby/dyn|
6340 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006341 Specifies the name of the Ruby shared library. The default is
6342 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006343 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006344 This option cannot be set from a |modeline| or in the |sandbox|, for
6345 security reasons.
6346
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006348'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 global
6350 {not in Vi}
6351 {not available when compiled without the
6352 |+cmdline_info| feature}
6353 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006354 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 text in the file is shown on the far right:
6356 Top first line is visible
6357 Bot last line is visible
6358 All first and last line are visible
6359 45% relative position in the file
6360 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006361 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006363 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 this option takes precedence over 'ruler' and 'rulerformat'
6365 If the number of characters displayed is different from the number of
6366 bytes in the text (e.g., for a TAB or a multi-byte character), both
6367 the text column (byte number) and the screen column are shown,
6368 separated with a dash.
6369 For an empty line "0-1" is shown.
6370 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006371 This option is reset when 'paste' is set and restored when 'paste' is
6372 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 If you don't want to see the ruler all the time but want to know where
6374 you are, use "g CTRL-G" |g_CTRL-G|.
6375 NOTE: This option is reset when 'compatible' is set.
6376
6377 *'rulerformat'* *'ruf'*
6378'rulerformat' 'ruf' string (default empty)
6379 global
6380 {not in Vi}
6381 {not available when compiled without the |+statusline|
6382 feature}
6383 When this option is not empty, it determines the content of the ruler
6384 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006385 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 The default ruler width is 17 characters. To make the ruler 15
6387 characters wide, put "%15(" at the start and "%)" at the end.
6388 Example: >
6389 :set rulerformat=%15(%c%V\ %p%%%)
6390<
6391 *'runtimepath'* *'rtp'* *vimfiles*
6392'runtimepath' 'rtp' string (default:
6393 Unix: "$HOME/.vim,
6394 $VIM/vimfiles,
6395 $VIMRUNTIME,
6396 $VIM/vimfiles/after,
6397 $HOME/.vim/after"
6398 Amiga: "home:vimfiles,
6399 $VIM/vimfiles,
6400 $VIMRUNTIME,
6401 $VIM/vimfiles/after,
6402 home:vimfiles/after"
6403 PC, OS/2: "$HOME/vimfiles,
6404 $VIM/vimfiles,
6405 $VIMRUNTIME,
6406 $VIM/vimfiles/after,
6407 $HOME/vimfiles/after"
6408 Macintosh: "$VIM:vimfiles,
6409 $VIMRUNTIME,
6410 $VIM:vimfiles:after"
6411 RISC-OS: "Choices:vimfiles,
6412 $VIMRUNTIME,
6413 Choices:vimfiles/after"
6414 VMS: "sys$login:vimfiles,
6415 $VIM/vimfiles,
6416 $VIMRUNTIME,
6417 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006418 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 global
6420 {not in Vi}
6421 This is a list of directories which will be searched for runtime
6422 files:
6423 filetype.vim filetypes by file name |new-filetype|
6424 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006425 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 colors/ color scheme files |:colorscheme|
6427 compiler/ compiler files |:compiler|
6428 doc/ documentation |write-local-help|
6429 ftplugin/ filetype plugins |write-filetype-plugin|
6430 indent/ indent scripts |indent-expression|
6431 keymap/ key mapping files |mbyte-keymap|
6432 lang/ menu translations |:menutrans|
6433 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006434 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 plugin/ plugin scripts |write-plugin|
6436 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006437 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 syntax/ syntax files |mysyntaxfile|
6439 tutor/ files for vimtutor |tutor|
6440
6441 And any other file searched for with the |:runtime| command.
6442
6443 The defaults for most systems are setup to search five locations:
6444 1. In your home directory, for your personal preferences.
6445 2. In a system-wide Vim directory, for preferences from the system
6446 administrator.
6447 3. In $VIMRUNTIME, for files distributed with Vim.
6448 *after-directory*
6449 4. In the "after" directory in the system-wide Vim directory. This is
6450 for the system administrator to overrule or add to the distributed
6451 defaults (rarely needed)
6452 5. In the "after" directory in your home directory. This is for
6453 personal preferences to overrule or add to the distributed defaults
6454 or system-wide settings (rarely needed).
6455
Bram Moolenaard0796902016-09-16 20:02:31 +02006456 More entries are added when using |packages|. If it gets very long
6457 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6458 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006459
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6461 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006462 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 wildcards.
6464 See |:runtime|.
6465 Example: >
6466 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6467< This will use the directory "~/vimruntime" first (containing your
6468 personal Vim runtime files), then "/mygroup/vim" (shared between a
6469 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6470 files).
6471 You probably should always include $VIMRUNTIME somewhere, to use the
6472 distributed runtime files. You can put a directory before $VIMRUNTIME
6473 to find files which replace a distributed runtime files. You can put
6474 a directory after $VIMRUNTIME to find files which add to distributed
6475 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006476 When Vim is started with |--clean| the home directory entries are not
6477 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 This option cannot be set from a |modeline| or in the |sandbox|, for
6479 security reasons.
6480
6481 *'scroll'* *'scr'*
6482'scroll' 'scr' number (default: half the window height)
6483 local to window
6484 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6485 set to half the number of lines in the window when the window size
6486 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006487 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6489 the number of screen lines instead of file lines, makes a difference
6490 when lines wrap}
6491
6492 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6493'scrollbind' 'scb' boolean (default off)
6494 local to window
6495 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 See also |scroll-binding|. When this option is set, the current
6497 window scrolls as other scrollbind windows (windows that also have
6498 this option set) scroll. This option is useful for viewing the
6499 differences between two versions of a file, see 'diff'.
6500 See |'scrollopt'| for options that determine how this option should be
6501 interpreted.
6502 This option is mostly reset when splitting a window to edit another
6503 file. This means that ":split | edit file" results in two windows
6504 with scroll-binding, but ":split file" does not.
6505
6506 *'scrolljump'* *'sj'*
6507'scrolljump' 'sj' number (default 1)
6508 global
6509 {not in Vi}
6510 Minimal number of lines to scroll when the cursor gets off the
6511 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6512 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006513 When set to a negative number from -1 to -100 this is used as the
6514 percentage of the window height. Thus -50 scrolls half the window
6515 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 NOTE: This option is set to 1 when 'compatible' is set.
6517
6518 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006519'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 global
6521 {not in Vi}
6522 Minimal number of screen lines to keep above and below the cursor.
6523 This will make some context visible around where you are working. If
6524 you set it to a very large value (999) the cursor line will always be
6525 in the middle of the window (except at the start or end of the file or
6526 when long lines wrap).
6527 For scrolling horizontally see 'sidescrolloff'.
6528 NOTE: This option is set to 0 when 'compatible' is set.
6529
6530 *'scrollopt'* *'sbo'*
6531'scrollopt' 'sbo' string (default "ver,jump")
6532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 {not in Vi}
6534 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006535 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6536 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 The following words are available:
6538 ver Bind vertical scrolling for 'scrollbind' windows
6539 hor Bind horizontal scrolling for 'scrollbind' windows
6540 jump Applies to the offset between two windows for vertical
6541 scrolling. This offset is the difference in the first
6542 displayed line of the bound windows. When moving
6543 around in a window, another 'scrollbind' window may
6544 reach a position before the start or after the end of
6545 the buffer. The offset is not changed though, when
6546 moving back the 'scrollbind' window will try to scroll
6547 to the desired position when possible.
6548 When now making that window the current one, two
6549 things can be done with the relative offset:
6550 1. When "jump" is not included, the relative offset is
6551 adjusted for the scroll position in the new current
6552 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006553 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 2. When "jump" is included, the other windows are
6555 scrolled to keep the same relative offset. When
6556 going back to the other window, it still uses the
6557 same relative offset.
6558 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006559 When 'diff' mode is active there always is vertical scroll binding,
6560 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561
6562 *'sections'* *'sect'*
6563'sections' 'sect' string (default "SHNHH HUnhsh")
6564 global
6565 Specifies the nroff macros that separate sections. These are pairs of
6566 two letters (See |object-motions|). The default makes a section start
6567 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6568
6569 *'secure'* *'nosecure'* *E523*
6570'secure' boolean (default off)
6571 global
6572 {not in Vi}
6573 When on, ":autocmd", shell and write commands are not allowed in
6574 ".vimrc" and ".exrc" in the current directory and map commands are
6575 displayed. Switch it off only if you know that you will not run into
6576 problems, or when the 'exrc' option is off. On Unix this option is
6577 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006578 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 'secure' at the end of your ~/.vimrc then.
6580 This option cannot be set from a |modeline| or in the |sandbox|, for
6581 security reasons.
6582
6583 *'selection'* *'sel'*
6584'selection' 'sel' string (default "inclusive")
6585 global
6586 {not in Vi}
6587 This option defines the behavior of the selection. It is only used
6588 in Visual and Select mode.
6589 Possible values:
6590 value past line inclusive ~
6591 old no yes
6592 inclusive yes yes
6593 exclusive yes no
6594 "past line" means that the cursor is allowed to be positioned one
6595 character past the line.
6596 "inclusive" means that the last character of the selection is included
6597 in an operation. For example, when "x" is used to delete the
6598 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006599 When "old" is used and 'virtualedit' allows the cursor to move past
6600 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 Note that when "exclusive" is used and selecting from the end
6602 backwards, you cannot include the last character of a line, when
6603 starting in Normal mode and 'virtualedit' empty.
6604
6605 The 'selection' option is set by the |:behave| command.
6606
6607 *'selectmode'* *'slm'*
6608'selectmode' 'slm' string (default "")
6609 global
6610 {not in Vi}
6611 This is a comma separated list of words, which specifies when to start
6612 Select mode instead of Visual mode, when a selection is started.
6613 Possible values:
6614 mouse when using the mouse
6615 key when using shifted special keys
6616 cmd when using "v", "V" or CTRL-V
6617 See |Select-mode|.
6618 The 'selectmode' option is set by the |:behave| command.
6619
6620 *'sessionoptions'* *'ssop'*
6621'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006622 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 global
6624 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006625 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 feature}
6627 Changes the effect of the |:mksession| command. It is a comma
6628 separated list of words. Each word enables saving and restoring
6629 something:
6630 word save and restore ~
6631 blank empty windows
6632 buffers hidden and unloaded buffers, not just those in windows
6633 curdir the current directory
6634 folds manually created folds, opened/closed folds and local
6635 fold options
6636 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006637 and contain at least one lowercase letter. Only
6638 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 help the help window
6640 localoptions options and mappings local to a window or buffer (not
6641 global values for local options)
6642 options all options and mappings (also global values for local
6643 options)
6644 resize size of the Vim window: 'lines' and 'columns'
6645 sesdir the directory in which the session file is located
6646 will become the current directory (useful with
6647 projects accessed over a network from different
6648 systems)
6649 slash backslashes in file names replaced with forward
6650 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006651 tabpages all tab pages; without this only the current tab page
6652 is restored, so that you can make a session for each
6653 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006654 terminal include terminal windows where the command can be
6655 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 unix with Unix end-of-line format (single <NL>), even when
6657 on Windows or DOS
6658 winpos position of the whole Vim window
6659 winsize window sizes
6660
6661 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006662 When neither "curdir" nor "sesdir" is included, file names are stored
6663 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 "slash" and "unix" are useful on Windows when sharing session files
6665 with Unix. The Unix version of Vim cannot source dos format scripts,
6666 but the Windows version of Vim can source unix format scripts.
6667
6668 *'shell'* *'sh'* *E91*
6669'shell' 'sh' string (default $SHELL or "sh",
6670 MS-DOS and Win32: "command.com" or
6671 "cmd.exe", OS/2: "cmd")
6672 global
6673 Name of the shell to use for ! and :! commands. When changing the
6674 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6675 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006676 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 See |option-backslash| about including spaces and backslashes.
6678 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006679
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006681 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6683< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006686 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006688 Example with escaped space (Vim will do this when initializing the
6689 option from $SHELL): >
6690 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006691< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006692 backslashes are consumed by `:set`.
6693
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 Under MS-Windows, when the executable ends in ".com" it must be
6695 included. Thus setting the shell to "command.com" or "4dos.com"
6696 works, but "command" and "4dos" do not work for all commands (e.g.,
6697 filtering).
6698 For unknown reasons, when using "4dos.com" the current directory is
6699 changed to "C:\". To avoid this set 'shell' like this: >
6700 :set shell=command.com\ /c\ 4dos
6701< This option cannot be set from a |modeline| or in the |sandbox|, for
6702 security reasons.
6703
6704 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006705'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006706 MS-DOS and Win32, when 'shell' does not
6707 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 global
6709 {not in Vi}
6710 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6711 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6712 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006713 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006714 On Unix it can have more than one flag. Each white space separated
6715 part is passed as an argument to the shell command.
6716 See |option-backslash| about including spaces and backslashes.
6717 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 This option cannot be set from a |modeline| or in the |sandbox|, for
6719 security reasons.
6720
6721 *'shellpipe'* *'sp'*
6722'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6723 global
6724 {not in Vi}
6725 {not available when compiled without the |+quickfix|
6726 feature}
6727 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006728 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 including spaces and backslashes.
6730 The name of the temporary file can be represented by "%s" if necessary
6731 (the file name is appended automatically if no %s appears in the value
6732 of this option).
6733 For the Amiga and MS-DOS the default is ">". The output is directly
6734 saved in a file and not echoed to the screen.
6735 For Unix the default it "| tee". The stdout of the compiler is saved
6736 in a file and echoed to the screen. If the 'shell' option is "csh" or
6737 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006738 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6739 default becomes "2>&1| tee". This means that stderr is also included.
6740 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6741 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 The initialization of this option is done after reading the ".vimrc"
6743 and the other initializations, so that when the 'shell' option is set
6744 there, the 'shellpipe' option changes automatically, unless it was
6745 explicitly set before.
6746 When 'shellpipe' is set to an empty string, no redirection of the
6747 ":make" output will be done. This is useful if you use a 'makeprg'
6748 that writes to 'makeef' by itself. If you want no piping, but do
6749 want to include the 'makeef', set 'shellpipe' to a single space.
6750 Don't forget to precede the space with a backslash: ":set sp=\ ".
6751 In the future pipes may be used for filtering and this option will
6752 become obsolete (at least for Unix).
6753 This option cannot be set from a |modeline| or in the |sandbox|, for
6754 security reasons.
6755
6756 *'shellquote'* *'shq'*
6757'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6758 contains "sh" somewhere: "\"")
6759 global
6760 {not in Vi}
6761 Quoting character(s), put around the command passed to the shell, for
6762 the "!" and ":!" commands. The redirection is kept outside of the
6763 quoting. See 'shellxquote' to include the redirection. It's
6764 probably not useful to set both options.
6765 This is an empty string by default. Only known to be useful for
6766 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6767 or bash, where it should be "\"". The default is adjusted according
6768 the value of 'shell', to reduce the need to set this option by the
6769 user. See |dos-shell|.
6770 This option cannot be set from a |modeline| or in the |sandbox|, for
6771 security reasons.
6772
6773 *'shellredir'* *'srr'*
6774'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6775 global
6776 {not in Vi}
6777 String to be used to put the output of a filter command in a temporary
6778 file. See also |:!|. See |option-backslash| about including spaces
6779 and backslashes.
6780 The name of the temporary file can be represented by "%s" if necessary
6781 (the file name is appended automatically if no %s appears in the value
6782 of this option).
6783 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6784 or "zsh" during initializations, the default becomes ">&". If the
6785 'shell' option is "sh", "ksh" or "bash" the default becomes
6786 ">%s 2>&1". This means that stderr is also included.
6787 For Win32, the Unix checks are done and additionally "cmd" is checked
6788 for, which makes the default ">%s 2>&1". Also, the same names with
6789 ".exe" appended are checked for.
6790 The initialization of this option is done after reading the ".vimrc"
6791 and the other initializations, so that when the 'shell' option is set
6792 there, the 'shellredir' option changes automatically unless it was
6793 explicitly set before.
6794 In the future pipes may be used for filtering and this option will
6795 become obsolete (at least for Unix).
6796 This option cannot be set from a |modeline| or in the |sandbox|, for
6797 security reasons.
6798
6799 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6800'shellslash' 'ssl' boolean (default off)
6801 global
6802 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6803 When set, a forward slash is used when expanding file names. This is
6804 useful when a Unix-like shell is used instead of command.com or
6805 cmd.exe. Backward slashes can still be typed, but they are changed to
6806 forward slashes by Vim.
6807 Note that setting or resetting this option has no effect for some
6808 existing file names, thus this option needs to be set before opening
6809 any file for best results. This might change in the future.
6810 'shellslash' only works when a backslash can be used as a path
6811 separator. To test if this is so use: >
6812 if exists('+shellslash')
6813<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006814 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6815'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6816 global
6817 {not in Vi}
6818 When on, use temp files for shell commands. When off use a pipe.
6819 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006820 Currently a pipe is only supported on Unix and MS-Windows 2K and
6821 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006822 :if has("filterpipe")
6823< The advantage of using a pipe is that nobody can read the temp file
6824 and the 'shell' command does not need to support redirection.
6825 The advantage of using a temp file is that the file type and encoding
6826 can be detected.
6827 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6828 |FilterWritePost| autocommands event are not triggered when
6829 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006830 The `system()` function does not respect this option and always uses
6831 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006832 NOTE: This option is set to the Vim default value when 'compatible'
6833 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006834
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 *'shelltype'* *'st'*
6836'shelltype' 'st' number (default 0)
6837 global
6838 {not in Vi} {only for the Amiga}
6839 On the Amiga this option influences the way how the commands work
6840 which use a shell.
6841 0 and 1: always use the shell
6842 2 and 3: use the shell only to filter lines
6843 4 and 5: use shell only for ':sh' command
6844 When not using the shell, the command is executed directly.
6845
6846 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6847 1 and 3: use "shell cmd" to start external commands
6848
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006849 *'shellxescape'* *'sxe'*
6850'shellxescape' 'sxe' string (default: "";
6851 for MS-DOS and MS-Windows: "\"&|<>()@^")
6852 global
6853 {not in Vi}
6854 When 'shellxquote' is set to "(" then the characters listed in this
6855 option will be escaped with a '^' character. This makes it possible
6856 to execute most external commands with cmd.exe.
6857
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 *'shellxquote'* *'sxq'*
6859'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006860 for Win32, when 'shell' is cmd.exe: "("
6861 for Win32, when 'shell' contains "sh"
6862 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 for Unix, when using system(): "\"")
6864 global
6865 {not in Vi}
6866 Quoting character(s), put around the command passed to the shell, for
6867 the "!" and ":!" commands. Includes the redirection. See
6868 'shellquote' to exclude the redirection. It's probably not useful
6869 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006870 When the value is '(' then ')' is appended. When the value is '"('
6871 then ')"' is appended.
6872 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006873 This is an empty string by default on most systems, but is known to be
6874 useful for on Win32 version, either for cmd.exe which automatically
6875 strips off the first and last quote on a command, or 3rd-party shells
6876 such as the MKS Korn Shell or bash, where it should be "\"". The
6877 default is adjusted according the value of 'shell', to reduce the need
6878 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 This option cannot be set from a |modeline| or in the |sandbox|, for
6880 security reasons.
6881
6882 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6883'shiftround' 'sr' boolean (default off)
6884 global
6885 {not in Vi}
6886 Round indent to multiple of 'shiftwidth'. Applies to > and <
6887 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6888 a multiple of 'shiftwidth' (this is Vi compatible).
6889 NOTE: This option is reset when 'compatible' is set.
6890
6891 *'shiftwidth'* *'sw'*
6892'shiftwidth' 'sw' number (default 8)
6893 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006894 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006896 When zero the 'ts' value will be used. Use the |shiftwidth()|
6897 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898
6899 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006900'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6901 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 global
6903 {not in Vi}
6904 This option helps to avoid all the |hit-enter| prompts caused by file
6905 messages, for example with CTRL-G, and to avoid some other messages.
6906 It is a list of flags:
6907 flag meaning when present ~
6908 f use "(3 of 5)" instead of "(file 3 of 5)"
6909 i use "[noeol]" instead of "[Incomplete last line]"
6910 l use "999L, 888C" instead of "999 lines, 888 characters"
6911 m use "[+]" instead of "[Modified]"
6912 n use "[New]" instead of "[New File]"
6913 r use "[RO]" instead of "[readonly]"
6914 w use "[w]" instead of "written" for file write message
6915 and "[a]" instead of "appended" for ':w >> file' command
6916 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6917 "[unix format]" and "[mac]" instead of "[mac format]".
6918 a all of the above abbreviations
6919
6920 o overwrite message for writing a file with subsequent message
6921 for reading a file (useful for ":wn" or when 'autowrite' on)
6922 O message for reading a file overwrites any previous message.
6923 Also for quickfix message (e.g., ":cn").
6924 s don't give "search hit BOTTOM, continuing at TOP" or "search
6925 hit TOP, continuing at BOTTOM" messages
6926 t truncate file message at the start if it is too long to fit
6927 on the command-line, "<" will appear in the left most column.
6928 Ignored in Ex mode.
6929 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006930 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 Ignored in Ex mode.
6932 W don't give "written" or "[w]" when writing a file
6933 A don't give the "ATTENTION" message when an existing swap file
6934 is found.
6935 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006936 c don't give |ins-completion-menu| messages. For example,
6937 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6938 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006939 q use "recording" instead of "recording @a"
6940 F don't give the file info when editing a file, like `:silent`
6941 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942
6943 This gives you the opportunity to avoid that a change between buffers
6944 requires you to hit <Enter>, but still gives as useful a message as
6945 possible for the space available. To get the whole message that you
6946 would have got with 'shm' empty, use ":file!"
6947 Useful values:
6948 shm= No abbreviation of message.
6949 shm=a Abbreviation, but no loss of information.
6950 shm=at Abbreviation, and truncate message when necessary.
6951
6952 NOTE: This option is set to the Vi default value when 'compatible' is
6953 set and to the Vim default value when 'compatible' is reset.
6954
6955 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6956'shortname' 'sn' boolean (default off)
6957 local to buffer
6958 {not in Vi, not in MS-DOS versions}
6959 Filenames are assumed to be 8 characters plus one extension of 3
6960 characters. Multiple dots in file names are not allowed. When this
6961 option is on, dots in file names are replaced with underscores when
6962 adding an extension (".~" or ".swp"). This option is not available
6963 for MS-DOS, because then it would always be on. This option is useful
6964 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6965 or crossdos. When running the Win32 GUI version under Win32s, this
6966 option is always on by default.
6967
6968 *'showbreak'* *'sbr'* *E595*
6969'showbreak' 'sbr' string (default "")
6970 global
6971 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006972 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 feature}
6974 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006975 values are "> " or "+++ ": >
6976 :set showbreak=>\
6977< Note the backslash to escape the trailing space. It's easier like
6978 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006979 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006980< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 comma (in a future version the comma might be used to separate the
6982 part that is shown at the end and at the start of a line).
6983 The characters are highlighted according to the '@' flag in
6984 'highlight'.
6985 Note that tabs after the showbreak will be displayed differently.
6986 If you want the 'showbreak' to appear in between line numbers, add the
6987 "n" flag to 'cpoptions'.
6988
6989 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006990'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6991 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 global
6993 {not in Vi}
6994 {not available when compiled without the
6995 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006996 Show (partial) command in the last line of the screen. Set this
6997 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 In Visual mode the size of the selected area is shown:
6999 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007000 If the number of bytes is different it is also displayed: "2-6"
7001 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007003 - When selecting a block, the size in screen characters:
7004 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 NOTE: This option is set to the Vi default value when 'compatible' is
7006 set and to the Vim default value when 'compatible' is reset.
7007
7008 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7009'showfulltag' 'sft' boolean (default off)
7010 global
7011 {not in Vi}
7012 When completing a word in insert mode (see |ins-completion|) from the
7013 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007014 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 matched a C function, you can see a template for what arguments are
7016 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007017 Note that this doesn't work well together with having "longest" in
7018 'completeopt', because the completion from the search pattern may not
7019 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020
7021 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7022'showmatch' 'sm' boolean (default off)
7023 global
7024 When a bracket is inserted, briefly jump to the matching one. The
7025 jump is only done if the match can be seen on the screen. The time to
7026 show the match can be set with 'matchtime'.
7027 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007028 seen or not).
7029 This option is reset when 'paste' is set and restored when 'paste' is
7030 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 When the 'm' flag is not included in 'cpoptions', typing a character
7032 will immediately move the cursor back to where it belongs.
7033 See the "sm" field in 'guicursor' for setting the cursor shape and
7034 blinking when showing the match.
7035 The 'matchpairs' option can be used to specify the characters to show
7036 matches for. 'rightleft' and 'revins' are used to look for opposite
7037 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007038 Also see the matchparen plugin for highlighting the match when moving
7039 around |pi_paren.txt|.
7040 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041
7042 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7043'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7044 global
7045 If in Insert, Replace or Visual mode put a message on the last line.
7046 Use the 'M' flag in 'highlight' to set the type of highlighting for
7047 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007048 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 doesn't mean XIM is really active, especially when 'imactivatekey' is
7050 not set.
7051 NOTE: This option is set to the Vi default value when 'compatible' is
7052 set and to the Vim default value when 'compatible' is reset.
7053
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007054 *'showtabline'* *'stal'*
7055'showtabline' 'stal' number (default 1)
7056 global
7057 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007058 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007059 feature}
7060 The value of this option specifies when the line with tab page labels
7061 will be displayed:
7062 0: never
7063 1: only if there are at least two tab pages
7064 2: always
7065 This is both for the GUI and non-GUI implementation of the tab pages
7066 line.
7067 See |tab-page| for more information about tab pages.
7068
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 *'sidescroll'* *'ss'*
7070'sidescroll' 'ss' number (default 0)
7071 global
7072 {not in Vi}
7073 The minimal number of columns to scroll horizontally. Used only when
7074 the 'wrap' option is off and the cursor is moved off of the screen.
7075 When it is zero the cursor will be put in the middle of the screen.
7076 When using a slow terminal set it to a large number or 0. When using
7077 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7078 commands.
7079
7080 *'sidescrolloff'* *'siso'*
7081'sidescrolloff' 'siso' number (default 0)
7082 global
7083 {not in Vi}
7084 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007085 right of the cursor if 'nowrap' is set. Setting this option to a
7086 value greater than 0 while having |'sidescroll'| also at a non-zero
7087 value makes some context visible in the line you are scrolling in
7088 horizontally (except at beginning of the line). Setting this option
7089 to a large value (like 999) has the effect of keeping the cursor
7090 horizontally centered in the window, as long as one does not come too
7091 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 NOTE: This option is set to 0 when 'compatible' is set.
7093
7094 Example: Try this together with 'sidescroll' and 'listchars' as
7095 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007096 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097
7098 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7099 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007100<
7101 *'signcolumn'* *'scl'*
7102'signcolumn' 'scl' string (default "auto")
7103 local to window
7104 {not in Vi}
7105 {not available when compiled without the |+signs|
7106 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007107 Whether or not to draw the signcolumn. Valid values are:
7108 "auto" only when there is a sign to display
7109 "no" never
7110 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111
7112
7113 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7114'smartcase' 'scs' boolean (default off)
7115 global
7116 {not in Vi}
7117 Override the 'ignorecase' option if the search pattern contains upper
7118 case characters. Only used when the search pattern is typed and
7119 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007120 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7122 recalling the search pattern from history and hitting <Enter>.
7123 NOTE: This option is reset when 'compatible' is set.
7124
7125 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7126'smartindent' 'si' boolean (default off)
7127 local to buffer
7128 {not in Vi}
7129 {not available when compiled without the
7130 |+smartindent| feature}
7131 Do smart autoindenting when starting a new line. Works for C-like
7132 programs, but can also be used for other languages. 'cindent' does
7133 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007134 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007135 setting 'si' has no effect. 'indentexpr' is a more advanced
7136 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 Normally 'autoindent' should also be on when using 'smartindent'.
7138 An indent is automatically inserted:
7139 - After a line ending in '{'.
7140 - After a line starting with a keyword from 'cinwords'.
7141 - Before a line starting with '}' (only with the "O" command).
7142 When typing '}' as the first character in a new line, that line is
7143 given the same indent as the matching '{'.
7144 When typing '#' as the first character in a new line, the indent for
7145 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007146 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7148 When using the ">>" command, lines starting with '#' are not shifted
7149 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007150 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007151 This option is reset when 'paste' is set and restored when 'paste' is
7152 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153
7154 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7155'smarttab' 'sta' boolean (default off)
7156 global
7157 {not in Vi}
7158 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007159 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7160 <BS> will delete a 'shiftwidth' worth of space at the start of the
7161 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007162 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007163 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7164 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007165 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007167 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007168 This option is reset when 'paste' is set and restored when 'paste' is
7169 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 NOTE: This option is reset when 'compatible' is set.
7171
7172 *'softtabstop'* *'sts'*
7173'softtabstop' 'sts' number (default 0)
7174 local to buffer
7175 {not in Vi}
7176 Number of spaces that a <Tab> counts for while performing editing
7177 operations, like inserting a <Tab> or using <BS>. It "feels" like
7178 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7179 used. This is useful to keep the 'ts' setting at its standard value
7180 of 8, while being able to edit like it is set to 'sts'. However,
7181 commands like "x" still work on the actual characters.
7182 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007183 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007184 'softtabstop' is set to 0 when the 'paste' option is set and restored
7185 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7187 spaces is minimized by using <Tab>s.
7188 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7189 set.
7190 NOTE: This option is set to 0 when 'compatible' is set.
7191
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007192 If Vim is compiled with the |+vartabs| feature then the value of
7193 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7194 anything other than an empty string.
7195
Bram Moolenaar217ad922005-03-20 22:37:15 +00007196 *'spell'* *'nospell'*
7197'spell' boolean (default off)
7198 local to window
7199 {not in Vi}
7200 {not available when compiled without the |+syntax|
7201 feature}
7202 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007203 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007204
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007205 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007206'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007207 local to buffer
7208 {not in Vi}
7209 {not available when compiled without the |+syntax|
7210 feature}
7211 Pattern to locate the end of a sentence. The following word will be
7212 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007213 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007214 When this check is not wanted make this option empty.
7215 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007216 Be careful with special characters, see |option-backslash| about
7217 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007218 To set this option automatically depending on the language, see
7219 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007220
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007221 *'spellfile'* *'spf'*
7222'spellfile' 'spf' string (default empty)
7223 local to buffer
7224 {not in Vi}
7225 {not available when compiled without the |+syntax|
7226 feature}
7227 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007228 commands. It must end in ".{encoding}.add". You need to include the
7229 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007230 *E765*
7231 It may also be a comma separated list of names. A count before the
7232 |zg| and |zw| commands can be used to access each. This allows using
7233 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007234 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007235 you: Using the first directory in 'runtimepath' that is writable. If
7236 there is no "spell" directory yet it will be created. For the file
7237 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007238 ignoring the region.
7239 The resulting ".spl" file will be used for spell checking, it does not
7240 have to appear in 'spelllang'.
7241 Normally one file is used for all regions, but you can add the region
7242 name if you want to. However, it will then only be used when
7243 'spellfile' is set to it, for entries in 'spelllang' only files
7244 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007245 This option cannot be set from a |modeline| or in the |sandbox|, for
7246 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007247
Bram Moolenaar217ad922005-03-20 22:37:15 +00007248 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007249'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007250 local to buffer
7251 {not in Vi}
7252 {not available when compiled without the |+syntax|
7253 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007254 A comma separated list of word list names. When the 'spell' option is
7255 on spellchecking will be done for these languages. Example: >
7256 set spelllang=en_us,nl,medical
7257< This means US English, Dutch and medical words are recognized. Words
7258 that are not recognized will be highlighted.
7259 The word list name must not include a comma or dot. Using a dash is
7260 recommended to separate the two letter language name from a
7261 specification. Thus "en-rare" is used for rare English words.
7262 A region name must come last and have the form "_xx", where "xx" is
7263 the two-letter, lower case region name. You can use more than one
7264 region by listing them: "en_us,en_ca" supports both US and Canadian
7265 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007266 Britain. (Note: currently en_au and en_nz dictionaries are older than
7267 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007268 If the name "cjk" is included East Asian characters are excluded from
7269 spell checking. This is useful when editing text that also has Asian
7270 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007271 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007272 As a special case the name of a .spl file can be given as-is. The
7273 first "_xx" in the name is removed and used as the region name
7274 (_xx is an underscore, two letters and followed by a non-letter).
7275 This is mainly for testing purposes. You must make sure the correct
7276 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007277 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007278 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7279 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007280 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007281
Bram Moolenaar98692072006-02-04 00:57:42 +00007282 If the |spellfile.vim| plugin is active and you use a language name
7283 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7284 will ask you if you want to download the file.
7285
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007286 After this option has been set successfully, Vim will source the files
7287 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007288 up to the first comma, dot or underscore.
7289 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007290
7291
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007292 *'spellsuggest'* *'sps'*
7293'spellsuggest' 'sps' string (default "best")
7294 global
7295 {not in Vi}
7296 {not available when compiled without the |+syntax|
7297 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007298 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007299 the |spellsuggest()| function. This is a comma-separated list of
7300 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007301
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007302 best Internal method that works best for English. Finds
7303 changes like "fast" and uses a bit of sound-a-like
7304 scoring to improve the ordering.
7305
7306 double Internal method that uses two methods and mixes the
7307 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007308 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007309 word. That only works when the language specifies
7310 sound folding. Can be slow and doesn't always give
7311 better results.
7312
7313 fast Internal method that only checks for simple changes:
7314 character inserts/deletes/swaps. Works well for
7315 simple typing mistakes.
7316
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007317 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007318 Not used for |spellsuggest()|. The number of
7319 suggestions is never more than the value of 'lines'
7320 minus two.
7321
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007322 file:{filename} Read file {filename}, which must have two columns,
7323 separated by a slash. The first column contains the
7324 bad word, the second column the suggested good word.
7325 Example:
7326 theribal/terrible ~
7327 Use this for common mistakes that do not appear at the
7328 top of the suggestion list with the internal methods.
7329 Lines without a slash are ignored, use this for
7330 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007331 The word in the second column must be correct,
7332 otherwise it will not be used. Add the word to an
7333 ".add" file if it is currently flagged as a spelling
7334 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007335 The file is used for all languages.
7336
7337 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7338 trouble with spaces. |v:val| holds the badly spelled
7339 word. The expression must evaluate to a List of
7340 Lists, each with a suggestion and a score.
7341 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007342 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007343 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007344 internal methods use. A lower score is better.
7345 This may invoke |spellsuggest()| if you temporarily
7346 set 'spellsuggest' to exclude the "expr:" part.
7347 Errors are silently ignored, unless you set the
7348 'verbose' option to a non-zero value.
7349
7350 Only one of "best", "double" or "fast" may be used. The others may
7351 appear several times in any order. Example: >
7352 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7353<
7354 This option cannot be set from a |modeline| or in the |sandbox|, for
7355 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007356
7357
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7359'splitbelow' 'sb' boolean (default off)
7360 global
7361 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007362 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 feature}
7364 When on, splitting a window will put the new window below the current
7365 one. |:split|
7366
7367 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7368'splitright' 'spr' boolean (default off)
7369 global
7370 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007371 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 feature}
7373 When on, splitting a window will put the new window right of the
7374 current one. |:vsplit|
7375
7376 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7377'startofline' 'sol' boolean (default on)
7378 global
7379 {not in Vi}
7380 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007381 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007382 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007383 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 with a linewise operator, with "%" with a count and to buffer changing
7385 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7386 only has a line number, e.g., ":25" or ":+".
7387 In case of buffer changing commands the cursor is placed at the column
7388 where it was the last time the buffer was edited.
7389 NOTE: This option is set when 'compatible' is set.
7390
Bram Moolenaar00654022011-02-25 14:42:19 +01007391 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007393 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 {not in Vi}
7395 {not available when compiled without the |+statusline|
7396 feature}
7397 When nonempty, this option determines the content of the status line.
7398 Also see |status-line|.
7399
7400 The option consists of printf style '%' items interspersed with
7401 normal text. Each status line item is of the form:
7402 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007403 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007404 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405
Bram Moolenaar238a5642006-02-21 22:12:05 +00007406 When the option starts with "%!" then it is used as an expression,
7407 evaluated and the result is used as the option value. Example: >
7408 :set statusline=%!MyStatusLine()
7409< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007410 Note that the "%!" expression is evaluated in the context of the
7411 current window and buffer, while %{} items are evaluated in the
7412 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007413
7414 When there is error while evaluating the option then it will be made
7415 empty to avoid further errors. Otherwise screen updating would loop.
7416
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 Note that the only effect of 'ruler' when this option is set (and
7418 'laststatus' is 2) is controlling the output of |CTRL-G|.
7419
7420 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007421 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007423 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 minwid Minimum width of the item, padding as set by '-' & '0'.
7425 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007426 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 on the left for text items. Numeric items will be
7428 shifted down to maxwid-2 digits followed by '>'number
7429 where number is the amount of missing digits, much like
7430 an exponential notation.
7431 item A one letter code as described below.
7432
7433 Following is a description of the possible statusline items. The
7434 second character in "item" is the type:
7435 N for number
7436 S for string
7437 F for flags as described below
7438 - not applicable
7439
7440 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007441 f S Path to the file in the buffer, as typed or relative to current
7442 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 F S Full path to the file in the buffer.
7444 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007445 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007447 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007449 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007451 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007453 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007455 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7457 being used: "<keymap>"
7458 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007459 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 B N As above, in hexadecimal.
7461 o N Byte number in file of byte under cursor, first byte is 1.
7462 Mnemonic: Offset from start of file (with one added)
7463 {not available when compiled without |+byte_offset| feature}
7464 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007465 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 l N Line number.
7467 L N Number of lines in buffer.
7468 c N Column number.
7469 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007470 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 p N Percentage through file in lines as in |CTRL-G|.
7472 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007473 percentage described for 'ruler'. Always 3 in length, unless
7474 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007475 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007477 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007478 Note that there is no '%' before the closing '}'. The
7479 expression cannot contain a '}' character, call a function to
7480 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007481 ( - Start of item group. Can be used for setting the width and
7482 alignment of a section. Must be followed by %) somewhere.
7483 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007484 T N For 'tabline': start of tab page N label. Use %T after the last
7485 label. This information is used for mouse clicks.
7486 X N For 'tabline': start of close tab N label. Use %X after the
7487 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7488 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 < - Where to truncate line if too long. Default is at the start.
7490 No width fields allowed.
7491 = - Separation point between left and right aligned items.
7492 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007493 # - Set highlight group. The name must follow and then a # again.
7494 Thus use %#HLname# for highlight group HLname. The same
7495 highlighting is used, also for the statusline of non-current
7496 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007498 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 The difference between User{N} and StatusLine will be applied
7500 to StatusLineNC for the statusline of non-current windows.
7501 The number N must be between 1 and 9. See |hl-User1..9|
7502
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007503 When displaying a flag, Vim removes the leading comma, if any, when
7504 that flag comes right after plaintext. This will make a nice display
7505 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506
Bram Moolenaar582fd852005-03-28 20:58:01 +00007507 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 not set) and a minwid is not set for the group, the whole group will
7509 become empty. This will make a group like the following disappear
7510 completely from the statusline when none of the flags are set. >
7511 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007512< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 Beware that an expression is evaluated each and every time the status
7514 line is displayed. The current buffer and current window will be set
7515 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007516 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007517 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007518 real current buffer.
7519
Bram Moolenaar30b65812012-07-12 22:01:11 +02007520 The 'statusline' option will be evaluated in the |sandbox| if set from
7521 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007522
7523 It is not allowed to change text or jump to another window while
7524 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525
7526 If the statusline is not updated when you want it (e.g., after setting
7527 a variable that's used in an expression), you can force an update by
7528 setting an option without changing its value. Example: >
7529 :let &ro = &ro
7530
7531< A result of all digits is regarded a number for display purposes.
7532 Otherwise the result is taken as flag text and applied to the rules
7533 described above.
7534
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007535 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007537 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538
7539 Examples:
7540 Emulate standard status line with 'ruler' set >
7541 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7542< Similar, but add ASCII value of char under the cursor (like "ga") >
7543 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7544< Display byte count and byte value, modified flag in red. >
7545 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7546 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7547< Display a ,GZ flag if a compressed file is loaded >
7548 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7549< In the |:autocmd|'s: >
7550 :let b:gzflag = 1
7551< And: >
7552 :unlet b:gzflag
7553< And define this function: >
7554 :function VarExists(var, val)
7555 : if exists(a:var) | return a:val | else | return '' | endif
7556 :endfunction
7557<
7558 *'suffixes'* *'su'*
7559'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7560 global
7561 {not in Vi}
7562 Files with these suffixes get a lower priority when multiple files
7563 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007564 suffixes. Spaces after the comma are ignored. A dot is also seen as
7565 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 separator, precede it with a backslash (see |option-backslash| about
7567 including spaces and backslashes).
7568 See 'wildignore' for completely ignoring files.
7569 The use of |:set+=| and |:set-=| is preferred when adding or removing
7570 suffixes from the list. This avoids problems when a future version
7571 uses another default.
7572
7573 *'suffixesadd'* *'sua'*
7574'suffixesadd' 'sua' string (default "")
7575 local to buffer
7576 {not in Vi}
7577 {not available when compiled without the
7578 |+file_in_path| feature}
7579 Comma separated list of suffixes, which are used when searching for a
7580 file for the "gf", "[I", etc. commands. Example: >
7581 :set suffixesadd=.java
7582<
7583 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7584'swapfile' 'swf' boolean (default on)
7585 local to buffer
7586 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007587 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 swapfile is not wanted for a specific buffer. For example, with
7589 confidential information that even root must not be able to access.
7590 Careful: All text will be in memory:
7591 - Don't use this for big files.
7592 - Recovery will be impossible!
7593 A swapfile will only be present when |'updatecount'| is non-zero and
7594 'swapfile' is set.
7595 When 'swapfile' is reset, the swap file for the current buffer is
7596 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7597 non-zero, a swap file is immediately created.
7598 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007599 If you want to open a new buffer without creating a swap file for it,
7600 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007601 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602
7603 This option is used together with 'bufhidden' and 'buftype' to
7604 specify special kinds of buffers. See |special-buffers|.
7605
7606 *'swapsync'* *'sws'*
7607'swapsync' 'sws' string (default "fsync")
7608 global
7609 {not in Vi}
7610 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007612 When this option is empty parts of the swap file may be in memory and
7613 not written to disk. When the system crashes you may lose more work.
7614 On Unix the system does a sync now and then without Vim asking for it,
7615 so the disadvantage of setting this option off is small. On some
7616 systems the swap file will not be written at all. For a unix system
7617 setting it to "sync" will use the sync() call instead of the default
7618 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007619 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620
7621 *'switchbuf'* *'swb'*
7622'switchbuf' 'swb' string (default "")
7623 global
7624 {not in Vi}
7625 This option controls the behavior when switching between buffers.
7626 Possible values (comma separated list):
7627 useopen If included, jump to the first open window that
7628 contains the specified buffer (if there is one).
7629 Otherwise: Do not examine other windows.
7630 This setting is checked with |quickfix| commands, when
7631 jumping to errors (":cc", ":cn", "cp", etc.). It is
7632 also used in all buffer related split commands, for
7633 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007634 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007635 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007637 a buffer for a |quickfix| command that display errors.
7638 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007639 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007640 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007641 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007643 *'synmaxcol'* *'smc'*
7644'synmaxcol' 'smc' number (default 3000)
7645 local to buffer
7646 {not in Vi}
7647 {not available when compiled without the |+syntax|
7648 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007649 Maximum column in which to search for syntax items. In long lines the
7650 text after this column is not highlighted and following lines may not
7651 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007652 This helps to avoid very slow redrawing for an XML file that is one
7653 long line.
7654 Set to zero to remove the limit.
7655
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 *'syntax'* *'syn'*
7657'syntax' 'syn' string (default empty)
7658 local to buffer
7659 {not in Vi}
7660 {not available when compiled without the |+syntax|
7661 feature}
7662 When this option is set, the syntax with this name is loaded, unless
7663 syntax highlighting has been switched off with ":syntax off".
7664 Otherwise this option does not always reflect the current syntax (the
7665 b:current_syntax variable does).
7666 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007667 not automatically recognized. Example, in an IDL file:
7668 /* vim: set syntax=idl : */ ~
7669 When a dot appears in the value then this separates two filetype
7670 names. Example:
7671 /* vim: set syntax=c.doxygen : */ ~
7672 This will use the "c" syntax first, then the "doxygen" syntax.
7673 Note that the second one must be prepared to be loaded as an addition,
7674 otherwise it will be skipped. More than one dot may appear.
7675 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 :set syntax=OFF
7677< To switch syntax highlighting on according to the current value of the
7678 'filetype' option: >
7679 :set syntax=ON
7680< What actually happens when setting the 'syntax' option is that the
7681 Syntax autocommand event is triggered with the value as argument.
7682 This option is not copied to another buffer, independent of the 's' or
7683 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007684 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007686 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007687'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007688 global
7689 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007690 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007691 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007692 When nonempty, this option determines the content of the tab pages
7693 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007694 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007695
7696 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007697 option and only when there is no GUI tab line. When 'e' is in
7698 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007699 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007700
7701 The value is evaluated like with 'statusline'. You can use
7702 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007703 the text to be displayed. Use "%1T" for the first label, "%2T" for
7704 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007705
7706 Keep in mind that only one of the tab pages is the current one, others
7707 are invisible and you can't jump to their windows.
7708
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007709
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007710 *'tabpagemax'* *'tpm'*
7711'tabpagemax' 'tpm' number (default 10)
7712 global
7713 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007714 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007715 feature}
7716 Maximum number of tab pages to be opened by the |-p| command line
7717 argument or the ":tab all" command. |tabpage|
7718
7719
7720 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007721'tabstop' 'ts' number (default 8)
7722 local to buffer
7723 Number of spaces that a <Tab> in the file counts for. Also see
7724 |:retab| command, and 'softtabstop' option.
7725
7726 Note: Setting 'tabstop' to any other value than 8 can make your file
7727 appear wrong in many places (e.g., when printing it).
7728
7729 There are four main ways to use tabs in Vim:
7730 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7731 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007732 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 behave like a tab appears every 4 (or 3) characters.
7734 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7735 'expandtab'. This way you will always insert spaces. The
7736 formatting will never be messed up when 'tabstop' is changed.
7737 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007738 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 works when using Vim to edit the file.
7740 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7741 'noexpandtab'. This should then work (for initial indents only)
7742 for any tabstop setting that people use. It might be nice to have
7743 tabs after the first non-blank inserted as spaces if you do this
7744 though. Otherwise aligned comments will be wrong when 'tabstop' is
7745 changed.
7746
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007747 If Vim is compiled with the |+vartabs| feature then the value of
7748 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7749 than an empty string.
7750
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7752'tagbsearch' 'tbs' boolean (default on)
7753 global
7754 {not in Vi}
7755 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007756 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 searching makes searching for a tag a LOT faster, but a linear search
7758 will find more tags if the tags file wasn't properly sorted.
7759 Vim normally assumes that your tags files are sorted, or indicate that
7760 they are not sorted. Only when this is not the case does the
7761 'tagbsearch' option need to be switched off.
7762
7763 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007764 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 certain files, or retry all files with a linear search. When
7766 'tagbsearch' is off, only a linear search is done.
7767
7768 Linear searching is done anyway, for one file, when Vim finds a line
7769 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007770 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771< [The whitespace before and after the '0' must be a single <Tab>]
7772
7773 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007774 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 instead of a normal tag name, a retry is done with a linear search.
7776 Tags in unsorted tags files, and matches with different case will only
7777 be found in the retry.
7778
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007779 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007780 linear search can be avoided when case is ignored. Use a value of '2'
7781 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7782 sorted with the -f switch to "sort" in most unices, as in the command:
7783 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7784 (at least 5.5) the --sort=foldcase switch can be used for this as
7785 well. Note that case must be folded to uppercase for this to work.
7786
7787 By default, tag searches are case-sensitive. Case is ignored when
7788 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7789 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007790 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7791 'tagcase' is "smart", and the pattern contains only lowercase
7792 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793
7794 When 'tagbsearch' is off, tags searching is slower when a full match
7795 exists, but faster when no full match exists. Tags in unsorted tags
7796 files may only be found with 'tagbsearch' off.
7797 When the tags file is not sorted, or sorted in a wrong way (not on
7798 ASCII byte value), 'tagbsearch' should be off, or the line given above
7799 must be included in the tags file.
7800 This option doesn't affect commands that find all matching tags (e.g.,
7801 command-line completion and ":help").
7802 {Vi: always uses binary search in some versions}
7803
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007804 *'tagcase'* *'tc'*
7805'tagcase' 'tc' string (default "followic")
7806 global or local to buffer |global-local|
7807 {not in Vi}
7808 This option specifies how case is handled when searching the tags
7809 file:
7810 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007811 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007812 ignore Ignore case
7813 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007814 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007815 NOTE: This option is set to the Vi default value when 'compatible' is
7816 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007817
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 *'taglength'* *'tl'*
7819'taglength' 'tl' number (default 0)
7820 global
7821 If non-zero, tags are significant up to this number of characters.
7822
7823 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7824'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7825 global
7826 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007827 If on and using a tags file in another directory, file names in that
7828 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 NOTE: This option is set to the Vi default value when 'compatible' is
7830 set and to the Vim default value when 'compatible' is reset.
7831
7832 *'tags'* *'tag'* *E433*
7833'tags' 'tag' string (default "./tags,tags", when compiled with
7834 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7835 global or local to buffer |global-local|
7836 Filenames for the tag command, separated by spaces or commas. To
7837 include a space or comma in a file name, precede it with a backslash
7838 (see |option-backslash| about including spaces and backslashes).
7839 When a file name starts with "./", the '.' is replaced with the path
7840 of the current file. But only when the 'd' flag is not included in
7841 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7842 |tags-option|.
7843 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007844 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7845 find all files named "tags" below "/lib". The filename itself cannot
7846 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7847 files called "tags?". {not available when compiled without the
7848 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007849 The |tagfiles()| function can be used to get a list of the file names
7850 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7852 files are also supported. They are automatically recognized. The
7853 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7854 differences are ignored (MS-Windows). |emacs-tags|
7855 The use of |:set+=| and |:set-=| is preferred when adding or removing
7856 file names from the list. This avoids problems when a future version
7857 uses another default.
7858 {Vi: default is "tags /usr/lib/tags"}
7859
7860 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7861'tagstack' 'tgst' boolean (default on)
7862 global
7863 {not in all versions of Vi}
7864 When on, the |tagstack| is used normally. When off, a ":tag" or
7865 ":tselect" command with an argument will not push the tag onto the
7866 tagstack. A following ":tag" without an argument, a ":pop" command or
7867 any other command that uses the tagstack will use the unmodified
7868 tagstack, but does change the pointer to the active entry.
7869 Resetting this option is useful when using a ":tag" command in a
7870 mapping which should not change the tagstack.
7871
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007872 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007873'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007874 global
7875 {not in Vi}
7876 {only available when compiled with the |+tcl/dyn|
7877 feature}
7878 Specifies the name of the Tcl shared library. The default is
7879 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007880 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007881 This option cannot be set from a |modeline| or in the |sandbox|, for
7882 security reasons.
7883
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 *'term'* *E529* *E530* *E531*
7885'term' string (default is $TERM, if that fails:
7886 in the GUI: "builtin_gui"
7887 on Amiga: "amiga"
7888 on BeOS: "beos-ansi"
7889 on Mac: "mac-ansi"
7890 on MiNT: "vt52"
7891 on MS-DOS: "pcterm"
7892 on OS/2: "os2ansi"
7893 on Unix: "ansi"
7894 on VMS: "ansi"
7895 on Win 32: "win32")
7896 global
7897 Name of the terminal. Used for choosing the terminal control
7898 characters. Environment variables are expanded |:set_env|.
7899 For example: >
7900 :set term=$TERM
7901< See |termcap|.
7902
7903 *'termbidi'* *'tbidi'*
7904 *'notermbidi'* *'notbidi'*
7905'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7906 global
7907 {not in Vi}
7908 {only available when compiled with the |+arabic|
7909 feature}
7910 The terminal is in charge of Bi-directionality of text (as specified
7911 by Unicode). The terminal is also expected to do the required shaping
7912 that some languages (such as Arabic) require.
7913 Setting this option implies that 'rightleft' will not be set when
7914 'arabic' is set and the value of 'arabicshape' will be ignored.
7915 Note that setting 'termbidi' has the immediate effect that
7916 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7917 This option is reset when the GUI is started.
7918 For further details see |arabic.txt|.
7919
7920 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007921'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 Macintosh GUI: "macroman")
7923 global
7924 {only available when compiled with the |+multi_byte|
7925 feature}
7926 {not in Vi}
7927 Encoding used for the terminal. This specifies what character
7928 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007929 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007930 display). Except for the Mac when 'macatsui' is off, then
7931 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007933 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7935 Any attempts to set a different value will be rejected, and an error
7936 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007937 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 because the Win32 system always passes Unicode characters.
7939 When empty, the same encoding is used as for the 'encoding' option.
7940 This is the normal value.
7941 Not all combinations for 'termencoding' and 'encoding' are valid. See
7942 |encoding-table|.
7943 The value for this option must be supported by internal conversions or
7944 iconv(). When this is not possible no conversion will be done and you
7945 will probably experience problems with non-ASCII characters.
7946 Example: You are working with the locale set to euc-jp (Japanese) and
7947 want to edit a UTF-8 file: >
7948 :let &termencoding = &encoding
7949 :set encoding=utf-8
7950< You need to do this when your system has no locale support for UTF-8.
7951
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007952 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007953'termguicolors' 'tgc' boolean (default off)
7954 global
7955 {not in Vi}
7956 {not available when compiled without the
7957 |+termguicolors| feature}
7958 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007959 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007960
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007961 Requires a ISO-8613-3 compatible terminal. If setting this option
7962 does not work (produces a colorless UI) reading |xterm-true-color|
7963 might help.
7964
7965 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7966 is required. Use this check to find out: >
7967 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007968< This requires Vim to be built with the |+vtp| feature.
7969
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007970 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007971 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007972
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007973 *'termwinscroll'* *'twsl'*
7974'termwinscroll' 'twsl' number (default 10000)
7975 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02007976 {not in Vi}
7977 {not available when compiled without the
7978 |+terminal| feature}
7979 Number of scrollback lines to keep. When going over this limit the
7980 first 10% of the scrollback lines are deleted. This is just to reduce
7981 the memory usage. See |Terminal-Normal|.
7982
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007983 *'termwinkey'* *'twk'*
7984'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007985 local to window
7986 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007987 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007988 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007989 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007990 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007991< The string must be one key stroke but can be multiple bytes.
7992 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007993 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007994 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007995
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007996 *'termwinsize'* *'tws'*
7997'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007998 local to window
7999 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008000 Size of the |terminal| window. Format: {rows}x{columns} or
8001 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008002 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008003 - When set with a "x" (e.g., "24x80") the terminal size is not
8004 adjusted to the window size. If the window is smaller only the
8005 top-left part is displayed.
8006 - When set with a "*" (e.g., "10*50") the terminal size follows the
8007 window size, but will not be smaller than the specified rows and/or
8008 columns.
8009 - When rows is zero then use the height of the window.
8010 - When columns is zero then use the width of the window.
8011 - Using "0x0" or "0*0" is the same as empty.
8012
8013 Examples:
8014 "30x0" uses 30 rows and the current window width.
8015 "20*0" uses at least 20 rows and the current window width.
8016 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008017 Note that the command running in the terminal window may still change
8018 the size of the terminal. In that case the Vim window will be
8019 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008020
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 *'terse'* *'noterse'*
8022'terse' boolean (default off)
8023 global
8024 When set: Add 's' flag to 'shortmess' option (this makes the message
8025 for a search that hits the start or end of the file not being
8026 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8027 shortens a lot of messages}
8028
8029 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8030'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8031 global
8032 {not in Vi}
8033 This option is obsolete. Use 'fileformats'.
8034 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8035 set to the default value for the current system. When 'textauto' is
8036 reset, 'fileformats' is made empty.
8037 NOTE: This option is set to the Vi default value when 'compatible' is
8038 set and to the Vim default value when 'compatible' is reset.
8039
8040 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8041'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8042 others: default off)
8043 local to buffer
8044 {not in Vi}
8045 This option is obsolete. Use 'fileformat'.
8046 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8047 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8048 "unix".
8049
8050 *'textwidth'* *'tw'*
8051'textwidth' 'tw' number (default 0)
8052 local to buffer
8053 {not in Vi}
8054 Maximum width of text that is being inserted. A longer line will be
8055 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008056 this.
8057 'textwidth' is set to 0 when the 'paste' option is set and restored
8058 when 'paste' is reset.
8059 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008061 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 NOTE: This option is set to 0 when 'compatible' is set.
8063
8064 *'thesaurus'* *'tsr'*
8065'thesaurus' 'tsr' string (default "")
8066 global or local to buffer |global-local|
8067 {not in Vi}
8068 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008069 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 the file should contain words with similar meaning, separated by
8071 non-keyword characters (white space is preferred). Maximum line
8072 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008073 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008074 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008075 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008076 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 after a comma are ignored, otherwise spaces are included in the file
8078 name. See |option-backslash| about using backslashes.
8079 The use of |:set+=| and |:set-=| is preferred when adding or removing
8080 directories from the list. This avoids problems when a future version
8081 uses another default.
8082 Backticks cannot be used in this option for security reasons.
8083
8084 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8085'tildeop' 'top' boolean (default off)
8086 global
8087 {not in Vi}
8088 When on: The tilde command "~" behaves like an operator.
8089 NOTE: This option is reset when 'compatible' is set.
8090
8091 *'timeout'* *'to'* *'notimeout'* *'noto'*
8092'timeout' 'to' boolean (default on)
8093 global
8094 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008095'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096 global
8097 {not in Vi}
8098 These two options together determine the behavior when part of a
8099 mapped key sequence or keyboard code has been received:
8100
8101 'timeout' 'ttimeout' action ~
8102 off off do not time out
8103 on on or off time out on :mappings and key codes
8104 off on time out on key codes
8105
8106 If both options are off, Vim will wait until either the complete
8107 mapping or key sequence has been received, or it is clear that there
8108 is no mapping or key sequence for the received characters. For
8109 example: if you have mapped "vl" and Vim has received 'v', the next
8110 character is needed to see if the 'v' is followed by an 'l'.
8111 When one of the options is on, Vim will wait for about 1 second for
8112 the next character to arrive. After that the already received
8113 characters are interpreted as single characters. The waiting time can
8114 be changed with the 'timeoutlen' option.
8115 On slow terminals or very busy systems timing out may cause
8116 malfunctioning cursor keys. If both options are off, Vim waits
8117 forever after an entered <Esc> if there are key codes that start
8118 with <Esc>. You will have to type <Esc> twice. If you do not have
8119 problems with key codes, but would like to have :mapped key
8120 sequences not timing out in 1 second, set the 'ttimeout' option and
8121 reset the 'timeout' option.
8122
8123 NOTE: 'ttimeout' is reset when 'compatible' is set.
8124
8125 *'timeoutlen'* *'tm'*
8126'timeoutlen' 'tm' number (default 1000)
8127 global
8128 {not in all versions of Vi}
8129 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008130'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 global
8132 {not in Vi}
8133 The time in milliseconds that is waited for a key code or mapped key
8134 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8135 when part of a command has been typed.
8136 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8137 different timeout value for key codes is desired set 'ttimeoutlen' to
8138 a non-negative number.
8139
8140 ttimeoutlen mapping delay key code delay ~
8141 < 0 'timeoutlen' 'timeoutlen'
8142 >= 0 'timeoutlen' 'ttimeoutlen'
8143
8144 The timeout only happens when the 'timeout' and 'ttimeout' options
8145 tell so. A useful setting would be >
8146 :set timeout timeoutlen=3000 ttimeoutlen=100
8147< (time out on mapping after three seconds, time out on key codes after
8148 a tenth of a second).
8149
8150 *'title'* *'notitle'*
8151'title' boolean (default off, on when title can be restored)
8152 global
8153 {not in Vi}
8154 {not available when compiled without the |+title|
8155 feature}
8156 When on, the title of the window will be set to the value of
8157 'titlestring' (if it is not empty), or to:
8158 filename [+=-] (path) - VIM
8159 Where:
8160 filename the name of the file being edited
8161 - indicates the file cannot be modified, 'ma' off
8162 + indicates the file was modified
8163 = indicates the file is read-only
8164 =+ indicates the file is read-only and modified
8165 (path) is the path of the file being edited
8166 - VIM the server name |v:servername| or "VIM"
8167 Only works if the terminal supports setting window titles
8168 (currently Amiga console, Win32 console, all GUI versions and
8169 terminals with a non- empty 't_ts' option - these are Unix xterm and
8170 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8171 *X11*
8172 When Vim was compiled with HAVE_X11 defined, the original title will
8173 be restored if possible. The output of ":version" will include "+X11"
8174 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8175 works for the icon name |'icon'|.
8176 But: When Vim was started with the |-X| argument, restoring the title
8177 will not work (except in the GUI).
8178 If the title cannot be restored, it is set to the value of 'titleold'.
8179 You might want to restore the title outside of Vim then.
8180 When using an xterm from a remote machine you can use this command:
8181 rsh machine_name xterm -display $DISPLAY &
8182 then the WINDOWID environment variable should be inherited and the
8183 title of the window should change back to what it should be after
8184 exiting Vim.
8185
8186 *'titlelen'*
8187'titlelen' number (default 85)
8188 global
8189 {not in Vi}
8190 {not available when compiled without the |+title|
8191 feature}
8192 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008193 title. When the title is longer, only the end of the path name is
8194 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195 Using a percentage makes this adapt to the width of the window. But
8196 it won't work perfectly, because the actual number of characters
8197 available also depends on the font used and other things in the title
8198 bar. When 'titlelen' is zero the full path is used. Otherwise,
8199 values from 1 to 30000 percent can be used.
8200 'titlelen' is also used for the 'titlestring' option.
8201
8202 *'titleold'*
8203'titleold' string (default "Thanks for flying Vim")
8204 global
8205 {not in Vi}
8206 {only available when compiled with the |+title|
8207 feature}
8208 This option will be used for the window title when exiting Vim if the
8209 original title cannot be restored. Only happens if 'title' is on or
8210 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008211 This option cannot be set from a |modeline| or in the |sandbox|, for
8212 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 *'titlestring'*
8214'titlestring' string (default "")
8215 global
8216 {not in Vi}
8217 {not available when compiled without the |+title|
8218 feature}
8219 When this option is not empty, it will be used for the title of the
8220 window. This happens only when the 'title' option is on.
8221 Only works if the terminal supports setting window titles (currently
8222 Amiga console, Win32 console, all GUI versions and terminals with a
8223 non-empty 't_ts' option).
8224 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008225 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 When this option contains printf-style '%' items, they will be
8227 expanded according to the rules used for 'statusline'.
8228 Example: >
8229 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8230 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8231< The value of 'titlelen' is used to align items in the middle or right
8232 of the available space.
8233 Some people prefer to have the file name first: >
8234 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8235< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008236 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237 separating space only when needed.
8238 NOTE: Use of special characters in 'titlestring' may cause the display
8239 to be garbled (e.g., when it contains a CR or NL character).
8240 {not available when compiled without the |+statusline| feature}
8241
8242 *'toolbar'* *'tb'*
8243'toolbar' 'tb' string (default "icons,tooltips")
8244 global
8245 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8246 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008247 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008248 possible values are:
8249 icons Toolbar buttons are shown with icons.
8250 text Toolbar buttons shown with text.
8251 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008252 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 tooltips Tooltips are active for toolbar buttons.
8254 Tooltips refer to the popup help text which appears after the mouse
8255 cursor is placed over a toolbar button for a brief moment.
8256
8257 If you want the toolbar to be shown with icons as well as text, do the
8258 following: >
8259 :set tb=icons,text
8260< Motif and Athena cannot display icons and text at the same time. They
8261 will show icons if both are requested.
8262
8263 If none of the strings specified in 'toolbar' are valid or if
8264 'toolbar' is empty, this option is ignored. If you want to disable
8265 the toolbar, you need to set the 'guioptions' option. For example: >
8266 :set guioptions-=T
8267< Also see |gui-toolbar|.
8268
8269 *'toolbariconsize'* *'tbis'*
8270'toolbariconsize' 'tbis' string (default "small")
8271 global
8272 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008273 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008275 tiny Use tiny icons.
8276 small Use small icons (default).
8277 medium Use medium-sized icons.
8278 large Use large icons.
8279 huge Use even larger icons.
8280 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008282 the current theme. Common dimensions are giant=48x48, huge=32x32,
8283 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284
8285 If 'toolbariconsize' is empty, the global default size as determined
8286 by user preferences or the current theme is used.
8287
8288 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8289'ttybuiltin' 'tbi' boolean (default on)
8290 global
8291 {not in Vi}
8292 When on, the builtin termcaps are searched before the external ones.
8293 When off the builtin termcaps are searched after the external ones.
8294 When this option is changed, you should set the 'term' option next for
8295 the change to take effect, for example: >
8296 :set notbi term=$TERM
8297< See also |termcap|.
8298 Rationale: The default for this option is "on", because the builtin
8299 termcap entries are generally better (many systems contain faulty
8300 xterm entries...).
8301
8302 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8303'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8304 sun-cmd, screen, rxvt, dtterm or
8305 iris-ansi; also on when running Vim in
8306 a DOS console)
8307 global
8308 {not in Vi}
8309 Indicates a fast terminal connection. More characters will be sent to
8310 the screen for redrawing, instead of using insert/delete line
8311 commands. Improves smoothness of redrawing when there are multiple
8312 windows and the terminal does not support a scrolling region.
8313 Also enables the extra writing of characters at the end of each screen
8314 line for lines that wrap. This helps when using copy/paste with the
8315 mouse in an xterm and other terminals.
8316
8317 *'ttymouse'* *'ttym'*
8318'ttymouse' 'ttym' string (default depends on 'term')
8319 global
8320 {not in Vi}
8321 {only in Unix and VMS, doesn't work in the GUI; not
8322 available when compiled without |+mouse|}
8323 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008324 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 *xterm-mouse*
8326 xterm xterm-like mouse handling. The mouse generates
8327 "<Esc>[Mscr", where "scr" is three bytes:
8328 "s" = button state
8329 "c" = column plus 33
8330 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008331 This only works up to 223 columns! See "dec",
8332 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008333 xterm2 Works like "xterm", but with the xterm reporting the
8334 mouse position while the mouse is dragged. This works
8335 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008336 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 work. See below for how Vim detects this
8338 automatically.
8339 *netterm-mouse*
8340 netterm NetTerm mouse handling. The mouse generates
8341 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8342 for the row and column.
8343 *dec-mouse*
8344 dec DEC terminal mouse handling. The mouse generates a
8345 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008346 This is also available for an Xterm, if it was
8347 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 *jsbterm-mouse*
8349 jsbterm JSB term mouse handling.
8350 *pterm-mouse*
8351 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008352 *urxvt-mouse*
8353 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008354 The mouse works only if the terminal supports this
8355 encoding style, but it does not have 223 columns limit
8356 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008357 *sgr-mouse*
8358 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008359 mouse reporting. The mouse works even in columns
8360 beyond 223. This option is backward compatible with
8361 "xterm2" because it can also decode "xterm2" style
8362 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363
8364 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008365 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8366 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8368 recognized, if enabled at compile time. DEC terminal mouse codes
8369 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008370 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8371 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008373 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8374 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8375 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008376 Additionally, if vim is compiled with the |+termresponse| feature and
8377 |t_RV| is set to the escape sequence to request the xterm version
8378 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008380 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008381 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008382 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8383 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 :set t_RV=
8385<
8386 *'ttyscroll'* *'tsl'*
8387'ttyscroll' 'tsl' number (default 999)
8388 global
8389 Maximum number of lines to scroll the screen. If there are more lines
8390 to scroll the window is redrawn. For terminals where scrolling is
8391 very slow and redrawing is not slow this can be set to a small number,
8392 e.g., 3, to speed up displaying.
8393
8394 *'ttytype'* *'tty'*
8395'ttytype' 'tty' string (default from $TERM)
8396 global
8397 Alias for 'term', see above.
8398
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008399 *'undodir'* *'udir'*
8400'undodir' 'udir' string (default ".")
8401 global
8402 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008403 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008404 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008405 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008406 "." means using the directory of the file. The undo file name for
8407 "file.txt" is ".file.txt.un~".
8408 For other directories the file name is the full path of the edited
8409 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008410 When writing: The first directory that exists is used. "." always
8411 works, no directories after "." will be used for writing.
8412 When reading all entries are tried to find an undo file. The first
8413 undo file that exists is used. When it cannot be read an error is
8414 given, no further entry is used.
8415 See |undo-persistence|.
8416
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008417 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008418'undofile' 'udf' boolean (default off)
8419 local to buffer
8420 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008421 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008422 When on, Vim automatically saves undo history to an undo file when
8423 writing a buffer to a file, and restores undo history from the same
8424 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008425 The directory where the undo file is stored is specified by 'undodir'.
8426 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008427 The undo file is not read when 'undoreload' causes the buffer from
8428 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008429 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008430 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008431
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 *'undolevels'* *'ul'*
8433'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8434 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008435 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 {not in Vi}
8437 Maximum number of changes that can be undone. Since undo information
8438 is kept in memory, higher numbers will cause more memory to be used
8439 (nevertheless, a single change can use an unlimited amount of memory).
8440 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8441 itself: >
8442 set ul=0
8443< But you can also get Vi compatibility by including the 'u' flag in
8444 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008445 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008446 Set to -1 for no undo at all. You might want to do this only for the
8447 current buffer: >
8448 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008450
8451 The local value is set to -123456 when the global value is to be used.
8452
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008453 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008455 *'undoreload'* *'ur'*
8456'undoreload' 'ur' number (default 10000)
8457 global
8458 {not in Vi}
8459 Save the whole buffer for undo when reloading it. This applies to the
8460 ":e!" command and reloading for when the buffer changed outside of
8461 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008462 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008463 of lines is smaller than the value of this option.
8464 Set this option to zero to disable undo for a reload.
8465
8466 When saving undo for a reload, any undo file is not read.
8467
8468 Note that this causes the whole buffer to be stored in memory. Set
8469 this option to a lower value if you run out of memory.
8470
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 *'updatecount'* *'uc'*
8472'updatecount' 'uc' number (default: 200)
8473 global
8474 {not in Vi}
8475 After typing this many characters the swap file will be written to
8476 disk. When zero, no swap file will be created at all (see chapter on
8477 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8478 Vim with the "-n" option, see |startup|. When editing in readonly
8479 mode this option will be initialized to 10000.
8480 The swapfile can be disabled per buffer with |'swapfile'|.
8481 When 'updatecount' is set from zero to non-zero, swap files are
8482 created for all buffers that have 'swapfile' set. When 'updatecount'
8483 is set to zero, existing swap files are not deleted.
8484 Also see |'swapsync'|.
8485 This option has no meaning in buffers where |'buftype'| is "nofile"
8486 or "nowrite".
8487
8488 *'updatetime'* *'ut'*
8489'updatetime' 'ut' number (default 4000)
8490 global
8491 {not in Vi}
8492 If this many milliseconds nothing is typed the swap file will be
8493 written to disk (see |crash-recovery|). Also used for the
8494 |CursorHold| autocommand event.
8495
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008496 *'varsofttabstop'* *'vsts'*
8497'varsofttabstop' 'vsts' string (default "")
8498 local to buffer
8499 {only available when compiled with the |+vartabs|
8500 feature}
8501 {not in Vi}
8502 A list of the number of spaces that a <Tab> counts for while editing,
8503 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8504 width <Tab>s are being inserted, while in fact a mixture of spaces
8505 and <Tab>s is used. Tab widths are separated with commas, with the
8506 final value applying to all subsequent tabs.
8507
8508 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008509 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008510 to use the following: >
8511 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008512< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8513 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008514
8515 Note that the value of |'softtabstop'| will be ignored while
8516 'varsofttabstop' is set.
8517
8518 *'vartabstop'* *'vts'*
8519'vartabstop' 'vts' string (default "")
8520 local to buffer
8521 {only available when compiled with the |+vartabs|
8522 feature}
8523 {not in Vi}
8524 A list of the number of spaces that a <Tab> in the file counts for,
8525 separated by commas. Each value corresponds to one tab, with the
8526 final value applying to all subsequent tabs. For example: >
8527 :set vartabstop=4,20,10,8
8528< This will make the first tab 4 spaces wide, the second 20 spaces,
8529 the third 10 spaces, and all following tabs 8 spaces.
8530
8531 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8532 is set.
8533
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 *'verbose'* *'vbs'*
8535'verbose' 'vbs' number (default 0)
8536 global
8537 {not in Vi, although some versions have a boolean
8538 verbose option}
8539 When bigger than zero, Vim will give messages about what it is doing.
8540 Currently, these messages are given:
8541 >= 1 When the viminfo file is read or written.
8542 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008543 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 >= 8 Files for which a group of autocommands is executed.
8545 >= 9 Every executed autocommand.
8546 >= 12 Every executed function.
8547 >= 13 When an exception is thrown, caught, finished, or discarded.
8548 >= 14 Anything pending in a ":finally" clause.
8549 >= 15 Every executed Ex command (truncated at 200 characters).
8550
8551 This option can also be set with the "-V" argument. See |-V|.
8552 This option is also set by the |:verbose| command.
8553
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008554 When the 'verbosefile' option is set then the verbose messages are not
8555 displayed.
8556
8557 *'verbosefile'* *'vfile'*
8558'verbosefile' 'vfile' string (default empty)
8559 global
8560 {not in Vi}
8561 When not empty all messages are written in a file with this name.
8562 When the file exists messages are appended.
8563 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008564 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008565 Setting 'verbosefile' to a new value is like making it empty first.
8566 The difference with |:redir| is that verbose messages are not
8567 displayed when 'verbosefile' is set.
8568
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 *'viewdir'* *'vdir'*
8570'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8571 "$VIM/vimfiles/view",
8572 for Unix: "~/.vim/view",
8573 for Macintosh: "$VIM:vimfiles:view"
8574 for VMS: "sys$login:vimfiles/view"
8575 for RiscOS: "Choices:vimfiles/view")
8576 global
8577 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008578 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 feature}
8580 Name of the directory where to store files for |:mkview|.
8581 This option cannot be set from a |modeline| or in the |sandbox|, for
8582 security reasons.
8583
8584 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008585'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 global
8587 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008588 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 feature}
8590 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008591 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 word save and restore ~
8593 cursor cursor position in file and in window
8594 folds manually created folds, opened/closed folds and local
8595 fold options
8596 options options and mappings local to a window or buffer (not
8597 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008598 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 slash backslashes in file names replaced with forward
8600 slashes
8601 unix with Unix end-of-line format (single <NL>), even when
8602 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008603 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604
8605 "slash" and "unix" are useful on Windows when sharing view files
8606 with Unix. The Unix version of Vim cannot source dos format scripts,
8607 but the Windows version of Vim can source unix format scripts.
8608
8609 *'viminfo'* *'vi'* *E526* *E527* *E528*
8610'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008611 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8612 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8613 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 global
8615 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008616 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 feature}
8618 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008619 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8620 "NONE".
8621 The string should be a comma separated list of parameters, each
8622 consisting of a single character identifying the particular parameter,
8623 followed by a number or string which specifies the value of that
8624 parameter. If a particular character is left out, then the default
8625 value is used for that parameter. The following is a list of the
8626 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008628 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 ! When included, save and restore global variables that start
8630 with an uppercase letter, and don't contain a lowercase
8631 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008632 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008633 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008634 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 " Maximum number of lines saved for each register. Old name of
8636 the '<' item, with the disadvantage that you need to put a
8637 backslash before the ", otherwise it will be recognized as the
8638 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008639 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008640 % When included, save and restore the buffer list. If Vim is
8641 started with a file name argument, the buffer list is not
8642 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008643 buffer list is restored from the viminfo file. Quickfix
8644 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8645 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008646 When followed by a number, the number specifies the maximum
8647 number of buffers that are stored. Without a number all
8648 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008649 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 ' Maximum number of previously edited files for which the marks
8651 are remembered. This parameter must always be included when
8652 'viminfo' is non-empty.
8653 Including this item also means that the |jumplist| and the
8654 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008655 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008657 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 patterns are also saved. When not included, the value of
8659 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008660 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008662 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008663 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 < Maximum number of lines saved for each register. If zero then
8665 registers are not saved. When not included, all lines are
8666 saved. '"' is the old name for this item.
8667 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008668 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008670 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008671 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 c When included, convert the text in the viminfo file from the
8673 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008674 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008675 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 f Whether file marks need to be stored. If zero, file marks ('0
8677 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008678 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008680 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 h Disable the effect of 'hlsearch' when loading the viminfo
8682 file. When not included, it depends on whether ":nohlsearch"
8683 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008684 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008685 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008686 the 'n'. Must be at the end of the option! If the
8687 'viminfofile' option is set, that file name overrides the one
8688 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008689 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008690 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 r Removable media. The argument is a string (up to the next
8692 ','). This parameter can be given several times. Each
8693 specifies the start of a path for which no marks will be
8694 stored. This is to avoid removable media. For MS-DOS you
8695 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8696 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8697 ignored. Maximum length of each 'r' argument is 50
8698 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008699 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008700 s Maximum size of an item in Kbyte. If zero then registers are
8701 not saved. Currently only applies to registers. The default
8702 "s10" will exclude registers with more than 10 Kbyte of text.
8703 Also see the '<' item above: line count limit.
8704
8705 Example: >
8706 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8707<
8708 '50 Marks will be remembered for the last 50 files you
8709 edited.
8710 <1000 Contents of registers (up to 1000 lines each) will be
8711 remembered.
8712 s100 Registers with more than 100 Kbyte text are skipped.
8713 :0 Command-line history will not be saved.
8714 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8715 no / Since '/' is not specified, the default will be used,
8716 that is, save all of the search history, and also the
8717 previous search and substitute patterns.
8718 no % The buffer list will not be saved nor read back.
8719 no h 'hlsearch' highlighting will be restored.
8720
8721 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8722 load the contents of the file, this is not done automatically.
8723
8724 This option cannot be set from a |modeline| or in the |sandbox|, for
8725 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008726 NOTE: This option is set to the Vim default value when 'compatible'
8727 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008728
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008729 *'viminfofile'* *'vif'*
8730'viminfofile' 'vif' string (default: "")
8731 global
8732 {not in Vi}
8733 {not available when compiled without the |+viminfo|
8734 feature}
8735 When non-empty, overrides the file name used for viminfo.
8736 When equal to "NONE" no viminfo file will be read or written.
8737 This option can be set with the |-i| command line flag. The |--clean|
8738 command line flag sets it to "NONE".
8739
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740 *'virtualedit'* *'ve'*
8741'virtualedit' 've' string (default "")
8742 global
8743 {not in Vi}
8744 {not available when compiled without the
8745 |+virtualedit| feature}
8746 A comma separated list of these words:
8747 block Allow virtual editing in Visual block mode.
8748 insert Allow virtual editing in Insert mode.
8749 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008750 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008751
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008753 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 of the line. Useful for selecting a rectangle in Visual mode and
8755 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008756 "onemore" is not the same, it will only allow moving the cursor just
8757 after the last character of the line. This makes some commands more
8758 consistent. Previously the cursor was always past the end of the line
8759 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008760 break some plugins or Vim scripts. For example because |l| can move
8761 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008762 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008763 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008764 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008765 It doesn't make sense to combine "all" with "onemore", but you will
8766 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008767 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768
8769 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8770'visualbell' 'vb' boolean (default off)
8771 global
8772 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008773 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008775 use: >
8776 :set vb t_vb=
8777< If you want a short flash, you can use this on many terminals: >
8778 :set vb t_vb=[?5h$<100>[?5l
8779< Here $<100> specifies the time, you can use a smaller or bigger value
8780 to get a shorter or longer flash.
8781
8782 Note: Vim will limit the bell to once per half a second. This avoids
8783 having to wait for the flashing to finish when there are lots of
8784 bells, e.g. on key repeat. This also happens without 'visualbell'
8785 set.
8786
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8788 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8789 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008790
8791 Note: When the GUI starts, 't_vb' is reset to its default value. You
8792 might want to set it again in your |gvimrc|.
8793
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 Does not work on the Amiga, you always get a screen flash.
8795 Also see 'errorbells'.
8796
8797 *'warn'* *'nowarn'*
8798'warn' boolean (default on)
8799 global
8800 Give a warning message when a shell command is used while the buffer
8801 has been changed.
8802
8803 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8804'weirdinvert' 'wiv' boolean (default off)
8805 global
8806 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008807 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 It is provided for backwards compatibility with version 4.x.
8809 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8810 vice versa. Has no effect when the GUI is running.
8811
8812 *'whichwrap'* *'ww'*
8813'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8814 global
8815 {not in Vi}
8816 Allow specified keys that move the cursor left/right to move to the
8817 previous/next line when the cursor is on the first/last character in
8818 the line. Concatenate characters to allow this for these keys:
8819 char key mode ~
8820 b <BS> Normal and Visual
8821 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008822 h "h" Normal and Visual (not recommended)
8823 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008824 < <Left> Normal and Visual
8825 > <Right> Normal and Visual
8826 ~ "~" Normal
8827 [ <Left> Insert and Replace
8828 ] <Right> Insert and Replace
8829 For example: >
8830 :set ww=<,>,[,]
8831< allows wrap only when cursor keys are used.
8832 When the movement keys are used in combination with a delete or change
8833 operator, the <EOL> also counts for a character. This makes "3h"
8834 different from "3dh" when the cursor crosses the end of a line. This
8835 is also true for "x" and "X", because they do the same as "dl" and
8836 "dh". If you use this, you may also want to use the mapping
8837 ":map <BS> X" to make backspace delete the character in front of the
8838 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008839 When 'l' is included and it is used after an operator at the end of a
8840 line then it will not move to the next line. This makes "dl", "cl",
8841 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 NOTE: This option is set to the Vi default value when 'compatible' is
8843 set and to the Vim default value when 'compatible' is reset.
8844
8845 *'wildchar'* *'wc'*
8846'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8847 global
8848 {not in Vi}
8849 Character you have to type to start wildcard expansion in the
8850 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008851 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 The character is not recognized when used inside a macro. See
8853 'wildcharm' for that.
8854 Although 'wc' is a number option, you can set it to a special key: >
8855 :set wc=<Esc>
8856< NOTE: This option is set to the Vi default value when 'compatible' is
8857 set and to the Vim default value when 'compatible' is reset.
8858
8859 *'wildcharm'* *'wcm'*
8860'wildcharm' 'wcm' number (default: none (0))
8861 global
8862 {not in Vi}
8863 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008864 recognized when used inside a macro. You can find "spare" command-line
8865 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 you'll never actually type 'wildcharm', just use it in mappings that
8867 automatically invoke completion mode, e.g.: >
8868 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008869 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870< Then after typing :ss you can use CTRL-P & CTRL-N.
8871
8872 *'wildignore'* *'wig'*
8873'wildignore' 'wig' string (default "")
8874 global
8875 {not in Vi}
8876 {not available when compiled without the |+wildignore|
8877 feature}
8878 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008879 patterns is ignored when expanding |wildcards|, completing file or
8880 directory names, and influences the result of |expand()|, |glob()| and
8881 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8883 Also see 'suffixes'.
8884 Example: >
8885 :set wildignore=*.o,*.obj
8886< The use of |:set+=| and |:set-=| is preferred when adding or removing
8887 a pattern from the list. This avoids problems when a future version
8888 uses another default.
8889
Bram Moolenaar94950a92010-12-02 16:01:29 +01008890
Bram Moolenaar81af9252010-12-10 20:35:50 +01008891 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008892'wildignorecase' 'wic' boolean (default off)
8893 global
8894 {not in Vi}
8895 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008896 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008897 Does not apply when the shell is used to expand wildcards, which
8898 happens when there are special characters.
8899
8900
Bram Moolenaar071d4272004-06-13 20:20:40 +00008901 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008902'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008903 global
8904 {not in Vi}
8905 {not available if compiled without the |+wildmenu|
8906 feature}
8907 When 'wildmenu' is on, command-line completion operates in an enhanced
8908 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8909 the possible matches are shown just above the command line, with the
8910 first match highlighted (overwriting the status line, if there is
8911 one). Keys that show the previous/next match, such as <Tab> or
8912 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8913 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8914 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008915 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 If there are more matches than can fit in the line, a ">" is shown on
8917 the right and/or a "<" is shown on the left. The status line scrolls
8918 as needed.
8919 The "wildmenu" mode is abandoned when a key is hit that is not used
8920 for selecting a completion.
8921 While the "wildmenu" is active the following keys have special
8922 meanings:
8923
8924 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8925 <Down> - in filename/menu name completion: move into a
8926 subdirectory or submenu.
8927 <CR> - in menu completion, when the cursor is just after a
8928 dot: move into a submenu.
8929 <Up> - in filename/menu name completion: move up into
8930 parent directory or parent menu.
8931
8932 This makes the menus accessible from the console |console-menus|.
8933
8934 If you prefer the <Left> and <Right> keys to move the cursor instead
8935 of selecting a different match, use this: >
8936 :cnoremap <Left> <Space><BS><Left>
8937 :cnoremap <Right> <Space><BS><Right>
8938<
8939 The "WildMenu" highlighting is used for displaying the current match
8940 |hl-WildMenu|.
8941
8942 *'wildmode'* *'wim'*
8943'wildmode' 'wim' string (Vim default: "full")
8944 global
8945 {not in Vi}
8946 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008947 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008948 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 first part specifies the behavior for the first use of 'wildchar',
8950 The second part for the second use, etc.
8951 These are the possible values for each part:
8952 "" Complete only the first match.
8953 "full" Complete the next full match. After the last match,
8954 the original string is used and then the first match
8955 again.
8956 "longest" Complete till longest common string. If this doesn't
8957 result in a longer string, use the next part.
8958 "longest:full" Like "longest", but also start 'wildmenu' if it is
8959 enabled.
8960 "list" When more than one match, list all matches.
8961 "list:full" When more than one match, list all matches and
8962 complete first match.
8963 "list:longest" When more than one match, list all matches and
8964 complete till longest common string.
8965 When there is only a single match, it is fully completed in all cases.
8966
8967 Examples: >
8968 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008969< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008970 :set wildmode=longest,full
8971< Complete longest common string, then each full match >
8972 :set wildmode=list:full
8973< List all matches and complete each full match >
8974 :set wildmode=list,full
8975< List all matches without completing, then each full match >
8976 :set wildmode=longest,list
8977< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008978 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008979
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008980 *'wildoptions'* *'wop'*
8981'wildoptions' 'wop' string (default "")
8982 global
8983 {not in Vi}
8984 {not available when compiled without the |+wildignore|
8985 feature}
8986 A list of words that change how command line completion is done.
8987 Currently only one word is allowed:
8988 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008989 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008990 is displayed per line. Often used tag kinds are:
8991 d #define
8992 f function
8993 Also see |cmdline-completion|.
8994
Bram Moolenaar071d4272004-06-13 20:20:40 +00008995 *'winaltkeys'* *'wak'*
8996'winaltkeys' 'wak' string (default "menu")
8997 global
8998 {not in Vi}
8999 {only used in Win32, Motif, GTK and Photon GUI}
9000 Some GUI versions allow the access to menu entries by using the ALT
9001 key in combination with a character that appears underlined in the
9002 menu. This conflicts with the use of the ALT key for mappings and
9003 entering special characters. This option tells what to do:
9004 no Don't use ALT keys for menus. ALT key combinations can be
9005 mapped, but there is no automatic handling. This can then be
9006 done with the |:simalt| command.
9007 yes ALT key handling is done by the windowing system. ALT key
9008 combinations cannot be mapped.
9009 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009010 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009011 keys can be mapped.
9012 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9013 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009014 This option is not used for <F10>; on Win32 and with GTK <F10> will
9015 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009016
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009017 *'window'* *'wi'*
9018'window' 'wi' number (default screen height - 1)
9019 global
9020 Window height. Do not confuse this with the height of the Vim window,
9021 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009022 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9023 value is smaller than 'lines' minus one. The screen will scroll
9024 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009025 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9026 in a much smarter way, taking care of wrapping lines.
9027 When resizing the Vim window, the value is smaller than 1 or more than
9028 or equal to 'lines' it will be set to 'lines' minus 1.
9029 {Vi also uses the option to specify the number of displayed lines}
9030
Bram Moolenaar071d4272004-06-13 20:20:40 +00009031 *'winheight'* *'wh'* *E591*
9032'winheight' 'wh' number (default 1)
9033 global
9034 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009035 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009036 feature}
9037 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009038 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009039 focus goes to a window that is smaller, its size is increased, at the
9040 cost of the height of other windows.
9041 Set 'winheight' to a small number for normal editing.
9042 Set it to 999 to make the current window fill most of the screen.
9043 Other windows will be only 'winminheight' high. This has the drawback
9044 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9045 to create only two windows, set the option after startup is done,
9046 using the |VimEnter| event: >
9047 au VimEnter * set winheight=999
9048< Minimum value is 1.
9049 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009050 height of the current window.
9051 'winheight' applies to the current window. Use 'winminheight' to set
9052 the minimal height for other windows.
9053
9054 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9055'winfixheight' 'wfh' boolean (default off)
9056 local to window
9057 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009058 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 feature}
9060 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009061 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9062 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009063 The height may be changed anyway when running out of room.
9064
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009065 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9066'winfixwidth' 'wfw' boolean (default off)
9067 local to window
9068 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009069 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009070 feature}
9071 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009072 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009073 The width may be changed anyway when running out of room.
9074
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 *'winminheight'* *'wmh'*
9076'winminheight' 'wmh' number (default 1)
9077 global
9078 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009079 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009080 feature}
9081 The minimal height of a window, when it's not the current window.
9082 This is a hard minimum, windows will never become smaller.
9083 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9084 status bar) if necessary. They will return to at least one line when
9085 they become active (since the cursor has to have somewhere to go.)
9086 Use 'winheight' to set the minimal height of the current window.
9087 This option is only checked when making a window smaller. Don't use a
9088 large number, it will cause errors when opening more than a few
9089 windows. A value of 0 to 3 is reasonable.
9090
9091 *'winminwidth'* *'wmw'*
9092'winminwidth' 'wmw' number (default 1)
9093 global
9094 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009095 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009096 feature}
9097 The minimal width of a window, when it's not the current window.
9098 This is a hard minimum, windows will never become smaller.
9099 When set to zero, windows may be "squashed" to zero columns (i.e. just
9100 a vertical separator) if necessary. They will return to at least one
9101 line when they become active (since the cursor has to have somewhere
9102 to go.)
9103 Use 'winwidth' to set the minimal width of the current window.
9104 This option is only checked when making a window smaller. Don't use a
9105 large number, it will cause errors when opening more than a few
9106 windows. A value of 0 to 12 is reasonable.
9107
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009108 *'winptydll'*
9109'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9110 global
9111 {not in Vi}
9112 {only available when compiled with the |terminal|
9113 feature on MS-Windows}
9114 Specifies the name of the winpty shared library, used for the
9115 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009116 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009117 a fallback.
9118 Environment variables are expanded |:set_env|.
9119 This option cannot be set from a |modeline| or in the |sandbox|, for
9120 security reasons.
9121
Bram Moolenaar071d4272004-06-13 20:20:40 +00009122 *'winwidth'* *'wiw'* *E592*
9123'winwidth' 'wiw' number (default 20)
9124 global
9125 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009126 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009127 feature}
9128 Minimal number of columns for the current window. This is not a hard
9129 minimum, Vim will use fewer columns if there is not enough room. If
9130 the current window is smaller, its size is increased, at the cost of
9131 the width of other windows. Set it to 999 to make the current window
9132 always fill the screen. Set it to a small number for normal editing.
9133 The width is not adjusted after one of the commands to change the
9134 width of the current window.
9135 'winwidth' applies to the current window. Use 'winminwidth' to set
9136 the minimal width for other windows.
9137
9138 *'wrap'* *'nowrap'*
9139'wrap' boolean (default on)
9140 local to window
9141 {not in Vi}
9142 This option changes how text is displayed. It doesn't change the text
9143 in the buffer, see 'textwidth' for that.
9144 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009145 displaying continues on the next line. When off lines will not wrap
9146 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009147 moved to a part that is not shown, the screen will scroll
9148 horizontally.
9149 The line will be broken in the middle of a word if necessary. See
9150 'linebreak' to get the break at a word boundary.
9151 To make scrolling horizontally a bit more useful, try this: >
9152 :set sidescroll=5
9153 :set listchars+=precedes:<,extends:>
9154< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009155 This option can't be set from a |modeline| when the 'diff' option is
9156 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009157
9158 *'wrapmargin'* *'wm'*
9159'wrapmargin' 'wm' number (default 0)
9160 local to buffer
9161 Number of characters from the right window border where wrapping
9162 starts. When typing text beyond this limit, an <EOL> will be inserted
9163 and inserting continues on the next line.
9164 Options that add a margin, such as 'number' and 'foldcolumn', cause
9165 the text width to be further reduced. This is Vi compatible.
9166 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009167 This option is set to 0 when 'paste' is set and restored when 'paste'
9168 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9170 and less usefully}
9171
9172 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9173'wrapscan' 'ws' boolean (default on) *E384* *E385*
9174 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009175 Searches wrap around the end of the file. Also applies to |]s| and
9176 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177
9178 *'write'* *'nowrite'*
9179'write' boolean (default on)
9180 global
9181 {not in Vi}
9182 Allows writing files. When not set, writing a file is not allowed.
9183 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009184 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009185 argument. Filtering text is still possible, even though this requires
9186 writing a temporary file.
9187
9188 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9189'writeany' 'wa' boolean (default off)
9190 global
9191 Allows writing to any file with no need for "!" override.
9192
9193 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9194'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9195 otherwise)
9196 global
9197 {not in Vi}
9198 Make a backup before overwriting a file. The backup is removed after
9199 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009200 also on.
9201 WARNING: Switching this option off means that when Vim fails to write
9202 your buffer correctly and then, for whatever reason, Vim exits, you
9203 lose both the original file and what you were writing. Only reset
9204 this option if your file system is almost full and it makes the write
9205 fail (and make sure not to exit Vim until the write was successful).
9206 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009207 When the 'backupskip' pattern matches, a backup is not made anyway.
9208 NOTE: This option is set to the default value when 'compatible' is
9209 set.
9210
9211 *'writedelay'* *'wd'*
9212'writedelay' 'wd' number (default 0)
9213 global
9214 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009215 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009216 screen. When non-zero, characters are sent to the terminal one by
9217 one. For MS-DOS pcterm this does not work. For debugging purposes.
9218
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009219 vim:tw=78:ts=8:noet:ft=help:norl: