blob: b05a47992b09db60035d0940a25582ad097f4c3a [file] [log] [blame]
Bram Moolenaar259f26a2018-05-15 22:25:40 +02001*options.txt* For Vim version 8.0. 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.
833 When the file has been deleted this is not done. |timestamp|
834 If this option has a local value, use this command to switch back to
835 using the global value: >
836 :set autoread<
837<
838 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
839'autowrite' 'aw' boolean (default off)
840 global
841 Write the contents of the file, if it has been modified, on each
842 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000843 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
845 Note that for some commands the 'autowrite' option is not used, see
846 'autowriteall' for that.
847
848 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
849'autowriteall' 'awa' boolean (default off)
850 global
851 {not in Vi}
852 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
853 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
854 Setting this option also implies that Vim behaves like 'autowrite' has
855 been set.
856
857 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200858'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 global
860 {not in Vi}
861 When set to "dark", Vim will try to use colors that look good on a
862 dark background. When set to "light", Vim will try to use colors that
863 look good on a light background. Any other value is illegal.
864 Vim tries to set the default value according to the terminal used.
865 This will not always be correct.
866 Setting this option does not change the background color, it tells Vim
867 what the background color looks like. For changing the background
868 color, see |:hi-normal|.
869
870 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000871 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000872 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100873 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 setting 'background' will cause the color scheme to be reloaded. If
875 the color scheme adjusts to the value of 'background' this will work.
876 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878
879 When setting 'background' to the default value with: >
880 :set background&
881< Vim will guess the value. In the GUI this should work correctly,
882 in other cases Vim might not be able to guess the right value.
883
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200884 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200885 color from the terminal. If the returned RGB value is dark/light and
886 'background' is not dark/light, 'background' will be set and the
887 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200888 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100889 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200890
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 When starting the GUI, the default value for 'background' will be
892 "light". When the value is not set in the .gvimrc, and Vim detects
893 that the background is actually quite dark, 'background' is set to
894 "dark". But this happens only AFTER the .gvimrc file has been read
895 (because the window needs to be opened to find the actual background
896 color). To get around this, force the GUI window to be opened by
897 putting a ":gui" command in the .gvimrc file, before where the value
898 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200899
900 For MS-DOS, Windows and OS/2 the default is "dark".
901 For other systems "dark" is used when 'term' is "linux",
902 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
903 background. Otherwise the default is "light".
904
Bram Moolenaarc572da52017-08-27 16:52:01 +0200905 The |:terminal| command and the |term_start()| function use the
906 'background' value to decide whether the terminal window will start
907 with a white or black background.
908
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 Normally this option would be set in the .vimrc file. Possibly
910 depending on the terminal name. Example: >
911 :if &term == "pcterm"
912 : set background=dark
913 :endif
914< When this option is set, the default settings for the highlight groups
915 will change. To use other settings, place ":highlight" commands AFTER
916 the setting of the 'background' option.
917 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
918 to select the colors for syntax highlighting. After changing this
919 option, you must load syntax.vim again to see the result. This can be
920 done with ":syntax on".
921
922 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200923'backspace' 'bs' string (default "", set to "indent,eol,start"
924 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 global
926 {not in Vi}
927 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
928 mode. This is a list of items, separated by commas. Each item allows
929 a way to backspace over something:
930 value effect ~
931 indent allow backspacing over autoindent
932 eol allow backspacing over line breaks (join lines)
933 start allow backspacing over the start of insert; CTRL-W and CTRL-U
934 stop once at the start of insert.
935
936 When the value is empty, Vi compatible backspacing is used.
937
938 For backwards compatibility with version 5.4 and earlier:
939 value effect ~
940 0 same as ":set backspace=" (Vi compatible)
941 1 same as ":set backspace=indent,eol"
942 2 same as ":set backspace=indent,eol,start"
943
944 See |:fixdel| if your <BS> or <Del> key does not do what you want.
945 NOTE: This option is set to "" when 'compatible' is set.
946
947 *'backup'* *'bk'* *'nobackup'* *'nobk'*
948'backup' 'bk' boolean (default off)
949 global
950 {not in Vi}
951 Make a backup before overwriting a file. Leave it around after the
952 file has been successfully written. If you do not want to keep the
953 backup file, but you do want a backup while the file is being
954 written, reset this option and set the 'writebackup' option (this is
955 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000956 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 |backup-table| for more explanations.
958 When the 'backupskip' pattern matches, a backup is not made anyway.
959 When 'patchmode' is set, the backup may be renamed to become the
960 oldest version of a file.
961 NOTE: This option is reset when 'compatible' is set.
962
963 *'backupcopy'* *'bkc'*
964'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200965 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 {not in Vi}
967 When writing a file and a backup is made, this option tells how it's
968 done. This is a comma separated list of words.
969
970 The main values are:
971 "yes" make a copy of the file and overwrite the original one
972 "no" rename the file and write a new one
973 "auto" one of the previous, what works best
974
975 Extra values that can be combined with the ones above are:
976 "breaksymlink" always break symlinks when writing
977 "breakhardlink" always break hardlinks when writing
978
979 Making a copy and overwriting the original file:
980 - Takes extra time to copy the file.
981 + When the file has special attributes, is a (hard/symbolic) link or
982 has a resource fork, all this is preserved.
983 - When the file is a link the backup will have the name of the link,
984 not of the real file.
985
986 Renaming the file and writing a new one:
987 + It's fast.
988 - Sometimes not all attributes of the file can be copied to the new
989 file.
990 - When the file is a link the new file will not be a link.
991
992 The "auto" value is the middle way: When Vim sees that renaming file
993 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000994 the file is not a link) that is used. When problems are expected, a
995 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 The "breaksymlink" and "breakhardlink" values can be used in
998 combination with any of "yes", "no" and "auto". When included, they
999 force Vim to always break either symbolic or hard links by doing
1000 exactly what the "no" option does, renaming the original file to
1001 become the backup and writing a new file in its place. This can be
1002 useful for example in source trees where all the files are symbolic or
1003 hard links and any changes should stay in the local source tree, not
1004 be propagated back to the original source.
1005 *crontab*
1006 One situation where "no" and "auto" will cause problems: A program
1007 that opens a file, invokes Vim to edit that file, and then tests if
1008 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001009 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 example.
1011
1012 When a copy is made, the original file is truncated and then filled
1013 with the new text. This means that protection bits, owner and
1014 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001015 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 group of the backup is set to the group of the original file. If this
1017 fails, the protection bits for the group are made the same as for
1018 others.
1019
1020 When the file is renamed this is the other way around: The backup has
1021 the same attributes of the original file, and the newly written file
1022 is owned by the current user. When the file was a (hard/symbolic)
1023 link, the new file will not! That's why the "auto" value doesn't
1024 rename when the file is a link. The owner and group of the newly
1025 written file will be set to the same ones as the original file, but
1026 the system may refuse to do this. In that case the "auto" value will
1027 again not rename the file.
1028
Bram Moolenaar036986f2017-03-16 17:41:02 +01001029 NOTE: This option is set to the Vi default value when 'compatible' is
1030 set and to the Vim default value when 'compatible' is reset.
1031
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 *'backupdir'* *'bdir'*
1033'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001034 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 for Unix: ".,~/tmp,~/")
1036 global
1037 {not in Vi}
1038 List of directories for the backup file, separated with commas.
1039 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001040 where this is possible. The directory must exist, Vim will not
1041 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001042 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 impossible!). Writing may fail because of this.
1044 - A directory "." means to put the backup file in the same directory
1045 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001046 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 put the backup file relative to where the edited file is. The
1048 leading "." is replaced with the path name of the edited file.
1049 ("." inside a directory name has no special meaning).
1050 - Spaces after the comma are ignored, other spaces are considered part
1051 of the directory name. To have a space at the start of a directory
1052 name, precede it with a backslash.
1053 - To include a comma in a directory name precede it with a backslash.
1054 - A directory name may end in an '/'.
1055 - Environment variables are expanded |:set_env|.
1056 - Careful with '\' characters, type one before a space, type two to
1057 get one in the option (see |option-backslash|), for example: >
1058 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1059< - For backwards compatibility with Vim version 3.0 a '>' at the start
1060 of the option is removed.
1061 See also 'backup' and 'writebackup' options.
1062 If you want to hide your backup files on Unix, consider this value: >
1063 :set backupdir=./.backup,~/.backup,.,/tmp
1064< You must create a ".backup" directory in each directory and in your
1065 home directory for this to work properly.
1066 The use of |:set+=| and |:set-=| is preferred when adding or removing
1067 directories from the list. This avoids problems when a future version
1068 uses another default.
1069 This option cannot be set from a |modeline| or in the |sandbox|, for
1070 security reasons.
1071
1072 *'backupext'* *'bex'* *E589*
1073'backupext' 'bex' string (default "~", for VMS: "_")
1074 global
1075 {not in Vi}
1076 String which is appended to a file name to make the name of the
1077 backup file. The default is quite unusual, because this avoids
1078 accidentally overwriting existing files with a backup file. You might
1079 prefer using ".bak", but make sure that you don't have files with
1080 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001081 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001083 If you like to keep a lot of backups, you could use a BufWritePre
1084 autocommand to change 'backupext' just before writing the file to
1085 include a timestamp. >
1086 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1087< Use 'backupdir' to put the backup in a different directory.
1088
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001090'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1091 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1092 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 global
1094 {not in Vi}
1095 {not available when compiled without the |+wildignore|
1096 feature}
1097 A list of file patterns. When one of the patterns matches with the
1098 name of the file which is written, no backup file is created. Both
1099 the specified file name and the full path name of the file are used.
1100 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1101 Watch out for special characters, see |option-backslash|.
1102 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001103 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001104
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001105 WARNING: Not having a backup file means that when Vim fails to write
1106 your buffer correctly and then, for whatever reason, Vim exits, you
1107 lose both the original file and what you were writing. Only disable
1108 backups if you don't care about losing the file.
1109
Bram Moolenaar02467872007-05-06 13:22:01 +00001110 Note that environment variables are not expanded. If you want to use
1111 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001112 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001113
1114< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001115 backup would be made by renaming the original file crontab won't see
1116 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
1118 *'balloondelay'* *'bdlay'*
1119'balloondelay' 'bdlay' number (default: 600)
1120 global
1121 {not in Vi}
1122 {only available when compiled with the |+balloon_eval|
1123 feature}
1124 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1125
1126 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1127'ballooneval' 'beval' boolean (default off)
1128 global
1129 {not in Vi}
1130 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001131 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001132 Switch on the |balloon-eval| functionality for the GUI.
1133
1134 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1135 *'nobevalterm'*
1136'balloonevalterm' 'bevalterm' boolean (default off)
1137 global
1138 {not in Vi}
1139 {only available when compiled with the
1140 |+balloon_eval_term| feature}
1141 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001143 *'balloonexpr'* *'bexpr'*
1144'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001145 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001146 {not in Vi}
1147 {only available when compiled with the |+balloon_eval|
1148 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001149 Expression for text to show in evaluation balloon. It is only used
1150 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001151
1152 v:beval_bufnr number of the buffer in which balloon is going to show
1153 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001154 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001155 v:beval_lnum line number
1156 v:beval_col column number (byte index)
1157 v:beval_text word under or after the mouse pointer
1158
1159 The evaluation of the expression must not have side effects!
1160 Example: >
1161 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001162 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001163 \', column ' . v:beval_col .
1164 \ ' of file ' . bufname(v:beval_bufnr) .
1165 \ ' on word "' . v:beval_text . '"'
1166 endfunction
1167 set bexpr=MyBalloonExpr()
1168 set ballooneval
1169<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001170 Also see |balloon_show()|, can be used if the content of the balloon
1171 is to be fetched asynchronously.
1172
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001173 NOTE: The balloon is displayed only if the cursor is on a text
1174 character. If the result of evaluating 'balloonexpr' is not empty,
1175 Vim does not try to send a message to an external debugger (Netbeans
1176 or Sun Workshop).
1177
Bram Moolenaar30b65812012-07-12 22:01:11 +02001178 The expression will be evaluated in the |sandbox| when set from a
1179 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001180
1181 It is not allowed to change text or jump to another window while
1182 evaluating 'balloonexpr' |textlock|.
1183
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001184 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001185 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001186< When they are supported "\n" characters will start a new line. If the
1187 expression evaluates to a |List| this is equal to using each List item
1188 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001189 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001190
Bram Moolenaar165bc692015-07-21 17:53:25 +02001191 *'belloff'* *'bo'*
1192'belloff' 'bo' string (default "")
1193 global
1194 {not in Vi}
1195 Specifies for which events the bell will not be rung. It is a comma
1196 separated list of items. For each item that is present, the bell
1197 will be silenced. This is most useful to specify specific events in
1198 insert mode to be silenced.
1199
1200 item meaning when present ~
1201 all All events.
1202 backspace When hitting <BS> or <Del> and deleting results in an
1203 error.
1204 cursor Fail to move around using the cursor keys or
1205 <PageUp>/<PageDown> in |Insert-mode|.
1206 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1207 |i_CTRL-X_CTRL-T|.
1208 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1209 |i_CTRL-E|.
1210 ctrlg Unknown Char after <C-G> in Insert mode.
1211 error Other Error occurred (e.g. try to join last line)
1212 (mostly used in |Normal-mode| or |Cmdline-mode|).
1213 esc hitting <Esc> in |Normal-mode|.
1214 ex In |Visual-mode|, hitting |Q| results in an error.
1215 hangul Error occurred when using hangul input.
1216 insertmode Pressing <Esc> in 'insertmode'.
1217 lang Calling the beep module for Lua/Mzscheme/TCL.
1218 mess No output available for |g<|.
1219 showmatch Error occurred for 'showmatch' function.
1220 operator Empty region error |cpo-E|.
1221 register Unknown register after <C-R> in |Insert-mode|.
1222 shell Bell from shell output |:!|.
1223 spell Error happened on spell suggest.
1224 wildmode More matches in |cmdline-completion| available
1225 (depends on the 'wildmode' setting).
1226
Bram Moolenaar036986f2017-03-16 17:41:02 +01001227 This is most useful to fine tune when in Insert mode the bell should
1228 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001229 indicate that an error occurred. It can be silenced by adding the
1230 "error" keyword.
1231
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1233'binary' 'bin' boolean (default off)
1234 local to buffer
1235 {not in Vi}
1236 This option should be set before editing a binary file. You can also
1237 use the |-b| Vim argument. When this option is switched on a few
1238 options will be changed (also when it already was on):
1239 'textwidth' will be set to 0
1240 'wrapmargin' will be set to 0
1241 'modeline' will be off
1242 'expandtab' will be off
1243 Also, 'fileformat' and 'fileformats' options will not be used, the
1244 file is read and written like 'fileformat' was "unix" (a single <NL>
1245 separates lines).
1246 The 'fileencoding' and 'fileencodings' options will not be used, the
1247 file is read without conversion.
1248 NOTE: When you start editing a(nother) file while the 'bin' option is
1249 on, settings from autocommands may change the settings again (e.g.,
1250 'textwidth'), causing trouble when editing. You might want to set
1251 'bin' again when the file has been loaded.
1252 The previous values of these options are remembered and restored when
1253 'bin' is switched from on to off. Each buffer has its own set of
1254 saved option values.
1255 To edit a file with 'binary' set you can use the |++bin| argument.
1256 This avoids you have to do ":set bin", which would have effect for all
1257 files you edit.
1258 When writing a file the <EOL> for the last line is only written if
1259 there was one in the original file (normally Vim appends an <EOL> to
1260 the last line if there is none; this would make the file longer). See
1261 the 'endofline' option.
1262
1263 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1264'bioskey' 'biosk' boolean (default on)
1265 global
1266 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001267 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
1269 *'bomb'* *'nobomb'*
1270'bomb' boolean (default off)
1271 local to buffer
1272 {not in Vi}
1273 {only available when compiled with the |+multi_byte|
1274 feature}
1275 When writing a file and the following conditions are met, a BOM (Byte
1276 Order Mark) is prepended to the file:
1277 - this option is on
1278 - the 'binary' option is off
1279 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1280 endian variants.
1281 Some applications use the BOM to recognize the encoding of the file.
1282 Often used for UCS-2 files on MS-Windows. For other applications it
1283 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001284 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1286 check for the presence of the BOM is done and 'bomb' set accordingly.
1287 Unless 'binary' is set, it is removed from the first line, so that you
1288 don't see it when editing. When you don't change the options, the BOM
1289 will be restored when writing the file.
1290
1291 *'breakat'* *'brk'*
1292'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1293 global
1294 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001295 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 feature}
1297 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001298 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1299 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001301 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302'breakindent' 'bri' boolean (default off)
1303 local to window
1304 {not in Vi}
1305 {not available when compiled without the |+linebreak|
1306 feature}
1307 Every wrapped line will continue visually indented (same amount of
1308 space as the beginning of that line), thus preserving horizontal blocks
1309 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001310 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001311
1312 *'breakindentopt'* *'briopt'*
1313'breakindentopt' 'briopt' string (default empty)
1314 local to window
1315 {not in Vi}
1316 {not available when compiled without the |+linebreak|
1317 feature}
1318 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001319 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001320 min:{n} Minimum text width that will be kept after
1321 applying 'breakindent', even if the resulting
1322 text should normally be narrower. This prevents
1323 text indented almost to the right window border
1324 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001325 shift:{n} After applying 'breakindent', the wrapped line's
1326 beginning will be shifted by the given number of
1327 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001328 indentation (negative) or emphasizing the line
1329 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001330 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001331 additional indent.
1332 The default value for min is 20 and shift is 0.
1333
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001335'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001337 {not in Vi} {only for Motif, Athena, GTK, Mac and
1338 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001340 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001341 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 buffer Use the directory of the related buffer.
1343 current Use the current directory.
1344 {path} Use the specified directory
1345
1346 *'bufhidden'* *'bh'*
1347'bufhidden' 'bh' string (default: "")
1348 local to buffer
1349 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 This option specifies what happens when a buffer is no longer
1351 displayed in a window:
1352 <empty> follow the global 'hidden' option
1353 hide hide the buffer (don't unload it), also when 'hidden'
1354 is not set
1355 unload unload the buffer, also when 'hidden' is set or using
1356 |:hide|
1357 delete delete the buffer from the buffer list, also when
1358 'hidden' is set or using |:hide|, like using
1359 |:bdelete|
1360 wipe wipe out the buffer from the buffer list, also when
1361 'hidden' is set or using |:hide|, like using
1362 |:bwipeout|
1363
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001364 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001365 are lost without a warning. Also, these values may break autocommands
1366 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 This option is used together with 'buftype' and 'swapfile' to specify
1368 special kinds of buffers. See |special-buffers|.
1369
1370 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1371'buflisted' 'bl' boolean (default: on)
1372 local to buffer
1373 {not in Vi}
1374 When this option is set, the buffer shows up in the buffer list. If
1375 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1376 This option is reset by Vim for buffers that are only used to remember
1377 a file name or marks. Vim sets it when starting to edit a buffer.
1378 But not when moving to a buffer with ":buffer".
1379
1380 *'buftype'* *'bt'* *E382*
1381'buftype' 'bt' string (default: "")
1382 local to buffer
1383 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 The value of this option specifies the type of a buffer:
1385 <empty> normal buffer
1386 nofile buffer which is not related to a file and will not be
1387 written
1388 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001389 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001390 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001392 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 help help buffer (you are not supposed to set this
1394 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001395 terminal buffer for a |terminal| (you are not supposed to set
1396 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397
1398 This option is used together with 'bufhidden' and 'swapfile' to
1399 specify special kinds of buffers. See |special-buffers|.
1400
1401 Be careful with changing this option, it can have many side effects!
1402
Bram Moolenaar280f1262006-01-30 00:14:18 +00001403 A "quickfix" buffer is only used for the error list and the location
1404 list. This value is set by the |:cwindow| and |:lwindow| commands and
1405 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406
1407 "nofile" and "nowrite" buffers are similar:
1408 both: The buffer is not to be written to disk, ":w" doesn't
1409 work (":w filename" does work though).
1410 both: The buffer is never considered to be |'modified'|.
1411 There is no warning when the changes will be lost, for
1412 example when you quit Vim.
1413 both: A swap file is only created when using too much memory
1414 (when 'swapfile' has been reset there is never a swap
1415 file).
1416 nofile only: The buffer name is fixed, it is not handled like a
1417 file name. It is not modified in response to a |:cd|
1418 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001419 both: When using ":e bufname" and already editing "bufname"
1420 the buffer is made empty and autocommands are
1421 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001422 *E676*
1423 "acwrite" implies that the buffer name is not related to a file, like
1424 "nofile", but it will be written. Thus, in contrast to "nofile" and
1425 "nowrite", ":w" does work and a modified buffer can't be abandoned
1426 without saving. For writing there must be matching |BufWriteCmd|,
1427 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428
1429 *'casemap'* *'cmp'*
1430'casemap' 'cmp' string (default: "internal,keepascii")
1431 global
1432 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001433 {only available when compiled with the |+multi_byte|
1434 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 Specifies details about changing the case of letters. It may contain
1436 these words, separated by a comma:
1437 internal Use internal case mapping functions, the current
1438 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001439 matters when 'encoding' is a Unicode encoding,
1440 "latin1" or "iso-8859-15". When "internal" is
1441 omitted, the towupper() and towlower() system library
1442 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1444 case mapping, the current locale is not effective.
1445 This probably only matters for Turkish.
1446
1447 *'cdpath'* *'cd'* *E344* *E346*
1448'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1449 global
1450 {not in Vi}
1451 {not available when compiled without the
1452 |+file_in_path| feature}
1453 This is a list of directories which will be searched when using the
1454 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001455 for has a relative path, not an absolute part starting with "/", "./"
1456 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457 The 'cdpath' option's value has the same form and semantics as
1458 |'path'|. Also see |file-searching|.
1459 The default value is taken from $CDPATH, with a "," prepended to look
1460 in the current directory first.
1461 If the default value taken from $CDPATH is not what you want, include
1462 a modified version of the following command in your vimrc file to
1463 override it: >
1464 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1465< This option cannot be set from a |modeline| or in the |sandbox|, for
1466 security reasons.
1467 (parts of 'cdpath' can be passed to the shell to expand file names).
1468
1469 *'cedit'*
1470'cedit' string (Vi default: "", Vim default: CTRL-F)
1471 global
1472 {not in Vi}
1473 {not available when compiled without the |+vertsplit|
1474 feature}
1475 The key used in Command-line Mode to open the command-line window.
1476 The default is CTRL-F when 'compatible' is off.
1477 Only non-printable keys are allowed.
1478 The key can be specified as a single character, but it is difficult to
1479 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001480 :exe "set cedit=\<C-Y>"
1481 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482< |Nvi| also has this option, but it only uses the first character.
1483 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001484 NOTE: This option is set to the Vim default value when 'compatible'
1485 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486
1487 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1488'charconvert' 'ccv' string (default "")
1489 global
1490 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001491 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 {not in Vi}
1493 An expression that is used for character encoding conversion. It is
1494 evaluated when a file that is to be read or has been written has a
1495 different encoding from what is desired.
1496 'charconvert' is not used when the internal iconv() function is
1497 supported and is able to do the conversion. Using iconv() is
1498 preferred, because it is much faster.
1499 'charconvert' is not used when reading stdin |--|, because there is no
1500 file to convert from. You will have to save the text in a file first.
1501 The expression must return zero or an empty string for success,
1502 non-zero for failure.
1503 The possible encoding names encountered are in 'encoding'.
1504 Additionally, names given in 'fileencodings' and 'fileencoding' are
1505 used.
1506 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1507 is done internally by Vim, 'charconvert' is not used for this.
1508 'charconvert' is also used to convert the viminfo file, if the 'c'
1509 flag is present in 'viminfo'. Also used for Unicode conversion.
1510 Example: >
1511 set charconvert=CharConvert()
1512 fun CharConvert()
1513 system("recode "
1514 \ . v:charconvert_from . ".." . v:charconvert_to
1515 \ . " <" . v:fname_in . " >" v:fname_out)
1516 return v:shell_error
1517 endfun
1518< The related Vim variables are:
1519 v:charconvert_from name of the current encoding
1520 v:charconvert_to name of the desired encoding
1521 v:fname_in name of the input file
1522 v:fname_out name of the output file
1523 Note that v:fname_in and v:fname_out will never be the same.
1524 Note that v:charconvert_from and v:charconvert_to may be different
1525 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1526 Encryption is not done by Vim when using 'charconvert'. If you want
1527 to encrypt the file after conversion, 'charconvert' should take care
1528 of this.
1529 This option cannot be set from a |modeline| or in the |sandbox|, for
1530 security reasons.
1531
1532 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1533'cindent' 'cin' boolean (default off)
1534 local to buffer
1535 {not in Vi}
1536 {not available when compiled without the |+cindent|
1537 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001538 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001539 that trigger reindenting in insert mode and 'cinoptions' to set your
1540 preferred indent style.
1541 If 'indentexpr' is not empty, it overrules 'cindent'.
1542 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1543 the "=" operator indents using this algorithm rather than calling an
1544 external program.
1545 See |C-indenting|.
1546 When you don't like the way 'cindent' works, try the 'smartindent'
1547 option or 'indentexpr'.
1548 This option is not used when 'paste' is set.
1549 NOTE: This option is reset when 'compatible' is set.
1550
1551 *'cinkeys'* *'cink'*
1552'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1553 local to buffer
1554 {not in Vi}
1555 {not available when compiled without the |+cindent|
1556 feature}
1557 A list of keys that, when typed in Insert mode, cause reindenting of
1558 the current line. Only used if 'cindent' is on and 'indentexpr' is
1559 empty.
1560 For the format of this option see |cinkeys-format|.
1561 See |C-indenting|.
1562
1563 *'cinoptions'* *'cino'*
1564'cinoptions' 'cino' string (default "")
1565 local to buffer
1566 {not in Vi}
1567 {not available when compiled without the |+cindent|
1568 feature}
1569 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1570 program. See |cinoptions-values| for the values of this option, and
1571 |C-indenting| for info on C indenting in general.
1572
1573
1574 *'cinwords'* *'cinw'*
1575'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1576 local to buffer
1577 {not in Vi}
1578 {not available when compiled without both the
1579 |+cindent| and the |+smartindent| features}
1580 These keywords start an extra indent in the next line when
1581 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1582 an appropriate place (inside {}).
1583 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1584 matter, include the keyword both the uppercase and lowercase:
1585 "if,If,IF".
1586
1587 *'clipboard'* *'cb'*
1588'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1589 for X-windows, "" otherwise)
1590 global
1591 {not in Vi}
1592 {only in GUI versions or when the |+xterm_clipboard|
1593 feature is included}
1594 This option is a list of comma separated names.
1595 These names are recognized:
1596
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001597 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001598 unnamed When included, Vim will use the clipboard register '*'
1599 for all yank, delete, change and put operations which
1600 would normally go to the unnamed register. When a
1601 register is explicitly specified, it will always be
1602 used regardless of whether "unnamed" is in 'clipboard'
1603 or not. The clipboard register can always be
1604 explicitly accessed using the "* notation. Also see
1605 |gui-clipboard|.
1606
Bram Moolenaar30b65812012-07-12 22:01:11 +02001607 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001608 unnamedplus A variant of the "unnamed" flag which uses the
1609 clipboard register '+' (|quoteplus|) instead of
1610 register '*' for all yank, delete, change and put
1611 operations which would normally go to the unnamed
1612 register. When "unnamed" is also included to the
1613 option, yank operations (but not delete, change or
1614 put) will additionally copy the text into register
1615 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001616 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001617 Availability can be checked with: >
1618 if has('unnamedplus')
1619<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001620 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 autoselect Works like the 'a' flag in 'guioptions': If present,
1622 then whenever Visual mode is started, or the Visual
1623 area extended, Vim tries to become the owner of the
1624 windowing system's global selection or put the
1625 selected text on the clipboard used by the selection
1626 register "*. See |guioptions_a| and |quotestar| for
1627 details. When the GUI is active, the 'a' flag in
1628 'guioptions' is used, when the GUI is not active, this
1629 "autoselect" flag is used.
1630 Also applies to the modeless selection.
1631
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001632 *clipboard-autoselectplus*
1633 autoselectplus Like "autoselect" but using the + register instead of
1634 the * register. Compare to the 'P' flag in
1635 'guioptions'.
1636
1637 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 autoselectml Like "autoselect", but for the modeless selection
1639 only. Compare to the 'A' flag in 'guioptions'.
1640
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001641 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001642 html When the clipboard contains HTML, use this when
1643 pasting. When putting text on the clipboard, mark it
1644 as HTML. This works to copy rendered HTML from
1645 Firefox, paste it as raw HTML in Vim, select the HTML
1646 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001647 You probably want to add this only temporarily,
1648 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001649 Only supported for GTK version 2 and later.
1650 Only available with the |+multi_byte| feature.
1651
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001652 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 exclude:{pattern}
1654 Defines a pattern that is matched against the name of
1655 the terminal 'term'. If there is a match, no
1656 connection will be made to the X server. This is
1657 useful in this situation:
1658 - Running Vim in a console.
1659 - $DISPLAY is set to start applications on another
1660 display.
1661 - You do not want to connect to the X server in the
1662 console, but do want this in a terminal emulator.
1663 To never connect to the X server use: >
1664 exclude:.*
1665< This has the same effect as using the |-X| argument.
1666 Note that when there is no connection to the X server
1667 the window title won't be restored and the clipboard
1668 cannot be accessed.
1669 The value of 'magic' is ignored, {pattern} is
1670 interpreted as if 'magic' was on.
1671 The rest of the option value will be used for
1672 {pattern}, this must be the last entry.
1673
1674 *'cmdheight'* *'ch'*
1675'cmdheight' 'ch' number (default 1)
1676 global
1677 {not in Vi}
1678 Number of screen lines to use for the command-line. Helps avoiding
1679 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001680 The value of this option is stored with the tab page, so that each tab
1681 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682
1683 *'cmdwinheight'* *'cwh'*
1684'cmdwinheight' 'cwh' number (default 7)
1685 global
1686 {not in Vi}
1687 {not available when compiled without the |+vertsplit|
1688 feature}
1689 Number of screen lines to use for the command-line window. |cmdwin|
1690
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001691 *'colorcolumn'* *'cc'*
1692'colorcolumn' 'cc' string (default "")
1693 local to window
1694 {not in Vi}
1695 {not available when compiled without the |+syntax|
1696 feature}
1697 'colorcolumn' is a comma separated list of screen columns that are
1698 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1699 text. Will make screen redrawing slower.
1700 The screen column can be an absolute number, or a number preceded with
1701 '+' or '-', which is added to or subtracted from 'textwidth'. >
1702
1703 :set cc=+1 " highlight column after 'textwidth'
1704 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1705 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1706<
1707 When 'textwidth' is zero then the items with '-' and '+' are not used.
1708 A maximum of 256 columns are highlighted.
1709
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 *'columns'* *'co'* *E594*
1711'columns' 'co' number (default 80 or terminal width)
1712 global
1713 {not in Vi}
1714 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001715 initialization and does not have to be set by hand. Also see
1716 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 When Vim is running in the GUI or in a resizable window, setting this
1718 option will cause the window size to be changed. When you only want
1719 to use the size for the GUI, put the command in your |gvimrc| file.
1720 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001721 number of columns of the display, the display may be messed up. For
1722 the GUI it is always possible and Vim limits the number of columns to
1723 what fits on the screen. You can use this command to get the widest
1724 window possible: >
1725 :set columns=9999
1726< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727
1728 *'comments'* *'com'* *E524* *E525*
1729'comments' 'com' string (default
1730 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1731 local to buffer
1732 {not in Vi}
1733 {not available when compiled without the |+comments|
1734 feature}
1735 A comma separated list of strings that can start a comment line. See
1736 |format-comments|. See |option-backslash| about using backslashes to
1737 insert a space.
1738
1739 *'commentstring'* *'cms'* *E537*
1740'commentstring' 'cms' string (default "/*%s*/")
1741 local to buffer
1742 {not in Vi}
1743 {not available when compiled without the |+folding|
1744 feature}
1745 A template for a comment. The "%s" in the value is replaced with the
1746 comment text. Currently only used to add markers for folding, see
1747 |fold-marker|.
1748
1749 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001750'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001751 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 global
1753 {not in Vi}
1754 This option has the effect of making Vim either more Vi-compatible, or
1755 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758 other options are also changed as a side effect.
1759 NOTE: Setting or resetting this option can have a lot of unexpected
1760 effects: Mappings are interpreted in another way, undo behaves
1761 differently, etc. If you set this option in your vimrc file, you
1762 should probably put it at the very start.
1763
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 By default this option is on and the Vi defaults are used for the
1765 options. This default was chosen for those people who want to use Vim
1766 just like Vi, and don't even (want to) know about the 'compatible'
1767 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001768 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001769 this option is switched off, and all options that have not been
1770 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001771 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001772 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001773 happen for the system-wide vimrc or gvimrc file, nor for a file given
1774 with the |-u| argument). Also see |compatible-default| and
1775 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 You can also set this option with the "-C" argument, and reset it with
1777 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779
Bram Moolenaar214641f2017-03-05 17:04:09 +01001780 When this option is set, numerous other options are set to make Vim as
1781 Vi-compatible as possible. When this option is unset, various options
1782 are set to make Vim more useful. The table below lists all the
1783 options affected.
1784 The {?} column indicates when the options are affected:
1785 + Means that the option is set to the value given in {set value} when
1786 'compatible' is set.
1787 & Means that the option is set to the value given in {set value} when
1788 'compatible' is set AND is set to its Vim default value when
1789 'compatible' is unset.
1790 - Means the option is NOT changed when setting 'compatible' but IS
1791 set to its Vim default when 'compatible' is unset.
1792 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793
Bram Moolenaar036986f2017-03-16 17:41:02 +01001794 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795
1796 'allowrevins' + off no CTRL-_ command
1797 'antialias' + off don't use antialiased fonts
1798 'arabic' + off reset arabic-related options
1799 'arabicshape' + on correct character shapes
1800 'backspace' + "" normal backspace
1801 'backup' + off no backup file
1802 'backupcopy' & Unix: "yes" backup file is a copy
1803 else: "auto" copy or rename backup file
1804 'balloonexpr' + "" text to show in evaluation balloon
1805 'breakindent' + off don't indent when wrapping lines
1806 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1807 'cindent' + off no C code indentation
1808 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1809 'copyindent' + off don't copy indent structure
1810 'cpoptions' & (all flags) Vi-compatible flags
1811 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001812 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001813 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001814 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001815 'cscopeverbose' + off see |cscopeverbose|
1816 'delcombine' + off unicode: delete whole char combination
1817 'digraph' + off no digraphs
1818 'esckeys' & off no <Esc>-keys in Insert mode
1819 'expandtab' + off tabs not expanded to spaces
1820 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001822 'formatexpr' + "" use 'formatprg' for auto-formatting
1823 'formatoptions' & "vt" Vi compatible formatting
1824 'gdefault' + off no default 'g' flag for ":s"
1825 'history' & 0 no commandline history
1826 'hkmap' + off no Hebrew keyboard mapping
1827 'hkmapp' + off no phonetic Hebrew keyboard mapping
1828 'hlsearch' + off no highlighting of search matches
1829 'incsearch' + off no incremental searching
1830 'indentexpr' + "" no indenting by expression
1831 'insertmode' + off do not start in Insert mode
1832 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001834 'joinspaces' + on insert 2 spaces after period
1835 'modeline' & off no modelines
1836 'more' & off no pauses in listings
1837 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1838 'numberwidth' & 8 min number of columns for line number
1839 'preserveindent'+ off don't preserve current indent structure
1840 when changing it
1841 'revins' + off no reverse insert
1842 'ruler' + off no ruler
1843 'scrolljump' + 1 no jump scroll
1844 'scrolloff' + 0 no scroll offset
1845 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1846 'shiftround' + off indent not rounded to shiftwidth
1847 'shortmess' & "" no shortening of messages
1848 'showcmd' & off command characters not shown
1849 'showmode' & off current mode not shown
1850 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1851 'smartcase' + off no automatic ignore case switch
1852 'smartindent' + off no smart indentation
1853 'smarttab' + off no smart tab size
1854 'softtabstop' + 0 tabs are always 'tabstop' positions
1855 'startofline' + on goto startofline with some commands
1856 'tagcase' & "followic" 'ignorecase' when searching tags file
1857 'tagrelative' & off tag file names are not relative
1858 'termguicolors' + off don't use highlight-(guifg|guibg)
1859 'textauto' & off no automatic textmode detection
1860 'textwidth' + 0 no automatic line wrap
1861 'tildeop' + off tilde is not an operator
1862 'ttimeout' + off no terminal timeout
1863 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001864 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001865 'virtualedit' + "" cursor can only be placed on characters
1866 'whichwrap' & "" left-right movements don't wrap
1867 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001869 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870
1871 *'complete'* *'cpt'* *E535*
1872'complete' 'cpt' string (default: ".,w,b,u,t,i")
1873 local to buffer
1874 {not in Vi}
1875 This option specifies how keyword completion |ins-completion| works
1876 when CTRL-P or CTRL-N are used. It is also used for whole-line
1877 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1878 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001879 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 w scan buffers from other windows
1881 b scan other loaded buffers that are in the buffer list
1882 u scan the unloaded buffers that are in the buffer list
1883 U scan the buffers that are not in the buffer list
1884 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001885 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 k{dict} scan the file {dict}. Several "k" flags can be given,
1887 patterns are valid too. For example: >
1888 :set cpt=k/usr/dict/*,k~/spanish
1889< s scan the files given with the 'thesaurus' option
1890 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1891 are valid too.
1892 i scan current and included files
1893 d scan current and included files for defined name or macro
1894 |i_CTRL-X_CTRL-D|
1895 ] tag completion
1896 t same as "]"
1897
1898 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1899 not executed, this may lead to unexpected completions from some files
1900 (gzipped files for example). Unloaded buffers are not scanned for
1901 whole-line completion.
1902
1903 The default is ".,w,b,u,t,i", which means to scan:
1904 1. the current buffer
1905 2. buffers in other windows
1906 3. other loaded buffers
1907 4. unloaded buffers
1908 5. tags
1909 6. included files
1910
1911 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001912 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1913 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001915 *'completefunc'* *'cfu'*
1916'completefunc' 'cfu' string (default: empty)
1917 local to buffer
1918 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001919 {not available when compiled without the |+eval|
1920 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001921 This option specifies a function to be used for Insert mode completion
1922 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001923 See |complete-functions| for an explanation of how the function is
1924 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001925 This option cannot be set from a |modeline| or in the |sandbox|, for
1926 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001927
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001928 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001929'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001930 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001931 {not available when compiled without the
1932 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001933 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001934 A comma separated list of options for Insert mode completion
1935 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001936
1937 menu Use a popup menu to show the possible completions. The
1938 menu is only shown when there is more than one match and
1939 sufficient colors are available. |ins-completion-menu|
1940
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001941 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001942 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001943 match, e.g., what file it comes from.
1944
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001945 longest Only insert the longest common text of the matches. If
1946 the menu is displayed you can use CTRL-L to add more
1947 characters. Whether case is ignored depends on the kind
1948 of completion. For buffer text the 'ignorecase' option is
1949 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001950
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001951 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001952 completion in the preview window. Only works in
1953 combination with "menu" or "menuone".
1954
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001955 noinsert Do not insert any text for a match until the user selects
1956 a match from the menu. Only works in combination with
1957 "menu" or "menuone". No effect if "longest" is present.
1958
1959 noselect Do not select a match in the menu, force the user to
1960 select one from the menu. Only works in combination with
1961 "menu" or "menuone".
1962
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001963
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 *'concealcursor'* *'cocu'*
1965'concealcursor' 'cocu' string (default: "")
1966 local to window
1967 {not in Vi}
1968 {not available when compiled without the |+conceal|
1969 feature}
1970 Sets the modes in which text in the cursor line can also be concealed.
1971 When the current mode is listed then concealing happens just like in
1972 other lines.
1973 n Normal mode
1974 v Visual mode
1975 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001976 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001977
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001978 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001979 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980 are moving around text is concealed, but when starting to insert text
1981 or selecting a Visual area the concealed text is displayed, so that
1982 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001983 Keep in mind that the cursor position is not always where it's
1984 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001985
1986
1987'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988 number (default 0)
1989 local to window
1990 {not in Vi}
1991 {not available when compiled without the |+conceal|
1992 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001993 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1994 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001995
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001996 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001997 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001998 1 Each block of concealed text is replaced with one
1999 character. If the syntax item does not have a custom
2000 replacement character defined (see |:syn-cchar|) the
2001 character defined in 'listchars' is used (default is a
2002 space).
2003 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002004 2 Concealed text is completely hidden unless it has a
2005 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002006 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002007 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002008
Bram Moolenaara7781e02010-07-19 20:13:22 +02002009 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002010 edit and copy the text. This can be changed with the 'concealcursor'
2011 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002012
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2014'confirm' 'cf' boolean (default off)
2015 global
2016 {not in Vi}
2017 When 'confirm' is on, certain operations that would normally
2018 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2019 instead raise a |dialog| asking if you wish to save the current
2020 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2021 If 'confirm' is off you can still activate confirmation for one
2022 command only (this is most useful in mappings) with the |:confirm|
2023 command.
2024 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2025
2026 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2027'conskey' 'consk' boolean (default off)
2028 global
2029 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002030 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
2032 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2033'copyindent' 'ci' boolean (default off)
2034 local to buffer
2035 {not in Vi}
2036 Copy the structure of the existing lines indent when autoindenting a
2037 new line. Normally the new indent is reconstructed by a series of
2038 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2039 in which case only spaces are used). Enabling this option makes the
2040 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002041 existing line. 'expandtab' has no effect on these characters, a Tab
2042 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002044 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 Also see 'preserveindent'.
2046
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002047 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048'cpoptions' 'cpo' string (Vim default: "aABceFs",
2049 Vi default: all flags)
2050 global
2051 {not in Vi}
2052 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002053 this indicates Vi-compatible behavior. This is used for things where
2054 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 'cpoptions' stands for "compatible-options".
2056 Commas can be added for readability.
2057 To avoid problems with flags that are added in the future, use the
2058 "+=" and "-=" feature of ":set" |add-option-flags|.
2059 NOTE: This option is set to the Vi default value when 'compatible' is
2060 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002061 NOTE: This option is set to the POSIX default value at startup when
2062 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002063 variable exists |posix|. This means Vim tries to behave like the
2064 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065
2066 contains behavior ~
2067 *cpo-a*
2068 a When included, a ":read" command with a file name
2069 argument will set the alternate file name for the
2070 current window.
2071 *cpo-A*
2072 A When included, a ":write" command with a file name
2073 argument will set the alternate file name for the
2074 current window.
2075 *cpo-b*
2076 b "\|" in a ":map" command is recognized as the end of
2077 the map command. The '\' is included in the mapping,
2078 the text after the '|' is interpreted as the next
2079 command. Use a CTRL-V instead of a backslash to
2080 include the '|' in the mapping. Applies to all
2081 mapping, abbreviation, menu and autocmd commands.
2082 See also |map_bar|.
2083 *cpo-B*
2084 B A backslash has no special meaning in mappings,
2085 abbreviations and the "to" part of the menu commands.
2086 Remove this flag to be able to use a backslash like a
2087 CTRL-V. For example, the command ":map X \<Esc>"
2088 results in X being mapped to:
2089 'B' included: "\^[" (^[ is a real <Esc>)
2090 'B' excluded: "<Esc>" (5 characters)
2091 ('<' excluded in both cases)
2092 *cpo-c*
2093 c Searching continues at the end of any match at the
2094 cursor position, but not further than the start of the
2095 next line. When not present searching continues
2096 one character from the cursor position. With 'c'
2097 "abababababab" only gets three matches when repeating
2098 "/abab", without 'c' there are five matches.
2099 *cpo-C*
2100 C Do not concatenate sourced lines that start with a
2101 backslash. See |line-continuation|.
2102 *cpo-d*
2103 d Using "./" in the 'tags' option doesn't mean to use
2104 the tags file relative to the current file, but the
2105 tags file in the current directory.
2106 *cpo-D*
2107 D Can't use CTRL-K to enter a digraph after Normal mode
2108 commands with a character argument, like |r|, |f| and
2109 |t|.
2110 *cpo-e*
2111 e When executing a register with ":@r", always add a
2112 <CR> to the last line, also when the register is not
2113 linewise. If this flag is not present, the register
2114 is not linewise and the last line does not end in a
2115 <CR>, then the last line is put on the command-line
2116 and can be edited before hitting <CR>.
2117 *cpo-E*
2118 E It is an error when using "y", "d", "c", "g~", "gu" or
2119 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002120 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 This makes "y0" fail in the first column.
2122 *cpo-f*
2123 f When included, a ":read" command with a file name
2124 argument will set the file name for the current buffer,
2125 if the current buffer doesn't have a file name yet.
2126 *cpo-F*
2127 F When included, a ":write" command with a file name
2128 argument will set the file name for the current
2129 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002130 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 *cpo-g*
2132 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002133 *cpo-H*
2134 H When using "I" on a line with only blanks, insert
2135 before the last blank. Without this flag insert after
2136 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 *cpo-i*
2138 i When included, interrupting the reading of a file will
2139 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002140 *cpo-I*
2141 I When moving the cursor up or down just after inserting
2142 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 *cpo-j*
2144 j When joining lines, only add two spaces after a '.',
2145 not after '!' or '?'. Also see 'joinspaces'.
2146 *cpo-J*
2147 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002148 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 white space.
2150 *cpo-k*
2151 k Disable the recognition of raw key codes in
2152 mappings, abbreviations, and the "to" part of menu
2153 commands. For example, if <Key> sends ^[OA (where ^[
2154 is <Esc>), the command ":map X ^[OA" results in X
2155 being mapped to:
2156 'k' included: "^[OA" (3 characters)
2157 'k' excluded: "<Key>" (one key code)
2158 Also see the '<' flag below.
2159 *cpo-K*
2160 K Don't wait for a key code to complete when it is
2161 halfway a mapping. This breaks mapping <F1><F1> when
2162 only part of the second <F1> has been read. It
2163 enables cancelling the mapping by typing <F1><Esc>.
2164 *cpo-l*
2165 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002166 literally, only "\]", "\^", "\-" and "\\" are special.
2167 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2169 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002170 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 *cpo-L*
2172 L When the 'list' option is set, 'wrapmargin',
2173 'textwidth', 'softtabstop' and Virtual Replace mode
2174 (see |gR|) count a <Tab> as two characters, instead of
2175 the normal behavior of a <Tab>.
2176 *cpo-m*
2177 m When included, a showmatch will always wait half a
2178 second. When not included, a showmatch will wait half
2179 a second or until a character is typed. |'showmatch'|
2180 *cpo-M*
2181 M When excluded, "%" matching will take backslashes into
2182 account. Thus in "( \( )" and "\( ( \)" the outer
2183 parenthesis match. When included "%" ignores
2184 backslashes, which is Vi compatible.
2185 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002186 n When included, the column used for 'number' and
2187 'relativenumber' will also be used for text of wrapped
2188 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 *cpo-o*
2190 o Line offset to search command is not remembered for
2191 next search.
2192 *cpo-O*
2193 O Don't complain if a file is being overwritten, even
2194 when it didn't exist when editing it. This is a
2195 protection against a file unexpectedly created by
2196 someone else. Vi didn't complain about this.
2197 *cpo-p*
2198 p Vi compatible Lisp indenting. When not present, a
2199 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002200 *cpo-P*
2201 P When included, a ":write" command that appends to a
2202 file will set the file name for the current buffer, if
2203 the current buffer doesn't have a file name yet and
2204 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002205 *cpo-q*
2206 q When joining multiple lines leave the cursor at the
2207 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 *cpo-r*
2209 r Redo ("." command) uses "/" to repeat a search
2210 command, instead of the actually used search string.
2211 *cpo-R*
2212 R Remove marks from filtered lines. Without this flag
2213 marks are kept like |:keepmarks| was used.
2214 *cpo-s*
2215 s Set buffer options when entering the buffer for the
2216 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002217 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 set when the buffer is created.
2219 *cpo-S*
2220 S Set buffer options always when entering a buffer
2221 (except 'readonly', 'fileformat', 'filetype' and
2222 'syntax'). This is the (most) Vi compatible setting.
2223 The options are set to the values in the current
2224 buffer. When you change an option and go to another
2225 buffer, the value is copied. Effectively makes the
2226 buffer options global to all buffers.
2227
2228 's' 'S' copy buffer options
2229 no no when buffer created
2230 yes no when buffer first entered (default)
2231 X yes each time when buffer entered (vi comp.)
2232 *cpo-t*
2233 t Search pattern for the tag command is remembered for
2234 "n" command. Otherwise Vim only puts the pattern in
2235 the history for search pattern, but doesn't change the
2236 last used search pattern.
2237 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002238 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *cpo-v*
2240 v Backspaced characters remain visible on the screen in
2241 Insert mode. Without this flag the characters are
2242 erased from the screen right away. With this flag the
2243 screen newly typed text overwrites backspaced
2244 characters.
2245 *cpo-w*
2246 w When using "cw" on a blank character, only change one
2247 character and not all blanks until the start of the
2248 next word.
2249 *cpo-W*
2250 W Don't overwrite a readonly file. When omitted, ":w!"
2251 overwrites a readonly file, if possible.
2252 *cpo-x*
2253 x <Esc> on the command-line executes the command-line.
2254 The default in Vim is to abandon the command-line,
2255 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002256 *cpo-X*
2257 X When using a count with "R" the replaced text is
2258 deleted only once. Also when repeating "R" with "."
2259 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 *cpo-y*
2261 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002262 *cpo-Z*
2263 Z When using "w!" while the 'readonly' option is set,
2264 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *cpo-!*
2266 ! When redoing a filter command, use the last used
2267 external command, whatever it was. Otherwise the last
2268 used -filter- command is used.
2269 *cpo-$*
2270 $ When making a change to one line, don't redisplay the
2271 line, but put a '$' at the end of the changed text.
2272 The changed text will be overwritten when you type the
2273 new text. The line is redisplayed if you type any
2274 command that moves the cursor from the insertion
2275 point.
2276 *cpo-%*
2277 % Vi-compatible matching is done for the "%" command.
2278 Does not recognize "#if", "#endif", etc.
2279 Does not recognize "/*" and "*/".
2280 Parens inside single and double quotes are also
2281 counted, causing a string that contains a paren to
2282 disturb the matching. For example, in a line like
2283 "if (strcmp("foo(", s))" the first paren does not
2284 match the last one. When this flag is not included,
2285 parens inside single and double quotes are treated
2286 specially. When matching a paren outside of quotes,
2287 everything inside quotes is ignored. When matching a
2288 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002289 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002290 This flag is also used for other features, such as
2291 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002292 *cpo--*
2293 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002294 it would go above the first line or below the last
2295 line. Without it the cursor moves to the first or
2296 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002297 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002298 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002299 *cpo-+*
2300 + When included, a ":write file" command will reset the
2301 'modified' flag of the buffer, even though the buffer
2302 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002303 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 * Use ":*" in the same way as ":@". When not included,
2305 ":*" is an alias for ":'<,'>", select the Visual area.
2306 *cpo-<*
2307 < Disable the recognition of special key codes in |<>|
2308 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002309 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 ":map X <Tab>" results in X being mapped to:
2311 '<' included: "<Tab>" (5 characters)
2312 '<' excluded: "^I" (^I is a real <Tab>)
2313 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002314 *cpo->*
2315 > When appending to a register, put a line break before
2316 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002317 *cpo-;*
2318 ; When using |,| or |;| to repeat the last |t| search
2319 and the cursor is right in front of the searched
2320 character, the cursor won't move. When not included,
2321 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002322 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002323
2324 POSIX flags. These are not included in the Vi default value, except
2325 when $VIM_POSIX was set on startup. |posix|
2326
2327 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002328 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002329 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330 *cpo-&*
2331 & When ":preserve" was used keep the swap file when
2332 exiting normally while this buffer is still loaded.
2333 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002334 *cpo-\*
2335 \ Backslash in a [] range in a search pattern is taken
2336 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002337 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2338 '\' excluded: "/[ \-]" finds <Space> and '-'
2339 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002340 *cpo-/*
2341 / When "%" is used as the replacement string in a |:s|
2342 command, use the previous replacement string. |:s%|
2343 *cpo-{*
2344 { The |{| and |}| commands also stop at a "{" character
2345 at the start of a line.
2346 *cpo-.*
2347 . The ":chdir" and ":cd" commands fail if the current
2348 buffer is modified, unless ! is used. Vim doesn't
2349 need this, since it remembers the full path of an
2350 opened file.
2351 *cpo-bar*
2352 | The value of the $LINES and $COLUMNS environment
2353 variables overrule the terminal size values obtained
2354 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002355
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002357 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002358'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002359 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002360 {not in Vi}
2361 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002362 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002363 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002364 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002365 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002366 blowfish Blowfish method. Medium strong encryption but it has
2367 an implementation flaw. Requires Vim 7.3 or later,
2368 files can NOT be read by Vim 7.2 and older. This adds
2369 a "seed" to the file, every time you write the file
2370 the encrypted bytes will be different.
2371 *blowfish2*
2372 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002373 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002374 and older. This adds a "seed" to the file, every time
2375 you write the file the encrypted bytes will be
2376 different. The whole undo file is encrypted, not just
2377 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002378
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002379 You should use "blowfish2", also to re-encrypt older files.
2380
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002381 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002382 to the detected method of the file being read. Thus if you write it
2383 without changing 'cryptmethod' the same method will be used.
2384 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002385 explicitly write it, you don't get a warning unless there are other
2386 modifications. Also see |:X|.
2387
2388 When setting the global value to an empty string, it will end up with
2389 the value "zip". When setting the local value to an empty string the
2390 buffer will use the global value.
2391
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002392 When a new encryption method is added in a later version of Vim, and
2393 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002394 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002395
2396
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 *'cscopepathcomp'* *'cspc'*
2398'cscopepathcomp' 'cspc' number (default 0)
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
2402 {not in Vi}
2403 Determines how many components of the path to show in a list of tags.
2404 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002405 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406
2407 *'cscopeprg'* *'csprg'*
2408'cscopeprg' 'csprg' string (default "cscope")
2409 global
2410 {not available when compiled without the |+cscope|
2411 feature}
2412 {not in Vi}
2413 Specifies the command to execute cscope. See |cscopeprg|.
2414 This option cannot be set from a |modeline| or in the |sandbox|, for
2415 security reasons.
2416
2417 *'cscopequickfix'* *'csqf'*
2418'cscopequickfix' 'csqf' string (default "")
2419 global
2420 {not available when compiled without the |+cscope|
2421 or |+quickfix| features}
2422 {not in Vi}
2423 Specifies whether to use quickfix window to show cscope results.
2424 See |cscopequickfix|.
2425
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002426 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002427'cscoperelative' 'csre' boolean (default off)
2428 global
2429 {not available when compiled without the |+cscope|
2430 feature}
2431 {not in Vi}
2432 In the absence of a prefix (-P) for cscope. setting this option enables
2433 to use the basename of cscope.out path as the prefix.
2434 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002435 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002436
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2438'cscopetag' 'cst' boolean (default off)
2439 global
2440 {not available when compiled without the |+cscope|
2441 feature}
2442 {not in Vi}
2443 Use cscope for tag commands. See |cscope-options|.
2444 NOTE: This option is reset when 'compatible' is set.
2445
2446 *'cscopetagorder'* *'csto'*
2447'cscopetagorder' 'csto' number (default 0)
2448 global
2449 {not available when compiled without the |+cscope|
2450 feature}
2451 {not in Vi}
2452 Determines the order in which ":cstag" performs a search. See
2453 |cscopetagorder|.
2454 NOTE: This option is set to 0 when 'compatible' is set.
2455
2456 *'cscopeverbose'* *'csverb'*
2457 *'nocscopeverbose'* *'nocsverb'*
2458'cscopeverbose' 'csverb' boolean (default off)
2459 global
2460 {not available when compiled without the |+cscope|
2461 feature}
2462 {not in Vi}
2463 Give messages when adding a cscope database. See |cscopeverbose|.
2464 NOTE: This option is reset when 'compatible' is set.
2465
Bram Moolenaar860cae12010-06-05 23:22:07 +02002466 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2467'cursorbind' 'crb' boolean (default off)
2468 local to window
2469 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002470 When this option is set, as the cursor in the current
2471 window moves other cursorbound windows (windows that also have
2472 this option set) move their cursors to the corresponding line and
2473 column. This option is useful for viewing the
2474 differences between two versions of a file (see 'diff'); in diff mode,
2475 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002476 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002477
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002478
2479 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2480'cursorcolumn' 'cuc' boolean (default off)
2481 local to window
2482 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002483 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002484 feature}
2485 Highlight the screen column of the cursor with CursorColumn
2486 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2487 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002488 If you only want the highlighting in the current window you can use
2489 these autocommands: >
2490 au WinLeave * set nocursorline nocursorcolumn
2491 au WinEnter * set cursorline cursorcolumn
2492<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002493
2494 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2495'cursorline' 'cul' boolean (default off)
2496 local to window
2497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002498 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002499 feature}
2500 Highlight the screen line of the cursor with CursorLine
2501 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2502 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002503 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002504 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002505
2506
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 *'debug'*
2508'debug' string (default "")
2509 global
2510 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002511 These values can be used:
2512 msg Error messages that would otherwise be omitted will be given
2513 anyway.
2514 throw Error messages that would otherwise be omitted will be given
2515 anyway and also throw an exception and set |v:errmsg|.
2516 beep A message will be given when otherwise only a beep would be
2517 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002518 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002519 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2520 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521
2522 *'define'* *'def'*
2523'define' 'def' string (default "^\s*#\s*define")
2524 global or local to buffer |global-local|
2525 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 pattern, just like for the "/" command. This option is used for the
2528 commands like "[i" and "[d" |include-search|. The 'isident' option is
2529 used to recognize the defined name after the match:
2530 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2531 See |option-backslash| about inserting backslashes to include a space
2532 or backslash.
2533 The default value is for C programs. For C++ this value would be
2534 useful, to include const type declarations: >
2535 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2536< When using the ":set" command, you need to double the backslashes!
2537
2538 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2539'delcombine' 'deco' boolean (default off)
2540 global
2541 {not in Vi}
2542 {only available when compiled with the |+multi_byte|
2543 feature}
2544 If editing Unicode and this option is set, backspace and Normal mode
2545 "x" delete each combining character on its own. When it is off (the
2546 default) the character along with its combining characters are
2547 deleted.
2548 Note: When 'delcombine' is set "xx" may work different from "2x"!
2549
2550 This is useful for Arabic, Hebrew and many other languages where one
2551 may have combining characters overtop of base characters, and want
2552 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002553 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554
2555 *'dictionary'* *'dict'*
2556'dictionary' 'dict' string (default "")
2557 global or local to buffer |global-local|
2558 {not in Vi}
2559 List of file names, separated by commas, that are used to lookup words
2560 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2561 contain a list of words. This can be one word per line, or several
2562 words per line, separated by non-keyword characters (white space is
2563 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002564
2565 When this option is empty or an entry "spell" is present, and spell
2566 checking is enabled, words in the word lists for the currently active
2567 'spelllang' are used. See |spell|.
2568
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002569 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 after a comma are ignored, otherwise spaces are included in the file
2571 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002572 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 Where to find a list of words?
2574 - On FreeBSD, there is the file "/usr/share/dict/words".
2575 - In the Simtel archive, look in the "msdos/linguist" directory.
2576 - In "miscfiles" of the GNU collection.
2577 The use of |:set+=| and |:set-=| is preferred when adding or removing
2578 directories from the list. This avoids problems when a future version
2579 uses another default.
2580 Backticks cannot be used in this option for security reasons.
2581
2582 *'diff'* *'nodiff'*
2583'diff' boolean (default off)
2584 local to window
2585 {not in Vi}
2586 {not available when compiled without the |+diff|
2587 feature}
2588 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002589 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590
2591 *'dex'* *'diffexpr'*
2592'diffexpr' 'dex' string (default "")
2593 global
2594 {not in Vi}
2595 {not available when compiled without the |+diff|
2596 feature}
2597 Expression which is evaluated to obtain an ed-style diff file from two
2598 versions of a file. See |diff-diffexpr|.
2599 This option cannot be set from a |modeline| or in the |sandbox|, for
2600 security reasons.
2601
2602 *'dip'* *'diffopt'*
2603'diffopt' 'dip' string (default "filler")
2604 global
2605 {not in Vi}
2606 {not available when compiled without the |+diff|
2607 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002608 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 All are optional. Items must be separated by a comma.
2610
2611 filler Show filler lines, to keep the text
2612 synchronized with a window that has inserted
2613 lines at the same position. Mostly useful
2614 when windows are side-by-side and 'scrollbind'
2615 is set.
2616
2617 context:{n} Use a context of {n} lines between a change
2618 and a fold that contains unchanged lines.
2619 When omitted a context of six lines is used.
2620 See |fold-diff|.
2621
2622 icase Ignore changes in case of text. "a" and "A"
2623 are considered the same. Adds the "-i" flag
2624 to the "diff" command if 'diffexpr' is empty.
2625
2626 iwhite Ignore changes in amount of white space. Adds
2627 the "-b" flag to the "diff" command if
2628 'diffexpr' is empty. Check the documentation
2629 of the "diff" command for what this does
2630 exactly. It should ignore adding trailing
2631 white space, but not leading white space.
2632
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002633 horizontal Start diff mode with horizontal splits (unless
2634 explicitly specified otherwise).
2635
2636 vertical Start diff mode with vertical splits (unless
2637 explicitly specified otherwise).
2638
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002639 hiddenoff Do not use diff mode for a buffer when it
2640 becomes hidden.
2641
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002642 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2643 starting diff mode. Without this 2 is used.
2644
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 Examples: >
2646
2647 :set diffopt=filler,context:4
2648 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002649 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650<
2651 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2652'digraph' 'dg' boolean (default off)
2653 global
2654 {not in Vi}
2655 {not available when compiled without the |+digraphs|
2656 feature}
2657 Enable the entering of digraphs in Insert mode with {char1} <BS>
2658 {char2}. See |digraphs|.
2659 NOTE: This option is reset when 'compatible' is set.
2660
2661 *'directory'* *'dir'*
2662'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002663 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 for Unix: ".,~/tmp,/var/tmp,/tmp")
2665 global
2666 List of directory names for the swap file, separated with commas.
2667 - The swap file will be created in the first directory where this is
2668 possible.
2669 - Empty means that no swap file will be used (recovery is
2670 impossible!).
2671 - A directory "." means to put the swap file in the same directory as
2672 the edited file. On Unix, a dot is prepended to the file name, so
2673 it doesn't show in a directory listing. On MS-Windows the "hidden"
2674 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002675 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 put the swap file relative to where the edited file is. The leading
2677 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002678 - For Unix and Win32, if a directory ends in two path separators "//"
2679 or "\\", the swap file name will be built from the complete path to
2680 the file with all path separators substituted to percent '%' signs.
2681 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002682 On Win32, when a separating comma is following, you must use "//",
2683 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 - Spaces after the comma are ignored, other spaces are considered part
2685 of the directory name. To have a space at the start of a directory
2686 name, precede it with a backslash.
2687 - To include a comma in a directory name precede it with a backslash.
2688 - A directory name may end in an ':' or '/'.
2689 - Environment variables are expanded |:set_env|.
2690 - Careful with '\' characters, type one before a space, type two to
2691 get one in the option (see |option-backslash|), for example: >
2692 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2693< - For backwards compatibility with Vim version 3.0 a '>' at the start
2694 of the option is removed.
2695 Using "." first in the list is recommended. This means that editing
2696 the same file twice will result in a warning. Using "/tmp" on Unix is
2697 discouraged: When the system crashes you lose the swap file.
2698 "/var/tmp" is often not cleared when rebooting, thus is a better
2699 choice than "/tmp". But it can contain a lot of files, your swap
2700 files get lost in the crowd. That is why a "tmp" directory in your
2701 home directory is tried first.
2702 The use of |:set+=| and |:set-=| is preferred when adding or removing
2703 directories from the list. This avoids problems when a future version
2704 uses another default.
2705 This option cannot be set from a |modeline| or in the |sandbox|, for
2706 security reasons.
2707 {Vi: directory to put temp file in, defaults to "/tmp"}
2708
2709 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002710'display' 'dy' string (default "", set to "truncate" in
2711 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 global
2713 {not in Vi}
2714 Change the way text is displayed. This is comma separated list of
2715 flags:
2716 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002717 in a window will be displayed. "@@@" is put in the
2718 last columns of the last screen line to indicate the
2719 rest of the line is not displayed.
2720 truncate Like "lastline", but "@@@" is displayed in the first
2721 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 uhex Show unprintable characters hexadecimal as <xx>
2723 instead of using ^C and ~C.
2724
Bram Moolenaard0796902016-09-16 20:02:31 +02002725 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002726 doesn't fit is replaced with "@" lines.
2727
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 *'eadirection'* *'ead'*
2729'eadirection' 'ead' string (default "both")
2730 global
2731 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002732 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 feature}
2734 Tells when the 'equalalways' option applies:
2735 ver vertically, width of windows is not affected
2736 hor horizontally, height of windows is not affected
2737 both width and height of windows is affected
2738
2739 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2740'edcompatible' 'ed' boolean (default off)
2741 global
2742 Makes the 'g' and 'c' flags of the ":substitute" command to be
2743 toggled each time the flag is given. See |complex-change|. See
2744 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002745 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746
Bram Moolenaar03413f42016-04-12 21:07:15 +02002747 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002748'emoji' 'emo' boolean (default: on)
2749 global
2750 {not in Vi}
2751 {only available when compiled with the |+multi_byte|
2752 feature}
2753 When on all Unicode emoji characters are considered to be full width.
2754
2755
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 *'encoding'* *'enc'* *E543*
2757'encoding' 'enc' string (default: "latin1" or value from $LANG)
2758 global
2759 {only available when compiled with the |+multi_byte|
2760 feature}
2761 {not in Vi}
2762 Sets the character encoding used inside Vim. It applies to text in
2763 the buffers, registers, Strings in expressions, text stored in the
2764 viminfo file, etc. It sets the kind of characters which Vim can work
2765 with. See |encoding-names| for the possible values.
2766
2767 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002768 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002770 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771
Bram Moolenaar865242e2010-07-14 21:12:05 +02002772 This option cannot be set from a |modeline|. It would most likely
2773 corrupt the text.
2774
Bram Moolenaar3df01732017-02-17 22:47:16 +01002775 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2776 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 'encoding', "utf-8" is the natural choice for the environment and
2778 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 versions, and to avoid changing the encoding of newly created files
2781 without your knowledge (in case 'fileencodings' is empty).
2782
2783 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002784 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 iconv() or as specified with 'charconvert'.
2786
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002787 If you need to know whether 'encoding' is a multi-byte encoding, you
2788 can use: >
2789 if has("multi_byte_encoding")
2790<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 Normally 'encoding' will be equal to your current locale. This will
2792 be the default if Vim recognizes your environment settings. If
2793 'encoding' is not set to the current locale, 'termencoding' must be
2794 set to convert typed and displayed text. See |encoding-table|.
2795
2796 When you set this option, it fires the |EncodingChanged| autocommand
2797 event so that you can set up fonts if necessary.
2798
2799 When the option is set, the value is converted to lowercase. Thus
2800 you can set it with uppercase values too. Underscores are translated
2801 to '-' signs.
2802 When the encoding is recognized, it is changed to the standard name.
2803 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2804 "iso-8859-2" and "utf8" becomes "utf-8".
2805
2806 Note: "latin1" is also used when the encoding could not be detected.
2807 This only works when editing files in the same encoding! When the
2808 actual character set is not latin1, make sure 'fileencoding' and
2809 'fileencodings' are empty. When conversion is needed, switch to using
2810 utf-8.
2811
2812 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2813 You don't notice this while editing, but it does matter for the
2814 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2815 setting 'encoding' to one of these values instead of utf-8 only has
2816 effect for encoding used for files when 'fileencoding' is empty.
2817
Bram Moolenaar661b1822005-07-28 22:36:45 +00002818 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2819 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820
2821 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2822'endofline' 'eol' boolean (default on)
2823 local to buffer
2824 {not in Vi}
2825 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002826 is on, or 'fixeol' option is off, no <EOL> will be written for the
2827 last line in the file. This option is automatically set or reset when
2828 starting to edit a new file, depending on whether file has an <EOL>
2829 for the last line in the file. Normally you don't have to set or
2830 reset this option.
2831 When 'binary' is off and 'fixeol' is on the value is not used when
2832 writing the file. When 'binary' is on or 'fixeol' is off it is used
2833 to remember the presence of a <EOL> for the last line in the file, so
2834 that when you write the file the situation from the original file can
2835 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836
2837 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2838'equalalways' 'ea' boolean (default on)
2839 global
2840 {not in Vi}
2841 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002842 splitting or closing a window. This also happens the moment the
2843 option is switched on. When off, splitting a window will reduce the
2844 size of the current window and leave the other windows the same. When
2845 closing a window the extra lines are given to the window next to it
2846 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 When mixing vertically and horizontally split windows, a minimal size
2848 is computed and some windows may be larger if there is room. The
2849 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002850 Changing the height and width of a window can be avoided by setting
2851 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002852 If a window size is specified when creating a new window sizes are
2853 currently not equalized (it's complicated, but may be implemented in
2854 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855
2856 *'equalprg'* *'ep'*
2857'equalprg' 'ep' string (default "")
2858 global or local to buffer |global-local|
2859 {not in Vi}
2860 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002861 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002862 or 'indentexpr'. When Vim was compiled without internal formatting,
2863 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002864 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 about including spaces and backslashes.
2866 This option cannot be set from a |modeline| or in the |sandbox|, for
2867 security reasons.
2868
2869 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2870'errorbells' 'eb' boolean (default off)
2871 global
2872 Ring the bell (beep or screen flash) for error messages. This only
2873 makes a difference for error messages, the bell will be used always
2874 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002875 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002876 screen flash or do nothing. See 'belloff' to finetune when to ring the
2877 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878
2879 *'errorfile'* *'ef'*
2880'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2881 others: "errors.err")
2882 global
2883 {not in Vi}
2884 {not available when compiled without the |+quickfix|
2885 feature}
2886 Name of the errorfile for the QuickFix mode (see |:cf|).
2887 When the "-q" command-line argument is used, 'errorfile' is set to the
2888 following argument. See |-q|.
2889 NOT used for the ":make" command. See 'makeef' for that.
2890 Environment variables are expanded |:set_env|.
2891 See |option-backslash| about including spaces and backslashes.
2892 This option cannot be set from a |modeline| or in the |sandbox|, for
2893 security reasons.
2894
2895 *'errorformat'* *'efm'*
2896'errorformat' 'efm' string (default is very long)
2897 global or local to buffer |global-local|
2898 {not in Vi}
2899 {not available when compiled without the |+quickfix|
2900 feature}
2901 Scanf-like description of the format for the lines in the error file
2902 (see |errorformat|).
2903
2904 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2905'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2906 global
2907 {not in Vi}
2908 Function keys that start with an <Esc> are recognized in Insert
2909 mode. When this option is off, the cursor and function keys cannot be
2910 used in Insert mode if they start with an <Esc>. The advantage of
2911 this is that the single <Esc> is recognized immediately, instead of
2912 after one second. Instead of resetting this option, you might want to
2913 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2914 when 'esckeys' is off, you can still map anything, but the cursor keys
2915 won't work by default.
2916 NOTE: This option is set to the Vi default value when 'compatible' is
2917 set and to the Vim default value when 'compatible' is reset.
2918
2919 *'eventignore'* *'ei'*
2920'eventignore' 'ei' string (default "")
2921 global
2922 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002924 When set to "all" or when "all" is one of the items, all autocommand
2925 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 Otherwise this is a comma separated list of event names. Example: >
2927 :set ei=WinEnter,WinLeave
2928<
2929 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2930'expandtab' 'et' boolean (default off)
2931 local to buffer
2932 {not in Vi}
2933 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002934 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2936 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002937 This option is reset when the 'paste' option is set and restored when
2938 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 NOTE: This option is reset when 'compatible' is set.
2940
2941 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2942'exrc' 'ex' boolean (default off)
2943 global
2944 {not in Vi}
2945 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002946 directory.
2947
2948 Setting this option is a potential security leak. E.g., consider
2949 unpacking a package or fetching files from github, a .vimrc in there
2950 might be a trojan horse. BETTER NOT SET THIS OPTION!
2951 Instead, define an autocommand in your .vimrc to set options for a
2952 matching directory.
2953
2954 If you do switch this option on you should also consider setting the
2955 'secure' option (see |initialization|).
2956 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 This option cannot be set from a |modeline| or in the |sandbox|, for
2958 security reasons.
2959
2960 *'fileencoding'* *'fenc'* *E213*
2961'fileencoding' 'fenc' string (default: "")
2962 local to buffer
2963 {only available when compiled with the |+multi_byte|
2964 feature}
2965 {not in Vi}
2966 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002967
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002969 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 When 'fileencoding' is empty, the same value as 'encoding' will be
2971 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002972 No error will be given when the value is set, only when it is used,
2973 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002974 Conversion will also be done when 'encoding' and 'fileencoding' are
2975 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2976 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002978 'encoding' is "utf-8" or another Unicode encoding, conversion
2979 is most likely done in a way that the reverse conversion
2980 results in the same text. When 'encoding' is not "utf-8" some
2981 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002982
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 See 'encoding' for the possible values. Additionally, values may be
2984 specified that can be handled by the converter, see
2985 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002986
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 When reading a file 'fileencoding' will be set from 'fileencodings'.
2988 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002989 'fileencoding', use the |++enc| argument. One exception: when
2990 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002991 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002992
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2994 When the option is set, the value is converted to lowercase. Thus
2995 you can set it with uppercase values too. '_' characters are
2996 replaced with '-'. If a name is recognized from the list for
2997 'encoding', it is replaced by the standard name. For example
2998 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002999
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 When this option is set, after starting to edit a file, the 'modified'
3001 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003002
3003 Keep in mind that changing 'fenc' from a modeline happens
3004 AFTER the text has been read, thus it applies to when the file will be
3005 written. If you do set 'fenc' in a modeline, you might want to set
3006 'nomodified' to avoid not being able to ":q".
3007
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 This option can not be changed when 'modifiable' is off.
3009
3010 *'fe'*
3011 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003012 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 old short name was 'fe', which is no longer used.
3014
3015 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003016'fileencodings' 'fencs' string (default: "ucs-bom",
3017 "ucs-bom,utf-8,default,latin1" when
3018 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 global
3020 {only available when compiled with the |+multi_byte|
3021 feature}
3022 {not in Vi}
3023 This is a list of character encodings considered when starting to edit
3024 an existing file. When a file is read, Vim tries to use the first
3025 mentioned character encoding. If an error is detected, the next one
3026 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003027 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 an empty string, which means the value of 'encoding' is used.
3029 WARNING: Conversion can cause loss of information! When
3030 'encoding' is "utf-8" (or one of the other Unicode variants)
3031 conversion is most likely done in a way that the reverse
3032 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003033 "utf-8" some non-ASCII characters may be lost! You can use
3034 the |++bad| argument to specify what is done with characters
3035 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 For an empty file or a file with only ASCII characters most encodings
3037 will work and the first entry of 'fileencodings' will be used (except
3038 "ucs-bom", which requires the BOM to be present). If you prefer
3039 another encoding use an BufReadPost autocommand event to test if your
3040 preferred encoding is to be used. Example: >
3041 au BufReadPost * if search('\S', 'w') == 0 |
3042 \ set fenc=iso-2022-jp | endif
3043< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3044 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003045 When the |++enc| argument is used then the value of 'fileencodings' is
3046 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003047 Note that 'fileencodings' is not used for a new file, the global value
3048 of 'fileencoding' is used instead. You can set it with: >
3049 :setglobal fenc=iso-8859-2
3050< This means that a non-existing file may get a different encoding than
3051 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 The special value "ucs-bom" can be used to check for a Unicode BOM
3053 (Byte Order Mark) at the start of the file. It must not be preceded
3054 by "utf-8" or another Unicode encoding for this to work properly.
3055 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3056 because Vim cannot detect an error, thus the encoding is always
3057 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003058 The special value "default" can be used for the encoding from the
3059 environment. This is the default value for 'encoding'. It is useful
3060 when 'encoding' is set to "utf-8" and your environment uses a
3061 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003062 When 'encoding' is "utf-8" and a file contains an illegal byte
3063 sequence it won't be recognized as UTF-8. You can use the |8g8|
3064 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 WRONG VALUES: WHAT'S WRONG:
3066 latin1,utf-8 "latin1" will always be used
3067 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3068 file
3069 cp1250,latin1 "cp1250" will always be used
3070 If 'fileencodings' is empty, 'fileencoding' is not modified.
3071 See 'fileencoding' for the possible values.
3072 Setting this option does not have an effect until the next time a file
3073 is read.
3074
3075 *'fileformat'* *'ff'*
3076'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3077 Unix default: "unix",
3078 Macintosh default: "mac")
3079 local to buffer
3080 {not in Vi}
3081 This gives the <EOL> of the current buffer, which is used for
3082 reading/writing the buffer from/to a file:
3083 dos <CR> <NL>
3084 unix <NL>
3085 mac <CR>
3086 When "dos" is used, CTRL-Z at the end of a file is ignored.
3087 See |file-formats| and |file-read|.
3088 For the character encoding of the file see 'fileencoding'.
3089 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003090 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 This option is set automatically when starting to edit a file and
3092 'fileformats' is not empty and 'binary' is off.
3093 When this option is set, after starting to edit a file, the 'modified'
3094 option is set, because the file would be different when written.
3095 This option can not be changed when 'modifiable' is off.
3096 For backwards compatibility: When this option is set to "dos",
3097 'textmode' is set, otherwise 'textmode' is reset.
3098
3099 *'fileformats'* *'ffs'*
3100'fileformats' 'ffs' string (default:
3101 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3102 Vim Unix: "unix,dos",
3103 Vim Mac: "mac,unix,dos",
3104 Vi Cygwin: "unix,dos",
3105 Vi others: "")
3106 global
3107 {not in Vi}
3108 This gives the end-of-line (<EOL>) formats that will be tried when
3109 starting to edit a new buffer and when reading a file into an existing
3110 buffer:
3111 - When empty, the format defined with 'fileformat' will be used
3112 always. It is not set automatically.
3113 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003114 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 'fileformats' name will be used when a file is read into an existing
3116 buffer, no matter what 'fileformat' for that buffer is set to.
3117 - When more than one name is present, separated by commas, automatic
3118 <EOL> detection will be done when reading a file. When starting to
3119 edit a file, a check is done for the <EOL>:
3120 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3121 'fileformat' is set to "dos".
3122 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003123 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003125 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3126 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003127 This means that "mac" is only chosen when:
3128 "unix" is not present or no <NL> is found in the file, and
3129 "dos" is not present or no <CR><NL> is found in the file.
3130 Except: if "unix" was chosen, but there is a <CR> before
3131 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003132 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 4. If 'fileformat' is still not set, the first name from
3134 'fileformats' is used.
3135 When reading a file into an existing buffer, the same is done, but
3136 this happens like 'fileformat' has been set appropriately for that
3137 file only, the option is not changed.
3138 When 'binary' is set, the value of 'fileformats' is not used.
3139
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003140 When Vim starts up with an empty buffer the first item is used. You
3141 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003142
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3144 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3145 done:
3146 - When 'fileformats' is empty, there is no automatic detection. Dos
3147 format will be used.
3148 - When 'fileformats' is set to one or more names, automatic detection
3149 is done. This is based on the first <NL> in the file: If there is a
3150 <CR> in front of it, Dos format is used, otherwise Unix format is
3151 used.
3152 Also see |file-formats|.
3153 For backwards compatibility: When this option is set to an empty
3154 string or one format (no comma is included), 'textauto' is reset,
3155 otherwise 'textauto' is set.
3156 NOTE: This option is set to the Vi default value when 'compatible' is
3157 set and to the Vim default value when 'compatible' is reset.
3158
Bram Moolenaarbf884932013-04-05 22:26:15 +02003159 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3160'fileignorecase' 'fic' boolean (default on for systems where case in file
3161 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003162 global
3163 {not in Vi}
3164 When set case is ignored when using file names and directories.
3165 See 'wildignorecase' for only ignoring case when doing completion.
3166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 *'filetype'* *'ft'*
3168'filetype' 'ft' string (default: "")
3169 local to buffer
3170 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 When this option is set, the FileType autocommand event is triggered.
3172 All autocommands that match with the value of this option will be
3173 executed. Thus the value of 'filetype' is used in place of the file
3174 name.
3175 Otherwise this option does not always reflect the current file type.
3176 This option is normally set when the file type is detected. To enable
3177 this use the ":filetype on" command. |:filetype|
3178 Setting this option to a different value is most useful in a modeline,
3179 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003180 Example, for in an IDL file:
3181 /* vim: set filetype=idl : */ ~
3182 |FileType| |filetypes|
3183 When a dot appears in the value then this separates two filetype
3184 names. Example:
3185 /* vim: set filetype=c.doxygen : */ ~
3186 This will use the "c" filetype first, then the "doxygen" filetype.
3187 This works both for filetype plugins and for syntax files. More than
3188 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003189 This option is not copied to another buffer, independent of the 's' or
3190 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003191 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192
3193 *'fillchars'* *'fcs'*
3194'fillchars' 'fcs' string (default "vert:|,fold:-")
3195 global
3196 {not in Vi}
3197 {not available when compiled without the |+windows|
3198 and |+folding| features}
3199 Characters to fill the statuslines and vertical separators.
3200 It is a comma separated list of items:
3201
3202 item default Used for ~
3203 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003204 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 vert:c '|' vertical separators |:vsplit|
3206 fold:c '-' filling 'foldtext'
3207 diff:c '-' deleted lines of the 'diff' option
3208
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003209 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003210 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 otherwise.
3212
3213 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003214 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215< This is similar to the default, except that these characters will also
3216 be used when there is highlighting.
3217
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003218 for "stl" and "stlnc" only single-byte values are supported.
3219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 The highlighting used for these items:
3221 item highlight group ~
3222 stl:c StatusLine |hl-StatusLine|
3223 stlnc:c StatusLineNC |hl-StatusLineNC|
3224 vert:c VertSplit |hl-VertSplit|
3225 fold:c Folded |hl-Folded|
3226 diff:c DiffDelete |hl-DiffDelete|
3227
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003228 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3229'fixendofline' 'fixeol' boolean (default on)
3230 local to buffer
3231 {not in Vi}
3232 When writing a file and this option is on, <EOL> at the end of file
3233 will be restored if missing. Turn this option off if you want to
3234 preserve the situation from the original file.
3235 When the 'binary' option is set the value of this option doesn't
3236 matter.
3237 See the 'endofline' option.
3238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3240'fkmap' 'fk' boolean (default off) *E198*
3241 global
3242 {not in Vi}
3243 {only available when compiled with the |+rightleft|
3244 feature}
3245 When on, the keyboard is mapped for the Farsi character set.
3246 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248
3249 *'foldclose'* *'fcl'*
3250'foldclose' 'fcl' string (default "")
3251 global
3252 {not in Vi}
3253 {not available when compiled without the |+folding|
3254 feature}
3255 When set to "all", a fold is closed when the cursor isn't in it and
3256 its level is higher than 'foldlevel'. Useful if you want folds to
3257 automatically close when moving out of them.
3258
3259 *'foldcolumn'* *'fdc'*
3260'foldcolumn' 'fdc' number (default 0)
3261 local to window
3262 {not in Vi}
3263 {not available when compiled without the |+folding|
3264 feature}
3265 When non-zero, a column with the specified width is shown at the side
3266 of the window which indicates open and closed folds. The maximum
3267 value is 12.
3268 See |folding|.
3269
3270 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3271'foldenable' 'fen' boolean (default on)
3272 local to window
3273 {not in Vi}
3274 {not available when compiled without the |+folding|
3275 feature}
3276 When off, all folds are open. This option can be used to quickly
3277 switch between showing all text unfolded and viewing the text with
3278 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003279 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 'foldenable' is off.
3281 This option is set by commands that create a new fold or close a fold.
3282 See |folding|.
3283
3284 *'foldexpr'* *'fde'*
3285'foldexpr' 'fde' string (default: "0")
3286 local to window
3287 {not in Vi}
3288 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003289 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003291 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003292
Bram Moolenaar30b65812012-07-12 22:01:11 +02003293 The expression will be evaluated in the |sandbox| if set from a
3294 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003295 This option can't be set from a |modeline| when the 'diff' option is
3296 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003297
3298 It is not allowed to change text or jump to another window while
3299 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
3301 *'foldignore'* *'fdi'*
3302'foldignore' 'fdi' string (default: "#")
3303 local to window
3304 {not in Vi}
3305 {not available when compiled without the |+folding|
3306 feature}
3307 Used only when 'foldmethod' is "indent". Lines starting with
3308 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 The default "#" works well for C programs. See |fold-indent|.
3311
3312 *'foldlevel'* *'fdl'*
3313'foldlevel' 'fdl' number (default: 0)
3314 local to window
3315 {not in Vi}
3316 {not available when compiled without the |+folding|
3317 feature}
3318 Sets the fold level: Folds with a higher level will be closed.
3319 Setting this option to zero will close all folds. Higher numbers will
3320 close fewer folds.
3321 This option is set by commands like |zm|, |zM| and |zR|.
3322 See |fold-foldlevel|.
3323
3324 *'foldlevelstart'* *'fdls'*
3325'foldlevelstart' 'fdls' number (default: -1)
3326 global
3327 {not in Vi}
3328 {not available when compiled without the |+folding|
3329 feature}
3330 Sets 'foldlevel' when starting to edit another buffer in a window.
3331 Useful to always start editing with all folds closed (value zero),
3332 some folds closed (one) or no folds closed (99).
3333 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003334 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 ignores this option and closes all folds.
3336 It is also done before BufReadPre autocommands, to allow an autocmd to
3337 overrule the 'foldlevel' value for specific files.
3338 When the value is negative, it is not used.
3339
3340 *'foldmarker'* *'fmr'* *E536*
3341'foldmarker' 'fmr' string (default: "{{{,}}}")
3342 local to window
3343 {not in Vi}
3344 {not available when compiled without the |+folding|
3345 feature}
3346 The start and end marker used when 'foldmethod' is "marker". There
3347 must be one comma, which separates the start and end marker. The
3348 marker is a literal string (a regular expression would be too slow).
3349 See |fold-marker|.
3350
3351 *'foldmethod'* *'fdm'*
3352'foldmethod' 'fdm' string (default: "manual")
3353 local to window
3354 {not in Vi}
3355 {not available when compiled without the |+folding|
3356 feature}
3357 The kind of folding used for the current window. Possible values:
3358 |fold-manual| manual Folds are created manually.
3359 |fold-indent| indent Lines with equal indent form a fold.
3360 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3361 |fold-marker| marker Markers are used to specify folds.
3362 |fold-syntax| syntax Syntax highlighting items specify folds.
3363 |fold-diff| diff Fold text that is not changed.
3364
3365 *'foldminlines'* *'fml'*
3366'foldminlines' 'fml' number (default: 1)
3367 local to window
3368 {not in Vi}
3369 {not available when compiled without the |+folding|
3370 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003371 Sets the number of screen lines above which a fold can be displayed
3372 closed. Also for manually closed folds. With the default value of
3373 one a fold can only be closed if it takes up two or more screen lines.
3374 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003375 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 "zc" to close a fold, which is displayed open because it's smaller
3377 than 'foldminlines', a following "zc" may close a containing fold.
3378
3379 *'foldnestmax'* *'fdn'*
3380'foldnestmax' 'fdn' number (default: 20)
3381 local to window
3382 {not in Vi}
3383 {not available when compiled without the |+folding|
3384 feature}
3385 Sets the maximum nesting of folds for the "indent" and "syntax"
3386 methods. This avoids that too many folds will be created. Using more
3387 than 20 doesn't work, because the internal limit is 20.
3388
3389 *'foldopen'* *'fdo'*
3390'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3391 search,tag,undo")
3392 global
3393 {not in Vi}
3394 {not available when compiled without the |+folding|
3395 feature}
3396 Specifies for which type of commands folds will be opened, if the
3397 command moves the cursor into a closed fold. It is a comma separated
3398 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003399 NOTE: When the command is part of a mapping this option is not used.
3400 Add the |zv| command to the mapping to get the same effect.
3401 (rationale: the mapping may want to control opening folds itself)
3402
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 item commands ~
3404 all any
3405 block "(", "{", "[[", "[{", etc.
3406 hor horizontal movements: "l", "w", "fx", etc.
3407 insert any command in Insert mode
3408 jump far jumps: "G", "gg", etc.
3409 mark jumping to a mark: "'m", CTRL-O, etc.
3410 percent "%"
3411 quickfix ":cn", ":crew", ":make", etc.
3412 search search for a pattern: "/", "n", "*", "gd", etc.
3413 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003414 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 tag jumping to a tag: ":ta", CTRL-T, etc.
3416 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 When a movement command is used for an operator (e.g., "dl" or "y%")
3418 this option is not used. This means the operator will include the
3419 whole closed fold.
3420 Note that vertical movements are not here, because it would make it
3421 very difficult to move onto a closed fold.
3422 In insert mode the folds containing the cursor will always be open
3423 when text is inserted.
3424 To close folds you can re-apply 'foldlevel' with the |zx| command or
3425 set the 'foldclose' option to "all".
3426
3427 *'foldtext'* *'fdt'*
3428'foldtext' 'fdt' string (default: "foldtext()")
3429 local to window
3430 {not in Vi}
3431 {not available when compiled without the |+folding|
3432 feature}
3433 An expression which is used to specify the text displayed for a closed
3434 fold. See |fold-foldtext|.
3435
Bram Moolenaar30b65812012-07-12 22:01:11 +02003436 The expression will be evaluated in the |sandbox| if set from a
3437 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003438
3439 It is not allowed to change text or jump to another window while
3440 evaluating 'foldtext' |textlock|.
3441
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003442 *'formatexpr'* *'fex'*
3443'formatexpr' 'fex' string (default "")
3444 local to buffer
3445 {not in Vi}
3446 {not available when compiled without the |+eval|
3447 feature}
3448 Expression which is evaluated to format a range of lines for the |gq|
3449 operator or automatic formatting (see 'formatoptions'). When this
3450 option is empty 'formatprg' is used.
3451
3452 The |v:lnum| variable holds the first line to be formatted.
3453 The |v:count| variable holds the number of lines to be formatted.
3454 The |v:char| variable holds the character that is going to be
3455 inserted if the expression is being evaluated due to
3456 automatic formatting. This can be empty. Don't insert
3457 it yet!
3458
3459 Example: >
3460 :set formatexpr=mylang#Format()
3461< This will invoke the mylang#Format() function in the
3462 autoload/mylang.vim file in 'runtimepath'. |autoload|
3463
3464 The expression is also evaluated when 'textwidth' is set and adding
3465 text beyond that limit. This happens under the same conditions as
3466 when internal formatting is used. Make sure the cursor is kept in the
3467 same spot relative to the text then! The |mode()| function will
3468 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003469
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003470 When the expression evaluates to non-zero Vim will fall back to using
3471 the internal format mechanism.
3472
3473 The expression will be evaluated in the |sandbox| when set from a
3474 modeline, see |sandbox-option|. That stops the option from working,
3475 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003476 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003477
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 *'formatoptions'* *'fo'*
3479'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3480 local to buffer
3481 {not in Vi}
3482 This is a sequence of letters which describes how automatic
3483 formatting is to be done. See |fo-table|. When the 'paste' option is
3484 on, no formatting is done (like 'formatoptions' is empty). Commas can
3485 be inserted for readability.
3486 To avoid problems with flags that are added in the future, use the
3487 "+=" and "-=" feature of ":set" |add-option-flags|.
3488 NOTE: This option is set to the Vi default value when 'compatible' is
3489 set and to the Vim default value when 'compatible' is reset.
3490
Bram Moolenaar86b68352004-12-27 21:59:20 +00003491 *'formatlistpat'* *'flp'*
3492'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3493 local to buffer
3494 {not in Vi}
3495 A pattern that is used to recognize a list header. This is used for
3496 the "n" flag in 'formatoptions'.
3497 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003498 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003499 while still checking more characters. There must be a character
3500 following the pattern, when it matches the whole line it is handled
3501 like there is no match.
3502 The default recognizes a number, followed by an optional punctuation
3503 character and white space.
3504
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 *'formatprg'* *'fp'*
3506'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003507 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 {not in Vi}
3509 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003510 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003512 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003513 If the 'formatexpr' option is not empty it will be used instead.
3514 Otherwise, if 'formatprg' option is an empty string, the internal
3515 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003516 Environment variables are expanded |:set_env|. See |option-backslash|
3517 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003518 This option cannot be set from a |modeline| or in the |sandbox|, for
3519 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520
Bram Moolenaard94464e2015-11-02 15:28:18 +01003521 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003522'fsync' 'fs' boolean (default on)
3523 global
3524 {not in Vi}
3525 When on, the library function fsync() will be called after writing a
3526 file. This will flush a file to disk, ensuring that it is safely
3527 written even on filesystems which do metadata-only journaling. This
3528 will force the harddrive to spin up on Linux systems running in laptop
3529 mode, so it may be undesirable in some situations. Be warned that
3530 turning this off increases the chances of data loss after a crash. On
3531 systems without an fsync() implementation, this variable is always
3532 off.
3533 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003534 'fsync' also applies to |writefile()|, unless a flag is used to
3535 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003536
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3538'gdefault' 'gd' boolean (default off)
3539 global
3540 {not in Vi}
3541 When on, the ":substitute" flag 'g' is default on. This means that
3542 all matches in a line are substituted instead of one. When a 'g' flag
3543 is given to a ":substitute" command, this will toggle the substitution
3544 of all or one match. See |complex-change|.
3545
3546 command 'gdefault' on 'gdefault' off ~
3547 :s/// subst. all subst. one
3548 :s///g subst. one subst. all
3549 :s///gg subst. all subst. one
3550
3551 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003552 DEPRECATED: Setting this option may break plugins that are not aware
3553 of this option. Also, many users get confused that adding the /g flag
3554 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555
3556 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003557'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 global
3559 {not in Vi}
3560 Format to recognize for the ":grep" command output.
3561 This is a scanf-like string that uses the same format as the
3562 'errorformat' option: see |errorformat|.
3563
3564 *'grepprg'* *'gp'*
3565'grepprg' 'gp' string (default "grep -n ",
3566 Unix: "grep -n $* /dev/null",
3567 Win32: "findstr /n" or "grep -n",
3568 VMS: "SEARCH/NUMBERS ")
3569 global or local to buffer |global-local|
3570 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003571 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572 and '#' characters, which are expanded like when used in a command-
3573 line. The placeholder "$*" is allowed to specify where the arguments
3574 will be included. Environment variables are expanded |:set_env|. See
3575 |option-backslash| about including spaces and backslashes.
3576 When your "grep" accepts the "-H" argument, use this to make ":grep"
3577 also work well with a single file: >
3578 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003579< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003580 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3581 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003582 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 apply equally to 'grepprg'.
3584 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3585 otherwise it's "grep -n".
3586 This option cannot be set from a |modeline| or in the |sandbox|, for
3587 security reasons.
3588
3589 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3590'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3591 ve:ver35-Cursor,
3592 o:hor50-Cursor,
3593 i-ci:ver25-Cursor/lCursor,
3594 r-cr:hor20-Cursor/lCursor,
3595 sm:block-Cursor
3596 -blinkwait175-blinkoff150-blinkon175",
3597 for MS-DOS and Win32 console:
3598 "n-v-c:block,o:hor50,i-ci:hor15,
3599 r-cr:hor30,sm:block")
3600 global
3601 {not in Vi}
3602 {only available when compiled with GUI enabled, and
3603 for MS-DOS and Win32 console}
3604 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003605 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 the height of the cursor can be changed. This can be done by
3607 specifying a block cursor, or a percentage for a vertical or
3608 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003609 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3610 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003612 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 mode-list and an argument-list:
3614 mode-list:argument-list,mode-list:argument-list,..
3615 The mode-list is a dash separated list of these modes:
3616 n Normal mode
3617 v Visual mode
3618 ve Visual mode with 'selection' "exclusive" (same as 'v',
3619 if not specified)
3620 o Operator-pending mode
3621 i Insert mode
3622 r Replace mode
3623 c Command-line Normal (append) mode
3624 ci Command-line Insert mode
3625 cr Command-line Replace mode
3626 sm showmatch in Insert mode
3627 a all modes
3628 The argument-list is a dash separated list of these arguments:
3629 hor{N} horizontal bar, {N} percent of the character height
3630 ver{N} vertical bar, {N} percent of the character width
3631 block block cursor, fills the whole character
3632 [only one of the above three should be present]
3633 blinkwait{N} *cursor-blinking*
3634 blinkon{N}
3635 blinkoff{N}
3636 blink times for cursor: blinkwait is the delay before
3637 the cursor starts blinking, blinkon is the time that
3638 the cursor is shown and blinkoff is the time that the
3639 cursor is not shown. The times are in msec. When one
3640 of the numbers is zero, there is no blinking. The
3641 default is: "blinkwait700-blinkon400-blinkoff250".
3642 These numbers are used for a missing entry. This
3643 means that blinking is enabled by default. To switch
3644 blinking off you can use "blinkon0". The cursor only
3645 blinks when Vim is waiting for input, not while
3646 executing a command.
3647 To make the cursor blink in an xterm, see
3648 |xterm-blink|.
3649 {group-name}
3650 a highlight group name, that sets the color and font
3651 for the cursor
3652 {group-name}/{group-name}
3653 Two highlight group names, the first is used when
3654 no language mappings are used, the other when they
3655 are. |language-mapping|
3656
3657 Examples of parts:
3658 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3659 block cursor with colors from the "nCursor"
3660 highlight group
3661 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3662 In Insert and Command-line Insert mode, use a
3663 30% vertical bar cursor with colors from the
3664 "iCursor" highlight group. Blink a bit
3665 faster.
3666
3667 The 'a' mode is different. It will set the given argument-list for
3668 all modes. It does not reset anything to defaults. This can be used
3669 to do a common setting for all modes. For example, to switch off
3670 blinking: "a:blinkon0"
3671
3672 Examples of cursor highlighting: >
3673 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3674 :highlight Cursor gui=NONE guifg=bg guibg=fg
3675<
3676 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003677 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678'guifont' 'gfn' string (default "")
3679 global
3680 {not in Vi}
3681 {only available when compiled with GUI enabled}
3682 This is a list of fonts which will be used for the GUI version of Vim.
3683 In its simplest form the value is just one font name. When
3684 the font cannot be found you will get an error message. To try other
3685 font names a list can be specified, font names separated with commas.
3686 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003687
Bram Moolenaar05159a02005-02-26 23:04:13 +00003688 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3689 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003690
Bram Moolenaar3df01732017-02-17 22:47:16 +01003691 Note: As to the GTK GUIs, no error is given against any invalid names,
3692 and the first element of the list is always picked up and made use of.
3693 This is because, instead of identifying a given name with a font, the
3694 GTK GUIs use it to construct a pattern and try to look up a font which
3695 best matches the pattern among available fonts, and this way, the
3696 matching never fails. An invalid name doesn't matter because a number
3697 of font properties other than name will do to get the matching done.
3698
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 Spaces after a comma are ignored. To include a comma in a font name
3700 precede it with a backslash. Setting an option requires an extra
3701 backslash before a space and a backslash. See also
3702 |option-backslash|. For example: >
3703 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003704< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003706
3707 If none of the fonts can be loaded, Vim will keep the current setting.
3708 If an empty font list is given, Vim will try using other resource
3709 settings (for X, it will use the Vim.font resource), and finally it
3710 will try some builtin default which should always be there ("7x13" in
3711 the case of X). The font names given should be "normal" fonts. Vim
3712 will try to find the related bold and italic fonts.
3713
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003714 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003715 :set guifont=*
3716< will bring up a font requester, where you can pick the font you want.
3717
3718 The font name depends on the GUI used. See |setting-guifont| for a
3719 way to set 'guifont' for various systems.
3720
Bram Moolenaar3df01732017-02-17 22:47:16 +01003721 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003723< That's all. XLFDs are not used. For Chinese this is reported to work
3724 well: >
3725 if has("gui_gtk2")
3726 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3727 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3728 endif
3729<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003730 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3731
Bram Moolenaar05159a02005-02-26 23:04:13 +00003732 For Mac OSX you can use something like this: >
3733 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003734< Also see 'macatsui', it can help fix display problems.
3735 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003737 width). An exception is GTK: all fonts are accepted, but mono-spaced
3738 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003739
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 To preview a font on X11, you might be able to use the "xfontsel"
3741 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003742
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 For the Win32 GUI *E244* *E245*
3744 - takes these options in the font name:
3745 hXX - height is XX (points, can be floating-point)
3746 wXX - width is XX (points, can be floating-point)
3747 b - bold
3748 i - italic
3749 u - underline
3750 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003751 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3753 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3754 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003755 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003756 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003757 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003758 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003759 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760
3761 Use a ':' to separate the options.
3762 - A '_' can be used in the place of a space, so you don't need to use
3763 backslashes to escape the spaces.
3764 - Examples: >
3765 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3766 :set guifont=Andale_Mono:h7.5:w4.5
3767< See also |font-sizes|.
3768
3769 *'guifontset'* *'gfs'*
3770 *E250* *E252* *E234* *E597* *E598*
3771'guifontset' 'gfs' string (default "")
3772 global
3773 {not in Vi}
3774 {only available when compiled with GUI enabled and
3775 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003776 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 When not empty, specifies two (or more) fonts to be used. The first
3778 one for normal English, the second one for your special language. See
3779 |xfontset|.
3780 Setting this option also means that all font names will be handled as
3781 a fontset name. Also the ones used for the "font" argument of the
3782 |:highlight| command.
3783 The fonts must match with the current locale. If fonts for the
3784 character sets that the current locale uses are not included, setting
3785 'guifontset' will fail.
3786 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3787 the comma-separated names are alternative names, one of which will be
3788 used. In 'guifontset' the whole string is one fontset name,
3789 including the commas. It is not possible to specify alternative
3790 fontset names.
3791 This example works on many X11 systems: >
3792 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3793<
3794 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3795'guifontwide' 'gfw' string (default "")
3796 global
3797 {not in Vi}
3798 {only available when compiled with GUI enabled}
3799 When not empty, specifies a comma-separated list of fonts to be used
3800 for double-width characters. The first font that can be loaded is
3801 used.
3802 Note: The size of these fonts must be exactly twice as wide as the one
3803 specified with 'guifont' and the same height.
3804
Bram Moolenaar3df01732017-02-17 22:47:16 +01003805 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806
3807 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3808 'guifontset' is empty or invalid.
3809 When 'guifont' is set and a valid font is found in it and
3810 'guifontwide' is empty Vim will attempt to find a matching
3811 double-width font and set 'guifontwide' to it.
3812
Bram Moolenaar3df01732017-02-17 22:47:16 +01003813 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814
3815 If set and valid, 'guifontwide' is always used for double width
3816 characters, even if 'encoding' is not set to "utf-8".
3817 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003818 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 font for characters not available in 'guifont'. Thus you do not need
3820 to set 'guifontwide' at all unless you want to override the choice
3821 made by Pango/Xft.
3822
Bram Moolenaar0f272122013-01-23 18:37:40 +01003823 Windows +multibyte only: *guifontwide_win_mbyte*
3824
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003825 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003826
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 *'guiheadroom'* *'ghr'*
3828'guiheadroom' 'ghr' number (default 50)
3829 global
3830 {not in Vi} {only for GTK and X11 GUI}
3831 The number of pixels subtracted from the screen height when fitting
3832 the GUI window on the screen. Set this before the GUI is started,
3833 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 lines will be left for window decorations and other items on the
3836 screen. Set it to a negative value to allow windows taller than the
3837 screen.
3838
3839 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003840'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3841 removed in |defaults.vim|),
3842 "aegimrLtT" (GTK, Motif and Athena),
3843 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 global
3845 {not in Vi}
3846 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003847 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 sequence of letters which describes what components and options of the
3849 GUI should be used.
3850 To avoid problems with flags that are added in the future, use the
3851 "+=" and "-=" feature of ":set" |add-option-flags|.
3852
Bram Moolenaar13568252018-03-16 20:46:58 +01003853 Valid characters are as follows:
3854 *'go-!'*
3855 '!' External commands are executed in a terminal window. Without
3856 this flag the MS-Windows GUI will open a console window to
3857 execute the command. The Unix GUI will simulate a dumb
3858 terminal to list the command output.
3859 The terminal window will be positioned at the bottom, and grow
3860 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003861 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 'a' Autoselect: If present, then whenever VISUAL mode is started,
3863 or the Visual area extended, Vim tries to become the owner of
3864 the windowing system's global selection. This means that the
3865 Visually highlighted text is available for pasting into other
3866 applications as well as into Vim itself. When the Visual mode
3867 ends, possibly due to an operation on the text, or when an
3868 application wants to paste the selection, the highlighted text
3869 is automatically yanked into the "* selection register.
3870 Thus the selection is still available for pasting into other
3871 applications after the VISUAL mode has ended.
3872 If not present, then Vim won't become the owner of the
3873 windowing system's global selection unless explicitly told to
3874 by a yank or delete operation for the "* register.
3875 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003876 *'go-P'*
3877 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003878 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003879 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003880 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 applies to the modeless selection.
3882
3883 'guioptions' autoselect Visual autoselect modeless ~
3884 "" - -
3885 "a" yes yes
3886 "A" - yes
3887 "aA" yes yes
3888
Bram Moolenaar02467872007-05-06 13:22:01 +00003889 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'c' Use console dialogs instead of popup dialogs for simple
3891 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003892 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003893 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003894 'guitablabel' can be used to change the text in the labels.
3895 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003896 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003897 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'f' Foreground: Don't use fork() to detach the GUI from the shell
3900 where it was started. Use this for programs that wait for the
3901 editor to finish (e.g., an e-mail program). Alternatively you
3902 can use "gvim -f" or ":gui -f" to start the GUI in the
3903 foreground. |gui-fork|
3904 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003905 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003906 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3908 corner of the window. It's black&white on non-GTK, because of
3909 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003910 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003912 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003913 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003915 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003917 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003918 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 'g' Grey menu items: Make menu items that are not active grey. If
3920 'g' is not included inactive menu items are not shown at all.
3921 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003922 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 't' Include tearoff menu items. Currently only works for Win32,
3924 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003925 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003926 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003927 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003928 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'R' Right-hand scrollbar is present when there is a vertically
3932 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003933 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003935 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'L' Left-hand scrollbar is present when there is a vertically
3937 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003938 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3940 the longest visible line, or on the cursor line if the 'h'
3941 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003942 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 'h' Limit horizontal scrollbar size to the length of the cursor
3944 line. Reduces computations. |gui-horiz-scroll|
3945
3946 And yes, you may even have scrollbars on the left AND the right if
3947 you really want to :-). See |gui-scrollbars| for more information.
3948
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003949 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 'v' Use a vertical button layout for dialogs. When not included,
3951 a horizontal layout is preferred, but when it doesn't fit a
3952 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003953 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 'p' Use Pointer callbacks for X11 GUI. This is required for some
3955 window managers. If the cursor is not blinking or hollow at
3956 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003957 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003959 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003960 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003961 *'go-k'*
3962 'k' Keep the GUI window size when adding/removing a scrollbar, or
3963 toolbar, tabline, etc. Instead, the behavior is similar to
3964 when the window is maximized and will adjust 'lines' and
3965 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003966 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003967 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003968
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 *'guipty'* *'noguipty'*
3970'guipty' boolean (default on)
3971 global
3972 {not in Vi}
3973 {only available when compiled with GUI enabled}
3974 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3975 I/O to/from shell commands. See |gui-pty|.
3976
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003977 *'guitablabel'* *'gtl'*
3978'guitablabel' 'gtl' string (default empty)
3979 global
3980 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003981 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003982 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003983 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003984 pages line. When empty and when the result is empty Vim will use a
3985 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003986
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003987 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003988 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003989 The expression will be evaluated in the |sandbox| when set from a
3990 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003991
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003992 Only used when the GUI tab pages line is displayed. 'e' must be
3993 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3994 used.
3995
Bram Moolenaar57657d82006-04-21 22:12:41 +00003996 *'guitabtooltip'* *'gtt'*
3997'guitabtooltip' 'gtt' string (default empty)
3998 global
3999 {not in Vi}
4000 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004001 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004002 When nonempty describes the text to use in a tooltip for the GUI tab
4003 pages line. When empty Vim will use a default tooltip.
4004 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004005 You can include a line break. Simplest method is to use |:let|: >
4006 :let &guitabtooltip = "line one\nline two"
4007<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004008
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009 *'helpfile'* *'hf'*
4010'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4011 (others) "$VIMRUNTIME/doc/help.txt")
4012 global
4013 {not in Vi}
4014 Name of the main help file. All distributed help files should be
4015 placed together in one directory. Additionally, all "doc" directories
4016 in 'runtimepath' will be used.
4017 Environment variables are expanded |:set_env|. For example:
4018 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004019 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 spaces and backslashes.
4021 This option cannot be set from a |modeline| or in the |sandbox|, for
4022 security reasons.
4023
4024 *'helpheight'* *'hh'*
4025'helpheight' 'hh' number (default 20)
4026 global
4027 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004028 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 feature}
4030 Minimal initial height of the help window when it is opened with the
4031 ":help" command. The initial height of the help window is half of the
4032 current window, or (when the 'ea' option is on) the same as other
4033 windows. When the height is less than 'helpheight', the height is
4034 set to 'helpheight'. Set to zero to disable.
4035
4036 *'helplang'* *'hlg'*
4037'helplang' 'hlg' string (default: messages language or empty)
4038 global
4039 {only available when compiled with the |+multi_lang|
4040 feature}
4041 {not in Vi}
4042 Comma separated list of languages. Vim will use the first language
4043 for which the desired help can be found. The English help will always
4044 be used as a last resort. You can add "en" to prefer English over
4045 another language, but that will only find tags that exist in that
4046 language and not in the English help.
4047 Example: >
4048 :set helplang=de,it
4049< This will first search German, then Italian and finally English help
4050 files.
4051 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4052 try to find the tag in the current language before using this option.
4053 See |help-translated|.
4054
4055 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4056'hidden' 'hid' boolean (default off)
4057 global
4058 {not in Vi}
4059 When off a buffer is unloaded when it is |abandon|ed. When on a
4060 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4061 displayed in another window, it does not become hidden, of course.
4062 The commands that move through the buffer list sometimes make a buffer
4063 hidden although the 'hidden' option is off: When the buffer is
4064 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004066 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 This option is set for one command with ":hide {command}" |:hide|.
4068 WARNING: It's easy to forget that you have changes in hidden buffers.
4069 Think twice when using ":q!" or ":qa!".
4070
4071 *'highlight'* *'hl'*
4072'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004073 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4074 d:Directory,e:ErrorMsg,i:IncSearch,
4075 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4076 N:CursorLineNr,r:Question,s:StatusLine,
4077 S:StatusLineNC,c:VertSplit,t:Title,
4078 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4079 F:FoldColumn,A:DiffAdd,C:DiffChange,
4080 D:DiffDelete,T:DiffText,>:SignColumn,
4081 B:SpellBad,P:SpellCap,R:SpellRare,
4082 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004083 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4084 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004085 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004086 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 global
4088 {not in Vi}
4089 This option can be used to set highlighting mode for various
4090 occasions. It is a comma separated list of character pairs. The
4091 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004092 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004094 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4095 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 characters from 'showbreak'
4097 |hl-Directory| d directories in CTRL-D listing and other special
4098 things in listings
4099 |hl-ErrorMsg| e error messages
4100 h (obsolete, ignored)
4101 |hl-IncSearch| i 'incsearch' highlighting
4102 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4103 |hl-MoreMsg| m |more-prompt|
4104 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004105 |hl-LineNr| n line number for ":number" and ":#" commands, and
4106 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004107 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4108 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 |hl-Question| r |hit-enter| prompt and yes/no questions
4110 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004111 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4113 |hl-VertSplit| c column used to separate vertically split windows
4114 |hl-Visual| v Visual mode
4115 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4116 Selection" Only X11 Gui's |gui-x11| and
4117 |xterm-clipboard|.
4118 |hl-WarningMsg| w warning messages
4119 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4120 |hl-Folded| f line used for closed folds
4121 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004122 |hl-DiffAdd| A added line in diff mode
4123 |hl-DiffChange| C changed line in diff mode
4124 |hl-DiffDelete| D deleted line in diff mode
4125 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004127 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004128 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004129 |hl-SpellRare| R rare word |spell|
4130 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004131 |hl-Conceal| - the placeholders used for concealed characters
4132 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004133 |hl-Pmenu| + popup menu normal line
4134 |hl-PmenuSel| = popup menu normal line
4135 |hl-PmenuSbar| x popup menu scrollbar
4136 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
4138 The display modes are:
4139 r reverse (termcap entry "mr" and "me")
4140 i italic (termcap entry "ZH" and "ZR")
4141 b bold (termcap entry "md" and "me")
4142 s standout (termcap entry "so" and "se")
4143 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004144 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004145 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 n no highlighting
4147 - no highlighting
4148 : use a highlight group
4149 The default is used for occasions that are not included.
4150 If you want to change what the display modes do, see |dos-colors|
4151 for an example.
4152 When using the ':' display mode, this must be followed by the name of
4153 a highlight group. A highlight group can be used to define any type
4154 of highlighting, including using color. See |:highlight| on how to
4155 define one. The default uses a different group for each occasion.
4156 See |highlight-default| for the default highlight groups.
4157
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004159'history' 'hi' number (Vim default: 50, Vi default: 0,
4160 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 global
4162 {not in Vi}
4163 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004164 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004166 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 NOTE: This option is set to the Vi default value when 'compatible' is
4168 set and to the Vim default value when 'compatible' is reset.
4169
4170 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4171'hkmap' 'hk' boolean (default off)
4172 global
4173 {not in Vi}
4174 {only available when compiled with the |+rightleft|
4175 feature}
4176 When on, the keyboard is mapped for the Hebrew character set.
4177 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4178 toggle this option. See |rileft.txt|.
4179 NOTE: This option is reset when 'compatible' is set.
4180
4181 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4182'hkmapp' 'hkp' boolean (default off)
4183 global
4184 {not in Vi}
4185 {only available when compiled with the |+rightleft|
4186 feature}
4187 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4188 This is useful if you have a non-Hebrew keyboard.
4189 See |rileft.txt|.
4190 NOTE: This option is reset when 'compatible' is set.
4191
Bram Moolenaar036986f2017-03-16 17:41:02 +01004192 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4193'hlsearch' 'hls' boolean (default off)
4194 global
4195 {not in Vi}
4196 {not available when compiled without the
4197 |+extra_search| feature}
4198 When there is a previous search pattern, highlight all its matches.
4199 The type of highlighting used can be set with the 'l' occasion in the
4200 'highlight' option. This uses the "Search" highlight group by
4201 default. Note that only the matching text is highlighted, any offsets
4202 are not applied.
4203 See also: 'incsearch' and |:match|.
4204 When you get bored looking at the highlighted matches, you can turn it
4205 off with |:nohlsearch|. This does not change the option value, as
4206 soon as you use a search command, the highlighting comes back.
4207 'redrawtime' specifies the maximum time spent on finding matches.
4208 When the search pattern can match an end-of-line, Vim will try to
4209 highlight all of the matched text. However, this depends on where the
4210 search starts. This will be the first line in the window or the first
4211 line below a closed fold. A match in a previous line which is not
4212 drawn may not continue in a newly drawn line.
4213 You can specify whether the highlight status is restored on startup
4214 with the 'h' flag in 'viminfo' |viminfo-h|.
4215 NOTE: This option is reset when 'compatible' is set.
4216
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 *'icon'* *'noicon'*
4218'icon' boolean (default off, on when title can be restored)
4219 global
4220 {not in Vi}
4221 {not available when compiled without the |+title|
4222 feature}
4223 When on, the icon text of the window will be set to the value of
4224 'iconstring' (if it is not empty), or to the name of the file
4225 currently being edited. Only the last part of the name is used.
4226 Overridden by the 'iconstring' option.
4227 Only works if the terminal supports setting window icons (currently
4228 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4229 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4230 builtin termcap).
4231 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004232 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004234 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
4236 *'iconstring'*
4237'iconstring' string (default "")
4238 global
4239 {not in Vi}
4240 {not available when compiled without the |+title|
4241 feature}
4242 When this option is not empty, it will be used for the icon text of
4243 the window. This happens only when the 'icon' option is on.
4244 Only works if the terminal supports setting window icon text
4245 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4246 Does not work for MS Windows.
4247 When Vim was compiled with HAVE_X11 defined, the original icon will be
4248 restored if possible |X11|.
4249 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004250 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251 'titlestring' for example settings.
4252 {not available when compiled without the |+statusline| feature}
4253
4254 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4255'ignorecase' 'ic' boolean (default off)
4256 global
4257 Ignore case in search patterns. Also used when searching in the tags
4258 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004259 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004260 Can be overruled by using "\c" or "\C" in the pattern, see
4261 |/ignorecase|.
4262
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004263 *'imactivatefunc'* *'imaf'*
4264'imactivatefunc' 'imaf' string (default "")
4265 global
4266 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004267 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004268 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004269 activate or deactivate the Input Method.
4270 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004271
4272 Example: >
4273 function ImActivateFunc(active)
4274 if a:active
4275 ... do something
4276 else
4277 ... do something
4278 endif
4279 " return value is not used
4280 endfunction
4281 set imactivatefunc=ImActivateFunc
4282<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 *'imactivatekey'* *'imak'*
4284'imactivatekey' 'imak' string (default "")
4285 global
4286 {not in Vi}
4287 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004288 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 Specifies the key that your Input Method in X-Windows uses for
4290 activation. When this is specified correctly, vim can fully control
4291 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4292 You can't use this option to change the activation key, the option
4293 tells Vim what the key is.
4294 Format:
4295 [MODIFIER_FLAG-]KEY_STRING
4296
4297 These characters can be used for MODIFIER_FLAG (case is ignored):
4298 S Shift key
4299 L Lock key
4300 C Control key
4301 1 Mod1 key
4302 2 Mod2 key
4303 3 Mod3 key
4304 4 Mod4 key
4305 5 Mod5 key
4306 Combinations are allowed, for example "S-C-space" or "SC-space" are
4307 both shift+ctrl+space.
4308 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4309
4310 Example: >
4311 :set imactivatekey=S-space
4312< "S-space" means shift+space. This is the activation key for kinput2 +
4313 canna (Japanese), and ami (Korean).
4314
4315 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4316'imcmdline' 'imc' boolean (default off)
4317 global
4318 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004319 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 When set the Input Method is always on when starting to edit a command
4321 line, unless entering a search pattern (see 'imsearch' for that).
4322 Setting this option is useful when your input method allows entering
4323 English characters directly, e.g., when it's used to type accented
4324 characters with dead keys.
4325
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004326 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4328 global
4329 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004330 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 When set the Input Method is never used. This is useful to disable
4332 the IM when it doesn't work properly.
4333 Currently this option is on by default for SGI/IRIX machines. This
4334 may change in later releases.
4335
4336 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004337'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 local to buffer
4339 {not in Vi}
4340 Specifies whether :lmap or an Input Method (IM) is to be used in
4341 Insert mode. Valid values:
4342 0 :lmap is off and IM is off
4343 1 :lmap is ON and IM is off
4344 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 To always reset the option to zero when leaving Insert mode with <Esc>
4346 this can be used: >
4347 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4348< This makes :lmap and IM turn off automatically when leaving Insert
4349 mode.
4350 Note that this option changes when using CTRL-^ in Insert mode
4351 |i_CTRL-^|.
4352 The value is set to 1 when setting 'keymap' to a valid keymap name.
4353 It is also used for the argument of commands like "r" and "f".
4354 The value 0 may not work correctly with Athena and Motif with some XIM
4355 methods. Use 'imdisable' to disable XIM then.
4356
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004357 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4358 via external command if vim is not compiled with the |+xim|,
4359 |+multi_byte_ime| or |global-ime|.
4360
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004362'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 local to buffer
4364 {not in Vi}
4365 Specifies whether :lmap or an Input Method (IM) is to be used when
4366 entering a search pattern. Valid values:
4367 -1 the value of 'iminsert' is used, makes it look like
4368 'iminsert' is also used when typing a search pattern
4369 0 :lmap is off and IM is off
4370 1 :lmap is ON and IM is off
4371 2 :lmap is off and IM is ON
4372 Note that this option changes when using CTRL-^ in Command-line mode
4373 |c_CTRL-^|.
4374 The value is set to 1 when it is not -1 and setting the 'keymap'
4375 option to a valid keymap name.
4376 The value 0 may not work correctly with Athena and Motif with some XIM
4377 methods. Use 'imdisable' to disable XIM then.
4378
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004379 *'imstatusfunc'* *'imsf'*
4380'imstatusfunc' 'imsf' string (default "")
4381 global
4382 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004383 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004384 This option specifies a function that is called to obtain the status
4385 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004386 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004387
4388 Example: >
4389 function ImStatusFunc()
4390 let is_active = ...do something
4391 return is_active ? 1 : 0
4392 endfunction
4393 set imstatusfunc=ImStatusFunc
4394<
4395 NOTE: This function is invoked very often. Keep it fast.
4396
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004397 *'imstyle'* *'imst'*
4398'imstyle' 'imst' number (default 1)
4399 global
4400 {not in Vi}
4401 {only available when compiled with |+xim| and
4402 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004403 This option specifies the input style of Input Method:
4404 0 use on-the-spot style
4405 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004406 See: |xim-input-style|
4407
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004408 For a long time on-the-spot style had been used in the GTK version of
4409 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004410 |single-repeat|, etc. Therefore over-the-spot style becomes the
4411 default now. This should work fine for most people, however if you
4412 have any problem with it, try using on-the-spot style.
4413
Bram Moolenaar071d4272004-06-13 20:20:40 +00004414 *'include'* *'inc'*
4415'include' 'inc' string (default "^\s*#\s*include")
4416 global or local to buffer |global-local|
4417 {not in Vi}
4418 {not available when compiled without the
4419 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004420 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 pattern, just like for the "/" command (See |pattern|). The default
4422 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004423 "]I", "[d", etc.
4424 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004425 comes after the matched pattern. But if "\zs" appears in the pattern
4426 then the text matched from "\zs" to the end, or until "\ze" if it
4427 appears, is used as the file name. Use this to include characters
4428 that are not in 'isfname', such as a space. You can then use
4429 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004430 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431
4432 *'includeexpr'* *'inex'*
4433'includeexpr' 'inex' string (default "")
4434 local to buffer
4435 {not in Vi}
4436 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004437 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 :set includeexpr=substitute(v:fname,'\\.','/','g')
4441< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004442
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004444 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 Also used for |<cfile>|.
4446
Bram Moolenaar30b65812012-07-12 22:01:11 +02004447 The expression will be evaluated in the |sandbox| when set from a
4448 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004449
4450 It is not allowed to change text or jump to another window while
4451 evaluating 'includeexpr' |textlock|.
4452
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004454'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4455 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 global
4457 {not in Vi}
4458 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004459 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004460 While typing a search command, show where the pattern, as it was typed
4461 so far, matches. The matched string is highlighted. If the pattern
4462 is invalid or not found, nothing is shown. The screen will be updated
4463 often, this is only useful on fast terminals.
4464 Note that the match will be shown, but the cursor will return to its
4465 original position when no match is found and when pressing <Esc>. You
4466 still need to finish the search command with <Enter> to move the
4467 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004468 You can use the CTRL-G and CTRL-T keys to move to the next and
4469 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004470 When compiled with the |+reltime| feature Vim only searches for about
4471 half a second. With a complicated pattern and/or a lot of text the
4472 match may not be found. This is to avoid that Vim hangs while you
4473 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004474 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004475 When 'hlsearch' is on, all matched strings are highlighted too while
4476 typing a search command. See also: 'hlsearch'.
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004477 If you don't want turn 'hlsearch' on, but want to highlight all matches
4478 while searching, you can turn on and off 'hlsearch' with autocmd.
4479 Example: >
4480 augroup vimrc-incsearch-highlight
4481 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004482 autocmd CmdlineEnter /,\? :set hlsearch
4483 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004484 augroup END
4485<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004486 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004487 to the command line. If 'ignorecase' and 'smartcase' are set and the
4488 command line has no uppercase characters, the added character is
4489 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004490 CTRL-R CTRL-W can be used to add the word at the end of the current
4491 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 NOTE: This option is reset when 'compatible' is set.
4493
4494 *'indentexpr'* *'inde'*
4495'indentexpr' 'inde' string (default "")
4496 local to buffer
4497 {not in Vi}
4498 {not available when compiled without the |+cindent|
4499 or |+eval| features}
4500 Expression which is evaluated to obtain the proper indent for a line.
4501 It is used when a new line is created, for the |=| operator and
4502 in Insert mode as specified with the 'indentkeys' option.
4503 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004504 'smartindent' indenting. When 'lisp' is set, this option is
4505 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 When 'paste' is set this option is not used for indenting.
4507 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004508 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 when the expression is evaluated (but it may be moved around).
4510 The expression must return the number of spaces worth of indent. It
4511 can return "-1" to keep the current indent (this means 'autoindent' is
4512 used for the indent).
4513 Functions useful for computing the indent are |indent()|, |cindent()|
4514 and |lispindent()|.
4515 The evaluation of the expression must not have side effects! It must
4516 not change the text, jump to another window, etc. Afterwards the
4517 cursor position is always restored, thus the cursor may be moved.
4518 Normally this option would be set to call a function: >
4519 :set indentexpr=GetMyIndent()
4520< Error messages will be suppressed, unless the 'debug' option contains
4521 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004522 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004523 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
Bram Moolenaar30b65812012-07-12 22:01:11 +02004525 The expression will be evaluated in the |sandbox| when set from a
4526 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004527
4528 It is not allowed to change text or jump to another window while
4529 evaluating 'indentexpr' |textlock|.
4530
4531
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 *'indentkeys'* *'indk'*
4533'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4534 local to buffer
4535 {not in Vi}
4536 {not available when compiled without the |+cindent|
4537 feature}
4538 A list of keys that, when typed in Insert mode, cause reindenting of
4539 the current line. Only happens if 'indentexpr' isn't empty.
4540 The format is identical to 'cinkeys', see |indentkeys-format|.
4541 See |C-indenting| and |indent-expression|.
4542
4543 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4544'infercase' 'inf' boolean (default off)
4545 local to buffer
4546 {not in Vi}
4547 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004548 'ignorecase' is also on, the case of the match is adjusted depending
4549 on the typed text. If the typed text contains a lowercase letter
4550 where the match has an upper case letter, the completed part is made
4551 lowercase. If the typed text has no lowercase letters and the match
4552 has a lowercase letter where the typed text has an uppercase letter,
4553 and there is a letter before it, the completed part is made uppercase.
4554 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555
4556 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4557'insertmode' 'im' boolean (default off)
4558 global
4559 {not in Vi}
4560 Makes Vim work in a way that Insert mode is the default mode. Useful
4561 if you want to use Vim as a modeless editor. Used for |evim|.
4562 These Insert mode commands will be useful:
4563 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004564 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 this is a mapping, it is executed as if 'insertmode' was off.
4566 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004568 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4569 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
4571 These items change when 'insertmode' is set:
4572 - when starting to edit of a file, Vim goes to Insert mode.
4573 - <Esc> in Insert mode is a no-op and beeps.
4574 - <Esc> in Normal mode makes Vim go to Insert mode.
4575 - CTRL-L in Insert mode is a command, it is not inserted.
4576 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4577 However, when <Esc> is used inside a mapping, it behaves like
4578 'insertmode' was not set. This was done to be able to use the same
4579 mappings with 'insertmode' set or not set.
4580 When executing commands with |:normal| 'insertmode' is not used.
4581
4582 NOTE: This option is reset when 'compatible' is set.
4583
4584 *'isfname'* *'isf'*
4585'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4586 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4587 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4588 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4589 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4590 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4591 global
4592 {not in Vi}
4593 The characters specified by this option are included in file names and
4594 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004595 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 Multi-byte characters 256 and above are always included, only the
4597 characters up to 255 are specified with this option.
4598 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004599 Think twice before adding white space to this option. Although a
4600 space may appear inside a file name, the effect will be that Vim
4601 doesn't know where a file name starts or ends when doing completion.
4602 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 Note that on systems using a backslash as path separator, Vim tries to
4605 do its best to make it work as you would expect. That is a bit
4606 tricky, since Vi originally used the backslash to escape special
4607 characters. Vim will not remove a backslash in front of a normal file
4608 name character on these systems, but it will on Unix and alikes. The
4609 '&' and '^' are not included by default, because these are special for
4610 cmd.exe.
4611
4612 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004613 Each part can be a single character number or a range. A range is two
4614 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 decimal number between 0 and 255 or the ASCII character itself (does
4616 not work for digits). Example:
4617 "_,-,128-140,#-43" (include '_' and '-' and the range
4618 128 to 140 and '#' to 43)
4619 If a part starts with '^', the following character number or range
4620 will be excluded from the option. The option is interpreted from left
4621 to right. Put the excluded character after the range where it is
4622 included. To include '^' itself use it as the last character of the
4623 option or the end of a range. Example:
4624 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4625 If the character is '@', all characters where isalpha() returns TRUE
4626 are included. Normally these are the characters a to z and A to Z,
4627 plus accented characters. To include '@' itself use "@-@". Examples:
4628 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004629 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 "a-z,A-Z,@-@" All letters plus the '@' character.
4631 A comma can be included by using it where a character number is
4632 expected. Example:
4633 "48-57,,,_" Digits, comma and underscore.
4634 A comma can be excluded by prepending a '^'. Example:
4635 " -~,^,,9" All characters from space to '~', excluding
4636 comma, plus <Tab>.
4637 See |option-backslash| about including spaces and backslashes.
4638
4639 *'isident'* *'isi'*
4640'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4641 "@,48-57,_,128-167,224-235"
4642 otherwise: "@,48-57,_,192-255")
4643 global
4644 {not in Vi}
4645 The characters given by this option are included in identifiers.
4646 Identifiers are used in recognizing environment variables and after a
4647 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004648 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 option.
4650 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004651 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4653
4654 *'iskeyword'* *'isk'*
4655'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4656 "@,48-57,_,128-167,224-235"
4657 otherwise: "@,48-57,_,192-255"
4658 Vi default: "@,48-57,_")
4659 local to buffer
4660 {not in Vi}
4661 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004662 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 'isfname' for a description of the format of this option. For C
4664 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4665 For a help file it is set to all non-blank printable characters except
4666 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4667 command).
4668 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004669 This option also influences syntax highlighting, unless the syntax
4670 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 NOTE: This option is set to the Vi default value when 'compatible' is
4672 set and to the Vim default value when 'compatible' is reset.
4673
4674 *'isprint'* *'isp'*
4675'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4676 "@,~-255"; otherwise: "@,161-255")
4677 global
4678 {not in Vi}
4679 The characters given by this option are displayed directly on the
4680 screen. It is also used for "\p" in a |pattern|. The characters from
4681 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4682 even when they are not included in 'isprint' or excluded. See
4683 'isfname' for a description of the format of this option.
4684
4685 Non-printable characters are displayed with two characters:
4686 0 - 31 "^@" - "^_"
4687 32 - 126 always single characters
4688 127 "^?"
4689 128 - 159 "~@" - "~_"
4690 160 - 254 "| " - "|~"
4691 255 "~?"
4692 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4693 displayed as <xx>, with the hexadecimal value of the byte.
4694 When 'display' contains "uhex" all unprintable characters are
4695 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004696 The SpecialKey highlighting will be used for unprintable characters.
4697 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698
4699 Multi-byte characters 256 and above are always included, only the
4700 characters up to 255 are specified with this option. When a character
4701 is printable but it is not available in the current font, a
4702 replacement character will be shown.
4703 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4704 There is no option to specify these characters.
4705
4706 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4707'joinspaces' 'js' boolean (default on)
4708 global
4709 {not in Vi}
4710 Insert two spaces after a '.', '?' and '!' with a join command.
4711 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4712 Otherwise only one space is inserted.
4713 NOTE: This option is set when 'compatible' is set.
4714
4715 *'key'*
4716'key' string (default "")
4717 local to buffer
4718 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004719 {only available when compiled with the |+cryptv|
4720 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004722 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 Careful: Do not set the key value by hand, someone might see the typed
4724 key. Use the |:X| command. But you can make 'key' empty: >
4725 :set key=
4726< It is not possible to get the value of this option with ":set key" or
4727 "echo &key". This is to avoid showing it to someone who shouldn't
4728 know. It also means you cannot see it yourself once you have set it,
4729 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004730 You can use "&key" in an expression to detect whether encryption is
4731 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732
4733 *'keymap'* *'kmp'* *E544*
4734'keymap' 'kmp' string (default "")
4735 local to buffer
4736 {not in Vi}
4737 {only available when compiled with the |+keymap|
4738 feature}
4739 Name of a keyboard mapping. See |mbyte-keymap|.
4740 Setting this option to a valid keymap name has the side effect of
4741 setting 'iminsert' to one, so that the keymap becomes effective.
4742 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004743 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 *'keymodel'* *'km'*
4746'keymodel' 'km' string (default "")
4747 global
4748 {not in Vi}
4749 List of comma separated words, which enable special things that keys
4750 can do. These values can be used:
4751 startsel Using a shifted special key starts selection (either
4752 Select mode or Visual mode, depending on "key" being
4753 present in 'selectmode').
4754 stopsel Using a not-shifted special key stops selection.
4755 Special keys in this context are the cursor keys, <End>, <Home>,
4756 <PageUp> and <PageDown>.
4757 The 'keymodel' option is set by the |:behave| command.
4758
4759 *'keywordprg'* *'kp'*
4760'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004761 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 global or local to buffer |global-local|
4763 {not in Vi}
4764 Program to use for the |K| command. Environment variables are
4765 expanded |:set_env|. ":help" may be used to access the Vim internal
4766 help. (Note that previously setting the global option to the empty
4767 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004768 When the first character is ":", the command is invoked as a Vim
4769 Ex command prefixed with [count].
4770 When "man", "man -s" or an Ex command is used, Vim will automatically
4771 translate a count for the "K" command and pass it as the first
4772 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 See |option-backslash| about including spaces and backslashes.
4774 Example: >
4775 :set keywordprg=man\ -s
4776< This option cannot be set from a |modeline| or in the |sandbox|, for
4777 security reasons.
4778
4779 *'langmap'* *'lmap'* *E357* *E358*
4780'langmap' 'lmap' string (default "")
4781 global
4782 {not in Vi}
4783 {only available when compiled with the |+langmap|
4784 feature}
4785 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004786 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004787 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 care of translating these special characters to the original meaning
4789 of the key. This means you don't have to change the keyboard mode to
4790 be able to execute Normal mode commands.
4791 This is the opposite of the 'keymap' option, where characters are
4792 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004793 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004794 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004795 This option cannot be set from a |modeline| or in the |sandbox|, for
4796 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004798 Example (for Greek, in UTF-8): *greek* >
4799 :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 +00004800< Example (exchanges meaning of z and y for commands): >
4801 :set langmap=zy,yz,ZY,YZ
4802<
4803 The 'langmap' option is a list of parts, separated with commas. Each
4804 part can be in one of two forms:
4805 1. A list of pairs. Each pair is a "from" character immediately
4806 followed by the "to" character. Examples: "aA", "aAbBcC".
4807 2. A list of "from" characters, a semi-colon and a list of "to"
4808 characters. Example: "abc;ABC"
4809 Example: "aA,fgh;FGH,cCdDeE"
4810 Special characters need to be preceded with a backslash. These are
4811 ";", ',' and backslash itself.
4812
4813 This will allow you to activate vim actions without having to switch
4814 back and forth between the languages. Your language characters will
4815 be understood as normal vim English characters (according to the
4816 langmap mappings) in the following cases:
4817 o Normal/Visual mode (commands, buffer/register names, user mappings)
4818 o Insert/Replace Mode: Register names after CTRL-R
4819 o Insert/Replace Mode: Mappings
4820 Characters entered in Command-line mode will NOT be affected by
4821 this option. Note that this option can be changed at any time
4822 allowing to switch between mappings for different languages/encodings.
4823 Use a mapping to avoid having to type it each time!
4824
4825 *'langmenu'* *'lm'*
4826'langmenu' 'lm' string (default "")
4827 global
4828 {not in Vi}
4829 {only available when compiled with the |+menu| and
4830 |+multi_lang| features}
4831 Language to use for menu translation. Tells which file is loaded
4832 from the "lang" directory in 'runtimepath': >
4833 "lang/menu_" . &langmenu . ".vim"
4834< (without the spaces). For example, to always use the Dutch menus, no
4835 matter what $LANG is set to: >
4836 :set langmenu=nl_NL.ISO_8859-1
4837< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004838 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 If your $LANG is set to a non-English language but you do want to use
4840 the English menus: >
4841 :set langmenu=none
4842< This option must be set before loading menus, switching on filetype
4843 detection or syntax highlighting. Once the menus are defined setting
4844 this option has no effect. But you could do this: >
4845 :source $VIMRUNTIME/delmenu.vim
4846 :set langmenu=de_DE.ISO_8859-1
4847 :source $VIMRUNTIME/menu.vim
4848< Warning: This deletes all menus that you defined yourself!
4849
Bram Moolenaard94464e2015-11-02 15:28:18 +01004850 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004851'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004852 global
4853 {not in Vi}
4854 {only available when compiled with the |+langmap|
4855 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004856 This is just like 'langremap' but with the value inverted. It only
4857 exists for backwards compatibility. When setting 'langremap' then
4858 'langnoremap' is set to the inverted value, and the other way around.
4859
4860 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4861'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4862 global
4863 {not in Vi}
4864 {only available when compiled with the |+langmap|
4865 feature}
4866 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004867 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004868 'langmap' disables some of your mappings, try resetting this option.
4869 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004870 that works for you to avoid mappings to break.
4871
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 *'laststatus'* *'ls'*
4873'laststatus' 'ls' number (default 1)
4874 global
4875 {not in Vi}
4876 The value of this option influences when the last window will have a
4877 status line:
4878 0: never
4879 1: only if there are at least two windows
4880 2: always
4881 The screen looks nicer with a status line if you have several
4882 windows, but it takes another screen line. |status-line|
4883
4884 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4885'lazyredraw' 'lz' boolean (default off)
4886 global
4887 {not in Vi}
4888 When this option is set, the screen will not be redrawn while
4889 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004890 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 update use |:redraw|.
4892
4893 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4894'linebreak' 'lbr' boolean (default off)
4895 local to window
4896 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004897 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004899 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 than at the last character that fits on the screen. Unlike
4901 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004902 it only affects the way the file is displayed, not its contents.
4903 If 'breakindent' is set, line is visually indented. Then, the value
4904 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004905 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 Note that <Tab> characters after an <EOL> are mostly not displayed
4907 with the right amount of white space.
4908
4909 *'lines'* *E593*
4910'lines' number (default 24 or terminal height)
4911 global
4912 Number of lines of the Vim window.
4913 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004914 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 When Vim is running in the GUI or in a resizable window, setting this
4916 option will cause the window size to be changed. When you only want
4917 to use the size for the GUI, put the command in your |gvimrc| file.
4918 Vim limits the number of lines to what fits on the screen. You can
4919 use this command to get the tallest window possible: >
4920 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004921< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004922 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 When you set this option and Vim is unable to change the physical
4924 number of lines of the display, the display may be messed up.
4925
4926 *'linespace'* *'lsp'*
4927'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4928 global
4929 {not in Vi}
4930 {only in the GUI}
4931 Number of pixel lines inserted between characters. Useful if the font
4932 uses the full character cell height, making lines touch each other.
4933 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004934 With some fonts there can be too much room between lines (to have
4935 space for ascents and descents). Then it makes sense to set
4936 'linespace' to a negative value. This may cause display problems
4937 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938
4939 *'lisp'* *'nolisp'*
4940'lisp' boolean (default off)
4941 local to buffer
4942 {not available when compiled without the |+lispindent|
4943 feature}
4944 Lisp mode: When <Enter> is typed in insert mode set the indent for
4945 the next line to Lisp standards (well, sort of). Also happens with
4946 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4947 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4948 better. Also see 'lispwords'.
4949 The '-' character is included in keyword characters. Redefines the
4950 "=" operator to use this same indentation algorithm rather than
4951 calling an external program if 'equalprg' is empty.
4952 This option is not used when 'paste' is set.
4953 {Vi: Does it a little bit differently}
4954
4955 *'lispwords'* *'lw'*
4956'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004957 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 {not in Vi}
4959 {not available when compiled without the |+lispindent|
4960 feature}
4961 Comma separated list of words that influence the Lisp indenting.
4962 |'lisp'|
4963
4964 *'list'* *'nolist'*
4965'list' boolean (default off)
4966 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004967 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4968 line. Useful to see the difference between tabs and spaces and for
4969 trailing blanks. Further changed by the 'listchars' option.
4970
4971 The cursor is displayed at the start of the space a Tab character
4972 occupies, not at the end as usual in Normal mode. To get this cursor
4973 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004974 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004975<
4976 Note that list mode will also affect formatting (set with 'textwidth'
4977 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 changing the way tabs are displayed.
4979
4980 *'listchars'* *'lcs'*
4981'listchars' 'lcs' string (default "eol:$")
4982 global
4983 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004984 Strings to use in 'list' mode and for the |:list| command. It is a
4985 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004986 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 eol:c Character to show at the end of each line. When
4988 omitted, there is no extra character at the end of the
4989 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004990 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004991 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004993 fill the space that the tab normally occupies.
4994 "tab:>-" will show a tab that takes four spaces as
4995 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004996 *lcs-space*
4997 space:c Character to show for a space. When omitted, spaces
4998 are left blank.
4999 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005000 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005001 trailing spaces are blank. Overrides the "space"
5002 setting for trailing spaces.
5003 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 extends:c Character to show in the last column, when 'wrap' is
5005 off and the line continues beyond the right of the
5006 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005007 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 precedes:c Character to show in the first column, when 'wrap'
5009 is off and there is text preceding the character
5010 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005011 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005012 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005013 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005014 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005015 nbsp:c Character to show for a non-breakable space character
5016 (0xA0 (160 decimal) and U+202F). Left blank when
5017 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005019 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005021 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022
5023 Examples: >
5024 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005025 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 :set lcs=extends:>,precedes:<
5027< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005028 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005029 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030
5031 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5032'loadplugins' 'lpl' boolean (default on)
5033 global
5034 {not in Vi}
5035 When on the plugin scripts are loaded when starting up |load-plugins|.
5036 This option can be reset in your |vimrc| file to disable the loading
5037 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005038 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5039 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040
Bram Moolenaard94464e2015-11-02 15:28:18 +01005041 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005042'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005043 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005044 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005045 {only available when compiled with the |+lua/dyn|
5046 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005047 Specifies the name of the Lua shared library. The default is
5048 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005049 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005050 This option cannot be set from a |modeline| or in the |sandbox|, for
5051 security reasons.
5052
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005053 *'macatsui'* *'nomacatsui'*
5054'macatsui' boolean (default on)
5055 global
5056 {only available in Mac GUI version}
5057 This is a workaround for when drawing doesn't work properly. When set
5058 and compiled with multi-byte support ATSUI text drawing is used. When
5059 not set ATSUI text drawing is not used. Switch this option off when
5060 you experience drawing problems. In a future version the problems may
5061 be solved and this option becomes obsolete. Therefore use this method
5062 to unset it: >
5063 if exists('&macatsui')
5064 set nomacatsui
5065 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005066< Another option to check if you have drawing problems is
5067 'termencoding'.
5068
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 *'magic'* *'nomagic'*
5070'magic' boolean (default on)
5071 global
5072 Changes the special characters that can be used in search patterns.
5073 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005074 WARNING: Switching this option off most likely breaks plugins! That
5075 is because many patterns assume it's on and will fail when it's off.
5076 Only switch it off when working with old Vi scripts. In any other
5077 situation write patterns that work when 'magic' is on. Include "\M"
5078 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079
5080 *'makeef'* *'mef'*
5081'makeef' 'mef' string (default: "")
5082 global
5083 {not in Vi}
5084 {not available when compiled without the |+quickfix|
5085 feature}
5086 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5087 and the |:grep| command.
5088 When it is empty, an internally generated temp file will be used.
5089 When "##" is included, it is replaced by a number to make the name
5090 unique. This makes sure that the ":make" command doesn't overwrite an
5091 existing file.
5092 NOT used for the ":cf" command. See 'errorfile' for that.
5093 Environment variables are expanded |:set_env|.
5094 See |option-backslash| about including spaces and backslashes.
5095 This option cannot be set from a |modeline| or in the |sandbox|, for
5096 security reasons.
5097
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005098 *'makeencoding'* *'menc'*
5099'makeencoding' 'menc' string (default "")
5100 global or local to buffer |global-local|
5101 {only available when compiled with the |+multi_byte|
5102 feature}
5103 {not in Vi}
5104 Encoding used for reading the output of external commands. When empty,
5105 encoding is not converted.
5106 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5107 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5108 and `:laddfile`.
5109
5110 This would be mostly useful when you use MS-Windows and set 'encoding'
5111 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5112 'makeencoding' to "char" has the same effect as setting to the system
5113 locale encoding. Example: >
5114 :set encoding=utf-8
5115 :set makeencoding=char " system locale is used
5116<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 *'makeprg'* *'mp'*
5118'makeprg' 'mp' string (default "make", VMS: "MMS")
5119 global or local to buffer |global-local|
5120 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005121 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005122 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5123 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005124 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005125 Environment variables are expanded |:set_env|. See |option-backslash|
5126 about including spaces and backslashes.
5127 Note that a '|' must be escaped twice: once for ":set" and once for
5128 the interpretation of a command. When you use a filter called
5129 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130 :set makeprg=gmake\ \\\|\ myfilter
5131< The placeholder "$*" can be given (even multiple times) to specify
5132 where the arguments will be included, for example: >
5133 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5134< This option cannot be set from a |modeline| or in the |sandbox|, for
5135 security reasons.
5136
5137 *'matchpairs'* *'mps'*
5138'matchpairs' 'mps' string (default "(:),{:},[:]")
5139 local to buffer
5140 {not in Vi}
5141 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005142 other.
5143 Only character pairs are allowed that are different, thus you cannot
5144 jump between two double quotes.
5145 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005146 The pairs must be separated by a comma. Example for including '<' and
5147 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 :set mps+=<:>
5149
5150< A more exotic example, to jump between the '=' and ';' in an
5151 assignment, useful for languages like C and Java: >
5152 :au FileType c,cpp,java set mps+==:;
5153
5154< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005155 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156
5157 *'matchtime'* *'mat'*
5158'matchtime' 'mat' number (default 5)
5159 global
5160 {not in Vi}{in Nvi}
5161 Tenths of a second to show the matching paren, when 'showmatch' is
5162 set. Note that this is not in milliseconds, like other options that
5163 set a time. This is to be compatible with Nvi.
5164
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005165 *'maxcombine'* *'mco'*
5166'maxcombine' 'mco' number (default 2)
5167 global
5168 {not in Vi}
5169 {only available when compiled with the |+multi_byte|
5170 feature}
5171 The maximum number of combining characters supported for displaying.
5172 Only used when 'encoding' is "utf-8".
5173 The default is OK for most languages. Hebrew may require 4.
5174 Maximum value is 6.
5175 Even when this option is set to 2 you can still edit text with more
5176 combining characters, you just can't see them. Use |g8| or |ga|.
5177 See |mbyte-combining|.
5178
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 *'maxfuncdepth'* *'mfd'*
5180'maxfuncdepth' 'mfd' number (default 100)
5181 global
5182 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005183 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005184 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 Maximum depth of function calls for user functions. This normally
5186 catches endless recursion. When using a recursive function with
5187 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5188 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005189 Increasing this limit above 200 also changes the maximum for Ex
5190 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 See also |:function|.
5192
5193 *'maxmapdepth'* *'mmd'* *E223*
5194'maxmapdepth' 'mmd' number (default 1000)
5195 global
5196 {not in Vi}
5197 Maximum number of times a mapping is done without resulting in a
5198 character to be used. This normally catches endless mappings, like
5199 ":map x y" with ":map y x". It still does not catch ":map g wg",
5200 because the 'w' is used before the next mapping is done. See also
5201 |key-mapping|.
5202
5203 *'maxmem'* *'mm'*
5204'maxmem' 'mm' number (default between 256 to 5120 (system
5205 dependent) or half the amount of memory
5206 available)
5207 global
5208 {not in Vi}
5209 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5210 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005211 other memory to be freed.
5212 The maximum usable value is about 2000000. Use this to work without a
5213 limit.
5214 The value is ignored when 'swapfile' is off.
5215 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005217 *'maxmempattern'* *'mmp'*
5218'maxmempattern' 'mmp' number (default 1000)
5219 global
5220 {not in Vi}
5221 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005222 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005223 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005224 When Vim runs into the limit it gives an error message and mostly
5225 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005226 Running into the limit often means that the pattern is very
5227 inefficient or too complex. This may already happen with the pattern
5228 "\(.\)*" on a very long line. ".*" works much better.
5229 Vim may run out of memory before hitting the 'maxmempattern' limit.
5230
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 *'maxmemtot'* *'mmt'*
5232'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5233 dependent) or half the amount of memory
5234 available)
5235 global
5236 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005237 Maximum amount of memory in Kbyte to use for all buffers together.
5238 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005239 without a limit.
5240 On 64 bit machines higher values might work. But hey, do you really
5241 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005242 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005243 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005244 Buffers with 'swapfile' off still count to the total amount of memory
5245 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005246 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
5248 *'menuitems'* *'mis'*
5249'menuitems' 'mis' number (default 25)
5250 global
5251 {not in Vi}
5252 {not available when compiled without the |+menu|
5253 feature}
5254 Maximum number of items to use in a menu. Used for menus that are
5255 generated from a list of items, e.g., the Buffers menu. Changing this
5256 option has no direct effect, the menu must be refreshed first.
5257
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005258 *'mkspellmem'* *'msm'*
5259'mkspellmem' 'msm' string (default "460000,2000,500")
5260 global
5261 {not in Vi}
5262 {not available when compiled without the |+syntax|
5263 feature}
5264 Parameters for |:mkspell|. This tunes when to start compressing the
5265 word tree. Compression can be slow when there are many words, but
5266 it's needed to avoid running out of memory. The amount of memory used
5267 per word depends very much on how similar the words are, that's why
5268 this tuning is complicated.
5269
5270 There are three numbers, separated by commas:
5271 {start},{inc},{added}
5272
5273 For most languages the uncompressed word tree fits in memory. {start}
5274 gives the amount of memory in Kbyte that can be used before any
5275 compression is done. It should be a bit smaller than the amount of
5276 memory that is available to Vim.
5277
5278 When going over the {start} limit the {inc} number specifies the
5279 amount of memory in Kbyte that can be allocated before another
5280 compression is done. A low number means compression is done after
5281 less words are added, which is slow. A high number means more memory
5282 will be allocated.
5283
5284 After doing compression, {added} times 1024 words can be added before
5285 the {inc} limit is ignored and compression is done when any extra
5286 amount of memory is needed. A low number means there is a smaller
5287 chance of hitting the {inc} limit, less memory is used but it's
5288 slower.
5289
5290 The languages for which these numbers are important are Italian and
5291 Hungarian. The default works for when you have about 512 Mbyte. If
5292 you have 1 Gbyte you could use: >
5293 :set mkspellmem=900000,3000,800
5294< If you have less than 512 Mbyte |:mkspell| may fail for some
5295 languages, no matter what you set 'mkspellmem' to.
5296
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005298'modeline' 'ml' boolean (Vim default: on (off for root),
5299 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 local to buffer
5301 *'modelines'* *'mls'*
5302'modelines' 'mls' number (default 5)
5303 global
5304 {not in Vi}
5305 If 'modeline' is on 'modelines' gives the number of lines that is
5306 checked for set commands. If 'modeline' is off or 'modelines' is zero
5307 no lines are checked. See |modeline|.
5308 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5309 set and to the Vim default value when 'compatible' is reset.
5310
5311 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5312'modifiable' 'ma' boolean (default on)
5313 local to buffer
5314 {not in Vi} *E21*
5315 When off the buffer contents cannot be changed. The 'fileformat' and
5316 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005317 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318
5319 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5320'modified' 'mod' boolean (default off)
5321 local to buffer
5322 {not in Vi}
5323 When on, the buffer is considered to be modified. This option is set
5324 when:
5325 1. A change was made to the text since it was last written. Using the
5326 |undo| command to go back to the original text will reset the
5327 option. But undoing changes that were made before writing the
5328 buffer will set the option again, since the text is different from
5329 when it was written.
5330 2. 'fileformat' or 'fileencoding' is different from its original
5331 value. The original value is set when the buffer is read or
5332 written. A ":set nomodified" command also resets the original
5333 values to the current values and the 'modified' option will be
5334 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005335 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005336 This option is not set when a change is made to the buffer as the
5337 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5338 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5339 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5341 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005342 Note that the text may actually be the same, e.g. 'modified' is set
5343 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344
5345 *'more'* *'nomore'*
5346'more' boolean (Vim default: on, Vi default: off)
5347 global
5348 {not in Vi}
5349 When on, listings pause when the whole screen is filled. You will get
5350 the |more-prompt|. When this option is off there are no pauses, the
5351 listing continues until finished.
5352 NOTE: This option is set to the Vi default value when 'compatible' is
5353 set and to the Vim default value when 'compatible' is reset.
5354
5355 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005356'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5357 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 global
5359 {not in Vi}
5360 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005361 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5362 sysmouse and Linux console with gpm). For using the mouse in the
5363 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005365 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 v Visual mode
5367 i Insert mode
5368 c Command-line mode
5369 h all previous modes when editing a help file
5370 a all previous modes
5371 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 Normally you would enable the mouse in all four modes with: >
5373 :set mouse=a
5374< When the mouse is not enabled, the GUI will still use the mouse for
5375 modeless selection. This doesn't move the text cursor.
5376
5377 See |mouse-using|. Also see |'clipboard'|.
5378
5379 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005380 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 the mouse buttons can still be used by keeping the shift key pressed.
5382 Also see the 'clipboard' option.
5383
5384 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5385'mousefocus' 'mousef' boolean (default off)
5386 global
5387 {not in Vi}
5388 {only works in the GUI}
5389 The window that the mouse pointer is on is automatically activated.
5390 When changing the window layout or window focus in another way, the
5391 mouse pointer is moved to the window with keyboard focus. Off is the
5392 default because it makes using the pull down menus a little goofy, as
5393 a pointer transit may activate a window unintentionally.
5394
5395 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5396'mousehide' 'mh' boolean (default on)
5397 global
5398 {not in Vi}
5399 {only works in the GUI}
5400 When on, the mouse pointer is hidden when characters are typed.
5401 The mouse pointer is restored when the mouse is moved.
5402
5403 *'mousemodel'* *'mousem'*
5404'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5405 global
5406 {not in Vi}
5407 Sets the model to use for the mouse. The name mostly specifies what
5408 the right mouse button is used for:
5409 extend Right mouse button extends a selection. This works
5410 like in an xterm.
5411 popup Right mouse button pops up a menu. The shifted left
5412 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005413 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 popup_setpos Like "popup", but the cursor will be moved to the
5415 position where the mouse was clicked, and thus the
5416 selected operation will act upon the clicked object.
5417 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005418 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 course, that right clicking outside a selection will
5420 end Visual mode.
5421 Overview of what button does what for each model:
5422 mouse extend popup(_setpos) ~
5423 left click place cursor place cursor
5424 left drag start selection start selection
5425 shift-left search word extend selection
5426 right click extend selection popup menu (place cursor)
5427 right drag extend selection -
5428 middle click paste paste
5429
5430 In the "popup" model the right mouse button produces a pop-up menu.
5431 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005432 In a terminal the popup menu works if Vim is compiled with the
5433 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434
5435 Note that you can further refine the meaning of buttons with mappings.
5436 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5437 selection (because that's handled in the GUI code directly).
5438
5439 The 'mousemodel' option is set by the |:behave| command.
5440
5441 *'mouseshape'* *'mouses'* *E547*
5442'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005443 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 global
5445 {not in Vi}
5446 {only available when compiled with the |+mouseshape|
5447 feature}
5448 This option tells Vim what the mouse pointer should look like in
5449 different modes. The option is a comma separated list of parts, much
5450 like used for 'guicursor'. Each part consist of a mode/location-list
5451 and an argument-list:
5452 mode-list:shape,mode-list:shape,..
5453 The mode-list is a dash separated list of these modes/locations:
5454 In a normal window: ~
5455 n Normal mode
5456 v Visual mode
5457 ve Visual mode with 'selection' "exclusive" (same as 'v',
5458 if not specified)
5459 o Operator-pending mode
5460 i Insert mode
5461 r Replace mode
5462
5463 Others: ~
5464 c appending to the command-line
5465 ci inserting in the command-line
5466 cr replacing in the command-line
5467 m at the 'Hit ENTER' or 'More' prompts
5468 ml idem, but cursor in the last line
5469 e any mode, pointer below last window
5470 s any mode, pointer on a status line
5471 sd any mode, while dragging a status line
5472 vs any mode, pointer on a vertical separator line
5473 vd any mode, while dragging a vertical separator line
5474 a everywhere
5475
5476 The shape is one of the following:
5477 avail name looks like ~
5478 w x arrow Normal mouse pointer
5479 w x blank no pointer at all (use with care!)
5480 w x beam I-beam
5481 w x updown up-down sizing arrows
5482 w x leftright left-right sizing arrows
5483 w x busy The system's usual busy pointer
5484 w x no The system's usual 'no input' pointer
5485 x udsizing indicates up-down resizing
5486 x lrsizing indicates left-right resizing
5487 x crosshair like a big thin +
5488 x hand1 black hand
5489 x hand2 white hand
5490 x pencil what you write with
5491 x question big ?
5492 x rightup-arrow arrow pointing right-up
5493 w x up-arrow arrow pointing up
5494 x <number> any X11 pointer number (see X11/cursorfont.h)
5495
5496 The "avail" column contains a 'w' if the shape is available for Win32,
5497 x for X11.
5498 Any modes not specified or shapes not available use the normal mouse
5499 pointer.
5500
5501 Example: >
5502 :set mouseshape=s:udsizing,m:no
5503< will make the mouse turn to a sizing arrow over the status lines and
5504 indicate no input when the hit-enter prompt is displayed (since
5505 clicking the mouse has no effect in this state.)
5506
5507 *'mousetime'* *'mouset'*
5508'mousetime' 'mouset' number (default 500)
5509 global
5510 {not in Vi}
5511 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5512 time in msec between two mouse clicks for the second click to be
5513 recognized as a multi click.
5514
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005515 *'mzschemedll'*
5516'mzschemedll' string (default depends on the build)
5517 global
5518 {not in Vi}
5519 {only available when compiled with the |+mzscheme/dyn|
5520 feature}
5521 Specifies the name of the MzScheme shared library. The default is
5522 DYNAMIC_MZSCH_DLL which was specified at compile time.
5523 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005524 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005525 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005526 This option cannot be set from a |modeline| or in the |sandbox|, for
5527 security reasons.
5528
5529 *'mzschemegcdll'*
5530'mzschemegcdll' string (default depends on the build)
5531 global
5532 {not in Vi}
5533 {only available when compiled with the |+mzscheme/dyn|
5534 feature}
5535 Specifies the name of the MzScheme GC shared library. The default is
5536 DYNAMIC_MZGC_DLL which was specified at compile time.
5537 The value can be equal to 'mzschemedll' if it includes the GC code.
5538 Environment variables are expanded |:set_env|.
5539 This option cannot be set from a |modeline| or in the |sandbox|, for
5540 security reasons.
5541
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005542 *'mzquantum'* *'mzq'*
5543'mzquantum' 'mzq' number (default 100)
5544 global
5545 {not in Vi}
5546 {not available when compiled without the |+mzscheme|
5547 feature}
5548 The number of milliseconds between polls for MzScheme threads.
5549 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005550 NOTE: This option is set to the Vim default value when 'compatible'
5551 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005552
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005554'nrformats' 'nf' string (default "bin,octal,hex",
5555 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 local to buffer
5557 {not in Vi}
5558 This defines what bases Vim will consider for numbers when using the
5559 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5560 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005561 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005563 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005564 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005566 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 considered to be hexadecimal. Example: Using CTRL-X on
5568 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005569 bin If included, numbers starting with "0b" or "0B" will be
5570 considered to be binary. Example: Using CTRL-X on
5571 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 Numbers which simply begin with a digit in the range 1-9 are always
5573 considered decimal. This also happens for numbers that are not
5574 recognized as octal or hex.
5575
5576 *'number'* *'nu'* *'nonumber'* *'nonu'*
5577'number' 'nu' boolean (default off)
5578 local to window
5579 Print the line number in front of each line. When the 'n' option is
5580 excluded from 'cpoptions' a wrapped line will not use the column of
5581 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005582 The 'numberwidth' option can be used to set the room used for the line
5583 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 When a long, wrapped line doesn't start with the first character, '-'
5585 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005586 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5587 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005588 *number_relativenumber*
5589 The 'relativenumber' option changes the displayed number to be
5590 relative to the cursor. Together with 'number' there are these
5591 four combinations (cursor in line 3):
5592
Bram Moolenaar3848e002016-03-19 18:42:29 +01005593 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005594 'nornu' 'nornu' 'rnu' 'rnu'
5595
5596 |apple | 1 apple | 2 apple | 2 apple
5597 |pear | 2 pear | 1 pear | 1 pear
5598 |nobody | 3 nobody | 0 nobody |3 nobody
5599 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005601 *'numberwidth'* *'nuw'*
5602'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5603 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005604 {not in Vi}
5605 {only available when compiled with the |+linebreak|
5606 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005607 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005608 when the 'number' or 'relativenumber' option is set or printing lines
5609 with a line number. Since one space is always between the number and
5610 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005611 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005612 fit the highest line number in the buffer respectively the number of
5613 rows in the window, depending on whether 'number' or 'relativenumber'
5614 is set. Thus with the Vim default of 4 there is room for a line number
5615 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005616 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005617 NOTE: This option is set to the Vi default value when 'compatible' is
5618 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005619
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005620 *'omnifunc'* *'ofu'*
5621'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005622 local to buffer
5623 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005624 {not available when compiled without the |+eval|
5625 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005626 This option specifies a function to be used for Insert mode omni
5627 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005628 See |complete-functions| for an explanation of how the function is
5629 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005630 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005631 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005632 This option cannot be set from a |modeline| or in the |sandbox|, for
5633 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005634
5635
Bram Moolenaar02467872007-05-06 13:22:01 +00005636 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005637'opendevice' 'odev' boolean (default off)
5638 global
5639 {not in Vi}
5640 {only for MS-DOS, MS-Windows and OS/2}
5641 Enable reading and writing from devices. This may get Vim stuck on a
5642 device that can be opened but doesn't actually do the I/O. Therefore
5643 it is off by default.
5644 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5645 result in editing a device.
5646
5647
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005648 *'operatorfunc'* *'opfunc'*
5649'operatorfunc' 'opfunc' string (default: empty)
5650 global
5651 {not in Vi}
5652 This option specifies a function to be called by the |g@| operator.
5653 See |:map-operator| for more info and an example.
5654
5655 This option cannot be set from a |modeline| or in the |sandbox|, for
5656 security reasons.
5657
5658
Bram Moolenaar251e1912011-06-19 05:09:16 +02005659 *'osfiletype'* *'oft'*
5660'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 local to buffer
5662 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005663 This option was supported on RISC OS, which has been removed.
5664
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005666 *'packpath'* *'pp'*
5667'packpath' 'pp' string (default: see 'runtimepath')
5668 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005669 Directories used to find packages. See |packages|.
5670
5671
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005673'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005674 global
5675 Specifies the nroff macros that separate paragraphs. These are pairs
5676 of two letters (see |object-motions|).
5677
5678 *'paste'* *'nopaste'*
5679'paste' boolean (default off)
5680 global
5681 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005682 Put Vim in Paste mode. This is useful if you want to cut or copy
5683 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 unexpected effects.
5685 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 knows about pasting and will mostly do the right thing without 'paste'
5688 being set. The same is true for a terminal where Vim handles the
5689 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005690 This option is reset when starting the GUI. Thus if you set it in
5691 your .vimrc it will work in a terminal, but not in the GUI. Setting
5692 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5693 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 When the 'paste' option is switched on (also when it was already on):
5695 - mapping in Insert mode and Command-line mode is disabled
5696 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005698 - 'expandtab' is reset
5699 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 - 'revins' is reset
5701 - 'ruler' is reset
5702 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005703 - 'smartindent' is reset
5704 - 'smarttab' is reset
5705 - 'softtabstop' is set to 0
5706 - 'textwidth' is set to 0
5707 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005710 - 'indentexpr'
5711 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 NOTE: When you start editing another file while the 'paste' option is
5713 on, settings from the modelines or autocommands may change the
5714 settings again, causing trouble when pasting text. You might want to
5715 set the 'paste' option again.
5716 When the 'paste' option is reset the mentioned options are restored to
5717 the value before the moment 'paste' was switched from off to on.
5718 Resetting 'paste' before ever setting it does not have any effect.
5719 Since mapping doesn't work while 'paste' is active, you need to use
5720 the 'pastetoggle' option to toggle the 'paste' option with some key.
5721
5722 *'pastetoggle'* *'pt'*
5723'pastetoggle' 'pt' string (default "")
5724 global
5725 {not in Vi}
5726 When non-empty, specifies the key sequence that toggles the 'paste'
5727 option. This is like specifying a mapping: >
5728 :map {keys} :set invpaste<CR>
5729< Where {keys} is the value of 'pastetoggle'.
5730 The difference is that it will work even when 'paste' is set.
5731 'pastetoggle' works in Insert mode and Normal mode, but not in
5732 Command-line mode.
5733 Mappings are checked first, thus overrule 'pastetoggle'. However,
5734 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5735 this: >
5736 :map <F10> :set paste<CR>
5737 :map <F11> :set nopaste<CR>
5738 :imap <F10> <C-O>:set paste<CR>
5739 :imap <F11> <nop>
5740 :set pastetoggle=<F11>
5741< This will make <F10> start paste mode and <F11> stop paste mode.
5742 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5743 mode everything is inserted literally, except the 'pastetoggle' key
5744 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005745 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746
5747 *'pex'* *'patchexpr'*
5748'patchexpr' 'pex' string (default "")
5749 global
5750 {not in Vi}
5751 {not available when compiled without the |+diff|
5752 feature}
5753 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005754 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755
Bram Moolenaardbc28022014-07-26 13:40:44 +02005756 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757'patchmode' 'pm' string (default "")
5758 global
5759 {not in Vi}
5760 When non-empty the oldest version of a file is kept. This can be used
5761 to keep the original version of a file if you are changing files in a
5762 source distribution. Only the first time that a file is written a
5763 copy of the original file will be kept. The name of the copy is the
5764 name of the original file with the string in the 'patchmode' option
5765 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005766 ".orig" or ".org". 'backupdir' must not be empty for this to work
5767 (Detail: The backup file is renamed to the patchmode file after the
5768 new file has been successfully written, that's why it must be possible
5769 to write a backup file). If there was no file to be backed up, an
5770 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 When the 'backupskip' pattern matches, a patchmode file is not made.
5772 Using 'patchmode' for compressed files appends the extension at the
5773 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5774 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005775 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005777 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778'path' 'pa' string (default on Unix: ".,/usr/include,,"
5779 on OS/2: ".,/emx/include,,"
5780 other systems: ".,,")
5781 global or local to buffer |global-local|
5782 {not in Vi}
5783 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005784 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5785 provided that the file being searched for has a relative path (not
5786 starting with "/", "./" or "../"). The directories in the 'path'
5787 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 - Use commas to separate directory names: >
5789 :set path=.,/usr/local/include,/usr/include
5790< - Spaces can also be used to separate directory names (for backwards
5791 compatibility with version 3.0). To have a space in a directory
5792 name, precede it with an extra backslash, and escape the space: >
5793 :set path=.,/dir/with\\\ space
5794< - To include a comma in a directory name precede it with an extra
5795 backslash: >
5796 :set path=.,/dir/with\\,comma
5797< - To search relative to the directory of the current file, use: >
5798 :set path=.
5799< - To search in the current directory use an empty string between two
5800 commas: >
5801 :set path=,,
5802< - A directory name may end in a ':' or '/'.
5803 - Environment variables are expanded |:set_env|.
5804 - When using |netrw.vim| URLs can be used. For example, adding
5805 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005806 - Search upwards and downwards in a directory tree using "*", "**" and
5807 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 {not available when compiled without the |+path_extra| feature}
5809 - Careful with '\' characters, type two to get one in the option: >
5810 :set path=.,c:\\include
5811< Or just use '/' instead: >
5812 :set path=.,c:/include
5813< Don't forget "." or files won't even be found in the same directory as
5814 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005815 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005816 it is something like 256 or 1024 characters.
5817 You can check if all the include files are found, using the value of
5818 'path', see |:checkpath|.
5819 The use of |:set+=| and |:set-=| is preferred when adding or removing
5820 directories from the list. This avoids problems when a future version
5821 uses another default. To remove the current directory use: >
5822 :set path-=
5823< To add the current directory use: >
5824 :set path+=
5825< To use an environment variable, you probably need to replace the
5826 separator. Here is an example to append $INCL, in which directory
5827 names are separated with a semi-colon: >
5828 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5829< Replace the ';' with a ':' or whatever separator is used. Note that
5830 this doesn't work when $INCL contains a comma or white space.
5831
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005832 *'perldll'*
5833'perldll' string (default depends on the build)
5834 global
5835 {not in Vi}
5836 {only available when compiled with the |+perl/dyn|
5837 feature}
5838 Specifies the name of the Perl shared library. The default is
5839 DYNAMIC_PERL_DLL, which was specified at compile time.
5840 Environment variables are expanded |:set_env|.
5841 This option cannot be set from a |modeline| or in the |sandbox|, for
5842 security reasons.
5843
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5845'preserveindent' 'pi' boolean (default off)
5846 local to buffer
5847 {not in Vi}
5848 When changing the indent of the current line, preserve as much of the
5849 indent structure as possible. Normally the indent is replaced by a
5850 series of tabs followed by spaces as required (unless |'expandtab'| is
5851 enabled, in which case only spaces are used). Enabling this option
5852 means the indent will preserve as many existing characters as possible
5853 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005854 'expandtab' does not apply to the preserved white space, a Tab remains
5855 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005856 NOTE: When using ">>" multiple times the resulting indent is a mix of
5857 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005858 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 Also see 'copyindent'.
5860 Use |:retab| to clean up white space.
5861
5862 *'previewheight'* *'pvh'*
5863'previewheight' 'pvh' number (default 12)
5864 global
5865 {not in Vi}
5866 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005867 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 Default height for a preview window. Used for |:ptag| and associated
5869 commands. Used for |CTRL-W_}| when no count is given.
5870
5871 *'previewwindow'* *'nopreviewwindow'*
5872 *'pvw'* *'nopvw'* *E590*
5873'previewwindow' 'pvw' boolean (default off)
5874 local to window
5875 {not in Vi}
5876 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005877 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005878 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 set. It's normally not set directly, but by using one of the commands
5880 |:ptag|, |:pedit|, etc.
5881
5882 *'printdevice'* *'pdev'*
5883'printdevice' 'pdev' string (default empty)
5884 global
5885 {not in Vi}
5886 {only available when compiled with the |+printer|
5887 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005888 The name of the printer to be used for |:hardcopy|.
5889 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005890 This option cannot be set from a |modeline| or in the |sandbox|, for
5891 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892
Bram Moolenaar8299df92004-07-10 09:47:34 +00005893 *'printencoding'* *'penc'*
5894'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 global
5896 {not in Vi}
5897 {only available when compiled with the |+printer|
5898 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005899 Sets the character encoding used when printing.
5900 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901
5902 *'printexpr'* *'pexpr'*
5903'printexpr' 'pexpr' String (default: see below)
5904 global
5905 {not in Vi}
5906 {only available when compiled with the |+printer|
5907 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005908 Expression used to print the PostScript produced with |:hardcopy|.
5909 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005912
Bram Moolenaar8299df92004-07-10 09:47:34 +00005913 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914'printfont' 'pfn' string (default "courier")
5915 global
5916 {not in Vi}
5917 {only available when compiled with the |+printer|
5918 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005919 The name of the font that will be used for |:hardcopy|.
5920 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921
5922 *'printheader'* *'pheader'*
5923'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5924 global
5925 {not in Vi}
5926 {only available when compiled with the |+printer|
5927 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005928 The format of the header produced in |:hardcopy| output.
5929 See |pheader-option|.
5930
5931 *'printmbcharset'* *'pmbcs'*
5932'printmbcharset' 'pmbcs' string (default "")
5933 global
5934 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005935 {only available when compiled with the |+printer|,
5936 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005937 The CJK character set to be used for CJK output from |:hardcopy|.
5938 See |pmbcs-option|.
5939
5940 *'printmbfont'* *'pmbfn'*
5941'printmbfont' 'pmbfn' string (default "")
5942 global
5943 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005944 {only available when compiled with the |+printer|,
5945 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005946 List of font names to be used for CJK output from |:hardcopy|.
5947 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948
5949 *'printoptions'* *'popt'*
5950'printoptions' 'popt' string (default "")
5951 global
5952 {not in Vi}
5953 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005954 List of items that control the format of the output of |:hardcopy|.
5955 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005957 *'prompt'* *'noprompt'*
5958'prompt' boolean (default on)
5959 global
5960 When on a ":" prompt is used in Ex mode.
5961
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005962 *'pumheight'* *'ph'*
5963'pumheight' 'ph' number (default 0)
5964 global
5965 {not available when compiled without the
5966 |+insert_expand| feature}
5967 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005968 Determines the maximum number of items to show in the popup menu for
5969 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005970 |ins-completion-menu|.
5971
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005972 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005973'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005974 global
5975 {not available when compiled without the
5976 |+insert_expand| feature}
5977 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005978 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005979 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005980
Bram Moolenaard94464e2015-11-02 15:28:18 +01005981 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005982'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005983 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005984 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005985 {only available when compiled with the |+python/dyn|
5986 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005987 Specifies the name of the Python 2.x shared library. The default is
5988 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005989 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005990 This option cannot be set from a |modeline| or in the |sandbox|, for
5991 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005992
Bram Moolenaar94073162018-01-31 21:49:05 +01005993 *'pythonhome'*
5994'pythonhome' string (default "")
5995 global
5996 {not in Vi}
5997 {only available when compiled with the |+python/dyn|
5998 feature}
5999 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6000 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6001 which was specified at compile time, will be used for the Python 2.x
6002 home directory.
6003 Environment variables are expanded |:set_env|.
6004 This option cannot be set from a |modeline| or in the |sandbox|, for
6005 security reasons.
6006
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006007 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006008'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006009 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006010 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006011 {only available when compiled with the |+python3/dyn|
6012 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006013 Specifies the name of the Python 3 shared library. The default is
6014 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006015 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006016 This option cannot be set from a |modeline| or in the |sandbox|, for
6017 security reasons.
6018
Bram Moolenaar94073162018-01-31 21:49:05 +01006019 *'pythonthreehome'*
6020'pythonthreehome' string (default "")
6021 global
6022 {not in Vi}
6023 {only available when compiled with the |+python3/dyn|
6024 feature}
6025 Specifies the name of the Python 3 home directory. When
6026 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6027 PYTHON3_HOME, which was specified at compile time, will be used for
6028 the Python 3 home directory.
6029 Environment variables are expanded |:set_env|.
6030 This option cannot be set from a |modeline| or in the |sandbox|, for
6031 security reasons.
6032
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006033 *'pyxversion'* *'pyx'*
6034'pyxversion' 'pyx' number (default depends on the build)
6035 global
6036 {not in Vi}
6037 {only available when compiled with the |+python| or
6038 the |+python3| feature}
6039 Specifies the python version used for pyx* functions and commands
6040 |python_x|. The default value is as follows:
6041
6042 Compiled with Default ~
6043 |+python| and |+python3| 0
6044 only |+python| 2
6045 only |+python3| 3
6046
6047 Available values are 0, 2 and 3.
6048 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6049 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6050 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6051 to 2 if Python 2 is available.
6052 See also: |has-pythonx|
6053
6054 If Vim is compiled with only |+python| or |+python3| setting
6055 'pyxversion' has no effect. The pyx* functions and commands are
6056 always the same as the compiled version.
6057
6058 This option cannot be set from a |modeline| or in the |sandbox|, for
6059 security reasons.
6060
Bram Moolenaar677ee682005-01-27 14:41:15 +00006061 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006062'quoteescape' 'qe' string (default "\")
6063 local to buffer
6064 {not in Vi}
6065 The characters that are used to escape quotes in a string. Used for
6066 objects like a', a" and a` |a'|.
6067 When one of the characters in this option is found inside a string,
6068 the following character will be skipped. The default value makes the
6069 text "foo\"bar\\" considered to be one string.
6070
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6072'readonly' 'ro' boolean (default off)
6073 local to buffer
6074 If on, writes fail unless you use a '!'. Protects you from
6075 accidentally overwriting a file. Default on when Vim is started
6076 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006077 When using ":w!" the 'readonly' option is reset for the current
6078 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006080 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006081 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006083 *'redrawtime'* *'rdt'*
6084'redrawtime' 'rdt' number (default 2000)
6085 global
6086 {not in Vi}
6087 {only available when compiled with the |+reltime|
6088 feature}
6089 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006090 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006091 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006092 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006093 matches will be highlighted.
6094 For syntax highlighting the time applies per window. When over the
6095 limit syntax highlighting is disabled until |CTRL-L| is used.
6096 This is used to avoid that Vim hangs when using a very complicated
6097 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006098
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006099 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006100'regexpengine' 're' number (default 0)
6101 global
6102 {not in Vi}
6103 This selects the default regexp engine. |two-engines|
6104 The possible values are:
6105 0 automatic selection
6106 1 old engine
6107 2 NFA engine
6108 Note that when using the NFA engine and the pattern contains something
6109 that is not supported the pattern will not match. This is only useful
6110 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006111 Using automatic selection enables Vim to switch the engine, if the
6112 default engine becomes too costly. E.g., when the NFA engine uses too
6113 many states. This should prevent Vim from hanging on a combination of
6114 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006115
Bram Moolenaar64486672010-05-16 15:46:46 +02006116 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6117'relativenumber' 'rnu' boolean (default off)
6118 local to window
6119 {not in Vi}
6120 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006121 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006122 precede some vertical motion commands (e.g. j k + -) with, without
6123 having to calculate it yourself. Especially useful in combination with
6124 other commands (e.g. y d c < > gq gw =).
6125 When the 'n' option is excluded from 'cpoptions' a wrapped
6126 line will not use the column of line numbers (this is the default when
6127 'compatible' isn't set).
6128 The 'numberwidth' option can be used to set the room used for the line
6129 number.
6130 When a long, wrapped line doesn't start with the first character, '-'
6131 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006132 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6133 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006134
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006135 The number in front of the cursor line also depends on the value of
6136 'number', see |number_relativenumber| for all combinations of the two
6137 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006138
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 *'remap'* *'noremap'*
6140'remap' boolean (default on)
6141 global
6142 Allows for mappings to work recursively. If you do not want this for
6143 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006144 NOTE: To avoid portability problems with Vim scripts, always keep
6145 this option at the default "on". Only switch it off when working with
6146 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006148 *'renderoptions'* *'rop'*
6149'renderoptions' 'rop' string (default: empty)
6150 global
6151 {not in Vi}
6152 {only available when compiled with GUI and DIRECTX on
6153 MS-Windows}
6154 Select a text renderer and set its options. The options depend on the
6155 renderer.
6156
6157 Syntax: >
6158 set rop=type:{renderer}(,{name}:{value})*
6159<
6160 Currently, only one optional renderer is available.
6161
6162 render behavior ~
6163 directx Vim will draw text using DirectX (DirectWrite). It makes
6164 drawn glyphs more beautiful than default GDI.
6165 It requires 'encoding' is "utf-8", and only works on
6166 MS-Windows Vista or newer version.
6167
6168 Options:
6169 name meaning type value ~
6170 gamma gamma float 1.0 - 2.2 (maybe)
6171 contrast enhancedContrast float (unknown)
6172 level clearTypeLevel float (unknown)
6173 geom pixelGeometry int 0 - 2 (see below)
6174 renmode renderingMode int 0 - 6 (see below)
6175 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006176 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006177
Bram Moolenaar92467d32017-12-05 13:22:16 +01006178 See this URL for detail (except for scrlines):
6179 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006180
6181 For geom: structure of a device pixel.
6182 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6183 1 - DWRITE_PIXEL_GEOMETRY_RGB
6184 2 - DWRITE_PIXEL_GEOMETRY_BGR
6185
6186 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006187 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006188
6189 For renmode: method of rendering glyphs.
6190 0 - DWRITE_RENDERING_MODE_DEFAULT
6191 1 - DWRITE_RENDERING_MODE_ALIASED
6192 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6193 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6194 4 - DWRITE_RENDERING_MODE_NATURAL
6195 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6196 6 - DWRITE_RENDERING_MODE_OUTLINE
6197
6198 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006199 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006200
6201 For taamode: antialiasing mode used for drawing text.
6202 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6203 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6204 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6205 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6206
6207 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006208 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6209
Bram Moolenaara338adc2018-01-31 20:51:47 +01006210 For scrlines:
6211 This was used for optimizing scrolling behavior, however this
6212 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006213
6214 Example: >
6215 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006216 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006217 set rop=type:directx
6218<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006219 If select a raster font (Courier, Terminal or FixedSys which
6220 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006221 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006222
6223 NOTE: It is known that some fonts and options combination
6224 causes trouble on drawing glyphs.
6225
Bram Moolenaar92467d32017-12-05 13:22:16 +01006226 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006227 special made fonts (True-Type fonts which includes only
6228 bitmap glyphs).
6229 - 'taamode:3' will not work with some vector fonts.
6230
6231 NOTE: With this option, you can display colored emoji
6232 (emoticon) in Windows 8.1 or later. To display colored emoji,
6233 there are some conditions which you should notice.
6234
6235 - If your font includes non-colored emoji already, it will
6236 be used.
6237 - If your font doesn't have emoji, the system chooses an
6238 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6239 will be used.
6240 - When this alternative font didn't have fixed width glyph,
6241 emoji might be rendered beyond the bounding box of drawing
6242 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006243
6244 Other render types are currently not supported.
6245
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246 *'report'*
6247'report' number (default 2)
6248 global
6249 Threshold for reporting number of lines changed. When the number of
6250 changed lines is more than 'report' a message will be given for most
6251 ":" commands. If you want it always, set 'report' to 0.
6252 For the ":substitute" command the number of substitutions is used
6253 instead of the number of lines.
6254
6255 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6256'restorescreen' 'rs' boolean (default on)
6257 global
6258 {not in Vi} {only in Windows 95/NT console version}
6259 When set, the screen contents is restored when exiting Vim. This also
6260 happens when executing external commands.
6261
6262 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6263 options in your .vimrc. To disable restoring:
6264 set t_ti= t_te=
6265 To enable restoring (for an xterm):
6266 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6267 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6268
6269 *'revins'* *'ri'* *'norevins'* *'nori'*
6270'revins' 'ri' boolean (default off)
6271 global
6272 {not in Vi}
6273 {only available when compiled with the |+rightleft|
6274 feature}
6275 Inserting characters in Insert mode will work backwards. See "typing
6276 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6277 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006278 NOTE: This option is reset when 'compatible' is set.
6279 This option is reset when 'paste' is set and restored when 'paste' is
6280 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281
6282 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6283'rightleft' 'rl' boolean (default off)
6284 local to window
6285 {not in Vi}
6286 {only available when compiled with the |+rightleft|
6287 feature}
6288 When on, display orientation becomes right-to-left, i.e., characters
6289 that are stored in the file appear from the right to the left.
6290 Using this option, it is possible to edit files for languages that
6291 are written from the right to the left such as Hebrew and Arabic.
6292 This option is per window, so it is possible to edit mixed files
6293 simultaneously, or to view the same file in both ways (this is
6294 useful whenever you have a mixed text file with both right-to-left
6295 and left-to-right strings so that both sets are displayed properly
6296 in different windows). Also see |rileft.txt|.
6297
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006298 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299'rightleftcmd' 'rlc' string (default "search")
6300 local to window
6301 {not in Vi}
6302 {only available when compiled with the |+rightleft|
6303 feature}
6304 Each word in this option enables the command line editing to work in
6305 right-to-left mode for a group of commands:
6306
6307 search "/" and "?" commands
6308
6309 This is useful for languages such as Hebrew, Arabic and Farsi.
6310 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6311
Bram Moolenaard94464e2015-11-02 15:28:18 +01006312 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006313'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006314 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006315 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006316 {only available when compiled with the |+ruby/dyn|
6317 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006318 Specifies the name of the Ruby shared library. The default is
6319 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006320 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006321 This option cannot be set from a |modeline| or in the |sandbox|, for
6322 security reasons.
6323
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006325'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006326 global
6327 {not in Vi}
6328 {not available when compiled without the
6329 |+cmdline_info| feature}
6330 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006331 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 text in the file is shown on the far right:
6333 Top first line is visible
6334 Bot last line is visible
6335 All first and last line are visible
6336 45% relative position in the file
6337 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006338 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006340 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 this option takes precedence over 'ruler' and 'rulerformat'
6342 If the number of characters displayed is different from the number of
6343 bytes in the text (e.g., for a TAB or a multi-byte character), both
6344 the text column (byte number) and the screen column are shown,
6345 separated with a dash.
6346 For an empty line "0-1" is shown.
6347 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006348 This option is reset when 'paste' is set and restored when 'paste' is
6349 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 If you don't want to see the ruler all the time but want to know where
6351 you are, use "g CTRL-G" |g_CTRL-G|.
6352 NOTE: This option is reset when 'compatible' is set.
6353
6354 *'rulerformat'* *'ruf'*
6355'rulerformat' 'ruf' string (default empty)
6356 global
6357 {not in Vi}
6358 {not available when compiled without the |+statusline|
6359 feature}
6360 When this option is not empty, it determines the content of the ruler
6361 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006362 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 The default ruler width is 17 characters. To make the ruler 15
6364 characters wide, put "%15(" at the start and "%)" at the end.
6365 Example: >
6366 :set rulerformat=%15(%c%V\ %p%%%)
6367<
6368 *'runtimepath'* *'rtp'* *vimfiles*
6369'runtimepath' 'rtp' string (default:
6370 Unix: "$HOME/.vim,
6371 $VIM/vimfiles,
6372 $VIMRUNTIME,
6373 $VIM/vimfiles/after,
6374 $HOME/.vim/after"
6375 Amiga: "home:vimfiles,
6376 $VIM/vimfiles,
6377 $VIMRUNTIME,
6378 $VIM/vimfiles/after,
6379 home:vimfiles/after"
6380 PC, OS/2: "$HOME/vimfiles,
6381 $VIM/vimfiles,
6382 $VIMRUNTIME,
6383 $VIM/vimfiles/after,
6384 $HOME/vimfiles/after"
6385 Macintosh: "$VIM:vimfiles,
6386 $VIMRUNTIME,
6387 $VIM:vimfiles:after"
6388 RISC-OS: "Choices:vimfiles,
6389 $VIMRUNTIME,
6390 Choices:vimfiles/after"
6391 VMS: "sys$login:vimfiles,
6392 $VIM/vimfiles,
6393 $VIMRUNTIME,
6394 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006395 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 global
6397 {not in Vi}
6398 This is a list of directories which will be searched for runtime
6399 files:
6400 filetype.vim filetypes by file name |new-filetype|
6401 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006402 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 colors/ color scheme files |:colorscheme|
6404 compiler/ compiler files |:compiler|
6405 doc/ documentation |write-local-help|
6406 ftplugin/ filetype plugins |write-filetype-plugin|
6407 indent/ indent scripts |indent-expression|
6408 keymap/ key mapping files |mbyte-keymap|
6409 lang/ menu translations |:menutrans|
6410 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006411 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 plugin/ plugin scripts |write-plugin|
6413 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006414 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 syntax/ syntax files |mysyntaxfile|
6416 tutor/ files for vimtutor |tutor|
6417
6418 And any other file searched for with the |:runtime| command.
6419
6420 The defaults for most systems are setup to search five locations:
6421 1. In your home directory, for your personal preferences.
6422 2. In a system-wide Vim directory, for preferences from the system
6423 administrator.
6424 3. In $VIMRUNTIME, for files distributed with Vim.
6425 *after-directory*
6426 4. In the "after" directory in the system-wide Vim directory. This is
6427 for the system administrator to overrule or add to the distributed
6428 defaults (rarely needed)
6429 5. In the "after" directory in your home directory. This is for
6430 personal preferences to overrule or add to the distributed defaults
6431 or system-wide settings (rarely needed).
6432
Bram Moolenaard0796902016-09-16 20:02:31 +02006433 More entries are added when using |packages|. If it gets very long
6434 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6435 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006436
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6438 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006439 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 wildcards.
6441 See |:runtime|.
6442 Example: >
6443 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6444< This will use the directory "~/vimruntime" first (containing your
6445 personal Vim runtime files), then "/mygroup/vim" (shared between a
6446 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6447 files).
6448 You probably should always include $VIMRUNTIME somewhere, to use the
6449 distributed runtime files. You can put a directory before $VIMRUNTIME
6450 to find files which replace a distributed runtime files. You can put
6451 a directory after $VIMRUNTIME to find files which add to distributed
6452 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006453 When Vim is started with |--clean| the home directory entries are not
6454 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 This option cannot be set from a |modeline| or in the |sandbox|, for
6456 security reasons.
6457
6458 *'scroll'* *'scr'*
6459'scroll' 'scr' number (default: half the window height)
6460 local to window
6461 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6462 set to half the number of lines in the window when the window size
6463 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006464 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6466 the number of screen lines instead of file lines, makes a difference
6467 when lines wrap}
6468
6469 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6470'scrollbind' 'scb' boolean (default off)
6471 local to window
6472 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 See also |scroll-binding|. When this option is set, the current
6474 window scrolls as other scrollbind windows (windows that also have
6475 this option set) scroll. This option is useful for viewing the
6476 differences between two versions of a file, see 'diff'.
6477 See |'scrollopt'| for options that determine how this option should be
6478 interpreted.
6479 This option is mostly reset when splitting a window to edit another
6480 file. This means that ":split | edit file" results in two windows
6481 with scroll-binding, but ":split file" does not.
6482
6483 *'scrolljump'* *'sj'*
6484'scrolljump' 'sj' number (default 1)
6485 global
6486 {not in Vi}
6487 Minimal number of lines to scroll when the cursor gets off the
6488 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6489 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006490 When set to a negative number from -1 to -100 this is used as the
6491 percentage of the window height. Thus -50 scrolls half the window
6492 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 NOTE: This option is set to 1 when 'compatible' is set.
6494
6495 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006496'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 global
6498 {not in Vi}
6499 Minimal number of screen lines to keep above and below the cursor.
6500 This will make some context visible around where you are working. If
6501 you set it to a very large value (999) the cursor line will always be
6502 in the middle of the window (except at the start or end of the file or
6503 when long lines wrap).
6504 For scrolling horizontally see 'sidescrolloff'.
6505 NOTE: This option is set to 0 when 'compatible' is set.
6506
6507 *'scrollopt'* *'sbo'*
6508'scrollopt' 'sbo' string (default "ver,jump")
6509 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 {not in Vi}
6511 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006512 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6513 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 The following words are available:
6515 ver Bind vertical scrolling for 'scrollbind' windows
6516 hor Bind horizontal scrolling for 'scrollbind' windows
6517 jump Applies to the offset between two windows for vertical
6518 scrolling. This offset is the difference in the first
6519 displayed line of the bound windows. When moving
6520 around in a window, another 'scrollbind' window may
6521 reach a position before the start or after the end of
6522 the buffer. The offset is not changed though, when
6523 moving back the 'scrollbind' window will try to scroll
6524 to the desired position when possible.
6525 When now making that window the current one, two
6526 things can be done with the relative offset:
6527 1. When "jump" is not included, the relative offset is
6528 adjusted for the scroll position in the new current
6529 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006530 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 2. When "jump" is included, the other windows are
6532 scrolled to keep the same relative offset. When
6533 going back to the other window, it still uses the
6534 same relative offset.
6535 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006536 When 'diff' mode is active there always is vertical scroll binding,
6537 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538
6539 *'sections'* *'sect'*
6540'sections' 'sect' string (default "SHNHH HUnhsh")
6541 global
6542 Specifies the nroff macros that separate sections. These are pairs of
6543 two letters (See |object-motions|). The default makes a section start
6544 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6545
6546 *'secure'* *'nosecure'* *E523*
6547'secure' boolean (default off)
6548 global
6549 {not in Vi}
6550 When on, ":autocmd", shell and write commands are not allowed in
6551 ".vimrc" and ".exrc" in the current directory and map commands are
6552 displayed. Switch it off only if you know that you will not run into
6553 problems, or when the 'exrc' option is off. On Unix this option is
6554 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006555 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 'secure' at the end of your ~/.vimrc then.
6557 This option cannot be set from a |modeline| or in the |sandbox|, for
6558 security reasons.
6559
6560 *'selection'* *'sel'*
6561'selection' 'sel' string (default "inclusive")
6562 global
6563 {not in Vi}
6564 This option defines the behavior of the selection. It is only used
6565 in Visual and Select mode.
6566 Possible values:
6567 value past line inclusive ~
6568 old no yes
6569 inclusive yes yes
6570 exclusive yes no
6571 "past line" means that the cursor is allowed to be positioned one
6572 character past the line.
6573 "inclusive" means that the last character of the selection is included
6574 in an operation. For example, when "x" is used to delete the
6575 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006576 When "old" is used and 'virtualedit' allows the cursor to move past
6577 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 Note that when "exclusive" is used and selecting from the end
6579 backwards, you cannot include the last character of a line, when
6580 starting in Normal mode and 'virtualedit' empty.
6581
6582 The 'selection' option is set by the |:behave| command.
6583
6584 *'selectmode'* *'slm'*
6585'selectmode' 'slm' string (default "")
6586 global
6587 {not in Vi}
6588 This is a comma separated list of words, which specifies when to start
6589 Select mode instead of Visual mode, when a selection is started.
6590 Possible values:
6591 mouse when using the mouse
6592 key when using shifted special keys
6593 cmd when using "v", "V" or CTRL-V
6594 See |Select-mode|.
6595 The 'selectmode' option is set by the |:behave| command.
6596
6597 *'sessionoptions'* *'ssop'*
6598'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006599 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 global
6601 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006602 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 feature}
6604 Changes the effect of the |:mksession| command. It is a comma
6605 separated list of words. Each word enables saving and restoring
6606 something:
6607 word save and restore ~
6608 blank empty windows
6609 buffers hidden and unloaded buffers, not just those in windows
6610 curdir the current directory
6611 folds manually created folds, opened/closed folds and local
6612 fold options
6613 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006614 and contain at least one lowercase letter. Only
6615 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 help the help window
6617 localoptions options and mappings local to a window or buffer (not
6618 global values for local options)
6619 options all options and mappings (also global values for local
6620 options)
6621 resize size of the Vim window: 'lines' and 'columns'
6622 sesdir the directory in which the session file is located
6623 will become the current directory (useful with
6624 projects accessed over a network from different
6625 systems)
6626 slash backslashes in file names replaced with forward
6627 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006628 tabpages all tab pages; without this only the current tab page
6629 is restored, so that you can make a session for each
6630 tab page separately
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006631 terminal include terminal windows where the command can be restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 unix with Unix end-of-line format (single <NL>), even when
6633 on Windows or DOS
6634 winpos position of the whole Vim window
6635 winsize window sizes
6636
6637 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006638 When neither "curdir" nor "sesdir" is included, file names are stored
6639 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 "slash" and "unix" are useful on Windows when sharing session files
6641 with Unix. The Unix version of Vim cannot source dos format scripts,
6642 but the Windows version of Vim can source unix format scripts.
6643
6644 *'shell'* *'sh'* *E91*
6645'shell' 'sh' string (default $SHELL or "sh",
6646 MS-DOS and Win32: "command.com" or
6647 "cmd.exe", OS/2: "cmd")
6648 global
6649 Name of the shell to use for ! and :! commands. When changing the
6650 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6651 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006652 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 See |option-backslash| about including spaces and backslashes.
6654 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006655
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006657 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6659< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006660 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006662 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006664 Example with escaped space (Vim will do this when initializing the
6665 option from $SHELL): >
6666 :set shell=/bin/with\\\ space/sh
6667< The resulting value of 'shell' is "/bin/with\ space/sh", two
6668 backslashes are consumed by `:set`.
6669
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 Under MS-Windows, when the executable ends in ".com" it must be
6671 included. Thus setting the shell to "command.com" or "4dos.com"
6672 works, but "command" and "4dos" do not work for all commands (e.g.,
6673 filtering).
6674 For unknown reasons, when using "4dos.com" the current directory is
6675 changed to "C:\". To avoid this set 'shell' like this: >
6676 :set shell=command.com\ /c\ 4dos
6677< This option cannot be set from a |modeline| or in the |sandbox|, for
6678 security reasons.
6679
6680 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006681'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006682 MS-DOS and Win32, when 'shell' does not
6683 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 global
6685 {not in Vi}
6686 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6687 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6688 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006689 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006690 On Unix it can have more than one flag. Each white space separated
6691 part is passed as an argument to the shell command.
6692 See |option-backslash| about including spaces and backslashes.
6693 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 This option cannot be set from a |modeline| or in the |sandbox|, for
6695 security reasons.
6696
6697 *'shellpipe'* *'sp'*
6698'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6699 global
6700 {not in Vi}
6701 {not available when compiled without the |+quickfix|
6702 feature}
6703 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006704 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 including spaces and backslashes.
6706 The name of the temporary file can be represented by "%s" if necessary
6707 (the file name is appended automatically if no %s appears in the value
6708 of this option).
6709 For the Amiga and MS-DOS the default is ">". The output is directly
6710 saved in a file and not echoed to the screen.
6711 For Unix the default it "| tee". The stdout of the compiler is saved
6712 in a file and echoed to the screen. If the 'shell' option is "csh" or
6713 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006714 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6715 default becomes "2>&1| tee". This means that stderr is also included.
6716 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6717 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 The initialization of this option is done after reading the ".vimrc"
6719 and the other initializations, so that when the 'shell' option is set
6720 there, the 'shellpipe' option changes automatically, unless it was
6721 explicitly set before.
6722 When 'shellpipe' is set to an empty string, no redirection of the
6723 ":make" output will be done. This is useful if you use a 'makeprg'
6724 that writes to 'makeef' by itself. If you want no piping, but do
6725 want to include the 'makeef', set 'shellpipe' to a single space.
6726 Don't forget to precede the space with a backslash: ":set sp=\ ".
6727 In the future pipes may be used for filtering and this option will
6728 become obsolete (at least for Unix).
6729 This option cannot be set from a |modeline| or in the |sandbox|, for
6730 security reasons.
6731
6732 *'shellquote'* *'shq'*
6733'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6734 contains "sh" somewhere: "\"")
6735 global
6736 {not in Vi}
6737 Quoting character(s), put around the command passed to the shell, for
6738 the "!" and ":!" commands. The redirection is kept outside of the
6739 quoting. See 'shellxquote' to include the redirection. It's
6740 probably not useful to set both options.
6741 This is an empty string by default. Only known to be useful for
6742 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6743 or bash, where it should be "\"". The default is adjusted according
6744 the value of 'shell', to reduce the need to set this option by the
6745 user. See |dos-shell|.
6746 This option cannot be set from a |modeline| or in the |sandbox|, for
6747 security reasons.
6748
6749 *'shellredir'* *'srr'*
6750'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6751 global
6752 {not in Vi}
6753 String to be used to put the output of a filter command in a temporary
6754 file. See also |:!|. See |option-backslash| about including spaces
6755 and backslashes.
6756 The name of the temporary file can be represented by "%s" if necessary
6757 (the file name is appended automatically if no %s appears in the value
6758 of this option).
6759 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6760 or "zsh" during initializations, the default becomes ">&". If the
6761 'shell' option is "sh", "ksh" or "bash" the default becomes
6762 ">%s 2>&1". This means that stderr is also included.
6763 For Win32, the Unix checks are done and additionally "cmd" is checked
6764 for, which makes the default ">%s 2>&1". Also, the same names with
6765 ".exe" appended are checked for.
6766 The initialization of this option is done after reading the ".vimrc"
6767 and the other initializations, so that when the 'shell' option is set
6768 there, the 'shellredir' option changes automatically unless it was
6769 explicitly set before.
6770 In the future pipes may be used for filtering and this option will
6771 become obsolete (at least for Unix).
6772 This option cannot be set from a |modeline| or in the |sandbox|, for
6773 security reasons.
6774
6775 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6776'shellslash' 'ssl' boolean (default off)
6777 global
6778 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6779 When set, a forward slash is used when expanding file names. This is
6780 useful when a Unix-like shell is used instead of command.com or
6781 cmd.exe. Backward slashes can still be typed, but they are changed to
6782 forward slashes by Vim.
6783 Note that setting or resetting this option has no effect for some
6784 existing file names, thus this option needs to be set before opening
6785 any file for best results. This might change in the future.
6786 'shellslash' only works when a backslash can be used as a path
6787 separator. To test if this is so use: >
6788 if exists('+shellslash')
6789<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006790 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6791'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6792 global
6793 {not in Vi}
6794 When on, use temp files for shell commands. When off use a pipe.
6795 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006796 Currently a pipe is only supported on Unix and MS-Windows 2K and
6797 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006798 :if has("filterpipe")
6799< The advantage of using a pipe is that nobody can read the temp file
6800 and the 'shell' command does not need to support redirection.
6801 The advantage of using a temp file is that the file type and encoding
6802 can be detected.
6803 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6804 |FilterWritePost| autocommands event are not triggered when
6805 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006806 The `system()` function does not respect this option and always uses
6807 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006808 NOTE: This option is set to the Vim default value when 'compatible'
6809 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006810
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 *'shelltype'* *'st'*
6812'shelltype' 'st' number (default 0)
6813 global
6814 {not in Vi} {only for the Amiga}
6815 On the Amiga this option influences the way how the commands work
6816 which use a shell.
6817 0 and 1: always use the shell
6818 2 and 3: use the shell only to filter lines
6819 4 and 5: use shell only for ':sh' command
6820 When not using the shell, the command is executed directly.
6821
6822 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6823 1 and 3: use "shell cmd" to start external commands
6824
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006825 *'shellxescape'* *'sxe'*
6826'shellxescape' 'sxe' string (default: "";
6827 for MS-DOS and MS-Windows: "\"&|<>()@^")
6828 global
6829 {not in Vi}
6830 When 'shellxquote' is set to "(" then the characters listed in this
6831 option will be escaped with a '^' character. This makes it possible
6832 to execute most external commands with cmd.exe.
6833
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 *'shellxquote'* *'sxq'*
6835'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006836 for Win32, when 'shell' is cmd.exe: "("
6837 for Win32, when 'shell' contains "sh"
6838 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 for Unix, when using system(): "\"")
6840 global
6841 {not in Vi}
6842 Quoting character(s), put around the command passed to the shell, for
6843 the "!" and ":!" commands. Includes the redirection. See
6844 'shellquote' to exclude the redirection. It's probably not useful
6845 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006846 When the value is '(' then ')' is appended. When the value is '"('
6847 then ')"' is appended.
6848 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006849 This is an empty string by default on most systems, but is known to be
6850 useful for on Win32 version, either for cmd.exe which automatically
6851 strips off the first and last quote on a command, or 3rd-party shells
6852 such as the MKS Korn Shell or bash, where it should be "\"". The
6853 default is adjusted according the value of 'shell', to reduce the need
6854 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 This option cannot be set from a |modeline| or in the |sandbox|, for
6856 security reasons.
6857
6858 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6859'shiftround' 'sr' boolean (default off)
6860 global
6861 {not in Vi}
6862 Round indent to multiple of 'shiftwidth'. Applies to > and <
6863 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6864 a multiple of 'shiftwidth' (this is Vi compatible).
6865 NOTE: This option is reset when 'compatible' is set.
6866
6867 *'shiftwidth'* *'sw'*
6868'shiftwidth' 'sw' number (default 8)
6869 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006870 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006872 When zero the 'ts' value will be used. Use the |shiftwidth()|
6873 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874
6875 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006876'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6877 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 global
6879 {not in Vi}
6880 This option helps to avoid all the |hit-enter| prompts caused by file
6881 messages, for example with CTRL-G, and to avoid some other messages.
6882 It is a list of flags:
6883 flag meaning when present ~
6884 f use "(3 of 5)" instead of "(file 3 of 5)"
6885 i use "[noeol]" instead of "[Incomplete last line]"
6886 l use "999L, 888C" instead of "999 lines, 888 characters"
6887 m use "[+]" instead of "[Modified]"
6888 n use "[New]" instead of "[New File]"
6889 r use "[RO]" instead of "[readonly]"
6890 w use "[w]" instead of "written" for file write message
6891 and "[a]" instead of "appended" for ':w >> file' command
6892 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6893 "[unix format]" and "[mac]" instead of "[mac format]".
6894 a all of the above abbreviations
6895
6896 o overwrite message for writing a file with subsequent message
6897 for reading a file (useful for ":wn" or when 'autowrite' on)
6898 O message for reading a file overwrites any previous message.
6899 Also for quickfix message (e.g., ":cn").
6900 s don't give "search hit BOTTOM, continuing at TOP" or "search
6901 hit TOP, continuing at BOTTOM" messages
6902 t truncate file message at the start if it is too long to fit
6903 on the command-line, "<" will appear in the left most column.
6904 Ignored in Ex mode.
6905 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006906 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 Ignored in Ex mode.
6908 W don't give "written" or "[w]" when writing a file
6909 A don't give the "ATTENTION" message when an existing swap file
6910 is found.
6911 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006912 c don't give |ins-completion-menu| messages. For example,
6913 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6914 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006915 q use "recording" instead of "recording @a"
6916 F don't give the file info when editing a file, like `:silent`
6917 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918
6919 This gives you the opportunity to avoid that a change between buffers
6920 requires you to hit <Enter>, but still gives as useful a message as
6921 possible for the space available. To get the whole message that you
6922 would have got with 'shm' empty, use ":file!"
6923 Useful values:
6924 shm= No abbreviation of message.
6925 shm=a Abbreviation, but no loss of information.
6926 shm=at Abbreviation, and truncate message when necessary.
6927
6928 NOTE: This option is set to the Vi default value when 'compatible' is
6929 set and to the Vim default value when 'compatible' is reset.
6930
6931 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6932'shortname' 'sn' boolean (default off)
6933 local to buffer
6934 {not in Vi, not in MS-DOS versions}
6935 Filenames are assumed to be 8 characters plus one extension of 3
6936 characters. Multiple dots in file names are not allowed. When this
6937 option is on, dots in file names are replaced with underscores when
6938 adding an extension (".~" or ".swp"). This option is not available
6939 for MS-DOS, because then it would always be on. This option is useful
6940 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6941 or crossdos. When running the Win32 GUI version under Win32s, this
6942 option is always on by default.
6943
6944 *'showbreak'* *'sbr'* *E595*
6945'showbreak' 'sbr' string (default "")
6946 global
6947 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006948 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 feature}
6950 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006951 values are "> " or "+++ ": >
6952 :set showbreak=>\
6953< Note the backslash to escape the trailing space. It's easier like
6954 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006955 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006956< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 comma (in a future version the comma might be used to separate the
6958 part that is shown at the end and at the start of a line).
6959 The characters are highlighted according to the '@' flag in
6960 'highlight'.
6961 Note that tabs after the showbreak will be displayed differently.
6962 If you want the 'showbreak' to appear in between line numbers, add the
6963 "n" flag to 'cpoptions'.
6964
6965 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006966'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6967 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 global
6969 {not in Vi}
6970 {not available when compiled without the
6971 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006972 Show (partial) command in the last line of the screen. Set this
6973 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 In Visual mode the size of the selected area is shown:
6975 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006976 If the number of bytes is different it is also displayed: "2-6"
6977 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006979 - When selecting a block, the size in screen characters:
6980 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 NOTE: This option is set to the Vi default value when 'compatible' is
6982 set and to the Vim default value when 'compatible' is reset.
6983
6984 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6985'showfulltag' 'sft' boolean (default off)
6986 global
6987 {not in Vi}
6988 When completing a word in insert mode (see |ins-completion|) from the
6989 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006990 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 matched a C function, you can see a template for what arguments are
6992 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006993 Note that this doesn't work well together with having "longest" in
6994 'completeopt', because the completion from the search pattern may not
6995 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996
6997 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6998'showmatch' 'sm' boolean (default off)
6999 global
7000 When a bracket is inserted, briefly jump to the matching one. The
7001 jump is only done if the match can be seen on the screen. The time to
7002 show the match can be set with 'matchtime'.
7003 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007004 seen or not).
7005 This option is reset when 'paste' is set and restored when 'paste' is
7006 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 When the 'm' flag is not included in 'cpoptions', typing a character
7008 will immediately move the cursor back to where it belongs.
7009 See the "sm" field in 'guicursor' for setting the cursor shape and
7010 blinking when showing the match.
7011 The 'matchpairs' option can be used to specify the characters to show
7012 matches for. 'rightleft' and 'revins' are used to look for opposite
7013 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007014 Also see the matchparen plugin for highlighting the match when moving
7015 around |pi_paren.txt|.
7016 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017
7018 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7019'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7020 global
7021 If in Insert, Replace or Visual mode put a message on the last line.
7022 Use the 'M' flag in 'highlight' to set the type of highlighting for
7023 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007024 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 doesn't mean XIM is really active, especially when 'imactivatekey' is
7026 not set.
7027 NOTE: This option is set to the Vi default value when 'compatible' is
7028 set and to the Vim default value when 'compatible' is reset.
7029
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007030 *'showtabline'* *'stal'*
7031'showtabline' 'stal' number (default 1)
7032 global
7033 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007034 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007035 feature}
7036 The value of this option specifies when the line with tab page labels
7037 will be displayed:
7038 0: never
7039 1: only if there are at least two tab pages
7040 2: always
7041 This is both for the GUI and non-GUI implementation of the tab pages
7042 line.
7043 See |tab-page| for more information about tab pages.
7044
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 *'sidescroll'* *'ss'*
7046'sidescroll' 'ss' number (default 0)
7047 global
7048 {not in Vi}
7049 The minimal number of columns to scroll horizontally. Used only when
7050 the 'wrap' option is off and the cursor is moved off of the screen.
7051 When it is zero the cursor will be put in the middle of the screen.
7052 When using a slow terminal set it to a large number or 0. When using
7053 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7054 commands.
7055
7056 *'sidescrolloff'* *'siso'*
7057'sidescrolloff' 'siso' number (default 0)
7058 global
7059 {not in Vi}
7060 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007061 right of the cursor if 'nowrap' is set. Setting this option to a
7062 value greater than 0 while having |'sidescroll'| also at a non-zero
7063 value makes some context visible in the line you are scrolling in
7064 horizontally (except at beginning of the line). Setting this option
7065 to a large value (like 999) has the effect of keeping the cursor
7066 horizontally centered in the window, as long as one does not come too
7067 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068 NOTE: This option is set to 0 when 'compatible' is set.
7069
7070 Example: Try this together with 'sidescroll' and 'listchars' as
7071 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007072 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073
7074 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7075 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007076<
7077 *'signcolumn'* *'scl'*
7078'signcolumn' 'scl' string (default "auto")
7079 local to window
7080 {not in Vi}
7081 {not available when compiled without the |+signs|
7082 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007083 Whether or not to draw the signcolumn. Valid values are:
7084 "auto" only when there is a sign to display
7085 "no" never
7086 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007087
7088
7089 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7090'smartcase' 'scs' boolean (default off)
7091 global
7092 {not in Vi}
7093 Override the 'ignorecase' option if the search pattern contains upper
7094 case characters. Only used when the search pattern is typed and
7095 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007096 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7098 recalling the search pattern from history and hitting <Enter>.
7099 NOTE: This option is reset when 'compatible' is set.
7100
7101 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7102'smartindent' 'si' boolean (default off)
7103 local to buffer
7104 {not in Vi}
7105 {not available when compiled without the
7106 |+smartindent| feature}
7107 Do smart autoindenting when starting a new line. Works for C-like
7108 programs, but can also be used for other languages. 'cindent' does
7109 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007110 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007111 setting 'si' has no effect. 'indentexpr' is a more advanced
7112 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 Normally 'autoindent' should also be on when using 'smartindent'.
7114 An indent is automatically inserted:
7115 - After a line ending in '{'.
7116 - After a line starting with a keyword from 'cinwords'.
7117 - Before a line starting with '}' (only with the "O" command).
7118 When typing '}' as the first character in a new line, that line is
7119 given the same indent as the matching '{'.
7120 When typing '#' as the first character in a new line, the indent for
7121 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007122 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7124 When using the ">>" command, lines starting with '#' are not shifted
7125 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007126 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007127 This option is reset when 'paste' is set and restored when 'paste' is
7128 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129
7130 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7131'smarttab' 'sta' boolean (default off)
7132 global
7133 {not in Vi}
7134 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007135 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7136 <BS> will delete a 'shiftwidth' worth of space at the start of the
7137 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007138 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007139 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7140 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007141 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007143 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007144 This option is reset when 'paste' is set and restored when 'paste' is
7145 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 NOTE: This option is reset when 'compatible' is set.
7147
7148 *'softtabstop'* *'sts'*
7149'softtabstop' 'sts' number (default 0)
7150 local to buffer
7151 {not in Vi}
7152 Number of spaces that a <Tab> counts for while performing editing
7153 operations, like inserting a <Tab> or using <BS>. It "feels" like
7154 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7155 used. This is useful to keep the 'ts' setting at its standard value
7156 of 8, while being able to edit like it is set to 'sts'. However,
7157 commands like "x" still work on the actual characters.
7158 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007159 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007160 'softtabstop' is set to 0 when the 'paste' option is set and restored
7161 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7163 spaces is minimized by using <Tab>s.
7164 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7165 set.
7166 NOTE: This option is set to 0 when 'compatible' is set.
7167
Bram Moolenaar217ad922005-03-20 22:37:15 +00007168 *'spell'* *'nospell'*
7169'spell' boolean (default off)
7170 local to window
7171 {not in Vi}
7172 {not available when compiled without the |+syntax|
7173 feature}
7174 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007175 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007176
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007177 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007178'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007179 local to buffer
7180 {not in Vi}
7181 {not available when compiled without the |+syntax|
7182 feature}
7183 Pattern to locate the end of a sentence. The following word will be
7184 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007185 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007186 When this check is not wanted make this option empty.
7187 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007188 Be careful with special characters, see |option-backslash| about
7189 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007190 To set this option automatically depending on the language, see
7191 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007192
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007193 *'spellfile'* *'spf'*
7194'spellfile' 'spf' string (default empty)
7195 local to buffer
7196 {not in Vi}
7197 {not available when compiled without the |+syntax|
7198 feature}
7199 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007200 commands. It must end in ".{encoding}.add". You need to include the
7201 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007202 *E765*
7203 It may also be a comma separated list of names. A count before the
7204 |zg| and |zw| commands can be used to access each. This allows using
7205 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007206 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007207 you: Using the first directory in 'runtimepath' that is writable. If
7208 there is no "spell" directory yet it will be created. For the file
7209 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007210 ignoring the region.
7211 The resulting ".spl" file will be used for spell checking, it does not
7212 have to appear in 'spelllang'.
7213 Normally one file is used for all regions, but you can add the region
7214 name if you want to. However, it will then only be used when
7215 'spellfile' is set to it, for entries in 'spelllang' only files
7216 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007217 This option cannot be set from a |modeline| or in the |sandbox|, for
7218 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007219
Bram Moolenaar217ad922005-03-20 22:37:15 +00007220 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007221'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007222 local to buffer
7223 {not in Vi}
7224 {not available when compiled without the |+syntax|
7225 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007226 A comma separated list of word list names. When the 'spell' option is
7227 on spellchecking will be done for these languages. Example: >
7228 set spelllang=en_us,nl,medical
7229< This means US English, Dutch and medical words are recognized. Words
7230 that are not recognized will be highlighted.
7231 The word list name must not include a comma or dot. Using a dash is
7232 recommended to separate the two letter language name from a
7233 specification. Thus "en-rare" is used for rare English words.
7234 A region name must come last and have the form "_xx", where "xx" is
7235 the two-letter, lower case region name. You can use more than one
7236 region by listing them: "en_us,en_ca" supports both US and Canadian
7237 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007238 Britain. (Note: currently en_au and en_nz dictionaries are older than
7239 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007240 If the name "cjk" is included East Asian characters are excluded from
7241 spell checking. This is useful when editing text that also has Asian
7242 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007243 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007244 As a special case the name of a .spl file can be given as-is. The
7245 first "_xx" in the name is removed and used as the region name
7246 (_xx is an underscore, two letters and followed by a non-letter).
7247 This is mainly for testing purposes. You must make sure the correct
7248 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007249 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007250 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7251 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007252 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007253
Bram Moolenaar98692072006-02-04 00:57:42 +00007254 If the |spellfile.vim| plugin is active and you use a language name
7255 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7256 will ask you if you want to download the file.
7257
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007258 After this option has been set successfully, Vim will source the files
7259 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007260 up to the first comma, dot or underscore.
7261 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007262
7263
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007264 *'spellsuggest'* *'sps'*
7265'spellsuggest' 'sps' string (default "best")
7266 global
7267 {not in Vi}
7268 {not available when compiled without the |+syntax|
7269 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007270 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007271 the |spellsuggest()| function. This is a comma-separated list of
7272 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007273
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007274 best Internal method that works best for English. Finds
7275 changes like "fast" and uses a bit of sound-a-like
7276 scoring to improve the ordering.
7277
7278 double Internal method that uses two methods and mixes the
7279 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007280 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007281 word. That only works when the language specifies
7282 sound folding. Can be slow and doesn't always give
7283 better results.
7284
7285 fast Internal method that only checks for simple changes:
7286 character inserts/deletes/swaps. Works well for
7287 simple typing mistakes.
7288
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007289 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007290 Not used for |spellsuggest()|. The number of
7291 suggestions is never more than the value of 'lines'
7292 minus two.
7293
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007294 file:{filename} Read file {filename}, which must have two columns,
7295 separated by a slash. The first column contains the
7296 bad word, the second column the suggested good word.
7297 Example:
7298 theribal/terrible ~
7299 Use this for common mistakes that do not appear at the
7300 top of the suggestion list with the internal methods.
7301 Lines without a slash are ignored, use this for
7302 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007303 The word in the second column must be correct,
7304 otherwise it will not be used. Add the word to an
7305 ".add" file if it is currently flagged as a spelling
7306 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007307 The file is used for all languages.
7308
7309 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7310 trouble with spaces. |v:val| holds the badly spelled
7311 word. The expression must evaluate to a List of
7312 Lists, each with a suggestion and a score.
7313 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007314 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007315 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007316 internal methods use. A lower score is better.
7317 This may invoke |spellsuggest()| if you temporarily
7318 set 'spellsuggest' to exclude the "expr:" part.
7319 Errors are silently ignored, unless you set the
7320 'verbose' option to a non-zero value.
7321
7322 Only one of "best", "double" or "fast" may be used. The others may
7323 appear several times in any order. Example: >
7324 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7325<
7326 This option cannot be set from a |modeline| or in the |sandbox|, for
7327 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007328
7329
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7331'splitbelow' 'sb' boolean (default off)
7332 global
7333 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007334 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 feature}
7336 When on, splitting a window will put the new window below the current
7337 one. |:split|
7338
7339 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7340'splitright' 'spr' boolean (default off)
7341 global
7342 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007343 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 feature}
7345 When on, splitting a window will put the new window right of the
7346 current one. |:vsplit|
7347
7348 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7349'startofline' 'sol' boolean (default on)
7350 global
7351 {not in Vi}
7352 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007353 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007354 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007355 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 with a linewise operator, with "%" with a count and to buffer changing
7357 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7358 only has a line number, e.g., ":25" or ":+".
7359 In case of buffer changing commands the cursor is placed at the column
7360 where it was the last time the buffer was edited.
7361 NOTE: This option is set when 'compatible' is set.
7362
Bram Moolenaar00654022011-02-25 14:42:19 +01007363 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007365 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 {not in Vi}
7367 {not available when compiled without the |+statusline|
7368 feature}
7369 When nonempty, this option determines the content of the status line.
7370 Also see |status-line|.
7371
7372 The option consists of printf style '%' items interspersed with
7373 normal text. Each status line item is of the form:
7374 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007375 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007376 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377
Bram Moolenaar238a5642006-02-21 22:12:05 +00007378 When the option starts with "%!" then it is used as an expression,
7379 evaluated and the result is used as the option value. Example: >
7380 :set statusline=%!MyStatusLine()
7381< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007382 Note that the "%!" expression is evaluated in the context of the
7383 current window and buffer, while %{} items are evaluated in the
7384 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007385
7386 When there is error while evaluating the option then it will be made
7387 empty to avoid further errors. Otherwise screen updating would loop.
7388
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 Note that the only effect of 'ruler' when this option is set (and
7390 'laststatus' is 2) is controlling the output of |CTRL-G|.
7391
7392 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007393 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007395 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 minwid Minimum width of the item, padding as set by '-' & '0'.
7397 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007398 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 on the left for text items. Numeric items will be
7400 shifted down to maxwid-2 digits followed by '>'number
7401 where number is the amount of missing digits, much like
7402 an exponential notation.
7403 item A one letter code as described below.
7404
7405 Following is a description of the possible statusline items. The
7406 second character in "item" is the type:
7407 N for number
7408 S for string
7409 F for flags as described below
7410 - not applicable
7411
7412 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007413 f S Path to the file in the buffer, as typed or relative to current
7414 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 F S Full path to the file in the buffer.
7416 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007417 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007419 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007421 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007423 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007425 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007427 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7429 being used: "<keymap>"
7430 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007431 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 B N As above, in hexadecimal.
7433 o N Byte number in file of byte under cursor, first byte is 1.
7434 Mnemonic: Offset from start of file (with one added)
7435 {not available when compiled without |+byte_offset| feature}
7436 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007437 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 l N Line number.
7439 L N Number of lines in buffer.
7440 c N Column number.
7441 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007442 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 p N Percentage through file in lines as in |CTRL-G|.
7444 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007445 percentage described for 'ruler'. Always 3 in length, unless
7446 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007447 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007449 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007450 Note that there is no '%' before the closing '}'. The
7451 expression cannot contain a '}' character, call a function to
7452 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007453 ( - Start of item group. Can be used for setting the width and
7454 alignment of a section. Must be followed by %) somewhere.
7455 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007456 T N For 'tabline': start of tab page N label. Use %T after the last
7457 label. This information is used for mouse clicks.
7458 X N For 'tabline': start of close tab N label. Use %X after the
7459 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7460 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 < - Where to truncate line if too long. Default is at the start.
7462 No width fields allowed.
7463 = - Separation point between left and right aligned items.
7464 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007465 # - Set highlight group. The name must follow and then a # again.
7466 Thus use %#HLname# for highlight group HLname. The same
7467 highlighting is used, also for the statusline of non-current
7468 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007470 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 The difference between User{N} and StatusLine will be applied
7472 to StatusLineNC for the statusline of non-current windows.
7473 The number N must be between 1 and 9. See |hl-User1..9|
7474
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007475 When displaying a flag, Vim removes the leading comma, if any, when
7476 that flag comes right after plaintext. This will make a nice display
7477 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478
Bram Moolenaar582fd852005-03-28 20:58:01 +00007479 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 not set) and a minwid is not set for the group, the whole group will
7481 become empty. This will make a group like the following disappear
7482 completely from the statusline when none of the flags are set. >
7483 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007484< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 Beware that an expression is evaluated each and every time the status
7486 line is displayed. The current buffer and current window will be set
7487 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007488 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007490 real current buffer.
7491
Bram Moolenaar30b65812012-07-12 22:01:11 +02007492 The 'statusline' option will be evaluated in the |sandbox| if set from
7493 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007494
7495 It is not allowed to change text or jump to another window while
7496 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497
7498 If the statusline is not updated when you want it (e.g., after setting
7499 a variable that's used in an expression), you can force an update by
7500 setting an option without changing its value. Example: >
7501 :let &ro = &ro
7502
7503< A result of all digits is regarded a number for display purposes.
7504 Otherwise the result is taken as flag text and applied to the rules
7505 described above.
7506
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007507 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007509 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510
7511 Examples:
7512 Emulate standard status line with 'ruler' set >
7513 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7514< Similar, but add ASCII value of char under the cursor (like "ga") >
7515 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7516< Display byte count and byte value, modified flag in red. >
7517 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7518 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7519< Display a ,GZ flag if a compressed file is loaded >
7520 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7521< In the |:autocmd|'s: >
7522 :let b:gzflag = 1
7523< And: >
7524 :unlet b:gzflag
7525< And define this function: >
7526 :function VarExists(var, val)
7527 : if exists(a:var) | return a:val | else | return '' | endif
7528 :endfunction
7529<
7530 *'suffixes'* *'su'*
7531'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7532 global
7533 {not in Vi}
7534 Files with these suffixes get a lower priority when multiple files
7535 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007536 suffixes. Spaces after the comma are ignored. A dot is also seen as
7537 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 separator, precede it with a backslash (see |option-backslash| about
7539 including spaces and backslashes).
7540 See 'wildignore' for completely ignoring files.
7541 The use of |:set+=| and |:set-=| is preferred when adding or removing
7542 suffixes from the list. This avoids problems when a future version
7543 uses another default.
7544
7545 *'suffixesadd'* *'sua'*
7546'suffixesadd' 'sua' string (default "")
7547 local to buffer
7548 {not in Vi}
7549 {not available when compiled without the
7550 |+file_in_path| feature}
7551 Comma separated list of suffixes, which are used when searching for a
7552 file for the "gf", "[I", etc. commands. Example: >
7553 :set suffixesadd=.java
7554<
7555 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7556'swapfile' 'swf' boolean (default on)
7557 local to buffer
7558 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007559 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 swapfile is not wanted for a specific buffer. For example, with
7561 confidential information that even root must not be able to access.
7562 Careful: All text will be in memory:
7563 - Don't use this for big files.
7564 - Recovery will be impossible!
7565 A swapfile will only be present when |'updatecount'| is non-zero and
7566 'swapfile' is set.
7567 When 'swapfile' is reset, the swap file for the current buffer is
7568 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7569 non-zero, a swap file is immediately created.
7570 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007571 If you want to open a new buffer without creating a swap file for it,
7572 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007573 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574
7575 This option is used together with 'bufhidden' and 'buftype' to
7576 specify special kinds of buffers. See |special-buffers|.
7577
7578 *'swapsync'* *'sws'*
7579'swapsync' 'sws' string (default "fsync")
7580 global
7581 {not in Vi}
7582 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007583 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 When this option is empty parts of the swap file may be in memory and
7585 not written to disk. When the system crashes you may lose more work.
7586 On Unix the system does a sync now and then without Vim asking for it,
7587 so the disadvantage of setting this option off is small. On some
7588 systems the swap file will not be written at all. For a unix system
7589 setting it to "sync" will use the sync() call instead of the default
7590 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007591 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592
7593 *'switchbuf'* *'swb'*
7594'switchbuf' 'swb' string (default "")
7595 global
7596 {not in Vi}
7597 This option controls the behavior when switching between buffers.
7598 Possible values (comma separated list):
7599 useopen If included, jump to the first open window that
7600 contains the specified buffer (if there is one).
7601 Otherwise: Do not examine other windows.
7602 This setting is checked with |quickfix| commands, when
7603 jumping to errors (":cc", ":cn", "cp", etc.). It is
7604 also used in all buffer related split commands, for
7605 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007606 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007607 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007609 a buffer for a |quickfix| command that display errors.
7610 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007611 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007612 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007613 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007615 *'synmaxcol'* *'smc'*
7616'synmaxcol' 'smc' number (default 3000)
7617 local to buffer
7618 {not in Vi}
7619 {not available when compiled without the |+syntax|
7620 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007621 Maximum column in which to search for syntax items. In long lines the
7622 text after this column is not highlighted and following lines may not
7623 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007624 This helps to avoid very slow redrawing for an XML file that is one
7625 long line.
7626 Set to zero to remove the limit.
7627
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 *'syntax'* *'syn'*
7629'syntax' 'syn' string (default empty)
7630 local to buffer
7631 {not in Vi}
7632 {not available when compiled without the |+syntax|
7633 feature}
7634 When this option is set, the syntax with this name is loaded, unless
7635 syntax highlighting has been switched off with ":syntax off".
7636 Otherwise this option does not always reflect the current syntax (the
7637 b:current_syntax variable does).
7638 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007639 not automatically recognized. Example, in an IDL file:
7640 /* vim: set syntax=idl : */ ~
7641 When a dot appears in the value then this separates two filetype
7642 names. Example:
7643 /* vim: set syntax=c.doxygen : */ ~
7644 This will use the "c" syntax first, then the "doxygen" syntax.
7645 Note that the second one must be prepared to be loaded as an addition,
7646 otherwise it will be skipped. More than one dot may appear.
7647 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 :set syntax=OFF
7649< To switch syntax highlighting on according to the current value of the
7650 'filetype' option: >
7651 :set syntax=ON
7652< What actually happens when setting the 'syntax' option is that the
7653 Syntax autocommand event is triggered with the value as argument.
7654 This option is not copied to another buffer, independent of the 's' or
7655 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007656 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007658 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007659'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007660 global
7661 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007662 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007663 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007664 When nonempty, this option determines the content of the tab pages
7665 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007666 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007667
7668 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007669 option and only when there is no GUI tab line. When 'e' is in
7670 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007671 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007672
7673 The value is evaluated like with 'statusline'. You can use
7674 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007675 the text to be displayed. Use "%1T" for the first label, "%2T" for
7676 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007677
7678 Keep in mind that only one of the tab pages is the current one, others
7679 are invisible and you can't jump to their windows.
7680
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007681
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007682 *'tabpagemax'* *'tpm'*
7683'tabpagemax' 'tpm' number (default 10)
7684 global
7685 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007686 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007687 feature}
7688 Maximum number of tab pages to be opened by the |-p| command line
7689 argument or the ":tab all" command. |tabpage|
7690
7691
7692 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693'tabstop' 'ts' number (default 8)
7694 local to buffer
7695 Number of spaces that a <Tab> in the file counts for. Also see
7696 |:retab| command, and 'softtabstop' option.
7697
7698 Note: Setting 'tabstop' to any other value than 8 can make your file
7699 appear wrong in many places (e.g., when printing it).
7700
7701 There are four main ways to use tabs in Vim:
7702 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7703 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007704 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 behave like a tab appears every 4 (or 3) characters.
7706 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7707 'expandtab'. This way you will always insert spaces. The
7708 formatting will never be messed up when 'tabstop' is changed.
7709 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007710 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 works when using Vim to edit the file.
7712 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7713 'noexpandtab'. This should then work (for initial indents only)
7714 for any tabstop setting that people use. It might be nice to have
7715 tabs after the first non-blank inserted as spaces if you do this
7716 though. Otherwise aligned comments will be wrong when 'tabstop' is
7717 changed.
7718
7719 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7720'tagbsearch' 'tbs' boolean (default on)
7721 global
7722 {not in Vi}
7723 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007724 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 searching makes searching for a tag a LOT faster, but a linear search
7726 will find more tags if the tags file wasn't properly sorted.
7727 Vim normally assumes that your tags files are sorted, or indicate that
7728 they are not sorted. Only when this is not the case does the
7729 'tagbsearch' option need to be switched off.
7730
7731 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007732 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 certain files, or retry all files with a linear search. When
7734 'tagbsearch' is off, only a linear search is done.
7735
7736 Linear searching is done anyway, for one file, when Vim finds a line
7737 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007738 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739< [The whitespace before and after the '0' must be a single <Tab>]
7740
7741 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007742 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 instead of a normal tag name, a retry is done with a linear search.
7744 Tags in unsorted tags files, and matches with different case will only
7745 be found in the retry.
7746
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007747 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007748 linear search can be avoided when case is ignored. Use a value of '2'
7749 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7750 sorted with the -f switch to "sort" in most unices, as in the command:
7751 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7752 (at least 5.5) the --sort=foldcase switch can be used for this as
7753 well. Note that case must be folded to uppercase for this to work.
7754
7755 By default, tag searches are case-sensitive. Case is ignored when
7756 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7757 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007758 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7759 'tagcase' is "smart", and the pattern contains only lowercase
7760 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761
7762 When 'tagbsearch' is off, tags searching is slower when a full match
7763 exists, but faster when no full match exists. Tags in unsorted tags
7764 files may only be found with 'tagbsearch' off.
7765 When the tags file is not sorted, or sorted in a wrong way (not on
7766 ASCII byte value), 'tagbsearch' should be off, or the line given above
7767 must be included in the tags file.
7768 This option doesn't affect commands that find all matching tags (e.g.,
7769 command-line completion and ":help").
7770 {Vi: always uses binary search in some versions}
7771
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007772 *'tagcase'* *'tc'*
7773'tagcase' 'tc' string (default "followic")
7774 global or local to buffer |global-local|
7775 {not in Vi}
7776 This option specifies how case is handled when searching the tags
7777 file:
7778 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007779 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007780 ignore Ignore case
7781 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007782 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007783 NOTE: This option is set to the Vi default value when 'compatible' is
7784 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007785
Bram Moolenaar071d4272004-06-13 20:20:40 +00007786 *'taglength'* *'tl'*
7787'taglength' 'tl' number (default 0)
7788 global
7789 If non-zero, tags are significant up to this number of characters.
7790
7791 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7792'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7793 global
7794 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007795 If on and using a tags file in another directory, file names in that
7796 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 NOTE: This option is set to the Vi default value when 'compatible' is
7798 set and to the Vim default value when 'compatible' is reset.
7799
7800 *'tags'* *'tag'* *E433*
7801'tags' 'tag' string (default "./tags,tags", when compiled with
7802 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7803 global or local to buffer |global-local|
7804 Filenames for the tag command, separated by spaces or commas. To
7805 include a space or comma in a file name, precede it with a backslash
7806 (see |option-backslash| about including spaces and backslashes).
7807 When a file name starts with "./", the '.' is replaced with the path
7808 of the current file. But only when the 'd' flag is not included in
7809 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7810 |tags-option|.
7811 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007812 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7813 find all files named "tags" below "/lib". The filename itself cannot
7814 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7815 files called "tags?". {not available when compiled without the
7816 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007817 The |tagfiles()| function can be used to get a list of the file names
7818 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7820 files are also supported. They are automatically recognized. The
7821 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7822 differences are ignored (MS-Windows). |emacs-tags|
7823 The use of |:set+=| and |:set-=| is preferred when adding or removing
7824 file names from the list. This avoids problems when a future version
7825 uses another default.
7826 {Vi: default is "tags /usr/lib/tags"}
7827
7828 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7829'tagstack' 'tgst' boolean (default on)
7830 global
7831 {not in all versions of Vi}
7832 When on, the |tagstack| is used normally. When off, a ":tag" or
7833 ":tselect" command with an argument will not push the tag onto the
7834 tagstack. A following ":tag" without an argument, a ":pop" command or
7835 any other command that uses the tagstack will use the unmodified
7836 tagstack, but does change the pointer to the active entry.
7837 Resetting this option is useful when using a ":tag" command in a
7838 mapping which should not change the tagstack.
7839
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007840 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007841'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007842 global
7843 {not in Vi}
7844 {only available when compiled with the |+tcl/dyn|
7845 feature}
7846 Specifies the name of the Tcl shared library. The default is
7847 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007848 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007849 This option cannot be set from a |modeline| or in the |sandbox|, for
7850 security reasons.
7851
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 *'term'* *E529* *E530* *E531*
7853'term' string (default is $TERM, if that fails:
7854 in the GUI: "builtin_gui"
7855 on Amiga: "amiga"
7856 on BeOS: "beos-ansi"
7857 on Mac: "mac-ansi"
7858 on MiNT: "vt52"
7859 on MS-DOS: "pcterm"
7860 on OS/2: "os2ansi"
7861 on Unix: "ansi"
7862 on VMS: "ansi"
7863 on Win 32: "win32")
7864 global
7865 Name of the terminal. Used for choosing the terminal control
7866 characters. Environment variables are expanded |:set_env|.
7867 For example: >
7868 :set term=$TERM
7869< See |termcap|.
7870
7871 *'termbidi'* *'tbidi'*
7872 *'notermbidi'* *'notbidi'*
7873'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7874 global
7875 {not in Vi}
7876 {only available when compiled with the |+arabic|
7877 feature}
7878 The terminal is in charge of Bi-directionality of text (as specified
7879 by Unicode). The terminal is also expected to do the required shaping
7880 that some languages (such as Arabic) require.
7881 Setting this option implies that 'rightleft' will not be set when
7882 'arabic' is set and the value of 'arabicshape' will be ignored.
7883 Note that setting 'termbidi' has the immediate effect that
7884 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7885 This option is reset when the GUI is started.
7886 For further details see |arabic.txt|.
7887
7888 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007889'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 Macintosh GUI: "macroman")
7891 global
7892 {only available when compiled with the |+multi_byte|
7893 feature}
7894 {not in Vi}
7895 Encoding used for the terminal. This specifies what character
7896 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007897 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007898 display). Except for the Mac when 'macatsui' is off, then
7899 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007901 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7903 Any attempts to set a different value will be rejected, and an error
7904 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007905 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 because the Win32 system always passes Unicode characters.
7907 When empty, the same encoding is used as for the 'encoding' option.
7908 This is the normal value.
7909 Not all combinations for 'termencoding' and 'encoding' are valid. See
7910 |encoding-table|.
7911 The value for this option must be supported by internal conversions or
7912 iconv(). When this is not possible no conversion will be done and you
7913 will probably experience problems with non-ASCII characters.
7914 Example: You are working with the locale set to euc-jp (Japanese) and
7915 want to edit a UTF-8 file: >
7916 :let &termencoding = &encoding
7917 :set encoding=utf-8
7918< You need to do this when your system has no locale support for UTF-8.
7919
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007920 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007921'termguicolors' 'tgc' boolean (default off)
7922 global
7923 {not in Vi}
7924 {not available when compiled without the
7925 |+termguicolors| feature}
7926 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007927 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007928
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007929 Requires a ISO-8613-3 compatible terminal. If setting this option
7930 does not work (produces a colorless UI) reading |xterm-true-color|
7931 might help.
7932
7933 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7934 is required. Use this check to find out: >
7935 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007936< This requires Vim to be built with the |+vtp| feature.
7937
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007938 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007939 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007940
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007941 *'termwinscroll'* *'twsl'*
7942'termwinscroll' 'twsl' number (default 10000)
7943 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02007944 {not in Vi}
7945 {not available when compiled without the
7946 |+terminal| feature}
7947 Number of scrollback lines to keep. When going over this limit the
7948 first 10% of the scrollback lines are deleted. This is just to reduce
7949 the memory usage. See |Terminal-Normal|.
7950
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007951 *'termwinkey'* *'twk'*
7952'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007953 local to window
7954 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007955 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007956 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007957 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007958 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007959< The string must be one key stroke but can be multiple bytes.
7960 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007961 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007962 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007963
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007964 *'termwinsize'* *'tws'*
7965'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007966 local to window
7967 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02007968 Size of the |terminal| window. Format: {rows}x{columns} or
7969 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007970 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007971 - When set with a "x" (e.g., "24x80") the terminal size is not
7972 adjusted to the window size. If the window is smaller only the
7973 top-left part is displayed.
7974 - When set with a "*" (e.g., "10*50") the terminal size follows the
7975 window size, but will not be smaller than the specified rows and/or
7976 columns.
7977 - When rows is zero then use the height of the window.
7978 - When columns is zero then use the width of the window.
7979 - Using "0x0" or "0*0" is the same as empty.
7980
7981 Examples:
7982 "30x0" uses 30 rows and the current window width.
7983 "20*0" uses at least 20 rows and the current window width.
7984 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007985 Note that the command running in the terminal window may still change
7986 the size of the terminal. In that case the Vim window will be
7987 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007988
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 *'terse'* *'noterse'*
7990'terse' boolean (default off)
7991 global
7992 When set: Add 's' flag to 'shortmess' option (this makes the message
7993 for a search that hits the start or end of the file not being
7994 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7995 shortens a lot of messages}
7996
7997 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7998'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7999 global
8000 {not in Vi}
8001 This option is obsolete. Use 'fileformats'.
8002 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8003 set to the default value for the current system. When 'textauto' is
8004 reset, 'fileformats' is made empty.
8005 NOTE: This option is set to the Vi default value when 'compatible' is
8006 set and to the Vim default value when 'compatible' is reset.
8007
8008 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8009'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8010 others: default off)
8011 local to buffer
8012 {not in Vi}
8013 This option is obsolete. Use 'fileformat'.
8014 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8015 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8016 "unix".
8017
8018 *'textwidth'* *'tw'*
8019'textwidth' 'tw' number (default 0)
8020 local to buffer
8021 {not in Vi}
8022 Maximum width of text that is being inserted. A longer line will be
8023 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008024 this.
8025 'textwidth' is set to 0 when the 'paste' option is set and restored
8026 when 'paste' is reset.
8027 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008029 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 NOTE: This option is set to 0 when 'compatible' is set.
8031
8032 *'thesaurus'* *'tsr'*
8033'thesaurus' 'tsr' string (default "")
8034 global or local to buffer |global-local|
8035 {not in Vi}
8036 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008037 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 the file should contain words with similar meaning, separated by
8039 non-keyword characters (white space is preferred). Maximum line
8040 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008041 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008042 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008043 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008044 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 after a comma are ignored, otherwise spaces are included in the file
8046 name. See |option-backslash| about using backslashes.
8047 The use of |:set+=| and |:set-=| is preferred when adding or removing
8048 directories from the list. This avoids problems when a future version
8049 uses another default.
8050 Backticks cannot be used in this option for security reasons.
8051
8052 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8053'tildeop' 'top' boolean (default off)
8054 global
8055 {not in Vi}
8056 When on: The tilde command "~" behaves like an operator.
8057 NOTE: This option is reset when 'compatible' is set.
8058
8059 *'timeout'* *'to'* *'notimeout'* *'noto'*
8060'timeout' 'to' boolean (default on)
8061 global
8062 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008063'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 global
8065 {not in Vi}
8066 These two options together determine the behavior when part of a
8067 mapped key sequence or keyboard code has been received:
8068
8069 'timeout' 'ttimeout' action ~
8070 off off do not time out
8071 on on or off time out on :mappings and key codes
8072 off on time out on key codes
8073
8074 If both options are off, Vim will wait until either the complete
8075 mapping or key sequence has been received, or it is clear that there
8076 is no mapping or key sequence for the received characters. For
8077 example: if you have mapped "vl" and Vim has received 'v', the next
8078 character is needed to see if the 'v' is followed by an 'l'.
8079 When one of the options is on, Vim will wait for about 1 second for
8080 the next character to arrive. After that the already received
8081 characters are interpreted as single characters. The waiting time can
8082 be changed with the 'timeoutlen' option.
8083 On slow terminals or very busy systems timing out may cause
8084 malfunctioning cursor keys. If both options are off, Vim waits
8085 forever after an entered <Esc> if there are key codes that start
8086 with <Esc>. You will have to type <Esc> twice. If you do not have
8087 problems with key codes, but would like to have :mapped key
8088 sequences not timing out in 1 second, set the 'ttimeout' option and
8089 reset the 'timeout' option.
8090
8091 NOTE: 'ttimeout' is reset when 'compatible' is set.
8092
8093 *'timeoutlen'* *'tm'*
8094'timeoutlen' 'tm' number (default 1000)
8095 global
8096 {not in all versions of Vi}
8097 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008098'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 global
8100 {not in Vi}
8101 The time in milliseconds that is waited for a key code or mapped key
8102 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8103 when part of a command has been typed.
8104 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8105 different timeout value for key codes is desired set 'ttimeoutlen' to
8106 a non-negative number.
8107
8108 ttimeoutlen mapping delay key code delay ~
8109 < 0 'timeoutlen' 'timeoutlen'
8110 >= 0 'timeoutlen' 'ttimeoutlen'
8111
8112 The timeout only happens when the 'timeout' and 'ttimeout' options
8113 tell so. A useful setting would be >
8114 :set timeout timeoutlen=3000 ttimeoutlen=100
8115< (time out on mapping after three seconds, time out on key codes after
8116 a tenth of a second).
8117
8118 *'title'* *'notitle'*
8119'title' boolean (default off, on when title can be restored)
8120 global
8121 {not in Vi}
8122 {not available when compiled without the |+title|
8123 feature}
8124 When on, the title of the window will be set to the value of
8125 'titlestring' (if it is not empty), or to:
8126 filename [+=-] (path) - VIM
8127 Where:
8128 filename the name of the file being edited
8129 - indicates the file cannot be modified, 'ma' off
8130 + indicates the file was modified
8131 = indicates the file is read-only
8132 =+ indicates the file is read-only and modified
8133 (path) is the path of the file being edited
8134 - VIM the server name |v:servername| or "VIM"
8135 Only works if the terminal supports setting window titles
8136 (currently Amiga console, Win32 console, all GUI versions and
8137 terminals with a non- empty 't_ts' option - these are Unix xterm and
8138 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8139 *X11*
8140 When Vim was compiled with HAVE_X11 defined, the original title will
8141 be restored if possible. The output of ":version" will include "+X11"
8142 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8143 works for the icon name |'icon'|.
8144 But: When Vim was started with the |-X| argument, restoring the title
8145 will not work (except in the GUI).
8146 If the title cannot be restored, it is set to the value of 'titleold'.
8147 You might want to restore the title outside of Vim then.
8148 When using an xterm from a remote machine you can use this command:
8149 rsh machine_name xterm -display $DISPLAY &
8150 then the WINDOWID environment variable should be inherited and the
8151 title of the window should change back to what it should be after
8152 exiting Vim.
8153
8154 *'titlelen'*
8155'titlelen' number (default 85)
8156 global
8157 {not in Vi}
8158 {not available when compiled without the |+title|
8159 feature}
8160 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008161 title. When the title is longer, only the end of the path name is
8162 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 Using a percentage makes this adapt to the width of the window. But
8164 it won't work perfectly, because the actual number of characters
8165 available also depends on the font used and other things in the title
8166 bar. When 'titlelen' is zero the full path is used. Otherwise,
8167 values from 1 to 30000 percent can be used.
8168 'titlelen' is also used for the 'titlestring' option.
8169
8170 *'titleold'*
8171'titleold' string (default "Thanks for flying Vim")
8172 global
8173 {not in Vi}
8174 {only available when compiled with the |+title|
8175 feature}
8176 This option will be used for the window title when exiting Vim if the
8177 original title cannot be restored. Only happens if 'title' is on or
8178 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008179 This option cannot be set from a |modeline| or in the |sandbox|, for
8180 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 *'titlestring'*
8182'titlestring' string (default "")
8183 global
8184 {not in Vi}
8185 {not available when compiled without the |+title|
8186 feature}
8187 When this option is not empty, it will be used for the title of the
8188 window. This happens only when the 'title' option is on.
8189 Only works if the terminal supports setting window titles (currently
8190 Amiga console, Win32 console, all GUI versions and terminals with a
8191 non-empty 't_ts' option).
8192 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008193 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 When this option contains printf-style '%' items, they will be
8195 expanded according to the rules used for 'statusline'.
8196 Example: >
8197 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8198 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8199< The value of 'titlelen' is used to align items in the middle or right
8200 of the available space.
8201 Some people prefer to have the file name first: >
8202 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8203< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008204 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 separating space only when needed.
8206 NOTE: Use of special characters in 'titlestring' may cause the display
8207 to be garbled (e.g., when it contains a CR or NL character).
8208 {not available when compiled without the |+statusline| feature}
8209
8210 *'toolbar'* *'tb'*
8211'toolbar' 'tb' string (default "icons,tooltips")
8212 global
8213 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8214 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008215 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 possible values are:
8217 icons Toolbar buttons are shown with icons.
8218 text Toolbar buttons shown with text.
8219 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008220 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 tooltips Tooltips are active for toolbar buttons.
8222 Tooltips refer to the popup help text which appears after the mouse
8223 cursor is placed over a toolbar button for a brief moment.
8224
8225 If you want the toolbar to be shown with icons as well as text, do the
8226 following: >
8227 :set tb=icons,text
8228< Motif and Athena cannot display icons and text at the same time. They
8229 will show icons if both are requested.
8230
8231 If none of the strings specified in 'toolbar' are valid or if
8232 'toolbar' is empty, this option is ignored. If you want to disable
8233 the toolbar, you need to set the 'guioptions' option. For example: >
8234 :set guioptions-=T
8235< Also see |gui-toolbar|.
8236
8237 *'toolbariconsize'* *'tbis'*
8238'toolbariconsize' 'tbis' string (default "small")
8239 global
8240 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008241 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008243 tiny Use tiny icons.
8244 small Use small icons (default).
8245 medium Use medium-sized icons.
8246 large Use large icons.
8247 huge Use even larger icons.
8248 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008250 the current theme. Common dimensions are giant=48x48, huge=32x32,
8251 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252
8253 If 'toolbariconsize' is empty, the global default size as determined
8254 by user preferences or the current theme is used.
8255
8256 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8257'ttybuiltin' 'tbi' boolean (default on)
8258 global
8259 {not in Vi}
8260 When on, the builtin termcaps are searched before the external ones.
8261 When off the builtin termcaps are searched after the external ones.
8262 When this option is changed, you should set the 'term' option next for
8263 the change to take effect, for example: >
8264 :set notbi term=$TERM
8265< See also |termcap|.
8266 Rationale: The default for this option is "on", because the builtin
8267 termcap entries are generally better (many systems contain faulty
8268 xterm entries...).
8269
8270 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8271'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8272 sun-cmd, screen, rxvt, dtterm or
8273 iris-ansi; also on when running Vim in
8274 a DOS console)
8275 global
8276 {not in Vi}
8277 Indicates a fast terminal connection. More characters will be sent to
8278 the screen for redrawing, instead of using insert/delete line
8279 commands. Improves smoothness of redrawing when there are multiple
8280 windows and the terminal does not support a scrolling region.
8281 Also enables the extra writing of characters at the end of each screen
8282 line for lines that wrap. This helps when using copy/paste with the
8283 mouse in an xterm and other terminals.
8284
8285 *'ttymouse'* *'ttym'*
8286'ttymouse' 'ttym' string (default depends on 'term')
8287 global
8288 {not in Vi}
8289 {only in Unix and VMS, doesn't work in the GUI; not
8290 available when compiled without |+mouse|}
8291 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008292 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 *xterm-mouse*
8294 xterm xterm-like mouse handling. The mouse generates
8295 "<Esc>[Mscr", where "scr" is three bytes:
8296 "s" = button state
8297 "c" = column plus 33
8298 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008299 This only works up to 223 columns! See "dec",
8300 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301 xterm2 Works like "xterm", but with the xterm reporting the
8302 mouse position while the mouse is dragged. This works
8303 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008304 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 work. See below for how Vim detects this
8306 automatically.
8307 *netterm-mouse*
8308 netterm NetTerm mouse handling. The mouse generates
8309 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8310 for the row and column.
8311 *dec-mouse*
8312 dec DEC terminal mouse handling. The mouse generates a
8313 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008314 This is also available for an Xterm, if it was
8315 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 *jsbterm-mouse*
8317 jsbterm JSB term mouse handling.
8318 *pterm-mouse*
8319 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008320 *urxvt-mouse*
8321 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008322 The mouse works only if the terminal supports this
8323 encoding style, but it does not have 223 columns limit
8324 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008325 *sgr-mouse*
8326 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008327 mouse reporting. The mouse works even in columns
8328 beyond 223. This option is backward compatible with
8329 "xterm2" because it can also decode "xterm2" style
8330 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331
8332 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008333 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8334 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8336 recognized, if enabled at compile time. DEC terminal mouse codes
8337 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008338 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8339 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008341 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8342 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8343 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008344 Additionally, if vim is compiled with the |+termresponse| feature and
8345 |t_RV| is set to the escape sequence to request the xterm version
8346 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008348 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008349 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008350 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8351 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 :set t_RV=
8353<
8354 *'ttyscroll'* *'tsl'*
8355'ttyscroll' 'tsl' number (default 999)
8356 global
8357 Maximum number of lines to scroll the screen. If there are more lines
8358 to scroll the window is redrawn. For terminals where scrolling is
8359 very slow and redrawing is not slow this can be set to a small number,
8360 e.g., 3, to speed up displaying.
8361
8362 *'ttytype'* *'tty'*
8363'ttytype' 'tty' string (default from $TERM)
8364 global
8365 Alias for 'term', see above.
8366
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008367 *'undodir'* *'udir'*
8368'undodir' 'udir' string (default ".")
8369 global
8370 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008371 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008372 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008373 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008374 "." means using the directory of the file. The undo file name for
8375 "file.txt" is ".file.txt.un~".
8376 For other directories the file name is the full path of the edited
8377 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008378 When writing: The first directory that exists is used. "." always
8379 works, no directories after "." will be used for writing.
8380 When reading all entries are tried to find an undo file. The first
8381 undo file that exists is used. When it cannot be read an error is
8382 given, no further entry is used.
8383 See |undo-persistence|.
8384
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008385 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008386'undofile' 'udf' boolean (default off)
8387 local to buffer
8388 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008389 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008390 When on, Vim automatically saves undo history to an undo file when
8391 writing a buffer to a file, and restores undo history from the same
8392 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008393 The directory where the undo file is stored is specified by 'undodir'.
8394 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008395 The undo file is not read when 'undoreload' causes the buffer from
8396 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008397 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008398 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008399
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 *'undolevels'* *'ul'*
8401'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8402 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008403 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 {not in Vi}
8405 Maximum number of changes that can be undone. Since undo information
8406 is kept in memory, higher numbers will cause more memory to be used
8407 (nevertheless, a single change can use an unlimited amount of memory).
8408 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8409 itself: >
8410 set ul=0
8411< But you can also get Vi compatibility by including the 'u' flag in
8412 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008413 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008414 Set to -1 for no undo at all. You might want to do this only for the
8415 current buffer: >
8416 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008418
8419 The local value is set to -123456 when the global value is to be used.
8420
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008421 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008423 *'undoreload'* *'ur'*
8424'undoreload' 'ur' number (default 10000)
8425 global
8426 {not in Vi}
8427 Save the whole buffer for undo when reloading it. This applies to the
8428 ":e!" command and reloading for when the buffer changed outside of
8429 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008430 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008431 of lines is smaller than the value of this option.
8432 Set this option to zero to disable undo for a reload.
8433
8434 When saving undo for a reload, any undo file is not read.
8435
8436 Note that this causes the whole buffer to be stored in memory. Set
8437 this option to a lower value if you run out of memory.
8438
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 *'updatecount'* *'uc'*
8440'updatecount' 'uc' number (default: 200)
8441 global
8442 {not in Vi}
8443 After typing this many characters the swap file will be written to
8444 disk. When zero, no swap file will be created at all (see chapter on
8445 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8446 Vim with the "-n" option, see |startup|. When editing in readonly
8447 mode this option will be initialized to 10000.
8448 The swapfile can be disabled per buffer with |'swapfile'|.
8449 When 'updatecount' is set from zero to non-zero, swap files are
8450 created for all buffers that have 'swapfile' set. When 'updatecount'
8451 is set to zero, existing swap files are not deleted.
8452 Also see |'swapsync'|.
8453 This option has no meaning in buffers where |'buftype'| is "nofile"
8454 or "nowrite".
8455
8456 *'updatetime'* *'ut'*
8457'updatetime' 'ut' number (default 4000)
8458 global
8459 {not in Vi}
8460 If this many milliseconds nothing is typed the swap file will be
8461 written to disk (see |crash-recovery|). Also used for the
8462 |CursorHold| autocommand event.
8463
8464 *'verbose'* *'vbs'*
8465'verbose' 'vbs' number (default 0)
8466 global
8467 {not in Vi, although some versions have a boolean
8468 verbose option}
8469 When bigger than zero, Vim will give messages about what it is doing.
8470 Currently, these messages are given:
8471 >= 1 When the viminfo file is read or written.
8472 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008473 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 >= 8 Files for which a group of autocommands is executed.
8475 >= 9 Every executed autocommand.
8476 >= 12 Every executed function.
8477 >= 13 When an exception is thrown, caught, finished, or discarded.
8478 >= 14 Anything pending in a ":finally" clause.
8479 >= 15 Every executed Ex command (truncated at 200 characters).
8480
8481 This option can also be set with the "-V" argument. See |-V|.
8482 This option is also set by the |:verbose| command.
8483
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008484 When the 'verbosefile' option is set then the verbose messages are not
8485 displayed.
8486
8487 *'verbosefile'* *'vfile'*
8488'verbosefile' 'vfile' string (default empty)
8489 global
8490 {not in Vi}
8491 When not empty all messages are written in a file with this name.
8492 When the file exists messages are appended.
8493 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008494 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008495 Setting 'verbosefile' to a new value is like making it empty first.
8496 The difference with |:redir| is that verbose messages are not
8497 displayed when 'verbosefile' is set.
8498
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 *'viewdir'* *'vdir'*
8500'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8501 "$VIM/vimfiles/view",
8502 for Unix: "~/.vim/view",
8503 for Macintosh: "$VIM:vimfiles:view"
8504 for VMS: "sys$login:vimfiles/view"
8505 for RiscOS: "Choices:vimfiles/view")
8506 global
8507 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008508 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 feature}
8510 Name of the directory where to store files for |:mkview|.
8511 This option cannot be set from a |modeline| or in the |sandbox|, for
8512 security reasons.
8513
8514 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008515'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 global
8517 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008518 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 feature}
8520 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008521 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 word save and restore ~
8523 cursor cursor position in file and in window
8524 folds manually created folds, opened/closed folds and local
8525 fold options
8526 options options and mappings local to a window or buffer (not
8527 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008528 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 slash backslashes in file names replaced with forward
8530 slashes
8531 unix with Unix end-of-line format (single <NL>), even when
8532 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008533 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534
8535 "slash" and "unix" are useful on Windows when sharing view files
8536 with Unix. The Unix version of Vim cannot source dos format scripts,
8537 but the Windows version of Vim can source unix format scripts.
8538
8539 *'viminfo'* *'vi'* *E526* *E527* *E528*
8540'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008541 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8542 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8543 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 global
8545 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008546 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008547 feature}
8548 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008549 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8550 "NONE".
8551 The string should be a comma separated list of parameters, each
8552 consisting of a single character identifying the particular parameter,
8553 followed by a number or string which specifies the value of that
8554 parameter. If a particular character is left out, then the default
8555 value is used for that parameter. The following is a list of the
8556 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008558 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 ! When included, save and restore global variables that start
8560 with an uppercase letter, and don't contain a lowercase
8561 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008562 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008563 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008564 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 " Maximum number of lines saved for each register. Old name of
8566 the '<' item, with the disadvantage that you need to put a
8567 backslash before the ", otherwise it will be recognized as the
8568 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008569 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 % When included, save and restore the buffer list. If Vim is
8571 started with a file name argument, the buffer list is not
8572 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008573 buffer list is restored from the viminfo file. Quickfix
8574 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8575 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008576 When followed by a number, the number specifies the maximum
8577 number of buffers that are stored. Without a number all
8578 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008579 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 ' Maximum number of previously edited files for which the marks
8581 are remembered. This parameter must always be included when
8582 'viminfo' is non-empty.
8583 Including this item also means that the |jumplist| and the
8584 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008585 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008587 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 patterns are also saved. When not included, the value of
8589 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008590 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008592 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008593 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 < Maximum number of lines saved for each register. If zero then
8595 registers are not saved. When not included, all lines are
8596 saved. '"' is the old name for this item.
8597 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008598 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008600 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008601 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 c When included, convert the text in the viminfo file from the
8603 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008604 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008605 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 f Whether file marks need to be stored. If zero, file marks ('0
8607 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008608 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008610 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 h Disable the effect of 'hlsearch' when loading the viminfo
8612 file. When not included, it depends on whether ":nohlsearch"
8613 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008614 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008616 the 'n'. Must be at the end of the option! If the
8617 'viminfofile' option is set, that file name overrides the one
8618 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008619 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008620 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 r Removable media. The argument is a string (up to the next
8622 ','). This parameter can be given several times. Each
8623 specifies the start of a path for which no marks will be
8624 stored. This is to avoid removable media. For MS-DOS you
8625 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8626 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8627 ignored. Maximum length of each 'r' argument is 50
8628 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008629 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 s Maximum size of an item in Kbyte. If zero then registers are
8631 not saved. Currently only applies to registers. The default
8632 "s10" will exclude registers with more than 10 Kbyte of text.
8633 Also see the '<' item above: line count limit.
8634
8635 Example: >
8636 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8637<
8638 '50 Marks will be remembered for the last 50 files you
8639 edited.
8640 <1000 Contents of registers (up to 1000 lines each) will be
8641 remembered.
8642 s100 Registers with more than 100 Kbyte text are skipped.
8643 :0 Command-line history will not be saved.
8644 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8645 no / Since '/' is not specified, the default will be used,
8646 that is, save all of the search history, and also the
8647 previous search and substitute patterns.
8648 no % The buffer list will not be saved nor read back.
8649 no h 'hlsearch' highlighting will be restored.
8650
8651 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8652 load the contents of the file, this is not done automatically.
8653
8654 This option cannot be set from a |modeline| or in the |sandbox|, for
8655 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008656 NOTE: This option is set to the Vim default value when 'compatible'
8657 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008659 *'viminfofile'* *'vif'*
8660'viminfofile' 'vif' string (default: "")
8661 global
8662 {not in Vi}
8663 {not available when compiled without the |+viminfo|
8664 feature}
8665 When non-empty, overrides the file name used for viminfo.
8666 When equal to "NONE" no viminfo file will be read or written.
8667 This option can be set with the |-i| command line flag. The |--clean|
8668 command line flag sets it to "NONE".
8669
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 *'virtualedit'* *'ve'*
8671'virtualedit' 've' string (default "")
8672 global
8673 {not in Vi}
8674 {not available when compiled without the
8675 |+virtualedit| feature}
8676 A comma separated list of these words:
8677 block Allow virtual editing in Visual block mode.
8678 insert Allow virtual editing in Insert mode.
8679 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008680 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008681
Bram Moolenaar071d4272004-06-13 20:20:40 +00008682 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008683 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 of the line. Useful for selecting a rectangle in Visual mode and
8685 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008686 "onemore" is not the same, it will only allow moving the cursor just
8687 after the last character of the line. This makes some commands more
8688 consistent. Previously the cursor was always past the end of the line
8689 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008690 break some plugins or Vim scripts. For example because |l| can move
8691 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008692 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008693 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008694 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008695 It doesn't make sense to combine "all" with "onemore", but you will
8696 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008697 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008698
8699 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8700'visualbell' 'vb' boolean (default off)
8701 global
8702 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008703 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008705 use: >
8706 :set vb t_vb=
8707< If you want a short flash, you can use this on many terminals: >
8708 :set vb t_vb=[?5h$<100>[?5l
8709< Here $<100> specifies the time, you can use a smaller or bigger value
8710 to get a shorter or longer flash.
8711
8712 Note: Vim will limit the bell to once per half a second. This avoids
8713 having to wait for the flashing to finish when there are lots of
8714 bells, e.g. on key repeat. This also happens without 'visualbell'
8715 set.
8716
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8718 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8719 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008720
8721 Note: When the GUI starts, 't_vb' is reset to its default value. You
8722 might want to set it again in your |gvimrc|.
8723
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 Does not work on the Amiga, you always get a screen flash.
8725 Also see 'errorbells'.
8726
8727 *'warn'* *'nowarn'*
8728'warn' boolean (default on)
8729 global
8730 Give a warning message when a shell command is used while the buffer
8731 has been changed.
8732
8733 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8734'weirdinvert' 'wiv' boolean (default off)
8735 global
8736 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008737 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 It is provided for backwards compatibility with version 4.x.
8739 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8740 vice versa. Has no effect when the GUI is running.
8741
8742 *'whichwrap'* *'ww'*
8743'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8744 global
8745 {not in Vi}
8746 Allow specified keys that move the cursor left/right to move to the
8747 previous/next line when the cursor is on the first/last character in
8748 the line. Concatenate characters to allow this for these keys:
8749 char key mode ~
8750 b <BS> Normal and Visual
8751 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008752 h "h" Normal and Visual (not recommended)
8753 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008754 < <Left> Normal and Visual
8755 > <Right> Normal and Visual
8756 ~ "~" Normal
8757 [ <Left> Insert and Replace
8758 ] <Right> Insert and Replace
8759 For example: >
8760 :set ww=<,>,[,]
8761< allows wrap only when cursor keys are used.
8762 When the movement keys are used in combination with a delete or change
8763 operator, the <EOL> also counts for a character. This makes "3h"
8764 different from "3dh" when the cursor crosses the end of a line. This
8765 is also true for "x" and "X", because they do the same as "dl" and
8766 "dh". If you use this, you may also want to use the mapping
8767 ":map <BS> X" to make backspace delete the character in front of the
8768 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008769 When 'l' is included and it is used after an operator at the end of a
8770 line then it will not move to the next line. This makes "dl", "cl",
8771 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 NOTE: This option is set to the Vi default value when 'compatible' is
8773 set and to the Vim default value when 'compatible' is reset.
8774
8775 *'wildchar'* *'wc'*
8776'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8777 global
8778 {not in Vi}
8779 Character you have to type to start wildcard expansion in the
8780 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008781 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 The character is not recognized when used inside a macro. See
8783 'wildcharm' for that.
8784 Although 'wc' is a number option, you can set it to a special key: >
8785 :set wc=<Esc>
8786< NOTE: This option is set to the Vi default value when 'compatible' is
8787 set and to the Vim default value when 'compatible' is reset.
8788
8789 *'wildcharm'* *'wcm'*
8790'wildcharm' 'wcm' number (default: none (0))
8791 global
8792 {not in Vi}
8793 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008794 recognized when used inside a macro. You can find "spare" command-line
8795 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 you'll never actually type 'wildcharm', just use it in mappings that
8797 automatically invoke completion mode, e.g.: >
8798 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008799 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800< Then after typing :ss you can use CTRL-P & CTRL-N.
8801
8802 *'wildignore'* *'wig'*
8803'wildignore' 'wig' string (default "")
8804 global
8805 {not in Vi}
8806 {not available when compiled without the |+wildignore|
8807 feature}
8808 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008809 patterns is ignored when expanding |wildcards|, completing file or
8810 directory names, and influences the result of |expand()|, |glob()| and
8811 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8813 Also see 'suffixes'.
8814 Example: >
8815 :set wildignore=*.o,*.obj
8816< The use of |:set+=| and |:set-=| is preferred when adding or removing
8817 a pattern from the list. This avoids problems when a future version
8818 uses another default.
8819
Bram Moolenaar94950a92010-12-02 16:01:29 +01008820
Bram Moolenaar81af9252010-12-10 20:35:50 +01008821 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008822'wildignorecase' 'wic' boolean (default off)
8823 global
8824 {not in Vi}
8825 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008826 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008827 Does not apply when the shell is used to expand wildcards, which
8828 happens when there are special characters.
8829
8830
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008832'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008833 global
8834 {not in Vi}
8835 {not available if compiled without the |+wildmenu|
8836 feature}
8837 When 'wildmenu' is on, command-line completion operates in an enhanced
8838 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8839 the possible matches are shown just above the command line, with the
8840 first match highlighted (overwriting the status line, if there is
8841 one). Keys that show the previous/next match, such as <Tab> or
8842 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8843 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8844 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008845 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 If there are more matches than can fit in the line, a ">" is shown on
8847 the right and/or a "<" is shown on the left. The status line scrolls
8848 as needed.
8849 The "wildmenu" mode is abandoned when a key is hit that is not used
8850 for selecting a completion.
8851 While the "wildmenu" is active the following keys have special
8852 meanings:
8853
8854 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8855 <Down> - in filename/menu name completion: move into a
8856 subdirectory or submenu.
8857 <CR> - in menu completion, when the cursor is just after a
8858 dot: move into a submenu.
8859 <Up> - in filename/menu name completion: move up into
8860 parent directory or parent menu.
8861
8862 This makes the menus accessible from the console |console-menus|.
8863
8864 If you prefer the <Left> and <Right> keys to move the cursor instead
8865 of selecting a different match, use this: >
8866 :cnoremap <Left> <Space><BS><Left>
8867 :cnoremap <Right> <Space><BS><Right>
8868<
8869 The "WildMenu" highlighting is used for displaying the current match
8870 |hl-WildMenu|.
8871
8872 *'wildmode'* *'wim'*
8873'wildmode' 'wim' string (Vim default: "full")
8874 global
8875 {not in Vi}
8876 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008877 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008878 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879 first part specifies the behavior for the first use of 'wildchar',
8880 The second part for the second use, etc.
8881 These are the possible values for each part:
8882 "" Complete only the first match.
8883 "full" Complete the next full match. After the last match,
8884 the original string is used and then the first match
8885 again.
8886 "longest" Complete till longest common string. If this doesn't
8887 result in a longer string, use the next part.
8888 "longest:full" Like "longest", but also start 'wildmenu' if it is
8889 enabled.
8890 "list" When more than one match, list all matches.
8891 "list:full" When more than one match, list all matches and
8892 complete first match.
8893 "list:longest" When more than one match, list all matches and
8894 complete till longest common string.
8895 When there is only a single match, it is fully completed in all cases.
8896
8897 Examples: >
8898 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008899< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 :set wildmode=longest,full
8901< Complete longest common string, then each full match >
8902 :set wildmode=list:full
8903< List all matches and complete each full match >
8904 :set wildmode=list,full
8905< List all matches without completing, then each full match >
8906 :set wildmode=longest,list
8907< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008908 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008910 *'wildoptions'* *'wop'*
8911'wildoptions' 'wop' string (default "")
8912 global
8913 {not in Vi}
8914 {not available when compiled without the |+wildignore|
8915 feature}
8916 A list of words that change how command line completion is done.
8917 Currently only one word is allowed:
8918 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008919 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008920 is displayed per line. Often used tag kinds are:
8921 d #define
8922 f function
8923 Also see |cmdline-completion|.
8924
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 *'winaltkeys'* *'wak'*
8926'winaltkeys' 'wak' string (default "menu")
8927 global
8928 {not in Vi}
8929 {only used in Win32, Motif, GTK and Photon GUI}
8930 Some GUI versions allow the access to menu entries by using the ALT
8931 key in combination with a character that appears underlined in the
8932 menu. This conflicts with the use of the ALT key for mappings and
8933 entering special characters. This option tells what to do:
8934 no Don't use ALT keys for menus. ALT key combinations can be
8935 mapped, but there is no automatic handling. This can then be
8936 done with the |:simalt| command.
8937 yes ALT key handling is done by the windowing system. ALT key
8938 combinations cannot be mapped.
8939 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008940 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 keys can be mapped.
8942 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8943 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008944 This option is not used for <F10>; on Win32 and with GTK <F10> will
8945 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008947 *'window'* *'wi'*
8948'window' 'wi' number (default screen height - 1)
8949 global
8950 Window height. Do not confuse this with the height of the Vim window,
8951 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008952 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8953 value is smaller than 'lines' minus one. The screen will scroll
8954 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008955 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8956 in a much smarter way, taking care of wrapping lines.
8957 When resizing the Vim window, the value is smaller than 1 or more than
8958 or equal to 'lines' it will be set to 'lines' minus 1.
8959 {Vi also uses the option to specify the number of displayed lines}
8960
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 *'winheight'* *'wh'* *E591*
8962'winheight' 'wh' number (default 1)
8963 global
8964 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008965 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008966 feature}
8967 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008968 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008969 focus goes to a window that is smaller, its size is increased, at the
8970 cost of the height of other windows.
8971 Set 'winheight' to a small number for normal editing.
8972 Set it to 999 to make the current window fill most of the screen.
8973 Other windows will be only 'winminheight' high. This has the drawback
8974 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8975 to create only two windows, set the option after startup is done,
8976 using the |VimEnter| event: >
8977 au VimEnter * set winheight=999
8978< Minimum value is 1.
8979 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 height of the current window.
8981 'winheight' applies to the current window. Use 'winminheight' to set
8982 the minimal height for other windows.
8983
8984 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8985'winfixheight' 'wfh' boolean (default off)
8986 local to window
8987 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008988 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008989 feature}
8990 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008991 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8992 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 The height may be changed anyway when running out of room.
8994
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008995 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8996'winfixwidth' 'wfw' boolean (default off)
8997 local to window
8998 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008999 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009000 feature}
9001 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009002 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009003 The width may be changed anyway when running out of room.
9004
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 *'winminheight'* *'wmh'*
9006'winminheight' 'wmh' number (default 1)
9007 global
9008 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009009 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009010 feature}
9011 The minimal height of a window, when it's not the current window.
9012 This is a hard minimum, windows will never become smaller.
9013 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9014 status bar) if necessary. They will return to at least one line when
9015 they become active (since the cursor has to have somewhere to go.)
9016 Use 'winheight' to set the minimal height of the current window.
9017 This option is only checked when making a window smaller. Don't use a
9018 large number, it will cause errors when opening more than a few
9019 windows. A value of 0 to 3 is reasonable.
9020
9021 *'winminwidth'* *'wmw'*
9022'winminwidth' 'wmw' number (default 1)
9023 global
9024 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009025 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009026 feature}
9027 The minimal width of a window, when it's not the current window.
9028 This is a hard minimum, windows will never become smaller.
9029 When set to zero, windows may be "squashed" to zero columns (i.e. just
9030 a vertical separator) if necessary. They will return to at least one
9031 line when they become active (since the cursor has to have somewhere
9032 to go.)
9033 Use 'winwidth' to set the minimal width of the current window.
9034 This option is only checked when making a window smaller. Don't use a
9035 large number, it will cause errors when opening more than a few
9036 windows. A value of 0 to 12 is reasonable.
9037
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009038 *'winptydll'*
9039'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9040 global
9041 {not in Vi}
9042 {only available when compiled with the |terminal|
9043 feature on MS-Windows}
9044 Specifies the name of the winpty shared library, used for the
9045 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009046 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009047 a fallback.
9048 Environment variables are expanded |:set_env|.
9049 This option cannot be set from a |modeline| or in the |sandbox|, for
9050 security reasons.
9051
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 *'winwidth'* *'wiw'* *E592*
9053'winwidth' 'wiw' number (default 20)
9054 global
9055 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009056 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009057 feature}
9058 Minimal number of columns for the current window. This is not a hard
9059 minimum, Vim will use fewer columns if there is not enough room. If
9060 the current window is smaller, its size is increased, at the cost of
9061 the width of other windows. Set it to 999 to make the current window
9062 always fill the screen. Set it to a small number for normal editing.
9063 The width is not adjusted after one of the commands to change the
9064 width of the current window.
9065 'winwidth' applies to the current window. Use 'winminwidth' to set
9066 the minimal width for other windows.
9067
9068 *'wrap'* *'nowrap'*
9069'wrap' boolean (default on)
9070 local to window
9071 {not in Vi}
9072 This option changes how text is displayed. It doesn't change the text
9073 in the buffer, see 'textwidth' for that.
9074 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009075 displaying continues on the next line. When off lines will not wrap
9076 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009077 moved to a part that is not shown, the screen will scroll
9078 horizontally.
9079 The line will be broken in the middle of a word if necessary. See
9080 'linebreak' to get the break at a word boundary.
9081 To make scrolling horizontally a bit more useful, try this: >
9082 :set sidescroll=5
9083 :set listchars+=precedes:<,extends:>
9084< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009085 This option can't be set from a |modeline| when the 'diff' option is
9086 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087
9088 *'wrapmargin'* *'wm'*
9089'wrapmargin' 'wm' number (default 0)
9090 local to buffer
9091 Number of characters from the right window border where wrapping
9092 starts. When typing text beyond this limit, an <EOL> will be inserted
9093 and inserting continues on the next line.
9094 Options that add a margin, such as 'number' and 'foldcolumn', cause
9095 the text width to be further reduced. This is Vi compatible.
9096 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009097 This option is set to 0 when 'paste' is set and restored when 'paste'
9098 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009099 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9100 and less usefully}
9101
9102 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9103'wrapscan' 'ws' boolean (default on) *E384* *E385*
9104 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009105 Searches wrap around the end of the file. Also applies to |]s| and
9106 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009107
9108 *'write'* *'nowrite'*
9109'write' boolean (default on)
9110 global
9111 {not in Vi}
9112 Allows writing files. When not set, writing a file is not allowed.
9113 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009114 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009115 argument. Filtering text is still possible, even though this requires
9116 writing a temporary file.
9117
9118 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9119'writeany' 'wa' boolean (default off)
9120 global
9121 Allows writing to any file with no need for "!" override.
9122
9123 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9124'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9125 otherwise)
9126 global
9127 {not in Vi}
9128 Make a backup before overwriting a file. The backup is removed after
9129 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009130 also on.
9131 WARNING: Switching this option off means that when Vim fails to write
9132 your buffer correctly and then, for whatever reason, Vim exits, you
9133 lose both the original file and what you were writing. Only reset
9134 this option if your file system is almost full and it makes the write
9135 fail (and make sure not to exit Vim until the write was successful).
9136 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 When the 'backupskip' pattern matches, a backup is not made anyway.
9138 NOTE: This option is set to the default value when 'compatible' is
9139 set.
9140
9141 *'writedelay'* *'wd'*
9142'writedelay' 'wd' number (default 0)
9143 global
9144 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009145 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009146 screen. When non-zero, characters are sent to the terminal one by
9147 one. For MS-DOS pcterm this does not work. For debugging purposes.
9148
9149 vim:tw=78:ts=8:ft=help:norl: