blob: 93efaec16dabb1e5a554e83c587bffc1894a2d73 [file] [log] [blame]
Bram Moolenaar98ef2332018-03-18 14:44:37 +01001*options.txt* For Vim version 8.0. Last change: 2018 Mar 13
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'*
1090'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1091 global
1092 {not in Vi}
1093 {not available when compiled without the |+wildignore|
1094 feature}
1095 A list of file patterns. When one of the patterns matches with the
1096 name of the file which is written, no backup file is created. Both
1097 the specified file name and the full path name of the file are used.
1098 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1099 Watch out for special characters, see |option-backslash|.
1100 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001101 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001102
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001103 WARNING: Not having a backup file means that when Vim fails to write
1104 your buffer correctly and then, for whatever reason, Vim exits, you
1105 lose both the original file and what you were writing. Only disable
1106 backups if you don't care about losing the file.
1107
Bram Moolenaar02467872007-05-06 13:22:01 +00001108 Note that environment variables are not expanded. If you want to use
1109 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001110 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001111
1112< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001113 backup would be made by renaming the original file crontab won't see
1114 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115
1116 *'balloondelay'* *'bdlay'*
1117'balloondelay' 'bdlay' number (default: 600)
1118 global
1119 {not in Vi}
1120 {only available when compiled with the |+balloon_eval|
1121 feature}
1122 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1123
1124 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1125'ballooneval' 'beval' boolean (default off)
1126 global
1127 {not in Vi}
1128 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001130 Switch on the |balloon-eval| functionality for the GUI.
1131
1132 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1133 *'nobevalterm'*
1134'balloonevalterm' 'bevalterm' boolean (default off)
1135 global
1136 {not in Vi}
1137 {only available when compiled with the
1138 |+balloon_eval_term| feature}
1139 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 *'balloonexpr'* *'bexpr'*
1142'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001143 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 {not in Vi}
1145 {only available when compiled with the |+balloon_eval|
1146 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001147 Expression for text to show in evaluation balloon. It is only used
1148 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149
1150 v:beval_bufnr number of the buffer in which balloon is going to show
1151 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001152 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 v:beval_lnum line number
1154 v:beval_col column number (byte index)
1155 v:beval_text word under or after the mouse pointer
1156
1157 The evaluation of the expression must not have side effects!
1158 Example: >
1159 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001160 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 \', column ' . v:beval_col .
1162 \ ' of file ' . bufname(v:beval_bufnr) .
1163 \ ' on word "' . v:beval_text . '"'
1164 endfunction
1165 set bexpr=MyBalloonExpr()
1166 set ballooneval
1167<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001168 Also see |balloon_show()|, can be used if the content of the balloon
1169 is to be fetched asynchronously.
1170
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001171 NOTE: The balloon is displayed only if the cursor is on a text
1172 character. If the result of evaluating 'balloonexpr' is not empty,
1173 Vim does not try to send a message to an external debugger (Netbeans
1174 or Sun Workshop).
1175
Bram Moolenaar30b65812012-07-12 22:01:11 +02001176 The expression will be evaluated in the |sandbox| when set from a
1177 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001178
1179 It is not allowed to change text or jump to another window while
1180 evaluating 'balloonexpr' |textlock|.
1181
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001182 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001183 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001184< When they are supported "\n" characters will start a new line. If the
1185 expression evaluates to a |List| this is equal to using each List item
1186 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001187 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001188
Bram Moolenaar165bc692015-07-21 17:53:25 +02001189 *'belloff'* *'bo'*
1190'belloff' 'bo' string (default "")
1191 global
1192 {not in Vi}
1193 Specifies for which events the bell will not be rung. It is a comma
1194 separated list of items. For each item that is present, the bell
1195 will be silenced. This is most useful to specify specific events in
1196 insert mode to be silenced.
1197
1198 item meaning when present ~
1199 all All events.
1200 backspace When hitting <BS> or <Del> and deleting results in an
1201 error.
1202 cursor Fail to move around using the cursor keys or
1203 <PageUp>/<PageDown> in |Insert-mode|.
1204 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1205 |i_CTRL-X_CTRL-T|.
1206 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1207 |i_CTRL-E|.
1208 ctrlg Unknown Char after <C-G> in Insert mode.
1209 error Other Error occurred (e.g. try to join last line)
1210 (mostly used in |Normal-mode| or |Cmdline-mode|).
1211 esc hitting <Esc> in |Normal-mode|.
1212 ex In |Visual-mode|, hitting |Q| results in an error.
1213 hangul Error occurred when using hangul input.
1214 insertmode Pressing <Esc> in 'insertmode'.
1215 lang Calling the beep module for Lua/Mzscheme/TCL.
1216 mess No output available for |g<|.
1217 showmatch Error occurred for 'showmatch' function.
1218 operator Empty region error |cpo-E|.
1219 register Unknown register after <C-R> in |Insert-mode|.
1220 shell Bell from shell output |:!|.
1221 spell Error happened on spell suggest.
1222 wildmode More matches in |cmdline-completion| available
1223 (depends on the 'wildmode' setting).
1224
Bram Moolenaar036986f2017-03-16 17:41:02 +01001225 This is most useful to fine tune when in Insert mode the bell should
1226 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001227 indicate that an error occurred. It can be silenced by adding the
1228 "error" keyword.
1229
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1231'binary' 'bin' boolean (default off)
1232 local to buffer
1233 {not in Vi}
1234 This option should be set before editing a binary file. You can also
1235 use the |-b| Vim argument. When this option is switched on a few
1236 options will be changed (also when it already was on):
1237 'textwidth' will be set to 0
1238 'wrapmargin' will be set to 0
1239 'modeline' will be off
1240 'expandtab' will be off
1241 Also, 'fileformat' and 'fileformats' options will not be used, the
1242 file is read and written like 'fileformat' was "unix" (a single <NL>
1243 separates lines).
1244 The 'fileencoding' and 'fileencodings' options will not be used, the
1245 file is read without conversion.
1246 NOTE: When you start editing a(nother) file while the 'bin' option is
1247 on, settings from autocommands may change the settings again (e.g.,
1248 'textwidth'), causing trouble when editing. You might want to set
1249 'bin' again when the file has been loaded.
1250 The previous values of these options are remembered and restored when
1251 'bin' is switched from on to off. Each buffer has its own set of
1252 saved option values.
1253 To edit a file with 'binary' set you can use the |++bin| argument.
1254 This avoids you have to do ":set bin", which would have effect for all
1255 files you edit.
1256 When writing a file the <EOL> for the last line is only written if
1257 there was one in the original file (normally Vim appends an <EOL> to
1258 the last line if there is none; this would make the file longer). See
1259 the 'endofline' option.
1260
1261 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1262'bioskey' 'biosk' boolean (default on)
1263 global
1264 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001265 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266
1267 *'bomb'* *'nobomb'*
1268'bomb' boolean (default off)
1269 local to buffer
1270 {not in Vi}
1271 {only available when compiled with the |+multi_byte|
1272 feature}
1273 When writing a file and the following conditions are met, a BOM (Byte
1274 Order Mark) is prepended to the file:
1275 - this option is on
1276 - the 'binary' option is off
1277 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1278 endian variants.
1279 Some applications use the BOM to recognize the encoding of the file.
1280 Often used for UCS-2 files on MS-Windows. For other applications it
1281 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001282 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1284 check for the presence of the BOM is done and 'bomb' set accordingly.
1285 Unless 'binary' is set, it is removed from the first line, so that you
1286 don't see it when editing. When you don't change the options, the BOM
1287 will be restored when writing the file.
1288
1289 *'breakat'* *'brk'*
1290'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1291 global
1292 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001293 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 feature}
1295 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001296 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1297 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001299 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300'breakindent' 'bri' boolean (default off)
1301 local to window
1302 {not in Vi}
1303 {not available when compiled without the |+linebreak|
1304 feature}
1305 Every wrapped line will continue visually indented (same amount of
1306 space as the beginning of that line), thus preserving horizontal blocks
1307 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001308 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309
1310 *'breakindentopt'* *'briopt'*
1311'breakindentopt' 'briopt' string (default empty)
1312 local to window
1313 {not in Vi}
1314 {not available when compiled without the |+linebreak|
1315 feature}
1316 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001317 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318 min:{n} Minimum text width that will be kept after
1319 applying 'breakindent', even if the resulting
1320 text should normally be narrower. This prevents
1321 text indented almost to the right window border
1322 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001323 shift:{n} After applying 'breakindent', the wrapped line's
1324 beginning will be shifted by the given number of
1325 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001326 indentation (negative) or emphasizing the line
1327 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001328 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001329 additional indent.
1330 The default value for min is 20 and shift is 0.
1331
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001333'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001335 {not in Vi} {only for Motif, Athena, GTK, Mac and
1336 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001338 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001339 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 buffer Use the directory of the related buffer.
1341 current Use the current directory.
1342 {path} Use the specified directory
1343
1344 *'bufhidden'* *'bh'*
1345'bufhidden' 'bh' string (default: "")
1346 local to buffer
1347 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 This option specifies what happens when a buffer is no longer
1349 displayed in a window:
1350 <empty> follow the global 'hidden' option
1351 hide hide the buffer (don't unload it), also when 'hidden'
1352 is not set
1353 unload unload the buffer, also when 'hidden' is set or using
1354 |:hide|
1355 delete delete the buffer from the buffer list, also when
1356 'hidden' is set or using |:hide|, like using
1357 |:bdelete|
1358 wipe wipe out the buffer from the buffer list, also when
1359 'hidden' is set or using |:hide|, like using
1360 |:bwipeout|
1361
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001362 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001363 are lost without a warning. Also, these values may break autocommands
1364 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 This option is used together with 'buftype' and 'swapfile' to specify
1366 special kinds of buffers. See |special-buffers|.
1367
1368 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1369'buflisted' 'bl' boolean (default: on)
1370 local to buffer
1371 {not in Vi}
1372 When this option is set, the buffer shows up in the buffer list. If
1373 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1374 This option is reset by Vim for buffers that are only used to remember
1375 a file name or marks. Vim sets it when starting to edit a buffer.
1376 But not when moving to a buffer with ":buffer".
1377
1378 *'buftype'* *'bt'* *E382*
1379'buftype' 'bt' string (default: "")
1380 local to buffer
1381 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 The value of this option specifies the type of a buffer:
1383 <empty> normal buffer
1384 nofile buffer which is not related to a file and will not be
1385 written
1386 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001387 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001388 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001390 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 help help buffer (you are not supposed to set this
1392 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001393 terminal buffer for a |terminal| (you are not supposed to set
1394 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395
1396 This option is used together with 'bufhidden' and 'swapfile' to
1397 specify special kinds of buffers. See |special-buffers|.
1398
1399 Be careful with changing this option, it can have many side effects!
1400
Bram Moolenaar280f1262006-01-30 00:14:18 +00001401 A "quickfix" buffer is only used for the error list and the location
1402 list. This value is set by the |:cwindow| and |:lwindow| commands and
1403 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404
1405 "nofile" and "nowrite" buffers are similar:
1406 both: The buffer is not to be written to disk, ":w" doesn't
1407 work (":w filename" does work though).
1408 both: The buffer is never considered to be |'modified'|.
1409 There is no warning when the changes will be lost, for
1410 example when you quit Vim.
1411 both: A swap file is only created when using too much memory
1412 (when 'swapfile' has been reset there is never a swap
1413 file).
1414 nofile only: The buffer name is fixed, it is not handled like a
1415 file name. It is not modified in response to a |:cd|
1416 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001417 both: When using ":e bufname" and already editing "bufname"
1418 the buffer is made empty and autocommands are
1419 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001420 *E676*
1421 "acwrite" implies that the buffer name is not related to a file, like
1422 "nofile", but it will be written. Thus, in contrast to "nofile" and
1423 "nowrite", ":w" does work and a modified buffer can't be abandoned
1424 without saving. For writing there must be matching |BufWriteCmd|,
1425 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
1427 *'casemap'* *'cmp'*
1428'casemap' 'cmp' string (default: "internal,keepascii")
1429 global
1430 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001431 {only available when compiled with the |+multi_byte|
1432 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 Specifies details about changing the case of letters. It may contain
1434 these words, separated by a comma:
1435 internal Use internal case mapping functions, the current
1436 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001437 matters when 'encoding' is a Unicode encoding,
1438 "latin1" or "iso-8859-15". When "internal" is
1439 omitted, the towupper() and towlower() system library
1440 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1442 case mapping, the current locale is not effective.
1443 This probably only matters for Turkish.
1444
1445 *'cdpath'* *'cd'* *E344* *E346*
1446'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1447 global
1448 {not in Vi}
1449 {not available when compiled without the
1450 |+file_in_path| feature}
1451 This is a list of directories which will be searched when using the
1452 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001453 for has a relative path, not an absolute part starting with "/", "./"
1454 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 The 'cdpath' option's value has the same form and semantics as
1456 |'path'|. Also see |file-searching|.
1457 The default value is taken from $CDPATH, with a "," prepended to look
1458 in the current directory first.
1459 If the default value taken from $CDPATH is not what you want, include
1460 a modified version of the following command in your vimrc file to
1461 override it: >
1462 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1463< This option cannot be set from a |modeline| or in the |sandbox|, for
1464 security reasons.
1465 (parts of 'cdpath' can be passed to the shell to expand file names).
1466
1467 *'cedit'*
1468'cedit' string (Vi default: "", Vim default: CTRL-F)
1469 global
1470 {not in Vi}
1471 {not available when compiled without the |+vertsplit|
1472 feature}
1473 The key used in Command-line Mode to open the command-line window.
1474 The default is CTRL-F when 'compatible' is off.
1475 Only non-printable keys are allowed.
1476 The key can be specified as a single character, but it is difficult to
1477 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001478 :exe "set cedit=\<C-Y>"
1479 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001480< |Nvi| also has this option, but it only uses the first character.
1481 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001482 NOTE: This option is set to the Vim default value when 'compatible'
1483 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484
1485 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1486'charconvert' 'ccv' string (default "")
1487 global
1488 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001489 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 {not in Vi}
1491 An expression that is used for character encoding conversion. It is
1492 evaluated when a file that is to be read or has been written has a
1493 different encoding from what is desired.
1494 'charconvert' is not used when the internal iconv() function is
1495 supported and is able to do the conversion. Using iconv() is
1496 preferred, because it is much faster.
1497 'charconvert' is not used when reading stdin |--|, because there is no
1498 file to convert from. You will have to save the text in a file first.
1499 The expression must return zero or an empty string for success,
1500 non-zero for failure.
1501 The possible encoding names encountered are in 'encoding'.
1502 Additionally, names given in 'fileencodings' and 'fileencoding' are
1503 used.
1504 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1505 is done internally by Vim, 'charconvert' is not used for this.
1506 'charconvert' is also used to convert the viminfo file, if the 'c'
1507 flag is present in 'viminfo'. Also used for Unicode conversion.
1508 Example: >
1509 set charconvert=CharConvert()
1510 fun CharConvert()
1511 system("recode "
1512 \ . v:charconvert_from . ".." . v:charconvert_to
1513 \ . " <" . v:fname_in . " >" v:fname_out)
1514 return v:shell_error
1515 endfun
1516< The related Vim variables are:
1517 v:charconvert_from name of the current encoding
1518 v:charconvert_to name of the desired encoding
1519 v:fname_in name of the input file
1520 v:fname_out name of the output file
1521 Note that v:fname_in and v:fname_out will never be the same.
1522 Note that v:charconvert_from and v:charconvert_to may be different
1523 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1524 Encryption is not done by Vim when using 'charconvert'. If you want
1525 to encrypt the file after conversion, 'charconvert' should take care
1526 of this.
1527 This option cannot be set from a |modeline| or in the |sandbox|, for
1528 security reasons.
1529
1530 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1531'cindent' 'cin' boolean (default off)
1532 local to buffer
1533 {not in Vi}
1534 {not available when compiled without the |+cindent|
1535 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001536 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 that trigger reindenting in insert mode and 'cinoptions' to set your
1538 preferred indent style.
1539 If 'indentexpr' is not empty, it overrules 'cindent'.
1540 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1541 the "=" operator indents using this algorithm rather than calling an
1542 external program.
1543 See |C-indenting|.
1544 When you don't like the way 'cindent' works, try the 'smartindent'
1545 option or 'indentexpr'.
1546 This option is not used when 'paste' is set.
1547 NOTE: This option is reset when 'compatible' is set.
1548
1549 *'cinkeys'* *'cink'*
1550'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1551 local to buffer
1552 {not in Vi}
1553 {not available when compiled without the |+cindent|
1554 feature}
1555 A list of keys that, when typed in Insert mode, cause reindenting of
1556 the current line. Only used if 'cindent' is on and 'indentexpr' is
1557 empty.
1558 For the format of this option see |cinkeys-format|.
1559 See |C-indenting|.
1560
1561 *'cinoptions'* *'cino'*
1562'cinoptions' 'cino' string (default "")
1563 local to buffer
1564 {not in Vi}
1565 {not available when compiled without the |+cindent|
1566 feature}
1567 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1568 program. See |cinoptions-values| for the values of this option, and
1569 |C-indenting| for info on C indenting in general.
1570
1571
1572 *'cinwords'* *'cinw'*
1573'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1574 local to buffer
1575 {not in Vi}
1576 {not available when compiled without both the
1577 |+cindent| and the |+smartindent| features}
1578 These keywords start an extra indent in the next line when
1579 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1580 an appropriate place (inside {}).
1581 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1582 matter, include the keyword both the uppercase and lowercase:
1583 "if,If,IF".
1584
1585 *'clipboard'* *'cb'*
1586'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1587 for X-windows, "" otherwise)
1588 global
1589 {not in Vi}
1590 {only in GUI versions or when the |+xterm_clipboard|
1591 feature is included}
1592 This option is a list of comma separated names.
1593 These names are recognized:
1594
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001595 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 unnamed When included, Vim will use the clipboard register '*'
1597 for all yank, delete, change and put operations which
1598 would normally go to the unnamed register. When a
1599 register is explicitly specified, it will always be
1600 used regardless of whether "unnamed" is in 'clipboard'
1601 or not. The clipboard register can always be
1602 explicitly accessed using the "* notation. Also see
1603 |gui-clipboard|.
1604
Bram Moolenaar30b65812012-07-12 22:01:11 +02001605 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001606 unnamedplus A variant of the "unnamed" flag which uses the
1607 clipboard register '+' (|quoteplus|) instead of
1608 register '*' for all yank, delete, change and put
1609 operations which would normally go to the unnamed
1610 register. When "unnamed" is also included to the
1611 option, yank operations (but not delete, change or
1612 put) will additionally copy the text into register
1613 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001614 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001615 Availability can be checked with: >
1616 if has('unnamedplus')
1617<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001618 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 autoselect Works like the 'a' flag in 'guioptions': If present,
1620 then whenever Visual mode is started, or the Visual
1621 area extended, Vim tries to become the owner of the
1622 windowing system's global selection or put the
1623 selected text on the clipboard used by the selection
1624 register "*. See |guioptions_a| and |quotestar| for
1625 details. When the GUI is active, the 'a' flag in
1626 'guioptions' is used, when the GUI is not active, this
1627 "autoselect" flag is used.
1628 Also applies to the modeless selection.
1629
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001630 *clipboard-autoselectplus*
1631 autoselectplus Like "autoselect" but using the + register instead of
1632 the * register. Compare to the 'P' flag in
1633 'guioptions'.
1634
1635 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 autoselectml Like "autoselect", but for the modeless selection
1637 only. Compare to the 'A' flag in 'guioptions'.
1638
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001639 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001640 html When the clipboard contains HTML, use this when
1641 pasting. When putting text on the clipboard, mark it
1642 as HTML. This works to copy rendered HTML from
1643 Firefox, paste it as raw HTML in Vim, select the HTML
1644 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001645 You probably want to add this only temporarily,
1646 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001647 Only supported for GTK version 2 and later.
1648 Only available with the |+multi_byte| feature.
1649
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001650 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 exclude:{pattern}
1652 Defines a pattern that is matched against the name of
1653 the terminal 'term'. If there is a match, no
1654 connection will be made to the X server. This is
1655 useful in this situation:
1656 - Running Vim in a console.
1657 - $DISPLAY is set to start applications on another
1658 display.
1659 - You do not want to connect to the X server in the
1660 console, but do want this in a terminal emulator.
1661 To never connect to the X server use: >
1662 exclude:.*
1663< This has the same effect as using the |-X| argument.
1664 Note that when there is no connection to the X server
1665 the window title won't be restored and the clipboard
1666 cannot be accessed.
1667 The value of 'magic' is ignored, {pattern} is
1668 interpreted as if 'magic' was on.
1669 The rest of the option value will be used for
1670 {pattern}, this must be the last entry.
1671
1672 *'cmdheight'* *'ch'*
1673'cmdheight' 'ch' number (default 1)
1674 global
1675 {not in Vi}
1676 Number of screen lines to use for the command-line. Helps avoiding
1677 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001678 The value of this option is stored with the tab page, so that each tab
1679 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680
1681 *'cmdwinheight'* *'cwh'*
1682'cmdwinheight' 'cwh' number (default 7)
1683 global
1684 {not in Vi}
1685 {not available when compiled without the |+vertsplit|
1686 feature}
1687 Number of screen lines to use for the command-line window. |cmdwin|
1688
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001689 *'colorcolumn'* *'cc'*
1690'colorcolumn' 'cc' string (default "")
1691 local to window
1692 {not in Vi}
1693 {not available when compiled without the |+syntax|
1694 feature}
1695 'colorcolumn' is a comma separated list of screen columns that are
1696 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1697 text. Will make screen redrawing slower.
1698 The screen column can be an absolute number, or a number preceded with
1699 '+' or '-', which is added to or subtracted from 'textwidth'. >
1700
1701 :set cc=+1 " highlight column after 'textwidth'
1702 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1703 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1704<
1705 When 'textwidth' is zero then the items with '-' and '+' are not used.
1706 A maximum of 256 columns are highlighted.
1707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 *'columns'* *'co'* *E594*
1709'columns' 'co' number (default 80 or terminal width)
1710 global
1711 {not in Vi}
1712 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001713 initialization and does not have to be set by hand. Also see
1714 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 When Vim is running in the GUI or in a resizable window, setting this
1716 option will cause the window size to be changed. When you only want
1717 to use the size for the GUI, put the command in your |gvimrc| file.
1718 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001719 number of columns of the display, the display may be messed up. For
1720 the GUI it is always possible and Vim limits the number of columns to
1721 what fits on the screen. You can use this command to get the widest
1722 window possible: >
1723 :set columns=9999
1724< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725
1726 *'comments'* *'com'* *E524* *E525*
1727'comments' 'com' string (default
1728 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1729 local to buffer
1730 {not in Vi}
1731 {not available when compiled without the |+comments|
1732 feature}
1733 A comma separated list of strings that can start a comment line. See
1734 |format-comments|. See |option-backslash| about using backslashes to
1735 insert a space.
1736
1737 *'commentstring'* *'cms'* *E537*
1738'commentstring' 'cms' string (default "/*%s*/")
1739 local to buffer
1740 {not in Vi}
1741 {not available when compiled without the |+folding|
1742 feature}
1743 A template for a comment. The "%s" in the value is replaced with the
1744 comment text. Currently only used to add markers for folding, see
1745 |fold-marker|.
1746
1747 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001748'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001749 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 global
1751 {not in Vi}
1752 This option has the effect of making Vim either more Vi-compatible, or
1753 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001754
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756 other options are also changed as a side effect.
1757 NOTE: Setting or resetting this option can have a lot of unexpected
1758 effects: Mappings are interpreted in another way, undo behaves
1759 differently, etc. If you set this option in your vimrc file, you
1760 should probably put it at the very start.
1761
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 By default this option is on and the Vi defaults are used for the
1763 options. This default was chosen for those people who want to use Vim
1764 just like Vi, and don't even (want to) know about the 'compatible'
1765 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001766 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001767 this option is switched off, and all options that have not been
1768 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001769 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001770 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001771 happen for the system-wide vimrc or gvimrc file, nor for a file given
1772 with the |-u| argument). Also see |compatible-default| and
1773 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 You can also set this option with the "-C" argument, and reset it with
1775 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777
Bram Moolenaar214641f2017-03-05 17:04:09 +01001778 When this option is set, numerous other options are set to make Vim as
1779 Vi-compatible as possible. When this option is unset, various options
1780 are set to make Vim more useful. The table below lists all the
1781 options affected.
1782 The {?} column indicates when the options are affected:
1783 + Means that the option is set to the value given in {set value} when
1784 'compatible' is set.
1785 & Means that the option is set to the value given in {set value} when
1786 'compatible' is set AND is set to its Vim default value when
1787 'compatible' is unset.
1788 - Means the option is NOT changed when setting 'compatible' but IS
1789 set to its Vim default when 'compatible' is unset.
1790 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791
Bram Moolenaar036986f2017-03-16 17:41:02 +01001792 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793
1794 'allowrevins' + off no CTRL-_ command
1795 'antialias' + off don't use antialiased fonts
1796 'arabic' + off reset arabic-related options
1797 'arabicshape' + on correct character shapes
1798 'backspace' + "" normal backspace
1799 'backup' + off no backup file
1800 'backupcopy' & Unix: "yes" backup file is a copy
1801 else: "auto" copy or rename backup file
1802 'balloonexpr' + "" text to show in evaluation balloon
1803 'breakindent' + off don't indent when wrapping lines
1804 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1805 'cindent' + off no C code indentation
1806 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1807 'copyindent' + off don't copy indent structure
1808 'cpoptions' & (all flags) Vi-compatible flags
1809 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001810 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001811 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001812 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001813 'cscopeverbose' + off see |cscopeverbose|
1814 'delcombine' + off unicode: delete whole char combination
1815 'digraph' + off no digraphs
1816 'esckeys' & off no <Esc>-keys in Insert mode
1817 'expandtab' + off tabs not expanded to spaces
1818 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'formatexpr' + "" use 'formatprg' for auto-formatting
1821 'formatoptions' & "vt" Vi compatible formatting
1822 'gdefault' + off no default 'g' flag for ":s"
1823 'history' & 0 no commandline history
1824 'hkmap' + off no Hebrew keyboard mapping
1825 'hkmapp' + off no phonetic Hebrew keyboard mapping
1826 'hlsearch' + off no highlighting of search matches
1827 'incsearch' + off no incremental searching
1828 'indentexpr' + "" no indenting by expression
1829 'insertmode' + off do not start in Insert mode
1830 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832 'joinspaces' + on insert 2 spaces after period
1833 'modeline' & off no modelines
1834 'more' & off no pauses in listings
1835 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1836 'numberwidth' & 8 min number of columns for line number
1837 'preserveindent'+ off don't preserve current indent structure
1838 when changing it
1839 'revins' + off no reverse insert
1840 'ruler' + off no ruler
1841 'scrolljump' + 1 no jump scroll
1842 'scrolloff' + 0 no scroll offset
1843 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1844 'shiftround' + off indent not rounded to shiftwidth
1845 'shortmess' & "" no shortening of messages
1846 'showcmd' & off command characters not shown
1847 'showmode' & off current mode not shown
1848 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1849 'smartcase' + off no automatic ignore case switch
1850 'smartindent' + off no smart indentation
1851 'smarttab' + off no smart tab size
1852 'softtabstop' + 0 tabs are always 'tabstop' positions
1853 'startofline' + on goto startofline with some commands
1854 'tagcase' & "followic" 'ignorecase' when searching tags file
1855 'tagrelative' & off tag file names are not relative
1856 'termguicolors' + off don't use highlight-(guifg|guibg)
1857 'textauto' & off no automatic textmode detection
1858 'textwidth' + 0 no automatic line wrap
1859 'tildeop' + off tilde is not an operator
1860 'ttimeout' + off no terminal timeout
1861 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001862 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001863 'virtualedit' + "" cursor can only be placed on characters
1864 'whichwrap' & "" left-right movements don't wrap
1865 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001867 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
1869 *'complete'* *'cpt'* *E535*
1870'complete' 'cpt' string (default: ".,w,b,u,t,i")
1871 local to buffer
1872 {not in Vi}
1873 This option specifies how keyword completion |ins-completion| works
1874 when CTRL-P or CTRL-N are used. It is also used for whole-line
1875 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1876 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001877 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 w scan buffers from other windows
1879 b scan other loaded buffers that are in the buffer list
1880 u scan the unloaded buffers that are in the buffer list
1881 U scan the buffers that are not in the buffer list
1882 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001883 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 k{dict} scan the file {dict}. Several "k" flags can be given,
1885 patterns are valid too. For example: >
1886 :set cpt=k/usr/dict/*,k~/spanish
1887< s scan the files given with the 'thesaurus' option
1888 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1889 are valid too.
1890 i scan current and included files
1891 d scan current and included files for defined name or macro
1892 |i_CTRL-X_CTRL-D|
1893 ] tag completion
1894 t same as "]"
1895
1896 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1897 not executed, this may lead to unexpected completions from some files
1898 (gzipped files for example). Unloaded buffers are not scanned for
1899 whole-line completion.
1900
1901 The default is ".,w,b,u,t,i", which means to scan:
1902 1. the current buffer
1903 2. buffers in other windows
1904 3. other loaded buffers
1905 4. unloaded buffers
1906 5. tags
1907 6. included files
1908
1909 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001910 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1911 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001913 *'completefunc'* *'cfu'*
1914'completefunc' 'cfu' string (default: empty)
1915 local to buffer
1916 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001917 {not available when compiled without the |+eval|
1918 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001919 This option specifies a function to be used for Insert mode completion
1920 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001921 See |complete-functions| for an explanation of how the function is
1922 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001923 This option cannot be set from a |modeline| or in the |sandbox|, for
1924 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001925
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001926 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001927'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001928 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001929 {not available when compiled without the
1930 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001931 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001932 A comma separated list of options for Insert mode completion
1933 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001934
1935 menu Use a popup menu to show the possible completions. The
1936 menu is only shown when there is more than one match and
1937 sufficient colors are available. |ins-completion-menu|
1938
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001939 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001940 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001941 match, e.g., what file it comes from.
1942
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001943 longest Only insert the longest common text of the matches. If
1944 the menu is displayed you can use CTRL-L to add more
1945 characters. Whether case is ignored depends on the kind
1946 of completion. For buffer text the 'ignorecase' option is
1947 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001948
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001949 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001950 completion in the preview window. Only works in
1951 combination with "menu" or "menuone".
1952
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001953 noinsert Do not insert any text for a match until the user selects
1954 a match from the menu. Only works in combination with
1955 "menu" or "menuone". No effect if "longest" is present.
1956
1957 noselect Do not select a match in the menu, force the user to
1958 select one from the menu. Only works in combination with
1959 "menu" or "menuone".
1960
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001961
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962 *'concealcursor'* *'cocu'*
1963'concealcursor' 'cocu' string (default: "")
1964 local to window
1965 {not in Vi}
1966 {not available when compiled without the |+conceal|
1967 feature}
1968 Sets the modes in which text in the cursor line can also be concealed.
1969 When the current mode is listed then concealing happens just like in
1970 other lines.
1971 n Normal mode
1972 v Visual mode
1973 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001974 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001975
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001976 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001977 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001978 are moving around text is concealed, but when starting to insert text
1979 or selecting a Visual area the concealed text is displayed, so that
1980 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001981 Keep in mind that the cursor position is not always where it's
1982 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983
1984
1985'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986 number (default 0)
1987 local to window
1988 {not in Vi}
1989 {not available when compiled without the |+conceal|
1990 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001991 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1992 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001993
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001994 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001995 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001996 1 Each block of concealed text is replaced with one
1997 character. If the syntax item does not have a custom
1998 replacement character defined (see |:syn-cchar|) the
1999 character defined in 'listchars' is used (default is a
2000 space).
2001 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002 2 Concealed text is completely hidden unless it has a
2003 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002004 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002005 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006
Bram Moolenaara7781e02010-07-19 20:13:22 +02002007 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002008 edit and copy the text. This can be changed with the 'concealcursor'
2009 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2012'confirm' 'cf' boolean (default off)
2013 global
2014 {not in Vi}
2015 When 'confirm' is on, certain operations that would normally
2016 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2017 instead raise a |dialog| asking if you wish to save the current
2018 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2019 If 'confirm' is off you can still activate confirmation for one
2020 command only (this is most useful in mappings) with the |:confirm|
2021 command.
2022 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2023
2024 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2025'conskey' 'consk' boolean (default off)
2026 global
2027 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002028 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029
2030 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2031'copyindent' 'ci' boolean (default off)
2032 local to buffer
2033 {not in Vi}
2034 Copy the structure of the existing lines indent when autoindenting a
2035 new line. Normally the new indent is reconstructed by a series of
2036 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2037 in which case only spaces are used). Enabling this option makes the
2038 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002039 existing line. 'expandtab' has no effect on these characters, a Tab
2040 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002042 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 Also see 'preserveindent'.
2044
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002045 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046'cpoptions' 'cpo' string (Vim default: "aABceFs",
2047 Vi default: all flags)
2048 global
2049 {not in Vi}
2050 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002051 this indicates Vi-compatible behavior. This is used for things where
2052 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 'cpoptions' stands for "compatible-options".
2054 Commas can be added for readability.
2055 To avoid problems with flags that are added in the future, use the
2056 "+=" and "-=" feature of ":set" |add-option-flags|.
2057 NOTE: This option is set to the Vi default value when 'compatible' is
2058 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002059 NOTE: This option is set to the POSIX default value at startup when
2060 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002061 variable exists |posix|. This means Vim tries to behave like the
2062 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063
2064 contains behavior ~
2065 *cpo-a*
2066 a When included, a ":read" command with a file name
2067 argument will set the alternate file name for the
2068 current window.
2069 *cpo-A*
2070 A When included, a ":write" command with a file name
2071 argument will set the alternate file name for the
2072 current window.
2073 *cpo-b*
2074 b "\|" in a ":map" command is recognized as the end of
2075 the map command. The '\' is included in the mapping,
2076 the text after the '|' is interpreted as the next
2077 command. Use a CTRL-V instead of a backslash to
2078 include the '|' in the mapping. Applies to all
2079 mapping, abbreviation, menu and autocmd commands.
2080 See also |map_bar|.
2081 *cpo-B*
2082 B A backslash has no special meaning in mappings,
2083 abbreviations and the "to" part of the menu commands.
2084 Remove this flag to be able to use a backslash like a
2085 CTRL-V. For example, the command ":map X \<Esc>"
2086 results in X being mapped to:
2087 'B' included: "\^[" (^[ is a real <Esc>)
2088 'B' excluded: "<Esc>" (5 characters)
2089 ('<' excluded in both cases)
2090 *cpo-c*
2091 c Searching continues at the end of any match at the
2092 cursor position, but not further than the start of the
2093 next line. When not present searching continues
2094 one character from the cursor position. With 'c'
2095 "abababababab" only gets three matches when repeating
2096 "/abab", without 'c' there are five matches.
2097 *cpo-C*
2098 C Do not concatenate sourced lines that start with a
2099 backslash. See |line-continuation|.
2100 *cpo-d*
2101 d Using "./" in the 'tags' option doesn't mean to use
2102 the tags file relative to the current file, but the
2103 tags file in the current directory.
2104 *cpo-D*
2105 D Can't use CTRL-K to enter a digraph after Normal mode
2106 commands with a character argument, like |r|, |f| and
2107 |t|.
2108 *cpo-e*
2109 e When executing a register with ":@r", always add a
2110 <CR> to the last line, also when the register is not
2111 linewise. If this flag is not present, the register
2112 is not linewise and the last line does not end in a
2113 <CR>, then the last line is put on the command-line
2114 and can be edited before hitting <CR>.
2115 *cpo-E*
2116 E It is an error when using "y", "d", "c", "g~", "gu" or
2117 "gU" on an Empty region. The operators only work when
2118 at least one character is to be operate on. Example:
2119 This makes "y0" fail in the first column.
2120 *cpo-f*
2121 f When included, a ":read" command with a file name
2122 argument will set the file name for the current buffer,
2123 if the current buffer doesn't have a file name yet.
2124 *cpo-F*
2125 F When included, a ":write" command with a file name
2126 argument will set the file name for the current
2127 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002128 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 *cpo-g*
2130 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002131 *cpo-H*
2132 H When using "I" on a line with only blanks, insert
2133 before the last blank. Without this flag insert after
2134 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 *cpo-i*
2136 i When included, interrupting the reading of a file will
2137 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 *cpo-I*
2139 I When moving the cursor up or down just after inserting
2140 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-j*
2142 j When joining lines, only add two spaces after a '.',
2143 not after '!' or '?'. Also see 'joinspaces'.
2144 *cpo-J*
2145 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002146 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 white space.
2148 *cpo-k*
2149 k Disable the recognition of raw key codes in
2150 mappings, abbreviations, and the "to" part of menu
2151 commands. For example, if <Key> sends ^[OA (where ^[
2152 is <Esc>), the command ":map X ^[OA" results in X
2153 being mapped to:
2154 'k' included: "^[OA" (3 characters)
2155 'k' excluded: "<Key>" (one key code)
2156 Also see the '<' flag below.
2157 *cpo-K*
2158 K Don't wait for a key code to complete when it is
2159 halfway a mapping. This breaks mapping <F1><F1> when
2160 only part of the second <F1> has been read. It
2161 enables cancelling the mapping by typing <F1><Esc>.
2162 *cpo-l*
2163 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002164 literally, only "\]", "\^", "\-" and "\\" are special.
2165 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2167 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002168 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 *cpo-L*
2170 L When the 'list' option is set, 'wrapmargin',
2171 'textwidth', 'softtabstop' and Virtual Replace mode
2172 (see |gR|) count a <Tab> as two characters, instead of
2173 the normal behavior of a <Tab>.
2174 *cpo-m*
2175 m When included, a showmatch will always wait half a
2176 second. When not included, a showmatch will wait half
2177 a second or until a character is typed. |'showmatch'|
2178 *cpo-M*
2179 M When excluded, "%" matching will take backslashes into
2180 account. Thus in "( \( )" and "\( ( \)" the outer
2181 parenthesis match. When included "%" ignores
2182 backslashes, which is Vi compatible.
2183 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002184 n When included, the column used for 'number' and
2185 'relativenumber' will also be used for text of wrapped
2186 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *cpo-o*
2188 o Line offset to search command is not remembered for
2189 next search.
2190 *cpo-O*
2191 O Don't complain if a file is being overwritten, even
2192 when it didn't exist when editing it. This is a
2193 protection against a file unexpectedly created by
2194 someone else. Vi didn't complain about this.
2195 *cpo-p*
2196 p Vi compatible Lisp indenting. When not present, a
2197 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002198 *cpo-P*
2199 P When included, a ":write" command that appends to a
2200 file will set the file name for the current buffer, if
2201 the current buffer doesn't have a file name yet and
2202 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002203 *cpo-q*
2204 q When joining multiple lines leave the cursor at the
2205 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 *cpo-r*
2207 r Redo ("." command) uses "/" to repeat a search
2208 command, instead of the actually used search string.
2209 *cpo-R*
2210 R Remove marks from filtered lines. Without this flag
2211 marks are kept like |:keepmarks| was used.
2212 *cpo-s*
2213 s Set buffer options when entering the buffer for the
2214 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002215 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 set when the buffer is created.
2217 *cpo-S*
2218 S Set buffer options always when entering a buffer
2219 (except 'readonly', 'fileformat', 'filetype' and
2220 'syntax'). This is the (most) Vi compatible setting.
2221 The options are set to the values in the current
2222 buffer. When you change an option and go to another
2223 buffer, the value is copied. Effectively makes the
2224 buffer options global to all buffers.
2225
2226 's' 'S' copy buffer options
2227 no no when buffer created
2228 yes no when buffer first entered (default)
2229 X yes each time when buffer entered (vi comp.)
2230 *cpo-t*
2231 t Search pattern for the tag command is remembered for
2232 "n" command. Otherwise Vim only puts the pattern in
2233 the history for search pattern, but doesn't change the
2234 last used search pattern.
2235 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002236 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 *cpo-v*
2238 v Backspaced characters remain visible on the screen in
2239 Insert mode. Without this flag the characters are
2240 erased from the screen right away. With this flag the
2241 screen newly typed text overwrites backspaced
2242 characters.
2243 *cpo-w*
2244 w When using "cw" on a blank character, only change one
2245 character and not all blanks until the start of the
2246 next word.
2247 *cpo-W*
2248 W Don't overwrite a readonly file. When omitted, ":w!"
2249 overwrites a readonly file, if possible.
2250 *cpo-x*
2251 x <Esc> on the command-line executes the command-line.
2252 The default in Vim is to abandon the command-line,
2253 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 *cpo-X*
2255 X When using a count with "R" the replaced text is
2256 deleted only once. Also when repeating "R" with "."
2257 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 *cpo-y*
2259 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002260 *cpo-Z*
2261 Z When using "w!" while the 'readonly' option is set,
2262 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 *cpo-!*
2264 ! When redoing a filter command, use the last used
2265 external command, whatever it was. Otherwise the last
2266 used -filter- command is used.
2267 *cpo-$*
2268 $ When making a change to one line, don't redisplay the
2269 line, but put a '$' at the end of the changed text.
2270 The changed text will be overwritten when you type the
2271 new text. The line is redisplayed if you type any
2272 command that moves the cursor from the insertion
2273 point.
2274 *cpo-%*
2275 % Vi-compatible matching is done for the "%" command.
2276 Does not recognize "#if", "#endif", etc.
2277 Does not recognize "/*" and "*/".
2278 Parens inside single and double quotes are also
2279 counted, causing a string that contains a paren to
2280 disturb the matching. For example, in a line like
2281 "if (strcmp("foo(", s))" the first paren does not
2282 match the last one. When this flag is not included,
2283 parens inside single and double quotes are treated
2284 specially. When matching a paren outside of quotes,
2285 everything inside quotes is ignored. When matching a
2286 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002287 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002288 This flag is also used for other features, such as
2289 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002290 *cpo--*
2291 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002292 it would go above the first line or below the last
2293 line. Without it the cursor moves to the first or
2294 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002295 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002296 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002297 *cpo-+*
2298 + When included, a ":write file" command will reset the
2299 'modified' flag of the buffer, even though the buffer
2300 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002301 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 * Use ":*" in the same way as ":@". When not included,
2303 ":*" is an alias for ":'<,'>", select the Visual area.
2304 *cpo-<*
2305 < Disable the recognition of special key codes in |<>|
2306 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002307 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 ":map X <Tab>" results in X being mapped to:
2309 '<' included: "<Tab>" (5 characters)
2310 '<' excluded: "^I" (^I is a real <Tab>)
2311 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002312 *cpo->*
2313 > When appending to a register, put a line break before
2314 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002315 *cpo-;*
2316 ; When using |,| or |;| to repeat the last |t| search
2317 and the cursor is right in front of the searched
2318 character, the cursor won't move. When not included,
2319 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002320 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002321
2322 POSIX flags. These are not included in the Vi default value, except
2323 when $VIM_POSIX was set on startup. |posix|
2324
2325 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002326 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328 *cpo-&*
2329 & When ":preserve" was used keep the swap file when
2330 exiting normally while this buffer is still loaded.
2331 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002332 *cpo-\*
2333 \ Backslash in a [] range in a search pattern is taken
2334 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002335 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2336 '\' excluded: "/[ \-]" finds <Space> and '-'
2337 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002338 *cpo-/*
2339 / When "%" is used as the replacement string in a |:s|
2340 command, use the previous replacement string. |:s%|
2341 *cpo-{*
2342 { The |{| and |}| commands also stop at a "{" character
2343 at the start of a line.
2344 *cpo-.*
2345 . The ":chdir" and ":cd" commands fail if the current
2346 buffer is modified, unless ! is used. Vim doesn't
2347 need this, since it remembers the full path of an
2348 opened file.
2349 *cpo-bar*
2350 | The value of the $LINES and $COLUMNS environment
2351 variables overrule the terminal size values obtained
2352 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002353
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002355 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002356'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002357 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002358 {not in Vi}
2359 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002360 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002361 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002362 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002363 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002364 blowfish Blowfish method. Medium strong encryption but it has
2365 an implementation flaw. Requires Vim 7.3 or later,
2366 files can NOT be read by Vim 7.2 and older. This adds
2367 a "seed" to the file, every time you write the file
2368 the encrypted bytes will be different.
2369 *blowfish2*
2370 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002371 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002372 and older. This adds a "seed" to the file, every time
2373 you write the file the encrypted bytes will be
2374 different. The whole undo file is encrypted, not just
2375 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002376
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002377 You should use "blowfish2", also to re-encrypt older files.
2378
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002379 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002380 to the detected method of the file being read. Thus if you write it
2381 without changing 'cryptmethod' the same method will be used.
2382 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002383 explicitly write it, you don't get a warning unless there are other
2384 modifications. Also see |:X|.
2385
2386 When setting the global value to an empty string, it will end up with
2387 the value "zip". When setting the local value to an empty string the
2388 buffer will use the global value.
2389
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002390 When a new encryption method is added in a later version of Vim, and
2391 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002392 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002393
2394
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 *'cscopepathcomp'* *'cspc'*
2396'cscopepathcomp' 'cspc' number (default 0)
2397 global
2398 {not available when compiled without the |+cscope|
2399 feature}
2400 {not in Vi}
2401 Determines how many components of the path to show in a list of tags.
2402 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002403 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404
2405 *'cscopeprg'* *'csprg'*
2406'cscopeprg' 'csprg' string (default "cscope")
2407 global
2408 {not available when compiled without the |+cscope|
2409 feature}
2410 {not in Vi}
2411 Specifies the command to execute cscope. See |cscopeprg|.
2412 This option cannot be set from a |modeline| or in the |sandbox|, for
2413 security reasons.
2414
2415 *'cscopequickfix'* *'csqf'*
2416'cscopequickfix' 'csqf' string (default "")
2417 global
2418 {not available when compiled without the |+cscope|
2419 or |+quickfix| features}
2420 {not in Vi}
2421 Specifies whether to use quickfix window to show cscope results.
2422 See |cscopequickfix|.
2423
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002424 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002425'cscoperelative' 'csre' boolean (default off)
2426 global
2427 {not available when compiled without the |+cscope|
2428 feature}
2429 {not in Vi}
2430 In the absence of a prefix (-P) for cscope. setting this option enables
2431 to use the basename of cscope.out path as the prefix.
2432 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002433 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002434
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2436'cscopetag' 'cst' boolean (default off)
2437 global
2438 {not available when compiled without the |+cscope|
2439 feature}
2440 {not in Vi}
2441 Use cscope for tag commands. See |cscope-options|.
2442 NOTE: This option is reset when 'compatible' is set.
2443
2444 *'cscopetagorder'* *'csto'*
2445'cscopetagorder' 'csto' number (default 0)
2446 global
2447 {not available when compiled without the |+cscope|
2448 feature}
2449 {not in Vi}
2450 Determines the order in which ":cstag" performs a search. See
2451 |cscopetagorder|.
2452 NOTE: This option is set to 0 when 'compatible' is set.
2453
2454 *'cscopeverbose'* *'csverb'*
2455 *'nocscopeverbose'* *'nocsverb'*
2456'cscopeverbose' 'csverb' boolean (default off)
2457 global
2458 {not available when compiled without the |+cscope|
2459 feature}
2460 {not in Vi}
2461 Give messages when adding a cscope database. See |cscopeverbose|.
2462 NOTE: This option is reset when 'compatible' is set.
2463
Bram Moolenaar860cae12010-06-05 23:22:07 +02002464 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2465'cursorbind' 'crb' boolean (default off)
2466 local to window
2467 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002468 When this option is set, as the cursor in the current
2469 window moves other cursorbound windows (windows that also have
2470 this option set) move their cursors to the corresponding line and
2471 column. This option is useful for viewing the
2472 differences between two versions of a file (see 'diff'); in diff mode,
2473 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002474 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002475
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002476
2477 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2478'cursorcolumn' 'cuc' boolean (default off)
2479 local to window
2480 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002481 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002482 feature}
2483 Highlight the screen column of the cursor with CursorColumn
2484 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2485 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002486 If you only want the highlighting in the current window you can use
2487 these autocommands: >
2488 au WinLeave * set nocursorline nocursorcolumn
2489 au WinEnter * set cursorline cursorcolumn
2490<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002491
2492 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2493'cursorline' 'cul' boolean (default off)
2494 local to window
2495 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002496 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002497 feature}
2498 Highlight the screen line of the cursor with CursorLine
2499 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2500 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002501 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002502 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002503
2504
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 *'debug'*
2506'debug' string (default "")
2507 global
2508 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002509 These values can be used:
2510 msg Error messages that would otherwise be omitted will be given
2511 anyway.
2512 throw Error messages that would otherwise be omitted will be given
2513 anyway and also throw an exception and set |v:errmsg|.
2514 beep A message will be given when otherwise only a beep would be
2515 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002516 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002517 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2518 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519
2520 *'define'* *'def'*
2521'define' 'def' string (default "^\s*#\s*define")
2522 global or local to buffer |global-local|
2523 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 pattern, just like for the "/" command. This option is used for the
2526 commands like "[i" and "[d" |include-search|. The 'isident' option is
2527 used to recognize the defined name after the match:
2528 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2529 See |option-backslash| about inserting backslashes to include a space
2530 or backslash.
2531 The default value is for C programs. For C++ this value would be
2532 useful, to include const type declarations: >
2533 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2534< When using the ":set" command, you need to double the backslashes!
2535
2536 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2537'delcombine' 'deco' boolean (default off)
2538 global
2539 {not in Vi}
2540 {only available when compiled with the |+multi_byte|
2541 feature}
2542 If editing Unicode and this option is set, backspace and Normal mode
2543 "x" delete each combining character on its own. When it is off (the
2544 default) the character along with its combining characters are
2545 deleted.
2546 Note: When 'delcombine' is set "xx" may work different from "2x"!
2547
2548 This is useful for Arabic, Hebrew and many other languages where one
2549 may have combining characters overtop of base characters, and want
2550 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002551 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552
2553 *'dictionary'* *'dict'*
2554'dictionary' 'dict' string (default "")
2555 global or local to buffer |global-local|
2556 {not in Vi}
2557 List of file names, separated by commas, that are used to lookup words
2558 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2559 contain a list of words. This can be one word per line, or several
2560 words per line, separated by non-keyword characters (white space is
2561 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002562 When this option is empty, or an entry "spell" is present, spell
2563 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002564 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 after a comma are ignored, otherwise spaces are included in the file
2566 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002567 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 Where to find a list of words?
2569 - On FreeBSD, there is the file "/usr/share/dict/words".
2570 - In the Simtel archive, look in the "msdos/linguist" directory.
2571 - In "miscfiles" of the GNU collection.
2572 The use of |:set+=| and |:set-=| is preferred when adding or removing
2573 directories from the list. This avoids problems when a future version
2574 uses another default.
2575 Backticks cannot be used in this option for security reasons.
2576
2577 *'diff'* *'nodiff'*
2578'diff' boolean (default off)
2579 local to window
2580 {not in Vi}
2581 {not available when compiled without the |+diff|
2582 feature}
2583 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002584 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585
2586 *'dex'* *'diffexpr'*
2587'diffexpr' 'dex' string (default "")
2588 global
2589 {not in Vi}
2590 {not available when compiled without the |+diff|
2591 feature}
2592 Expression which is evaluated to obtain an ed-style diff file from two
2593 versions of a file. See |diff-diffexpr|.
2594 This option cannot be set from a |modeline| or in the |sandbox|, for
2595 security reasons.
2596
2597 *'dip'* *'diffopt'*
2598'diffopt' 'dip' string (default "filler")
2599 global
2600 {not in Vi}
2601 {not available when compiled without the |+diff|
2602 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002603 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 All are optional. Items must be separated by a comma.
2605
2606 filler Show filler lines, to keep the text
2607 synchronized with a window that has inserted
2608 lines at the same position. Mostly useful
2609 when windows are side-by-side and 'scrollbind'
2610 is set.
2611
2612 context:{n} Use a context of {n} lines between a change
2613 and a fold that contains unchanged lines.
2614 When omitted a context of six lines is used.
2615 See |fold-diff|.
2616
2617 icase Ignore changes in case of text. "a" and "A"
2618 are considered the same. Adds the "-i" flag
2619 to the "diff" command if 'diffexpr' is empty.
2620
2621 iwhite Ignore changes in amount of white space. Adds
2622 the "-b" flag to the "diff" command if
2623 'diffexpr' is empty. Check the documentation
2624 of the "diff" command for what this does
2625 exactly. It should ignore adding trailing
2626 white space, but not leading white space.
2627
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002628 horizontal Start diff mode with horizontal splits (unless
2629 explicitly specified otherwise).
2630
2631 vertical Start diff mode with vertical splits (unless
2632 explicitly specified otherwise).
2633
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002634 hiddenoff Do not use diff mode for a buffer when it
2635 becomes hidden.
2636
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002637 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2638 starting diff mode. Without this 2 is used.
2639
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 Examples: >
2641
2642 :set diffopt=filler,context:4
2643 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002644 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645<
2646 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2647'digraph' 'dg' boolean (default off)
2648 global
2649 {not in Vi}
2650 {not available when compiled without the |+digraphs|
2651 feature}
2652 Enable the entering of digraphs in Insert mode with {char1} <BS>
2653 {char2}. See |digraphs|.
2654 NOTE: This option is reset when 'compatible' is set.
2655
2656 *'directory'* *'dir'*
2657'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002658 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 for Unix: ".,~/tmp,/var/tmp,/tmp")
2660 global
2661 List of directory names for the swap file, separated with commas.
2662 - The swap file will be created in the first directory where this is
2663 possible.
2664 - Empty means that no swap file will be used (recovery is
2665 impossible!).
2666 - A directory "." means to put the swap file in the same directory as
2667 the edited file. On Unix, a dot is prepended to the file name, so
2668 it doesn't show in a directory listing. On MS-Windows the "hidden"
2669 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002670 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 put the swap file relative to where the edited file is. The leading
2672 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002673 - For Unix and Win32, if a directory ends in two path separators "//"
2674 or "\\", the swap file name will be built from the complete path to
2675 the file with all path separators substituted to percent '%' signs.
2676 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002677 On Win32, when a separating comma is following, you must use "//",
2678 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 - Spaces after the comma are ignored, other spaces are considered part
2680 of the directory name. To have a space at the start of a directory
2681 name, precede it with a backslash.
2682 - To include a comma in a directory name precede it with a backslash.
2683 - A directory name may end in an ':' or '/'.
2684 - Environment variables are expanded |:set_env|.
2685 - Careful with '\' characters, type one before a space, type two to
2686 get one in the option (see |option-backslash|), for example: >
2687 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2688< - For backwards compatibility with Vim version 3.0 a '>' at the start
2689 of the option is removed.
2690 Using "." first in the list is recommended. This means that editing
2691 the same file twice will result in a warning. Using "/tmp" on Unix is
2692 discouraged: When the system crashes you lose the swap file.
2693 "/var/tmp" is often not cleared when rebooting, thus is a better
2694 choice than "/tmp". But it can contain a lot of files, your swap
2695 files get lost in the crowd. That is why a "tmp" directory in your
2696 home directory is tried first.
2697 The use of |:set+=| and |:set-=| is preferred when adding or removing
2698 directories from the list. This avoids problems when a future version
2699 uses another default.
2700 This option cannot be set from a |modeline| or in the |sandbox|, for
2701 security reasons.
2702 {Vi: directory to put temp file in, defaults to "/tmp"}
2703
2704 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002705'display' 'dy' string (default "", set to "truncate" in
2706 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 global
2708 {not in Vi}
2709 Change the way text is displayed. This is comma separated list of
2710 flags:
2711 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002712 in a window will be displayed. "@@@" is put in the
2713 last columns of the last screen line to indicate the
2714 rest of the line is not displayed.
2715 truncate Like "lastline", but "@@@" is displayed in the first
2716 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 uhex Show unprintable characters hexadecimal as <xx>
2718 instead of using ^C and ~C.
2719
Bram Moolenaard0796902016-09-16 20:02:31 +02002720 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002721 doesn't fit is replaced with "@" lines.
2722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 *'eadirection'* *'ead'*
2724'eadirection' 'ead' string (default "both")
2725 global
2726 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002727 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 feature}
2729 Tells when the 'equalalways' option applies:
2730 ver vertically, width of windows is not affected
2731 hor horizontally, height of windows is not affected
2732 both width and height of windows is affected
2733
2734 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2735'edcompatible' 'ed' boolean (default off)
2736 global
2737 Makes the 'g' and 'c' flags of the ":substitute" command to be
2738 toggled each time the flag is given. See |complex-change|. See
2739 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002740 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741
Bram Moolenaar03413f42016-04-12 21:07:15 +02002742 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002743'emoji' 'emo' boolean (default: on)
2744 global
2745 {not in Vi}
2746 {only available when compiled with the |+multi_byte|
2747 feature}
2748 When on all Unicode emoji characters are considered to be full width.
2749
2750
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 *'encoding'* *'enc'* *E543*
2752'encoding' 'enc' string (default: "latin1" or value from $LANG)
2753 global
2754 {only available when compiled with the |+multi_byte|
2755 feature}
2756 {not in Vi}
2757 Sets the character encoding used inside Vim. It applies to text in
2758 the buffers, registers, Strings in expressions, text stored in the
2759 viminfo file, etc. It sets the kind of characters which Vim can work
2760 with. See |encoding-names| for the possible values.
2761
2762 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002763 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002765 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
Bram Moolenaar865242e2010-07-14 21:12:05 +02002767 This option cannot be set from a |modeline|. It would most likely
2768 corrupt the text.
2769
Bram Moolenaar3df01732017-02-17 22:47:16 +01002770 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2771 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 'encoding', "utf-8" is the natural choice for the environment and
2773 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 versions, and to avoid changing the encoding of newly created files
2776 without your knowledge (in case 'fileencodings' is empty).
2777
2778 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 iconv() or as specified with 'charconvert'.
2781
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002782 If you need to know whether 'encoding' is a multi-byte encoding, you
2783 can use: >
2784 if has("multi_byte_encoding")
2785<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 Normally 'encoding' will be equal to your current locale. This will
2787 be the default if Vim recognizes your environment settings. If
2788 'encoding' is not set to the current locale, 'termencoding' must be
2789 set to convert typed and displayed text. See |encoding-table|.
2790
2791 When you set this option, it fires the |EncodingChanged| autocommand
2792 event so that you can set up fonts if necessary.
2793
2794 When the option is set, the value is converted to lowercase. Thus
2795 you can set it with uppercase values too. Underscores are translated
2796 to '-' signs.
2797 When the encoding is recognized, it is changed to the standard name.
2798 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2799 "iso-8859-2" and "utf8" becomes "utf-8".
2800
2801 Note: "latin1" is also used when the encoding could not be detected.
2802 This only works when editing files in the same encoding! When the
2803 actual character set is not latin1, make sure 'fileencoding' and
2804 'fileencodings' are empty. When conversion is needed, switch to using
2805 utf-8.
2806
2807 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2808 You don't notice this while editing, but it does matter for the
2809 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2810 setting 'encoding' to one of these values instead of utf-8 only has
2811 effect for encoding used for files when 'fileencoding' is empty.
2812
Bram Moolenaar661b1822005-07-28 22:36:45 +00002813 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2814 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815
2816 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2817'endofline' 'eol' boolean (default on)
2818 local to buffer
2819 {not in Vi}
2820 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002821 is on, or 'fixeol' option is off, no <EOL> will be written for the
2822 last line in the file. This option is automatically set or reset when
2823 starting to edit a new file, depending on whether file has an <EOL>
2824 for the last line in the file. Normally you don't have to set or
2825 reset this option.
2826 When 'binary' is off and 'fixeol' is on the value is not used when
2827 writing the file. When 'binary' is on or 'fixeol' is off it is used
2828 to remember the presence of a <EOL> for the last line in the file, so
2829 that when you write the file the situation from the original file can
2830 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831
2832 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2833'equalalways' 'ea' boolean (default on)
2834 global
2835 {not in Vi}
2836 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002837 splitting or closing a window. This also happens the moment the
2838 option is switched on. When off, splitting a window will reduce the
2839 size of the current window and leave the other windows the same. When
2840 closing a window the extra lines are given to the window next to it
2841 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 When mixing vertically and horizontally split windows, a minimal size
2843 is computed and some windows may be larger if there is room. The
2844 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002845 Changing the height and width of a window can be avoided by setting
2846 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002847 If a window size is specified when creating a new window sizes are
2848 currently not equalized (it's complicated, but may be implemented in
2849 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850
2851 *'equalprg'* *'ep'*
2852'equalprg' 'ep' string (default "")
2853 global or local to buffer |global-local|
2854 {not in Vi}
2855 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002856 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002857 or 'indentexpr'. When Vim was compiled without internal formatting,
2858 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002859 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 about including spaces and backslashes.
2861 This option cannot be set from a |modeline| or in the |sandbox|, for
2862 security reasons.
2863
2864 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2865'errorbells' 'eb' boolean (default off)
2866 global
2867 Ring the bell (beep or screen flash) for error messages. This only
2868 makes a difference for error messages, the bell will be used always
2869 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002870 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002871 screen flash or do nothing. See 'belloff' to finetune when to ring the
2872 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
2874 *'errorfile'* *'ef'*
2875'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2876 others: "errors.err")
2877 global
2878 {not in Vi}
2879 {not available when compiled without the |+quickfix|
2880 feature}
2881 Name of the errorfile for the QuickFix mode (see |:cf|).
2882 When the "-q" command-line argument is used, 'errorfile' is set to the
2883 following argument. See |-q|.
2884 NOT used for the ":make" command. See 'makeef' for that.
2885 Environment variables are expanded |:set_env|.
2886 See |option-backslash| about including spaces and backslashes.
2887 This option cannot be set from a |modeline| or in the |sandbox|, for
2888 security reasons.
2889
2890 *'errorformat'* *'efm'*
2891'errorformat' 'efm' string (default is very long)
2892 global or local to buffer |global-local|
2893 {not in Vi}
2894 {not available when compiled without the |+quickfix|
2895 feature}
2896 Scanf-like description of the format for the lines in the error file
2897 (see |errorformat|).
2898
2899 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2900'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2901 global
2902 {not in Vi}
2903 Function keys that start with an <Esc> are recognized in Insert
2904 mode. When this option is off, the cursor and function keys cannot be
2905 used in Insert mode if they start with an <Esc>. The advantage of
2906 this is that the single <Esc> is recognized immediately, instead of
2907 after one second. Instead of resetting this option, you might want to
2908 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2909 when 'esckeys' is off, you can still map anything, but the cursor keys
2910 won't work by default.
2911 NOTE: This option is set to the Vi default value when 'compatible' is
2912 set and to the Vim default value when 'compatible' is reset.
2913
2914 *'eventignore'* *'ei'*
2915'eventignore' 'ei' string (default "")
2916 global
2917 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002919 When set to "all" or when "all" is one of the items, all autocommand
2920 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 Otherwise this is a comma separated list of event names. Example: >
2922 :set ei=WinEnter,WinLeave
2923<
2924 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2925'expandtab' 'et' boolean (default off)
2926 local to buffer
2927 {not in Vi}
2928 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002929 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2931 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002932 This option is reset when the 'paste' option is set and restored when
2933 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 NOTE: This option is reset when 'compatible' is set.
2935
2936 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2937'exrc' 'ex' boolean (default off)
2938 global
2939 {not in Vi}
2940 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002941 directory.
2942
2943 Setting this option is a potential security leak. E.g., consider
2944 unpacking a package or fetching files from github, a .vimrc in there
2945 might be a trojan horse. BETTER NOT SET THIS OPTION!
2946 Instead, define an autocommand in your .vimrc to set options for a
2947 matching directory.
2948
2949 If you do switch this option on you should also consider setting the
2950 'secure' option (see |initialization|).
2951 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 This option cannot be set from a |modeline| or in the |sandbox|, for
2953 security reasons.
2954
2955 *'fileencoding'* *'fenc'* *E213*
2956'fileencoding' 'fenc' string (default: "")
2957 local to buffer
2958 {only available when compiled with the |+multi_byte|
2959 feature}
2960 {not in Vi}
2961 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002964 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 When 'fileencoding' is empty, the same value as 'encoding' will be
2966 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002967 No error will be given when the value is set, only when it is used,
2968 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002969 Conversion will also be done when 'encoding' and 'fileencoding' are
2970 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2971 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002973 'encoding' is "utf-8" or another Unicode encoding, conversion
2974 is most likely done in a way that the reverse conversion
2975 results in the same text. When 'encoding' is not "utf-8" some
2976 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002977
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 See 'encoding' for the possible values. Additionally, values may be
2979 specified that can be handled by the converter, see
2980 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002981
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 When reading a file 'fileencoding' will be set from 'fileencodings'.
2983 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002984 'fileencoding', use the |++enc| argument. One exception: when
2985 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002986 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2989 When the option is set, the value is converted to lowercase. Thus
2990 you can set it with uppercase values too. '_' characters are
2991 replaced with '-'. If a name is recognized from the list for
2992 'encoding', it is replaced by the standard name. For example
2993 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 When this option is set, after starting to edit a file, the 'modified'
2996 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002997
2998 Keep in mind that changing 'fenc' from a modeline happens
2999 AFTER the text has been read, thus it applies to when the file will be
3000 written. If you do set 'fenc' in a modeline, you might want to set
3001 'nomodified' to avoid not being able to ":q".
3002
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 This option can not be changed when 'modifiable' is off.
3004
3005 *'fe'*
3006 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003007 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 old short name was 'fe', which is no longer used.
3009
3010 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003011'fileencodings' 'fencs' string (default: "ucs-bom",
3012 "ucs-bom,utf-8,default,latin1" when
3013 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 global
3015 {only available when compiled with the |+multi_byte|
3016 feature}
3017 {not in Vi}
3018 This is a list of character encodings considered when starting to edit
3019 an existing file. When a file is read, Vim tries to use the first
3020 mentioned character encoding. If an error is detected, the next one
3021 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003022 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 an empty string, which means the value of 'encoding' is used.
3024 WARNING: Conversion can cause loss of information! When
3025 'encoding' is "utf-8" (or one of the other Unicode variants)
3026 conversion is most likely done in a way that the reverse
3027 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003028 "utf-8" some non-ASCII characters may be lost! You can use
3029 the |++bad| argument to specify what is done with characters
3030 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 For an empty file or a file with only ASCII characters most encodings
3032 will work and the first entry of 'fileencodings' will be used (except
3033 "ucs-bom", which requires the BOM to be present). If you prefer
3034 another encoding use an BufReadPost autocommand event to test if your
3035 preferred encoding is to be used. Example: >
3036 au BufReadPost * if search('\S', 'w') == 0 |
3037 \ set fenc=iso-2022-jp | endif
3038< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3039 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003040 When the |++enc| argument is used then the value of 'fileencodings' is
3041 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003042 Note that 'fileencodings' is not used for a new file, the global value
3043 of 'fileencoding' is used instead. You can set it with: >
3044 :setglobal fenc=iso-8859-2
3045< This means that a non-existing file may get a different encoding than
3046 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 The special value "ucs-bom" can be used to check for a Unicode BOM
3048 (Byte Order Mark) at the start of the file. It must not be preceded
3049 by "utf-8" or another Unicode encoding for this to work properly.
3050 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3051 because Vim cannot detect an error, thus the encoding is always
3052 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003053 The special value "default" can be used for the encoding from the
3054 environment. This is the default value for 'encoding'. It is useful
3055 when 'encoding' is set to "utf-8" and your environment uses a
3056 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003057 When 'encoding' is "utf-8" and a file contains an illegal byte
3058 sequence it won't be recognized as UTF-8. You can use the |8g8|
3059 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 WRONG VALUES: WHAT'S WRONG:
3061 latin1,utf-8 "latin1" will always be used
3062 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3063 file
3064 cp1250,latin1 "cp1250" will always be used
3065 If 'fileencodings' is empty, 'fileencoding' is not modified.
3066 See 'fileencoding' for the possible values.
3067 Setting this option does not have an effect until the next time a file
3068 is read.
3069
3070 *'fileformat'* *'ff'*
3071'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3072 Unix default: "unix",
3073 Macintosh default: "mac")
3074 local to buffer
3075 {not in Vi}
3076 This gives the <EOL> of the current buffer, which is used for
3077 reading/writing the buffer from/to a file:
3078 dos <CR> <NL>
3079 unix <NL>
3080 mac <CR>
3081 When "dos" is used, CTRL-Z at the end of a file is ignored.
3082 See |file-formats| and |file-read|.
3083 For the character encoding of the file see 'fileencoding'.
3084 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003085 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 This option is set automatically when starting to edit a file and
3087 'fileformats' is not empty and 'binary' is off.
3088 When this option is set, after starting to edit a file, the 'modified'
3089 option is set, because the file would be different when written.
3090 This option can not be changed when 'modifiable' is off.
3091 For backwards compatibility: When this option is set to "dos",
3092 'textmode' is set, otherwise 'textmode' is reset.
3093
3094 *'fileformats'* *'ffs'*
3095'fileformats' 'ffs' string (default:
3096 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3097 Vim Unix: "unix,dos",
3098 Vim Mac: "mac,unix,dos",
3099 Vi Cygwin: "unix,dos",
3100 Vi others: "")
3101 global
3102 {not in Vi}
3103 This gives the end-of-line (<EOL>) formats that will be tried when
3104 starting to edit a new buffer and when reading a file into an existing
3105 buffer:
3106 - When empty, the format defined with 'fileformat' will be used
3107 always. It is not set automatically.
3108 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003109 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 'fileformats' name will be used when a file is read into an existing
3111 buffer, no matter what 'fileformat' for that buffer is set to.
3112 - When more than one name is present, separated by commas, automatic
3113 <EOL> detection will be done when reading a file. When starting to
3114 edit a file, a check is done for the <EOL>:
3115 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3116 'fileformat' is set to "dos".
3117 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003118 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003120 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3121 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003122 This means that "mac" is only chosen when:
3123 "unix" is not present or no <NL> is found in the file, and
3124 "dos" is not present or no <CR><NL> is found in the file.
3125 Except: if "unix" was chosen, but there is a <CR> before
3126 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003127 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 4. If 'fileformat' is still not set, the first name from
3129 'fileformats' is used.
3130 When reading a file into an existing buffer, the same is done, but
3131 this happens like 'fileformat' has been set appropriately for that
3132 file only, the option is not changed.
3133 When 'binary' is set, the value of 'fileformats' is not used.
3134
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003135 When Vim starts up with an empty buffer the first item is used. You
3136 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003137
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3139 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3140 done:
3141 - When 'fileformats' is empty, there is no automatic detection. Dos
3142 format will be used.
3143 - When 'fileformats' is set to one or more names, automatic detection
3144 is done. This is based on the first <NL> in the file: If there is a
3145 <CR> in front of it, Dos format is used, otherwise Unix format is
3146 used.
3147 Also see |file-formats|.
3148 For backwards compatibility: When this option is set to an empty
3149 string or one format (no comma is included), 'textauto' is reset,
3150 otherwise 'textauto' is set.
3151 NOTE: This option is set to the Vi default value when 'compatible' is
3152 set and to the Vim default value when 'compatible' is reset.
3153
Bram Moolenaarbf884932013-04-05 22:26:15 +02003154 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3155'fileignorecase' 'fic' boolean (default on for systems where case in file
3156 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003157 global
3158 {not in Vi}
3159 When set case is ignored when using file names and directories.
3160 See 'wildignorecase' for only ignoring case when doing completion.
3161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 *'filetype'* *'ft'*
3163'filetype' 'ft' string (default: "")
3164 local to buffer
3165 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 When this option is set, the FileType autocommand event is triggered.
3167 All autocommands that match with the value of this option will be
3168 executed. Thus the value of 'filetype' is used in place of the file
3169 name.
3170 Otherwise this option does not always reflect the current file type.
3171 This option is normally set when the file type is detected. To enable
3172 this use the ":filetype on" command. |:filetype|
3173 Setting this option to a different value is most useful in a modeline,
3174 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003175 Example, for in an IDL file:
3176 /* vim: set filetype=idl : */ ~
3177 |FileType| |filetypes|
3178 When a dot appears in the value then this separates two filetype
3179 names. Example:
3180 /* vim: set filetype=c.doxygen : */ ~
3181 This will use the "c" filetype first, then the "doxygen" filetype.
3182 This works both for filetype plugins and for syntax files. More than
3183 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 This option is not copied to another buffer, independent of the 's' or
3185 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003186 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187
3188 *'fillchars'* *'fcs'*
3189'fillchars' 'fcs' string (default "vert:|,fold:-")
3190 global
3191 {not in Vi}
3192 {not available when compiled without the |+windows|
3193 and |+folding| features}
3194 Characters to fill the statuslines and vertical separators.
3195 It is a comma separated list of items:
3196
3197 item default Used for ~
3198 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003199 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 vert:c '|' vertical separators |:vsplit|
3201 fold:c '-' filling 'foldtext'
3202 diff:c '-' deleted lines of the 'diff' option
3203
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003205 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 otherwise.
3207
3208 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003209 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210< This is similar to the default, except that these characters will also
3211 be used when there is highlighting.
3212
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003213 for "stl" and "stlnc" only single-byte values are supported.
3214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 The highlighting used for these items:
3216 item highlight group ~
3217 stl:c StatusLine |hl-StatusLine|
3218 stlnc:c StatusLineNC |hl-StatusLineNC|
3219 vert:c VertSplit |hl-VertSplit|
3220 fold:c Folded |hl-Folded|
3221 diff:c DiffDelete |hl-DiffDelete|
3222
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003223 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3224'fixendofline' 'fixeol' boolean (default on)
3225 local to buffer
3226 {not in Vi}
3227 When writing a file and this option is on, <EOL> at the end of file
3228 will be restored if missing. Turn this option off if you want to
3229 preserve the situation from the original file.
3230 When the 'binary' option is set the value of this option doesn't
3231 matter.
3232 See the 'endofline' option.
3233
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3235'fkmap' 'fk' boolean (default off) *E198*
3236 global
3237 {not in Vi}
3238 {only available when compiled with the |+rightleft|
3239 feature}
3240 When on, the keyboard is mapped for the Farsi character set.
3241 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003242 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243
3244 *'foldclose'* *'fcl'*
3245'foldclose' 'fcl' string (default "")
3246 global
3247 {not in Vi}
3248 {not available when compiled without the |+folding|
3249 feature}
3250 When set to "all", a fold is closed when the cursor isn't in it and
3251 its level is higher than 'foldlevel'. Useful if you want folds to
3252 automatically close when moving out of them.
3253
3254 *'foldcolumn'* *'fdc'*
3255'foldcolumn' 'fdc' number (default 0)
3256 local to window
3257 {not in Vi}
3258 {not available when compiled without the |+folding|
3259 feature}
3260 When non-zero, a column with the specified width is shown at the side
3261 of the window which indicates open and closed folds. The maximum
3262 value is 12.
3263 See |folding|.
3264
3265 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3266'foldenable' 'fen' boolean (default on)
3267 local to window
3268 {not in Vi}
3269 {not available when compiled without the |+folding|
3270 feature}
3271 When off, all folds are open. This option can be used to quickly
3272 switch between showing all text unfolded and viewing the text with
3273 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003274 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 'foldenable' is off.
3276 This option is set by commands that create a new fold or close a fold.
3277 See |folding|.
3278
3279 *'foldexpr'* *'fde'*
3280'foldexpr' 'fde' string (default: "0")
3281 local to window
3282 {not in Vi}
3283 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003284 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003286 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003287
Bram Moolenaar30b65812012-07-12 22:01:11 +02003288 The expression will be evaluated in the |sandbox| if set from a
3289 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290 This option can't be set from a |modeline| when the 'diff' option is
3291 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003292
3293 It is not allowed to change text or jump to another window while
3294 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 *'foldignore'* *'fdi'*
3297'foldignore' 'fdi' string (default: "#")
3298 local to window
3299 {not in Vi}
3300 {not available when compiled without the |+folding|
3301 feature}
3302 Used only when 'foldmethod' is "indent". Lines starting with
3303 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003304 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 The default "#" works well for C programs. See |fold-indent|.
3306
3307 *'foldlevel'* *'fdl'*
3308'foldlevel' 'fdl' number (default: 0)
3309 local to window
3310 {not in Vi}
3311 {not available when compiled without the |+folding|
3312 feature}
3313 Sets the fold level: Folds with a higher level will be closed.
3314 Setting this option to zero will close all folds. Higher numbers will
3315 close fewer folds.
3316 This option is set by commands like |zm|, |zM| and |zR|.
3317 See |fold-foldlevel|.
3318
3319 *'foldlevelstart'* *'fdls'*
3320'foldlevelstart' 'fdls' number (default: -1)
3321 global
3322 {not in Vi}
3323 {not available when compiled without the |+folding|
3324 feature}
3325 Sets 'foldlevel' when starting to edit another buffer in a window.
3326 Useful to always start editing with all folds closed (value zero),
3327 some folds closed (one) or no folds closed (99).
3328 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003329 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 ignores this option and closes all folds.
3331 It is also done before BufReadPre autocommands, to allow an autocmd to
3332 overrule the 'foldlevel' value for specific files.
3333 When the value is negative, it is not used.
3334
3335 *'foldmarker'* *'fmr'* *E536*
3336'foldmarker' 'fmr' string (default: "{{{,}}}")
3337 local to window
3338 {not in Vi}
3339 {not available when compiled without the |+folding|
3340 feature}
3341 The start and end marker used when 'foldmethod' is "marker". There
3342 must be one comma, which separates the start and end marker. The
3343 marker is a literal string (a regular expression would be too slow).
3344 See |fold-marker|.
3345
3346 *'foldmethod'* *'fdm'*
3347'foldmethod' 'fdm' string (default: "manual")
3348 local to window
3349 {not in Vi}
3350 {not available when compiled without the |+folding|
3351 feature}
3352 The kind of folding used for the current window. Possible values:
3353 |fold-manual| manual Folds are created manually.
3354 |fold-indent| indent Lines with equal indent form a fold.
3355 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3356 |fold-marker| marker Markers are used to specify folds.
3357 |fold-syntax| syntax Syntax highlighting items specify folds.
3358 |fold-diff| diff Fold text that is not changed.
3359
3360 *'foldminlines'* *'fml'*
3361'foldminlines' 'fml' number (default: 1)
3362 local to window
3363 {not in Vi}
3364 {not available when compiled without the |+folding|
3365 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003366 Sets the number of screen lines above which a fold can be displayed
3367 closed. Also for manually closed folds. With the default value of
3368 one a fold can only be closed if it takes up two or more screen lines.
3369 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003370 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 "zc" to close a fold, which is displayed open because it's smaller
3372 than 'foldminlines', a following "zc" may close a containing fold.
3373
3374 *'foldnestmax'* *'fdn'*
3375'foldnestmax' 'fdn' number (default: 20)
3376 local to window
3377 {not in Vi}
3378 {not available when compiled without the |+folding|
3379 feature}
3380 Sets the maximum nesting of folds for the "indent" and "syntax"
3381 methods. This avoids that too many folds will be created. Using more
3382 than 20 doesn't work, because the internal limit is 20.
3383
3384 *'foldopen'* *'fdo'*
3385'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3386 search,tag,undo")
3387 global
3388 {not in Vi}
3389 {not available when compiled without the |+folding|
3390 feature}
3391 Specifies for which type of commands folds will be opened, if the
3392 command moves the cursor into a closed fold. It is a comma separated
3393 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003394 NOTE: When the command is part of a mapping this option is not used.
3395 Add the |zv| command to the mapping to get the same effect.
3396 (rationale: the mapping may want to control opening folds itself)
3397
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 item commands ~
3399 all any
3400 block "(", "{", "[[", "[{", etc.
3401 hor horizontal movements: "l", "w", "fx", etc.
3402 insert any command in Insert mode
3403 jump far jumps: "G", "gg", etc.
3404 mark jumping to a mark: "'m", CTRL-O, etc.
3405 percent "%"
3406 quickfix ":cn", ":crew", ":make", etc.
3407 search search for a pattern: "/", "n", "*", "gd", etc.
3408 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003409 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 tag jumping to a tag: ":ta", CTRL-T, etc.
3411 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 When a movement command is used for an operator (e.g., "dl" or "y%")
3413 this option is not used. This means the operator will include the
3414 whole closed fold.
3415 Note that vertical movements are not here, because it would make it
3416 very difficult to move onto a closed fold.
3417 In insert mode the folds containing the cursor will always be open
3418 when text is inserted.
3419 To close folds you can re-apply 'foldlevel' with the |zx| command or
3420 set the 'foldclose' option to "all".
3421
3422 *'foldtext'* *'fdt'*
3423'foldtext' 'fdt' string (default: "foldtext()")
3424 local to window
3425 {not in Vi}
3426 {not available when compiled without the |+folding|
3427 feature}
3428 An expression which is used to specify the text displayed for a closed
3429 fold. See |fold-foldtext|.
3430
Bram Moolenaar30b65812012-07-12 22:01:11 +02003431 The expression will be evaluated in the |sandbox| if set from a
3432 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003433
3434 It is not allowed to change text or jump to another window while
3435 evaluating 'foldtext' |textlock|.
3436
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003437 *'formatexpr'* *'fex'*
3438'formatexpr' 'fex' string (default "")
3439 local to buffer
3440 {not in Vi}
3441 {not available when compiled without the |+eval|
3442 feature}
3443 Expression which is evaluated to format a range of lines for the |gq|
3444 operator or automatic formatting (see 'formatoptions'). When this
3445 option is empty 'formatprg' is used.
3446
3447 The |v:lnum| variable holds the first line to be formatted.
3448 The |v:count| variable holds the number of lines to be formatted.
3449 The |v:char| variable holds the character that is going to be
3450 inserted if the expression is being evaluated due to
3451 automatic formatting. This can be empty. Don't insert
3452 it yet!
3453
3454 Example: >
3455 :set formatexpr=mylang#Format()
3456< This will invoke the mylang#Format() function in the
3457 autoload/mylang.vim file in 'runtimepath'. |autoload|
3458
3459 The expression is also evaluated when 'textwidth' is set and adding
3460 text beyond that limit. This happens under the same conditions as
3461 when internal formatting is used. Make sure the cursor is kept in the
3462 same spot relative to the text then! The |mode()| function will
3463 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003464
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003465 When the expression evaluates to non-zero Vim will fall back to using
3466 the internal format mechanism.
3467
3468 The expression will be evaluated in the |sandbox| when set from a
3469 modeline, see |sandbox-option|. That stops the option from working,
3470 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003471 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003472
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 *'formatoptions'* *'fo'*
3474'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3475 local to buffer
3476 {not in Vi}
3477 This is a sequence of letters which describes how automatic
3478 formatting is to be done. See |fo-table|. When the 'paste' option is
3479 on, no formatting is done (like 'formatoptions' is empty). Commas can
3480 be inserted for readability.
3481 To avoid problems with flags that are added in the future, use the
3482 "+=" and "-=" feature of ":set" |add-option-flags|.
3483 NOTE: This option is set to the Vi default value when 'compatible' is
3484 set and to the Vim default value when 'compatible' is reset.
3485
Bram Moolenaar86b68352004-12-27 21:59:20 +00003486 *'formatlistpat'* *'flp'*
3487'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3488 local to buffer
3489 {not in Vi}
3490 A pattern that is used to recognize a list header. This is used for
3491 the "n" flag in 'formatoptions'.
3492 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003493 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003494 while still checking more characters. There must be a character
3495 following the pattern, when it matches the whole line it is handled
3496 like there is no match.
3497 The default recognizes a number, followed by an optional punctuation
3498 character and white space.
3499
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 *'formatprg'* *'fp'*
3501'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003502 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 {not in Vi}
3504 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003505 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003507 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003508 If the 'formatexpr' option is not empty it will be used instead.
3509 Otherwise, if 'formatprg' option is an empty string, the internal
3510 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003511 Environment variables are expanded |:set_env|. See |option-backslash|
3512 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003513 This option cannot be set from a |modeline| or in the |sandbox|, for
3514 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515
Bram Moolenaard94464e2015-11-02 15:28:18 +01003516 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003517'fsync' 'fs' boolean (default on)
3518 global
3519 {not in Vi}
3520 When on, the library function fsync() will be called after writing a
3521 file. This will flush a file to disk, ensuring that it is safely
3522 written even on filesystems which do metadata-only journaling. This
3523 will force the harddrive to spin up on Linux systems running in laptop
3524 mode, so it may be undesirable in some situations. Be warned that
3525 turning this off increases the chances of data loss after a crash. On
3526 systems without an fsync() implementation, this variable is always
3527 off.
3528 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003529 'fsync' also applies to |writefile()|, unless a flag is used to
3530 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003531
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3533'gdefault' 'gd' boolean (default off)
3534 global
3535 {not in Vi}
3536 When on, the ":substitute" flag 'g' is default on. This means that
3537 all matches in a line are substituted instead of one. When a 'g' flag
3538 is given to a ":substitute" command, this will toggle the substitution
3539 of all or one match. See |complex-change|.
3540
3541 command 'gdefault' on 'gdefault' off ~
3542 :s/// subst. all subst. one
3543 :s///g subst. one subst. all
3544 :s///gg subst. all subst. one
3545
3546 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003547 DEPRECATED: Setting this option may break plugins that are not aware
3548 of this option. Also, many users get confused that adding the /g flag
3549 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550
3551 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003552'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 global
3554 {not in Vi}
3555 Format to recognize for the ":grep" command output.
3556 This is a scanf-like string that uses the same format as the
3557 'errorformat' option: see |errorformat|.
3558
3559 *'grepprg'* *'gp'*
3560'grepprg' 'gp' string (default "grep -n ",
3561 Unix: "grep -n $* /dev/null",
3562 Win32: "findstr /n" or "grep -n",
3563 VMS: "SEARCH/NUMBERS ")
3564 global or local to buffer |global-local|
3565 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003566 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 and '#' characters, which are expanded like when used in a command-
3568 line. The placeholder "$*" is allowed to specify where the arguments
3569 will be included. Environment variables are expanded |:set_env|. See
3570 |option-backslash| about including spaces and backslashes.
3571 When your "grep" accepts the "-H" argument, use this to make ":grep"
3572 also work well with a single file: >
3573 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003574< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003575 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3576 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003577 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 apply equally to 'grepprg'.
3579 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3580 otherwise it's "grep -n".
3581 This option cannot be set from a |modeline| or in the |sandbox|, for
3582 security reasons.
3583
3584 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3585'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3586 ve:ver35-Cursor,
3587 o:hor50-Cursor,
3588 i-ci:ver25-Cursor/lCursor,
3589 r-cr:hor20-Cursor/lCursor,
3590 sm:block-Cursor
3591 -blinkwait175-blinkoff150-blinkon175",
3592 for MS-DOS and Win32 console:
3593 "n-v-c:block,o:hor50,i-ci:hor15,
3594 r-cr:hor30,sm:block")
3595 global
3596 {not in Vi}
3597 {only available when compiled with GUI enabled, and
3598 for MS-DOS and Win32 console}
3599 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003600 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 the height of the cursor can be changed. This can be done by
3602 specifying a block cursor, or a percentage for a vertical or
3603 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003604 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3605 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003607 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 mode-list and an argument-list:
3609 mode-list:argument-list,mode-list:argument-list,..
3610 The mode-list is a dash separated list of these modes:
3611 n Normal mode
3612 v Visual mode
3613 ve Visual mode with 'selection' "exclusive" (same as 'v',
3614 if not specified)
3615 o Operator-pending mode
3616 i Insert mode
3617 r Replace mode
3618 c Command-line Normal (append) mode
3619 ci Command-line Insert mode
3620 cr Command-line Replace mode
3621 sm showmatch in Insert mode
3622 a all modes
3623 The argument-list is a dash separated list of these arguments:
3624 hor{N} horizontal bar, {N} percent of the character height
3625 ver{N} vertical bar, {N} percent of the character width
3626 block block cursor, fills the whole character
3627 [only one of the above three should be present]
3628 blinkwait{N} *cursor-blinking*
3629 blinkon{N}
3630 blinkoff{N}
3631 blink times for cursor: blinkwait is the delay before
3632 the cursor starts blinking, blinkon is the time that
3633 the cursor is shown and blinkoff is the time that the
3634 cursor is not shown. The times are in msec. When one
3635 of the numbers is zero, there is no blinking. The
3636 default is: "blinkwait700-blinkon400-blinkoff250".
3637 These numbers are used for a missing entry. This
3638 means that blinking is enabled by default. To switch
3639 blinking off you can use "blinkon0". The cursor only
3640 blinks when Vim is waiting for input, not while
3641 executing a command.
3642 To make the cursor blink in an xterm, see
3643 |xterm-blink|.
3644 {group-name}
3645 a highlight group name, that sets the color and font
3646 for the cursor
3647 {group-name}/{group-name}
3648 Two highlight group names, the first is used when
3649 no language mappings are used, the other when they
3650 are. |language-mapping|
3651
3652 Examples of parts:
3653 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3654 block cursor with colors from the "nCursor"
3655 highlight group
3656 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3657 In Insert and Command-line Insert mode, use a
3658 30% vertical bar cursor with colors from the
3659 "iCursor" highlight group. Blink a bit
3660 faster.
3661
3662 The 'a' mode is different. It will set the given argument-list for
3663 all modes. It does not reset anything to defaults. This can be used
3664 to do a common setting for all modes. For example, to switch off
3665 blinking: "a:blinkon0"
3666
3667 Examples of cursor highlighting: >
3668 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3669 :highlight Cursor gui=NONE guifg=bg guibg=fg
3670<
3671 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003672 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673'guifont' 'gfn' string (default "")
3674 global
3675 {not in Vi}
3676 {only available when compiled with GUI enabled}
3677 This is a list of fonts which will be used for the GUI version of Vim.
3678 In its simplest form the value is just one font name. When
3679 the font cannot be found you will get an error message. To try other
3680 font names a list can be specified, font names separated with commas.
3681 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003682
Bram Moolenaar05159a02005-02-26 23:04:13 +00003683 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3684 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003685
Bram Moolenaar3df01732017-02-17 22:47:16 +01003686 Note: As to the GTK GUIs, no error is given against any invalid names,
3687 and the first element of the list is always picked up and made use of.
3688 This is because, instead of identifying a given name with a font, the
3689 GTK GUIs use it to construct a pattern and try to look up a font which
3690 best matches the pattern among available fonts, and this way, the
3691 matching never fails. An invalid name doesn't matter because a number
3692 of font properties other than name will do to get the matching done.
3693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 Spaces after a comma are ignored. To include a comma in a font name
3695 precede it with a backslash. Setting an option requires an extra
3696 backslash before a space and a backslash. See also
3697 |option-backslash|. For example: >
3698 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003699< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003701
3702 If none of the fonts can be loaded, Vim will keep the current setting.
3703 If an empty font list is given, Vim will try using other resource
3704 settings (for X, it will use the Vim.font resource), and finally it
3705 will try some builtin default which should always be there ("7x13" in
3706 the case of X). The font names given should be "normal" fonts. Vim
3707 will try to find the related bold and italic fonts.
3708
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003709 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003710 :set guifont=*
3711< will bring up a font requester, where you can pick the font you want.
3712
3713 The font name depends on the GUI used. See |setting-guifont| for a
3714 way to set 'guifont' for various systems.
3715
Bram Moolenaar3df01732017-02-17 22:47:16 +01003716 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003718< That's all. XLFDs are not used. For Chinese this is reported to work
3719 well: >
3720 if has("gui_gtk2")
3721 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3722 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3723 endif
3724<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003725 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3726
Bram Moolenaar05159a02005-02-26 23:04:13 +00003727 For Mac OSX you can use something like this: >
3728 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003729< Also see 'macatsui', it can help fix display problems.
3730 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003732 width). An exception is GTK: all fonts are accepted, but mono-spaced
3733 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003734
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 To preview a font on X11, you might be able to use the "xfontsel"
3736 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003737
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 For the Win32 GUI *E244* *E245*
3739 - takes these options in the font name:
3740 hXX - height is XX (points, can be floating-point)
3741 wXX - width is XX (points, can be floating-point)
3742 b - bold
3743 i - italic
3744 u - underline
3745 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003746 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3748 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3749 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003750 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003751 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003752 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003753 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003754 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755
3756 Use a ':' to separate the options.
3757 - A '_' can be used in the place of a space, so you don't need to use
3758 backslashes to escape the spaces.
3759 - Examples: >
3760 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3761 :set guifont=Andale_Mono:h7.5:w4.5
3762< See also |font-sizes|.
3763
3764 *'guifontset'* *'gfs'*
3765 *E250* *E252* *E234* *E597* *E598*
3766'guifontset' 'gfs' string (default "")
3767 global
3768 {not in Vi}
3769 {only available when compiled with GUI enabled and
3770 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003771 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 When not empty, specifies two (or more) fonts to be used. The first
3773 one for normal English, the second one for your special language. See
3774 |xfontset|.
3775 Setting this option also means that all font names will be handled as
3776 a fontset name. Also the ones used for the "font" argument of the
3777 |:highlight| command.
3778 The fonts must match with the current locale. If fonts for the
3779 character sets that the current locale uses are not included, setting
3780 'guifontset' will fail.
3781 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3782 the comma-separated names are alternative names, one of which will be
3783 used. In 'guifontset' the whole string is one fontset name,
3784 including the commas. It is not possible to specify alternative
3785 fontset names.
3786 This example works on many X11 systems: >
3787 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3788<
3789 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3790'guifontwide' 'gfw' string (default "")
3791 global
3792 {not in Vi}
3793 {only available when compiled with GUI enabled}
3794 When not empty, specifies a comma-separated list of fonts to be used
3795 for double-width characters. The first font that can be loaded is
3796 used.
3797 Note: The size of these fonts must be exactly twice as wide as the one
3798 specified with 'guifont' and the same height.
3799
Bram Moolenaar3df01732017-02-17 22:47:16 +01003800 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801
3802 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3803 'guifontset' is empty or invalid.
3804 When 'guifont' is set and a valid font is found in it and
3805 'guifontwide' is empty Vim will attempt to find a matching
3806 double-width font and set 'guifontwide' to it.
3807
Bram Moolenaar3df01732017-02-17 22:47:16 +01003808 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809
3810 If set and valid, 'guifontwide' is always used for double width
3811 characters, even if 'encoding' is not set to "utf-8".
3812 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003813 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 font for characters not available in 'guifont'. Thus you do not need
3815 to set 'guifontwide' at all unless you want to override the choice
3816 made by Pango/Xft.
3817
Bram Moolenaar0f272122013-01-23 18:37:40 +01003818 Windows +multibyte only: *guifontwide_win_mbyte*
3819
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003820 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003821
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 *'guiheadroom'* *'ghr'*
3823'guiheadroom' 'ghr' number (default 50)
3824 global
3825 {not in Vi} {only for GTK and X11 GUI}
3826 The number of pixels subtracted from the screen height when fitting
3827 the GUI window on the screen. Set this before the GUI is started,
3828 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003829 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 lines will be left for window decorations and other items on the
3831 screen. Set it to a negative value to allow windows taller than the
3832 screen.
3833
3834 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003835'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3836 removed in |defaults.vim|),
3837 "aegimrLtT" (GTK, Motif and Athena),
3838 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 global
3840 {not in Vi}
3841 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003842 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 sequence of letters which describes what components and options of the
3844 GUI should be used.
3845 To avoid problems with flags that are added in the future, use the
3846 "+=" and "-=" feature of ":set" |add-option-flags|.
3847
Bram Moolenaar13568252018-03-16 20:46:58 +01003848 Valid characters are as follows:
3849 *'go-!'*
3850 '!' External commands are executed in a terminal window. Without
3851 this flag the MS-Windows GUI will open a console window to
3852 execute the command. The Unix GUI will simulate a dumb
3853 terminal to list the command output.
3854 The terminal window will be positioned at the bottom, and grow
3855 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003856 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 'a' Autoselect: If present, then whenever VISUAL mode is started,
3858 or the Visual area extended, Vim tries to become the owner of
3859 the windowing system's global selection. This means that the
3860 Visually highlighted text is available for pasting into other
3861 applications as well as into Vim itself. When the Visual mode
3862 ends, possibly due to an operation on the text, or when an
3863 application wants to paste the selection, the highlighted text
3864 is automatically yanked into the "* selection register.
3865 Thus the selection is still available for pasting into other
3866 applications after the VISUAL mode has ended.
3867 If not present, then Vim won't become the owner of the
3868 windowing system's global selection unless explicitly told to
3869 by a yank or delete operation for the "* register.
3870 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003871 *'go-P'*
3872 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003873 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003875 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 applies to the modeless selection.
3877
3878 'guioptions' autoselect Visual autoselect modeless ~
3879 "" - -
3880 "a" yes yes
3881 "A" - yes
3882 "aA" yes yes
3883
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 'c' Use console dialogs instead of popup dialogs for simple
3886 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003887 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003888 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003889 'guitablabel' can be used to change the text in the labels.
3890 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003891 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003892 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003893 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 'f' Foreground: Don't use fork() to detach the GUI from the shell
3895 where it was started. Use this for programs that wait for the
3896 editor to finish (e.g., an e-mail program). Alternatively you
3897 can use "gvim -f" or ":gui -f" to start the GUI in the
3898 foreground. |gui-fork|
3899 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003900 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003901 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3903 corner of the window. It's black&white on non-GTK, because of
3904 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003905 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003907 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003908 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003910 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003912 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003913 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 'g' Grey menu items: Make menu items that are not active grey. If
3915 'g' is not included inactive menu items are not shown at all.
3916 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 't' Include tearoff menu items. Currently only works for Win32,
3919 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003921 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003922 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003923 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003925 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'R' Right-hand scrollbar is present when there is a vertically
3927 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003928 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'L' Left-hand scrollbar is present when there is a vertically
3932 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003933 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3935 the longest visible line, or on the cursor line if the 'h'
3936 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003937 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 'h' Limit horizontal scrollbar size to the length of the cursor
3939 line. Reduces computations. |gui-horiz-scroll|
3940
3941 And yes, you may even have scrollbars on the left AND the right if
3942 you really want to :-). See |gui-scrollbars| for more information.
3943
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003944 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 'v' Use a vertical button layout for dialogs. When not included,
3946 a horizontal layout is preferred, but when it doesn't fit a
3947 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003948 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'p' Use Pointer callbacks for X11 GUI. This is required for some
3950 window managers. If the cursor is not blinking or hollow at
3951 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003952 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003954 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003955 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003956 *'go-k'*
3957 'k' Keep the GUI window size when adding/removing a scrollbar, or
3958 toolbar, tabline, etc. Instead, the behavior is similar to
3959 when the window is maximized and will adjust 'lines' and
3960 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003961 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003962 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003963
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 *'guipty'* *'noguipty'*
3965'guipty' boolean (default on)
3966 global
3967 {not in Vi}
3968 {only available when compiled with GUI enabled}
3969 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3970 I/O to/from shell commands. See |gui-pty|.
3971
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003972 *'guitablabel'* *'gtl'*
3973'guitablabel' 'gtl' string (default empty)
3974 global
3975 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003976 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003977 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003978 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003979 pages line. When empty and when the result is empty Vim will use a
3980 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003981
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003982 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003983 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003984 The expression will be evaluated in the |sandbox| when set from a
3985 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003986
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003987 Only used when the GUI tab pages line is displayed. 'e' must be
3988 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3989 used.
3990
Bram Moolenaar57657d82006-04-21 22:12:41 +00003991 *'guitabtooltip'* *'gtt'*
3992'guitabtooltip' 'gtt' string (default empty)
3993 global
3994 {not in Vi}
3995 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003996 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003997 When nonempty describes the text to use in a tooltip for the GUI tab
3998 pages line. When empty Vim will use a default tooltip.
3999 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004000 You can include a line break. Simplest method is to use |:let|: >
4001 :let &guitabtooltip = "line one\nline two"
4002<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004003
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 *'helpfile'* *'hf'*
4005'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4006 (others) "$VIMRUNTIME/doc/help.txt")
4007 global
4008 {not in Vi}
4009 Name of the main help file. All distributed help files should be
4010 placed together in one directory. Additionally, all "doc" directories
4011 in 'runtimepath' will be used.
4012 Environment variables are expanded |:set_env|. For example:
4013 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004014 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 spaces and backslashes.
4016 This option cannot be set from a |modeline| or in the |sandbox|, for
4017 security reasons.
4018
4019 *'helpheight'* *'hh'*
4020'helpheight' 'hh' number (default 20)
4021 global
4022 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004023 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 feature}
4025 Minimal initial height of the help window when it is opened with the
4026 ":help" command. The initial height of the help window is half of the
4027 current window, or (when the 'ea' option is on) the same as other
4028 windows. When the height is less than 'helpheight', the height is
4029 set to 'helpheight'. Set to zero to disable.
4030
4031 *'helplang'* *'hlg'*
4032'helplang' 'hlg' string (default: messages language or empty)
4033 global
4034 {only available when compiled with the |+multi_lang|
4035 feature}
4036 {not in Vi}
4037 Comma separated list of languages. Vim will use the first language
4038 for which the desired help can be found. The English help will always
4039 be used as a last resort. You can add "en" to prefer English over
4040 another language, but that will only find tags that exist in that
4041 language and not in the English help.
4042 Example: >
4043 :set helplang=de,it
4044< This will first search German, then Italian and finally English help
4045 files.
4046 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4047 try to find the tag in the current language before using this option.
4048 See |help-translated|.
4049
4050 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4051'hidden' 'hid' boolean (default off)
4052 global
4053 {not in Vi}
4054 When off a buffer is unloaded when it is |abandon|ed. When on a
4055 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4056 displayed in another window, it does not become hidden, of course.
4057 The commands that move through the buffer list sometimes make a buffer
4058 hidden although the 'hidden' option is off: When the buffer is
4059 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004060 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004061 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 This option is set for one command with ":hide {command}" |:hide|.
4063 WARNING: It's easy to forget that you have changes in hidden buffers.
4064 Think twice when using ":q!" or ":qa!".
4065
4066 *'highlight'* *'hl'*
4067'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004068 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4069 d:Directory,e:ErrorMsg,i:IncSearch,
4070 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4071 N:CursorLineNr,r:Question,s:StatusLine,
4072 S:StatusLineNC,c:VertSplit,t:Title,
4073 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4074 F:FoldColumn,A:DiffAdd,C:DiffChange,
4075 D:DiffDelete,T:DiffText,>:SignColumn,
4076 B:SpellBad,P:SpellCap,R:SpellRare,
4077 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004078 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4079 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004080 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004081 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 global
4083 {not in Vi}
4084 This option can be used to set highlighting mode for various
4085 occasions. It is a comma separated list of character pairs. The
4086 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004087 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004089 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4090 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 characters from 'showbreak'
4092 |hl-Directory| d directories in CTRL-D listing and other special
4093 things in listings
4094 |hl-ErrorMsg| e error messages
4095 h (obsolete, ignored)
4096 |hl-IncSearch| i 'incsearch' highlighting
4097 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4098 |hl-MoreMsg| m |more-prompt|
4099 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004100 |hl-LineNr| n line number for ":number" and ":#" commands, and
4101 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004102 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4103 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 |hl-Question| r |hit-enter| prompt and yes/no questions
4105 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004106 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4108 |hl-VertSplit| c column used to separate vertically split windows
4109 |hl-Visual| v Visual mode
4110 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4111 Selection" Only X11 Gui's |gui-x11| and
4112 |xterm-clipboard|.
4113 |hl-WarningMsg| w warning messages
4114 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4115 |hl-Folded| f line used for closed folds
4116 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004117 |hl-DiffAdd| A added line in diff mode
4118 |hl-DiffChange| C changed line in diff mode
4119 |hl-DiffDelete| D deleted line in diff mode
4120 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004122 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004123 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004124 |hl-SpellRare| R rare word |spell|
4125 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004126 |hl-Conceal| - the placeholders used for concealed characters
4127 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004128 |hl-Pmenu| + popup menu normal line
4129 |hl-PmenuSel| = popup menu normal line
4130 |hl-PmenuSbar| x popup menu scrollbar
4131 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132
4133 The display modes are:
4134 r reverse (termcap entry "mr" and "me")
4135 i italic (termcap entry "ZH" and "ZR")
4136 b bold (termcap entry "md" and "me")
4137 s standout (termcap entry "so" and "se")
4138 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004139 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004140 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 n no highlighting
4142 - no highlighting
4143 : use a highlight group
4144 The default is used for occasions that are not included.
4145 If you want to change what the display modes do, see |dos-colors|
4146 for an example.
4147 When using the ':' display mode, this must be followed by the name of
4148 a highlight group. A highlight group can be used to define any type
4149 of highlighting, including using color. See |:highlight| on how to
4150 define one. The default uses a different group for each occasion.
4151 See |highlight-default| for the default highlight groups.
4152
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004154'history' 'hi' number (Vim default: 50, Vi default: 0,
4155 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 global
4157 {not in Vi}
4158 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004159 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004161 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 NOTE: This option is set to the Vi default value when 'compatible' is
4163 set and to the Vim default value when 'compatible' is reset.
4164
4165 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4166'hkmap' 'hk' boolean (default off)
4167 global
4168 {not in Vi}
4169 {only available when compiled with the |+rightleft|
4170 feature}
4171 When on, the keyboard is mapped for the Hebrew character set.
4172 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4173 toggle this option. See |rileft.txt|.
4174 NOTE: This option is reset when 'compatible' is set.
4175
4176 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4177'hkmapp' 'hkp' boolean (default off)
4178 global
4179 {not in Vi}
4180 {only available when compiled with the |+rightleft|
4181 feature}
4182 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4183 This is useful if you have a non-Hebrew keyboard.
4184 See |rileft.txt|.
4185 NOTE: This option is reset when 'compatible' is set.
4186
Bram Moolenaar036986f2017-03-16 17:41:02 +01004187 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4188'hlsearch' 'hls' boolean (default off)
4189 global
4190 {not in Vi}
4191 {not available when compiled without the
4192 |+extra_search| feature}
4193 When there is a previous search pattern, highlight all its matches.
4194 The type of highlighting used can be set with the 'l' occasion in the
4195 'highlight' option. This uses the "Search" highlight group by
4196 default. Note that only the matching text is highlighted, any offsets
4197 are not applied.
4198 See also: 'incsearch' and |:match|.
4199 When you get bored looking at the highlighted matches, you can turn it
4200 off with |:nohlsearch|. This does not change the option value, as
4201 soon as you use a search command, the highlighting comes back.
4202 'redrawtime' specifies the maximum time spent on finding matches.
4203 When the search pattern can match an end-of-line, Vim will try to
4204 highlight all of the matched text. However, this depends on where the
4205 search starts. This will be the first line in the window or the first
4206 line below a closed fold. A match in a previous line which is not
4207 drawn may not continue in a newly drawn line.
4208 You can specify whether the highlight status is restored on startup
4209 with the 'h' flag in 'viminfo' |viminfo-h|.
4210 NOTE: This option is reset when 'compatible' is set.
4211
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 *'icon'* *'noicon'*
4213'icon' boolean (default off, on when title can be restored)
4214 global
4215 {not in Vi}
4216 {not available when compiled without the |+title|
4217 feature}
4218 When on, the icon text of the window will be set to the value of
4219 'iconstring' (if it is not empty), or to the name of the file
4220 currently being edited. Only the last part of the name is used.
4221 Overridden by the 'iconstring' option.
4222 Only works if the terminal supports setting window icons (currently
4223 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4224 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4225 builtin termcap).
4226 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004227 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004229 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230
4231 *'iconstring'*
4232'iconstring' string (default "")
4233 global
4234 {not in Vi}
4235 {not available when compiled without the |+title|
4236 feature}
4237 When this option is not empty, it will be used for the icon text of
4238 the window. This happens only when the 'icon' option is on.
4239 Only works if the terminal supports setting window icon text
4240 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4241 Does not work for MS Windows.
4242 When Vim was compiled with HAVE_X11 defined, the original icon will be
4243 restored if possible |X11|.
4244 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004245 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 'titlestring' for example settings.
4247 {not available when compiled without the |+statusline| feature}
4248
4249 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4250'ignorecase' 'ic' boolean (default off)
4251 global
4252 Ignore case in search patterns. Also used when searching in the tags
4253 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004254 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 Can be overruled by using "\c" or "\C" in the pattern, see
4256 |/ignorecase|.
4257
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004258 *'imactivatefunc'* *'imaf'*
4259'imactivatefunc' 'imaf' string (default "")
4260 global
4261 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004262 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004263 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004264 activate or deactivate the Input Method.
4265 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004266
4267 Example: >
4268 function ImActivateFunc(active)
4269 if a:active
4270 ... do something
4271 else
4272 ... do something
4273 endif
4274 " return value is not used
4275 endfunction
4276 set imactivatefunc=ImActivateFunc
4277<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 *'imactivatekey'* *'imak'*
4279'imactivatekey' 'imak' string (default "")
4280 global
4281 {not in Vi}
4282 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004283 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 Specifies the key that your Input Method in X-Windows uses for
4285 activation. When this is specified correctly, vim can fully control
4286 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4287 You can't use this option to change the activation key, the option
4288 tells Vim what the key is.
4289 Format:
4290 [MODIFIER_FLAG-]KEY_STRING
4291
4292 These characters can be used for MODIFIER_FLAG (case is ignored):
4293 S Shift key
4294 L Lock key
4295 C Control key
4296 1 Mod1 key
4297 2 Mod2 key
4298 3 Mod3 key
4299 4 Mod4 key
4300 5 Mod5 key
4301 Combinations are allowed, for example "S-C-space" or "SC-space" are
4302 both shift+ctrl+space.
4303 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4304
4305 Example: >
4306 :set imactivatekey=S-space
4307< "S-space" means shift+space. This is the activation key for kinput2 +
4308 canna (Japanese), and ami (Korean).
4309
4310 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4311'imcmdline' 'imc' boolean (default off)
4312 global
4313 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004314 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 When set the Input Method is always on when starting to edit a command
4316 line, unless entering a search pattern (see 'imsearch' for that).
4317 Setting this option is useful when your input method allows entering
4318 English characters directly, e.g., when it's used to type accented
4319 characters with dead keys.
4320
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004321 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4323 global
4324 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004325 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 When set the Input Method is never used. This is useful to disable
4327 the IM when it doesn't work properly.
4328 Currently this option is on by default for SGI/IRIX machines. This
4329 may change in later releases.
4330
4331 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004332'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 local to buffer
4334 {not in Vi}
4335 Specifies whether :lmap or an Input Method (IM) is to be used in
4336 Insert mode. Valid values:
4337 0 :lmap is off and IM is off
4338 1 :lmap is ON and IM is off
4339 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 To always reset the option to zero when leaving Insert mode with <Esc>
4341 this can be used: >
4342 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4343< This makes :lmap and IM turn off automatically when leaving Insert
4344 mode.
4345 Note that this option changes when using CTRL-^ in Insert mode
4346 |i_CTRL-^|.
4347 The value is set to 1 when setting 'keymap' to a valid keymap name.
4348 It is also used for the argument of commands like "r" and "f".
4349 The value 0 may not work correctly with Athena and Motif with some XIM
4350 methods. Use 'imdisable' to disable XIM then.
4351
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004352 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4353 via external command if vim is not compiled with the |+xim|,
4354 |+multi_byte_ime| or |global-ime|.
4355
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004357'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 local to buffer
4359 {not in Vi}
4360 Specifies whether :lmap or an Input Method (IM) is to be used when
4361 entering a search pattern. Valid values:
4362 -1 the value of 'iminsert' is used, makes it look like
4363 'iminsert' is also used when typing a search pattern
4364 0 :lmap is off and IM is off
4365 1 :lmap is ON and IM is off
4366 2 :lmap is off and IM is ON
4367 Note that this option changes when using CTRL-^ in Command-line mode
4368 |c_CTRL-^|.
4369 The value is set to 1 when it is not -1 and setting the 'keymap'
4370 option to a valid keymap name.
4371 The value 0 may not work correctly with Athena and Motif with some XIM
4372 methods. Use 'imdisable' to disable XIM then.
4373
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004374 *'imstatusfunc'* *'imsf'*
4375'imstatusfunc' 'imsf' string (default "")
4376 global
4377 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004378 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004379 This option specifies a function that is called to obtain the status
4380 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004381 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004382
4383 Example: >
4384 function ImStatusFunc()
4385 let is_active = ...do something
4386 return is_active ? 1 : 0
4387 endfunction
4388 set imstatusfunc=ImStatusFunc
4389<
4390 NOTE: This function is invoked very often. Keep it fast.
4391
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004392 *'imstyle'* *'imst'*
4393'imstyle' 'imst' number (default 1)
4394 global
4395 {not in Vi}
4396 {only available when compiled with |+xim| and
4397 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004398 This option specifies the input style of Input Method:
4399 0 use on-the-spot style
4400 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004401 See: |xim-input-style|
4402
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004403 For a long time on-the-spot style had been used in the GTK version of
4404 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004405 |single-repeat|, etc. Therefore over-the-spot style becomes the
4406 default now. This should work fine for most people, however if you
4407 have any problem with it, try using on-the-spot style.
4408
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 *'include'* *'inc'*
4410'include' 'inc' string (default "^\s*#\s*include")
4411 global or local to buffer |global-local|
4412 {not in Vi}
4413 {not available when compiled without the
4414 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004415 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 pattern, just like for the "/" command (See |pattern|). The default
4417 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004418 "]I", "[d", etc.
4419 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004420 comes after the matched pattern. But if "\zs" appears in the pattern
4421 then the text matched from "\zs" to the end, or until "\ze" if it
4422 appears, is used as the file name. Use this to include characters
4423 that are not in 'isfname', such as a space. You can then use
4424 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004425 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426
4427 *'includeexpr'* *'inex'*
4428'includeexpr' 'inex' string (default "")
4429 local to buffer
4430 {not in Vi}
4431 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004432 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004434 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 :set includeexpr=substitute(v:fname,'\\.','/','g')
4436< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004437
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 Also used for |<cfile>|.
4441
Bram Moolenaar30b65812012-07-12 22:01:11 +02004442 The expression will be evaluated in the |sandbox| when set from a
4443 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004444
4445 It is not allowed to change text or jump to another window while
4446 evaluating 'includeexpr' |textlock|.
4447
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004449'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4450 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 global
4452 {not in Vi}
4453 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004454 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004455 While typing a search command, show where the pattern, as it was typed
4456 so far, matches. The matched string is highlighted. If the pattern
4457 is invalid or not found, nothing is shown. The screen will be updated
4458 often, this is only useful on fast terminals.
4459 Note that the match will be shown, but the cursor will return to its
4460 original position when no match is found and when pressing <Esc>. You
4461 still need to finish the search command with <Enter> to move the
4462 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004463 You can use the CTRL-G and CTRL-T keys to move to the next and
4464 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004465 When compiled with the |+reltime| feature Vim only searches for about
4466 half a second. With a complicated pattern and/or a lot of text the
4467 match may not be found. This is to avoid that Vim hangs while you
4468 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004469 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004470 When 'hlsearch' is on, all matched strings are highlighted too while
4471 typing a search command. See also: 'hlsearch'.
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004472 If you don't want turn 'hlsearch' on, but want to highlight all matches
4473 while searching, you can turn on and off 'hlsearch' with autocmd.
4474 Example: >
4475 augroup vimrc-incsearch-highlight
4476 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004477 autocmd CmdlineEnter /,\? :set hlsearch
4478 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004479 augroup END
4480<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004481 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004482 to the command line. If 'ignorecase' and 'smartcase' are set and the
4483 command line has no uppercase characters, the added character is
4484 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004485 CTRL-R CTRL-W can be used to add the word at the end of the current
4486 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 NOTE: This option is reset when 'compatible' is set.
4488
4489 *'indentexpr'* *'inde'*
4490'indentexpr' 'inde' string (default "")
4491 local to buffer
4492 {not in Vi}
4493 {not available when compiled without the |+cindent|
4494 or |+eval| features}
4495 Expression which is evaluated to obtain the proper indent for a line.
4496 It is used when a new line is created, for the |=| operator and
4497 in Insert mode as specified with the 'indentkeys' option.
4498 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004499 'smartindent' indenting. When 'lisp' is set, this option is
4500 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 When 'paste' is set this option is not used for indenting.
4502 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004503 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 when the expression is evaluated (but it may be moved around).
4505 The expression must return the number of spaces worth of indent. It
4506 can return "-1" to keep the current indent (this means 'autoindent' is
4507 used for the indent).
4508 Functions useful for computing the indent are |indent()|, |cindent()|
4509 and |lispindent()|.
4510 The evaluation of the expression must not have side effects! It must
4511 not change the text, jump to another window, etc. Afterwards the
4512 cursor position is always restored, thus the cursor may be moved.
4513 Normally this option would be set to call a function: >
4514 :set indentexpr=GetMyIndent()
4515< Error messages will be suppressed, unless the 'debug' option contains
4516 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004517 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004518 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519
Bram Moolenaar30b65812012-07-12 22:01:11 +02004520 The expression will be evaluated in the |sandbox| when set from a
4521 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004522
4523 It is not allowed to change text or jump to another window while
4524 evaluating 'indentexpr' |textlock|.
4525
4526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'indentkeys'* *'indk'*
4528'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4529 local to buffer
4530 {not in Vi}
4531 {not available when compiled without the |+cindent|
4532 feature}
4533 A list of keys that, when typed in Insert mode, cause reindenting of
4534 the current line. Only happens if 'indentexpr' isn't empty.
4535 The format is identical to 'cinkeys', see |indentkeys-format|.
4536 See |C-indenting| and |indent-expression|.
4537
4538 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4539'infercase' 'inf' boolean (default off)
4540 local to buffer
4541 {not in Vi}
4542 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004543 'ignorecase' is also on, the case of the match is adjusted depending
4544 on the typed text. If the typed text contains a lowercase letter
4545 where the match has an upper case letter, the completed part is made
4546 lowercase. If the typed text has no lowercase letters and the match
4547 has a lowercase letter where the typed text has an uppercase letter,
4548 and there is a letter before it, the completed part is made uppercase.
4549 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550
4551 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4552'insertmode' 'im' boolean (default off)
4553 global
4554 {not in Vi}
4555 Makes Vim work in a way that Insert mode is the default mode. Useful
4556 if you want to use Vim as a modeless editor. Used for |evim|.
4557 These Insert mode commands will be useful:
4558 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004559 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 this is a mapping, it is executed as if 'insertmode' was off.
4561 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004563 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4564 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565
4566 These items change when 'insertmode' is set:
4567 - when starting to edit of a file, Vim goes to Insert mode.
4568 - <Esc> in Insert mode is a no-op and beeps.
4569 - <Esc> in Normal mode makes Vim go to Insert mode.
4570 - CTRL-L in Insert mode is a command, it is not inserted.
4571 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4572 However, when <Esc> is used inside a mapping, it behaves like
4573 'insertmode' was not set. This was done to be able to use the same
4574 mappings with 'insertmode' set or not set.
4575 When executing commands with |:normal| 'insertmode' is not used.
4576
4577 NOTE: This option is reset when 'compatible' is set.
4578
4579 *'isfname'* *'isf'*
4580'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4581 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4582 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4583 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4584 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4585 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4586 global
4587 {not in Vi}
4588 The characters specified by this option are included in file names and
4589 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004590 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 Multi-byte characters 256 and above are always included, only the
4592 characters up to 255 are specified with this option.
4593 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004594 Think twice before adding white space to this option. Although a
4595 space may appear inside a file name, the effect will be that Vim
4596 doesn't know where a file name starts or ends when doing completion.
4597 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
4599 Note that on systems using a backslash as path separator, Vim tries to
4600 do its best to make it work as you would expect. That is a bit
4601 tricky, since Vi originally used the backslash to escape special
4602 characters. Vim will not remove a backslash in front of a normal file
4603 name character on these systems, but it will on Unix and alikes. The
4604 '&' and '^' are not included by default, because these are special for
4605 cmd.exe.
4606
4607 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004608 Each part can be a single character number or a range. A range is two
4609 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 decimal number between 0 and 255 or the ASCII character itself (does
4611 not work for digits). Example:
4612 "_,-,128-140,#-43" (include '_' and '-' and the range
4613 128 to 140 and '#' to 43)
4614 If a part starts with '^', the following character number or range
4615 will be excluded from the option. The option is interpreted from left
4616 to right. Put the excluded character after the range where it is
4617 included. To include '^' itself use it as the last character of the
4618 option or the end of a range. Example:
4619 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4620 If the character is '@', all characters where isalpha() returns TRUE
4621 are included. Normally these are the characters a to z and A to Z,
4622 plus accented characters. To include '@' itself use "@-@". Examples:
4623 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004624 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 "a-z,A-Z,@-@" All letters plus the '@' character.
4626 A comma can be included by using it where a character number is
4627 expected. Example:
4628 "48-57,,,_" Digits, comma and underscore.
4629 A comma can be excluded by prepending a '^'. Example:
4630 " -~,^,,9" All characters from space to '~', excluding
4631 comma, plus <Tab>.
4632 See |option-backslash| about including spaces and backslashes.
4633
4634 *'isident'* *'isi'*
4635'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4636 "@,48-57,_,128-167,224-235"
4637 otherwise: "@,48-57,_,192-255")
4638 global
4639 {not in Vi}
4640 The characters given by this option are included in identifiers.
4641 Identifiers are used in recognizing environment variables and after a
4642 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004643 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 option.
4645 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4648
4649 *'iskeyword'* *'isk'*
4650'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4651 "@,48-57,_,128-167,224-235"
4652 otherwise: "@,48-57,_,192-255"
4653 Vi default: "@,48-57,_")
4654 local to buffer
4655 {not in Vi}
4656 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004657 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 'isfname' for a description of the format of this option. For C
4659 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4660 For a help file it is set to all non-blank printable characters except
4661 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4662 command).
4663 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004664 This option also influences syntax highlighting, unless the syntax
4665 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 NOTE: This option is set to the Vi default value when 'compatible' is
4667 set and to the Vim default value when 'compatible' is reset.
4668
4669 *'isprint'* *'isp'*
4670'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4671 "@,~-255"; otherwise: "@,161-255")
4672 global
4673 {not in Vi}
4674 The characters given by this option are displayed directly on the
4675 screen. It is also used for "\p" in a |pattern|. The characters from
4676 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4677 even when they are not included in 'isprint' or excluded. See
4678 'isfname' for a description of the format of this option.
4679
4680 Non-printable characters are displayed with two characters:
4681 0 - 31 "^@" - "^_"
4682 32 - 126 always single characters
4683 127 "^?"
4684 128 - 159 "~@" - "~_"
4685 160 - 254 "| " - "|~"
4686 255 "~?"
4687 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4688 displayed as <xx>, with the hexadecimal value of the byte.
4689 When 'display' contains "uhex" all unprintable characters are
4690 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004691 The SpecialKey highlighting will be used for unprintable characters.
4692 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693
4694 Multi-byte characters 256 and above are always included, only the
4695 characters up to 255 are specified with this option. When a character
4696 is printable but it is not available in the current font, a
4697 replacement character will be shown.
4698 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4699 There is no option to specify these characters.
4700
4701 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4702'joinspaces' 'js' boolean (default on)
4703 global
4704 {not in Vi}
4705 Insert two spaces after a '.', '?' and '!' with a join command.
4706 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4707 Otherwise only one space is inserted.
4708 NOTE: This option is set when 'compatible' is set.
4709
4710 *'key'*
4711'key' string (default "")
4712 local to buffer
4713 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004714 {only available when compiled with the |+cryptv|
4715 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004717 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 Careful: Do not set the key value by hand, someone might see the typed
4719 key. Use the |:X| command. But you can make 'key' empty: >
4720 :set key=
4721< It is not possible to get the value of this option with ":set key" or
4722 "echo &key". This is to avoid showing it to someone who shouldn't
4723 know. It also means you cannot see it yourself once you have set it,
4724 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004725 You can use "&key" in an expression to detect whether encryption is
4726 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727
4728 *'keymap'* *'kmp'* *E544*
4729'keymap' 'kmp' string (default "")
4730 local to buffer
4731 {not in Vi}
4732 {only available when compiled with the |+keymap|
4733 feature}
4734 Name of a keyboard mapping. See |mbyte-keymap|.
4735 Setting this option to a valid keymap name has the side effect of
4736 setting 'iminsert' to one, so that the keymap becomes effective.
4737 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004738 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739
4740 *'keymodel'* *'km'*
4741'keymodel' 'km' string (default "")
4742 global
4743 {not in Vi}
4744 List of comma separated words, which enable special things that keys
4745 can do. These values can be used:
4746 startsel Using a shifted special key starts selection (either
4747 Select mode or Visual mode, depending on "key" being
4748 present in 'selectmode').
4749 stopsel Using a not-shifted special key stops selection.
4750 Special keys in this context are the cursor keys, <End>, <Home>,
4751 <PageUp> and <PageDown>.
4752 The 'keymodel' option is set by the |:behave| command.
4753
4754 *'keywordprg'* *'kp'*
4755'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004756 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 global or local to buffer |global-local|
4758 {not in Vi}
4759 Program to use for the |K| command. Environment variables are
4760 expanded |:set_env|. ":help" may be used to access the Vim internal
4761 help. (Note that previously setting the global option to the empty
4762 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004763 When the first character is ":", the command is invoked as a Vim
4764 Ex command prefixed with [count].
4765 When "man", "man -s" or an Ex command is used, Vim will automatically
4766 translate a count for the "K" command and pass it as the first
4767 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 See |option-backslash| about including spaces and backslashes.
4769 Example: >
4770 :set keywordprg=man\ -s
4771< This option cannot be set from a |modeline| or in the |sandbox|, for
4772 security reasons.
4773
4774 *'langmap'* *'lmap'* *E357* *E358*
4775'langmap' 'lmap' string (default "")
4776 global
4777 {not in Vi}
4778 {only available when compiled with the |+langmap|
4779 feature}
4780 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004781 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004782 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 care of translating these special characters to the original meaning
4784 of the key. This means you don't have to change the keyboard mode to
4785 be able to execute Normal mode commands.
4786 This is the opposite of the 'keymap' option, where characters are
4787 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004788 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004789 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004790 This option cannot be set from a |modeline| or in the |sandbox|, for
4791 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004793 Example (for Greek, in UTF-8): *greek* >
4794 :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 +00004795< Example (exchanges meaning of z and y for commands): >
4796 :set langmap=zy,yz,ZY,YZ
4797<
4798 The 'langmap' option is a list of parts, separated with commas. Each
4799 part can be in one of two forms:
4800 1. A list of pairs. Each pair is a "from" character immediately
4801 followed by the "to" character. Examples: "aA", "aAbBcC".
4802 2. A list of "from" characters, a semi-colon and a list of "to"
4803 characters. Example: "abc;ABC"
4804 Example: "aA,fgh;FGH,cCdDeE"
4805 Special characters need to be preceded with a backslash. These are
4806 ";", ',' and backslash itself.
4807
4808 This will allow you to activate vim actions without having to switch
4809 back and forth between the languages. Your language characters will
4810 be understood as normal vim English characters (according to the
4811 langmap mappings) in the following cases:
4812 o Normal/Visual mode (commands, buffer/register names, user mappings)
4813 o Insert/Replace Mode: Register names after CTRL-R
4814 o Insert/Replace Mode: Mappings
4815 Characters entered in Command-line mode will NOT be affected by
4816 this option. Note that this option can be changed at any time
4817 allowing to switch between mappings for different languages/encodings.
4818 Use a mapping to avoid having to type it each time!
4819
4820 *'langmenu'* *'lm'*
4821'langmenu' 'lm' string (default "")
4822 global
4823 {not in Vi}
4824 {only available when compiled with the |+menu| and
4825 |+multi_lang| features}
4826 Language to use for menu translation. Tells which file is loaded
4827 from the "lang" directory in 'runtimepath': >
4828 "lang/menu_" . &langmenu . ".vim"
4829< (without the spaces). For example, to always use the Dutch menus, no
4830 matter what $LANG is set to: >
4831 :set langmenu=nl_NL.ISO_8859-1
4832< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004833 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 If your $LANG is set to a non-English language but you do want to use
4835 the English menus: >
4836 :set langmenu=none
4837< This option must be set before loading menus, switching on filetype
4838 detection or syntax highlighting. Once the menus are defined setting
4839 this option has no effect. But you could do this: >
4840 :source $VIMRUNTIME/delmenu.vim
4841 :set langmenu=de_DE.ISO_8859-1
4842 :source $VIMRUNTIME/menu.vim
4843< Warning: This deletes all menus that you defined yourself!
4844
Bram Moolenaard94464e2015-11-02 15:28:18 +01004845 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004846'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004847 global
4848 {not in Vi}
4849 {only available when compiled with the |+langmap|
4850 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004851 This is just like 'langremap' but with the value inverted. It only
4852 exists for backwards compatibility. When setting 'langremap' then
4853 'langnoremap' is set to the inverted value, and the other way around.
4854
4855 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4856'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4857 global
4858 {not in Vi}
4859 {only available when compiled with the |+langmap|
4860 feature}
4861 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004862 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004863 'langmap' disables some of your mappings, try resetting this option.
4864 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004865 that works for you to avoid mappings to break.
4866
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 *'laststatus'* *'ls'*
4868'laststatus' 'ls' number (default 1)
4869 global
4870 {not in Vi}
4871 The value of this option influences when the last window will have a
4872 status line:
4873 0: never
4874 1: only if there are at least two windows
4875 2: always
4876 The screen looks nicer with a status line if you have several
4877 windows, but it takes another screen line. |status-line|
4878
4879 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4880'lazyredraw' 'lz' boolean (default off)
4881 global
4882 {not in Vi}
4883 When this option is set, the screen will not be redrawn while
4884 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004885 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 update use |:redraw|.
4887
4888 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4889'linebreak' 'lbr' boolean (default off)
4890 local to window
4891 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004892 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004894 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 than at the last character that fits on the screen. Unlike
4896 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004897 it only affects the way the file is displayed, not its contents.
4898 If 'breakindent' is set, line is visually indented. Then, the value
4899 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004900 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 Note that <Tab> characters after an <EOL> are mostly not displayed
4902 with the right amount of white space.
4903
4904 *'lines'* *E593*
4905'lines' number (default 24 or terminal height)
4906 global
4907 Number of lines of the Vim window.
4908 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004909 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 When Vim is running in the GUI or in a resizable window, setting this
4911 option will cause the window size to be changed. When you only want
4912 to use the size for the GUI, put the command in your |gvimrc| file.
4913 Vim limits the number of lines to what fits on the screen. You can
4914 use this command to get the tallest window possible: >
4915 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004916< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004917 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 When you set this option and Vim is unable to change the physical
4919 number of lines of the display, the display may be messed up.
4920
4921 *'linespace'* *'lsp'*
4922'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4923 global
4924 {not in Vi}
4925 {only in the GUI}
4926 Number of pixel lines inserted between characters. Useful if the font
4927 uses the full character cell height, making lines touch each other.
4928 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004929 With some fonts there can be too much room between lines (to have
4930 space for ascents and descents). Then it makes sense to set
4931 'linespace' to a negative value. This may cause display problems
4932 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
4934 *'lisp'* *'nolisp'*
4935'lisp' boolean (default off)
4936 local to buffer
4937 {not available when compiled without the |+lispindent|
4938 feature}
4939 Lisp mode: When <Enter> is typed in insert mode set the indent for
4940 the next line to Lisp standards (well, sort of). Also happens with
4941 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4942 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4943 better. Also see 'lispwords'.
4944 The '-' character is included in keyword characters. Redefines the
4945 "=" operator to use this same indentation algorithm rather than
4946 calling an external program if 'equalprg' is empty.
4947 This option is not used when 'paste' is set.
4948 {Vi: Does it a little bit differently}
4949
4950 *'lispwords'* *'lw'*
4951'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004952 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 {not in Vi}
4954 {not available when compiled without the |+lispindent|
4955 feature}
4956 Comma separated list of words that influence the Lisp indenting.
4957 |'lisp'|
4958
4959 *'list'* *'nolist'*
4960'list' boolean (default off)
4961 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004962 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4963 line. Useful to see the difference between tabs and spaces and for
4964 trailing blanks. Further changed by the 'listchars' option.
4965
4966 The cursor is displayed at the start of the space a Tab character
4967 occupies, not at the end as usual in Normal mode. To get this cursor
4968 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004969 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004970<
4971 Note that list mode will also affect formatting (set with 'textwidth'
4972 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 changing the way tabs are displayed.
4974
4975 *'listchars'* *'lcs'*
4976'listchars' 'lcs' string (default "eol:$")
4977 global
4978 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004979 Strings to use in 'list' mode and for the |:list| command. It is a
4980 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004981 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 eol:c Character to show at the end of each line. When
4983 omitted, there is no extra character at the end of the
4984 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004985 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004986 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004988 fill the space that the tab normally occupies.
4989 "tab:>-" will show a tab that takes four spaces as
4990 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004991 *lcs-space*
4992 space:c Character to show for a space. When omitted, spaces
4993 are left blank.
4994 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004995 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004996 trailing spaces are blank. Overrides the "space"
4997 setting for trailing spaces.
4998 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 extends:c Character to show in the last column, when 'wrap' is
5000 off and the line continues beyond the right of the
5001 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005002 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 precedes:c Character to show in the first column, when 'wrap'
5004 is off and there is text preceding the character
5005 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005006 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005007 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005008 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005009 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005010 nbsp:c Character to show for a non-breakable space character
5011 (0xA0 (160 decimal) and U+202F). Left blank when
5012 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005014 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005016 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017
5018 Examples: >
5019 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005020 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 :set lcs=extends:>,precedes:<
5022< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005023 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005024 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025
5026 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5027'loadplugins' 'lpl' boolean (default on)
5028 global
5029 {not in Vi}
5030 When on the plugin scripts are loaded when starting up |load-plugins|.
5031 This option can be reset in your |vimrc| file to disable the loading
5032 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005033 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5034 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035
Bram Moolenaard94464e2015-11-02 15:28:18 +01005036 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005037'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005038 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005039 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005040 {only available when compiled with the |+lua/dyn|
5041 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005042 Specifies the name of the Lua shared library. The default is
5043 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005044 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005045 This option cannot be set from a |modeline| or in the |sandbox|, for
5046 security reasons.
5047
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005048 *'macatsui'* *'nomacatsui'*
5049'macatsui' boolean (default on)
5050 global
5051 {only available in Mac GUI version}
5052 This is a workaround for when drawing doesn't work properly. When set
5053 and compiled with multi-byte support ATSUI text drawing is used. When
5054 not set ATSUI text drawing is not used. Switch this option off when
5055 you experience drawing problems. In a future version the problems may
5056 be solved and this option becomes obsolete. Therefore use this method
5057 to unset it: >
5058 if exists('&macatsui')
5059 set nomacatsui
5060 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005061< Another option to check if you have drawing problems is
5062 'termencoding'.
5063
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 *'magic'* *'nomagic'*
5065'magic' boolean (default on)
5066 global
5067 Changes the special characters that can be used in search patterns.
5068 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005069 WARNING: Switching this option off most likely breaks plugins! That
5070 is because many patterns assume it's on and will fail when it's off.
5071 Only switch it off when working with old Vi scripts. In any other
5072 situation write patterns that work when 'magic' is on. Include "\M"
5073 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
5075 *'makeef'* *'mef'*
5076'makeef' 'mef' string (default: "")
5077 global
5078 {not in Vi}
5079 {not available when compiled without the |+quickfix|
5080 feature}
5081 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5082 and the |:grep| command.
5083 When it is empty, an internally generated temp file will be used.
5084 When "##" is included, it is replaced by a number to make the name
5085 unique. This makes sure that the ":make" command doesn't overwrite an
5086 existing file.
5087 NOT used for the ":cf" command. See 'errorfile' for that.
5088 Environment variables are expanded |:set_env|.
5089 See |option-backslash| about including spaces and backslashes.
5090 This option cannot be set from a |modeline| or in the |sandbox|, for
5091 security reasons.
5092
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005093 *'makeencoding'* *'menc'*
5094'makeencoding' 'menc' string (default "")
5095 global or local to buffer |global-local|
5096 {only available when compiled with the |+multi_byte|
5097 feature}
5098 {not in Vi}
5099 Encoding used for reading the output of external commands. When empty,
5100 encoding is not converted.
5101 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5102 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5103 and `:laddfile`.
5104
5105 This would be mostly useful when you use MS-Windows and set 'encoding'
5106 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5107 'makeencoding' to "char" has the same effect as setting to the system
5108 locale encoding. Example: >
5109 :set encoding=utf-8
5110 :set makeencoding=char " system locale is used
5111<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 *'makeprg'* *'mp'*
5113'makeprg' 'mp' string (default "make", VMS: "MMS")
5114 global or local to buffer |global-local|
5115 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005116 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005117 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5118 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005119 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005120 Environment variables are expanded |:set_env|. See |option-backslash|
5121 about including spaces and backslashes.
5122 Note that a '|' must be escaped twice: once for ":set" and once for
5123 the interpretation of a command. When you use a filter called
5124 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 :set makeprg=gmake\ \\\|\ myfilter
5126< The placeholder "$*" can be given (even multiple times) to specify
5127 where the arguments will be included, for example: >
5128 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5129< This option cannot be set from a |modeline| or in the |sandbox|, for
5130 security reasons.
5131
5132 *'matchpairs'* *'mps'*
5133'matchpairs' 'mps' string (default "(:),{:},[:]")
5134 local to buffer
5135 {not in Vi}
5136 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005137 other.
5138 Only character pairs are allowed that are different, thus you cannot
5139 jump between two double quotes.
5140 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005141 The pairs must be separated by a comma. Example for including '<' and
5142 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005143 :set mps+=<:>
5144
5145< A more exotic example, to jump between the '=' and ';' in an
5146 assignment, useful for languages like C and Java: >
5147 :au FileType c,cpp,java set mps+==:;
5148
5149< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005150 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151
5152 *'matchtime'* *'mat'*
5153'matchtime' 'mat' number (default 5)
5154 global
5155 {not in Vi}{in Nvi}
5156 Tenths of a second to show the matching paren, when 'showmatch' is
5157 set. Note that this is not in milliseconds, like other options that
5158 set a time. This is to be compatible with Nvi.
5159
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005160 *'maxcombine'* *'mco'*
5161'maxcombine' 'mco' number (default 2)
5162 global
5163 {not in Vi}
5164 {only available when compiled with the |+multi_byte|
5165 feature}
5166 The maximum number of combining characters supported for displaying.
5167 Only used when 'encoding' is "utf-8".
5168 The default is OK for most languages. Hebrew may require 4.
5169 Maximum value is 6.
5170 Even when this option is set to 2 you can still edit text with more
5171 combining characters, you just can't see them. Use |g8| or |ga|.
5172 See |mbyte-combining|.
5173
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 *'maxfuncdepth'* *'mfd'*
5175'maxfuncdepth' 'mfd' number (default 100)
5176 global
5177 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005178 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005179 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 Maximum depth of function calls for user functions. This normally
5181 catches endless recursion. When using a recursive function with
5182 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5183 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005184 Increasing this limit above 200 also changes the maximum for Ex
5185 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 See also |:function|.
5187
5188 *'maxmapdepth'* *'mmd'* *E223*
5189'maxmapdepth' 'mmd' number (default 1000)
5190 global
5191 {not in Vi}
5192 Maximum number of times a mapping is done without resulting in a
5193 character to be used. This normally catches endless mappings, like
5194 ":map x y" with ":map y x". It still does not catch ":map g wg",
5195 because the 'w' is used before the next mapping is done. See also
5196 |key-mapping|.
5197
5198 *'maxmem'* *'mm'*
5199'maxmem' 'mm' number (default between 256 to 5120 (system
5200 dependent) or half the amount of memory
5201 available)
5202 global
5203 {not in Vi}
5204 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5205 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005206 other memory to be freed.
5207 The maximum usable value is about 2000000. Use this to work without a
5208 limit.
5209 The value is ignored when 'swapfile' is off.
5210 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005212 *'maxmempattern'* *'mmp'*
5213'maxmempattern' 'mmp' number (default 1000)
5214 global
5215 {not in Vi}
5216 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005217 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005218 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005219 When Vim runs into the limit it gives an error message and mostly
5220 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005221 Running into the limit often means that the pattern is very
5222 inefficient or too complex. This may already happen with the pattern
5223 "\(.\)*" on a very long line. ".*" works much better.
5224 Vim may run out of memory before hitting the 'maxmempattern' limit.
5225
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 *'maxmemtot'* *'mmt'*
5227'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5228 dependent) or half the amount of memory
5229 available)
5230 global
5231 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005232 Maximum amount of memory in Kbyte to use for all buffers together.
5233 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005234 without a limit.
5235 On 64 bit machines higher values might work. But hey, do you really
5236 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005237 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005238 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005239 Buffers with 'swapfile' off still count to the total amount of memory
5240 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005241 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
5243 *'menuitems'* *'mis'*
5244'menuitems' 'mis' number (default 25)
5245 global
5246 {not in Vi}
5247 {not available when compiled without the |+menu|
5248 feature}
5249 Maximum number of items to use in a menu. Used for menus that are
5250 generated from a list of items, e.g., the Buffers menu. Changing this
5251 option has no direct effect, the menu must be refreshed first.
5252
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005253 *'mkspellmem'* *'msm'*
5254'mkspellmem' 'msm' string (default "460000,2000,500")
5255 global
5256 {not in Vi}
5257 {not available when compiled without the |+syntax|
5258 feature}
5259 Parameters for |:mkspell|. This tunes when to start compressing the
5260 word tree. Compression can be slow when there are many words, but
5261 it's needed to avoid running out of memory. The amount of memory used
5262 per word depends very much on how similar the words are, that's why
5263 this tuning is complicated.
5264
5265 There are three numbers, separated by commas:
5266 {start},{inc},{added}
5267
5268 For most languages the uncompressed word tree fits in memory. {start}
5269 gives the amount of memory in Kbyte that can be used before any
5270 compression is done. It should be a bit smaller than the amount of
5271 memory that is available to Vim.
5272
5273 When going over the {start} limit the {inc} number specifies the
5274 amount of memory in Kbyte that can be allocated before another
5275 compression is done. A low number means compression is done after
5276 less words are added, which is slow. A high number means more memory
5277 will be allocated.
5278
5279 After doing compression, {added} times 1024 words can be added before
5280 the {inc} limit is ignored and compression is done when any extra
5281 amount of memory is needed. A low number means there is a smaller
5282 chance of hitting the {inc} limit, less memory is used but it's
5283 slower.
5284
5285 The languages for which these numbers are important are Italian and
5286 Hungarian. The default works for when you have about 512 Mbyte. If
5287 you have 1 Gbyte you could use: >
5288 :set mkspellmem=900000,3000,800
5289< If you have less than 512 Mbyte |:mkspell| may fail for some
5290 languages, no matter what you set 'mkspellmem' to.
5291
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005293'modeline' 'ml' boolean (Vim default: on (off for root),
5294 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 local to buffer
5296 *'modelines'* *'mls'*
5297'modelines' 'mls' number (default 5)
5298 global
5299 {not in Vi}
5300 If 'modeline' is on 'modelines' gives the number of lines that is
5301 checked for set commands. If 'modeline' is off or 'modelines' is zero
5302 no lines are checked. See |modeline|.
5303 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5304 set and to the Vim default value when 'compatible' is reset.
5305
5306 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5307'modifiable' 'ma' boolean (default on)
5308 local to buffer
5309 {not in Vi} *E21*
5310 When off the buffer contents cannot be changed. The 'fileformat' and
5311 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005312 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313
5314 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5315'modified' 'mod' boolean (default off)
5316 local to buffer
5317 {not in Vi}
5318 When on, the buffer is considered to be modified. This option is set
5319 when:
5320 1. A change was made to the text since it was last written. Using the
5321 |undo| command to go back to the original text will reset the
5322 option. But undoing changes that were made before writing the
5323 buffer will set the option again, since the text is different from
5324 when it was written.
5325 2. 'fileformat' or 'fileencoding' is different from its original
5326 value. The original value is set when the buffer is read or
5327 written. A ":set nomodified" command also resets the original
5328 values to the current values and the 'modified' option will be
5329 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005330 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005331 This option is not set when a change is made to the buffer as the
5332 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5333 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5334 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5336 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005337 Note that the text may actually be the same, e.g. 'modified' is set
5338 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339
5340 *'more'* *'nomore'*
5341'more' boolean (Vim default: on, Vi default: off)
5342 global
5343 {not in Vi}
5344 When on, listings pause when the whole screen is filled. You will get
5345 the |more-prompt|. When this option is off there are no pauses, the
5346 listing continues until finished.
5347 NOTE: This option is set to the Vi default value when 'compatible' is
5348 set and to the Vim default value when 'compatible' is reset.
5349
5350 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005351'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5352 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 global
5354 {not in Vi}
5355 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005356 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5357 sysmouse and Linux console with gpm). For using the mouse in the
5358 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005360 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 v Visual mode
5362 i Insert mode
5363 c Command-line mode
5364 h all previous modes when editing a help file
5365 a all previous modes
5366 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 Normally you would enable the mouse in all four modes with: >
5368 :set mouse=a
5369< When the mouse is not enabled, the GUI will still use the mouse for
5370 modeless selection. This doesn't move the text cursor.
5371
5372 See |mouse-using|. Also see |'clipboard'|.
5373
5374 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005375 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 the mouse buttons can still be used by keeping the shift key pressed.
5377 Also see the 'clipboard' option.
5378
5379 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5380'mousefocus' 'mousef' boolean (default off)
5381 global
5382 {not in Vi}
5383 {only works in the GUI}
5384 The window that the mouse pointer is on is automatically activated.
5385 When changing the window layout or window focus in another way, the
5386 mouse pointer is moved to the window with keyboard focus. Off is the
5387 default because it makes using the pull down menus a little goofy, as
5388 a pointer transit may activate a window unintentionally.
5389
5390 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5391'mousehide' 'mh' boolean (default on)
5392 global
5393 {not in Vi}
5394 {only works in the GUI}
5395 When on, the mouse pointer is hidden when characters are typed.
5396 The mouse pointer is restored when the mouse is moved.
5397
5398 *'mousemodel'* *'mousem'*
5399'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5400 global
5401 {not in Vi}
5402 Sets the model to use for the mouse. The name mostly specifies what
5403 the right mouse button is used for:
5404 extend Right mouse button extends a selection. This works
5405 like in an xterm.
5406 popup Right mouse button pops up a menu. The shifted left
5407 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005408 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 popup_setpos Like "popup", but the cursor will be moved to the
5410 position where the mouse was clicked, and thus the
5411 selected operation will act upon the clicked object.
5412 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005413 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 course, that right clicking outside a selection will
5415 end Visual mode.
5416 Overview of what button does what for each model:
5417 mouse extend popup(_setpos) ~
5418 left click place cursor place cursor
5419 left drag start selection start selection
5420 shift-left search word extend selection
5421 right click extend selection popup menu (place cursor)
5422 right drag extend selection -
5423 middle click paste paste
5424
5425 In the "popup" model the right mouse button produces a pop-up menu.
5426 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005427 In a terminal the popup menu works if Vim is compiled with the
5428 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429
5430 Note that you can further refine the meaning of buttons with mappings.
5431 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5432 selection (because that's handled in the GUI code directly).
5433
5434 The 'mousemodel' option is set by the |:behave| command.
5435
5436 *'mouseshape'* *'mouses'* *E547*
5437'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005438 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 global
5440 {not in Vi}
5441 {only available when compiled with the |+mouseshape|
5442 feature}
5443 This option tells Vim what the mouse pointer should look like in
5444 different modes. The option is a comma separated list of parts, much
5445 like used for 'guicursor'. Each part consist of a mode/location-list
5446 and an argument-list:
5447 mode-list:shape,mode-list:shape,..
5448 The mode-list is a dash separated list of these modes/locations:
5449 In a normal window: ~
5450 n Normal mode
5451 v Visual mode
5452 ve Visual mode with 'selection' "exclusive" (same as 'v',
5453 if not specified)
5454 o Operator-pending mode
5455 i Insert mode
5456 r Replace mode
5457
5458 Others: ~
5459 c appending to the command-line
5460 ci inserting in the command-line
5461 cr replacing in the command-line
5462 m at the 'Hit ENTER' or 'More' prompts
5463 ml idem, but cursor in the last line
5464 e any mode, pointer below last window
5465 s any mode, pointer on a status line
5466 sd any mode, while dragging a status line
5467 vs any mode, pointer on a vertical separator line
5468 vd any mode, while dragging a vertical separator line
5469 a everywhere
5470
5471 The shape is one of the following:
5472 avail name looks like ~
5473 w x arrow Normal mouse pointer
5474 w x blank no pointer at all (use with care!)
5475 w x beam I-beam
5476 w x updown up-down sizing arrows
5477 w x leftright left-right sizing arrows
5478 w x busy The system's usual busy pointer
5479 w x no The system's usual 'no input' pointer
5480 x udsizing indicates up-down resizing
5481 x lrsizing indicates left-right resizing
5482 x crosshair like a big thin +
5483 x hand1 black hand
5484 x hand2 white hand
5485 x pencil what you write with
5486 x question big ?
5487 x rightup-arrow arrow pointing right-up
5488 w x up-arrow arrow pointing up
5489 x <number> any X11 pointer number (see X11/cursorfont.h)
5490
5491 The "avail" column contains a 'w' if the shape is available for Win32,
5492 x for X11.
5493 Any modes not specified or shapes not available use the normal mouse
5494 pointer.
5495
5496 Example: >
5497 :set mouseshape=s:udsizing,m:no
5498< will make the mouse turn to a sizing arrow over the status lines and
5499 indicate no input when the hit-enter prompt is displayed (since
5500 clicking the mouse has no effect in this state.)
5501
5502 *'mousetime'* *'mouset'*
5503'mousetime' 'mouset' number (default 500)
5504 global
5505 {not in Vi}
5506 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5507 time in msec between two mouse clicks for the second click to be
5508 recognized as a multi click.
5509
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005510 *'mzschemedll'*
5511'mzschemedll' string (default depends on the build)
5512 global
5513 {not in Vi}
5514 {only available when compiled with the |+mzscheme/dyn|
5515 feature}
5516 Specifies the name of the MzScheme shared library. The default is
5517 DYNAMIC_MZSCH_DLL which was specified at compile time.
5518 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005519 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005520 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005521 This option cannot be set from a |modeline| or in the |sandbox|, for
5522 security reasons.
5523
5524 *'mzschemegcdll'*
5525'mzschemegcdll' string (default depends on the build)
5526 global
5527 {not in Vi}
5528 {only available when compiled with the |+mzscheme/dyn|
5529 feature}
5530 Specifies the name of the MzScheme GC shared library. The default is
5531 DYNAMIC_MZGC_DLL which was specified at compile time.
5532 The value can be equal to 'mzschemedll' if it includes the GC code.
5533 Environment variables are expanded |:set_env|.
5534 This option cannot be set from a |modeline| or in the |sandbox|, for
5535 security reasons.
5536
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005537 *'mzquantum'* *'mzq'*
5538'mzquantum' 'mzq' number (default 100)
5539 global
5540 {not in Vi}
5541 {not available when compiled without the |+mzscheme|
5542 feature}
5543 The number of milliseconds between polls for MzScheme threads.
5544 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005545 NOTE: This option is set to the Vim default value when 'compatible'
5546 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005549'nrformats' 'nf' string (default "bin,octal,hex",
5550 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 local to buffer
5552 {not in Vi}
5553 This defines what bases Vim will consider for numbers when using the
5554 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5555 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005556 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005558 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005559 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005561 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 considered to be hexadecimal. Example: Using CTRL-X on
5563 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005564 bin If included, numbers starting with "0b" or "0B" will be
5565 considered to be binary. Example: Using CTRL-X on
5566 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 Numbers which simply begin with a digit in the range 1-9 are always
5568 considered decimal. This also happens for numbers that are not
5569 recognized as octal or hex.
5570
5571 *'number'* *'nu'* *'nonumber'* *'nonu'*
5572'number' 'nu' boolean (default off)
5573 local to window
5574 Print the line number in front of each line. When the 'n' option is
5575 excluded from 'cpoptions' a wrapped line will not use the column of
5576 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005577 The 'numberwidth' option can be used to set the room used for the line
5578 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 When a long, wrapped line doesn't start with the first character, '-'
5580 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005581 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5582 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005583 *number_relativenumber*
5584 The 'relativenumber' option changes the displayed number to be
5585 relative to the cursor. Together with 'number' there are these
5586 four combinations (cursor in line 3):
5587
Bram Moolenaar3848e002016-03-19 18:42:29 +01005588 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005589 'nornu' 'nornu' 'rnu' 'rnu'
5590
5591 |apple | 1 apple | 2 apple | 2 apple
5592 |pear | 2 pear | 1 pear | 1 pear
5593 |nobody | 3 nobody | 0 nobody |3 nobody
5594 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005596 *'numberwidth'* *'nuw'*
5597'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5598 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005599 {not in Vi}
5600 {only available when compiled with the |+linebreak|
5601 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005602 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005603 when the 'number' or 'relativenumber' option is set or printing lines
5604 with a line number. Since one space is always between the number and
5605 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005606 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005607 fit the highest line number in the buffer respectively the number of
5608 rows in the window, depending on whether 'number' or 'relativenumber'
5609 is set. Thus with the Vim default of 4 there is room for a line number
5610 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005611 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005612 NOTE: This option is set to the Vi default value when 'compatible' is
5613 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005614
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005615 *'omnifunc'* *'ofu'*
5616'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005617 local to buffer
5618 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005619 {not available when compiled without the |+eval|
5620 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005621 This option specifies a function to be used for Insert mode omni
5622 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005623 See |complete-functions| for an explanation of how the function is
5624 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005625 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005626 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005627 This option cannot be set from a |modeline| or in the |sandbox|, for
5628 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005629
5630
Bram Moolenaar02467872007-05-06 13:22:01 +00005631 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005632'opendevice' 'odev' boolean (default off)
5633 global
5634 {not in Vi}
5635 {only for MS-DOS, MS-Windows and OS/2}
5636 Enable reading and writing from devices. This may get Vim stuck on a
5637 device that can be opened but doesn't actually do the I/O. Therefore
5638 it is off by default.
5639 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5640 result in editing a device.
5641
5642
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005643 *'operatorfunc'* *'opfunc'*
5644'operatorfunc' 'opfunc' string (default: empty)
5645 global
5646 {not in Vi}
5647 This option specifies a function to be called by the |g@| operator.
5648 See |:map-operator| for more info and an example.
5649
5650 This option cannot be set from a |modeline| or in the |sandbox|, for
5651 security reasons.
5652
5653
Bram Moolenaar251e1912011-06-19 05:09:16 +02005654 *'osfiletype'* *'oft'*
5655'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 local to buffer
5657 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005658 This option was supported on RISC OS, which has been removed.
5659
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005661 *'packpath'* *'pp'*
5662'packpath' 'pp' string (default: see 'runtimepath')
5663 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005664 Directories used to find packages. See |packages|.
5665
5666
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005668'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 global
5670 Specifies the nroff macros that separate paragraphs. These are pairs
5671 of two letters (see |object-motions|).
5672
5673 *'paste'* *'nopaste'*
5674'paste' boolean (default off)
5675 global
5676 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005677 Put Vim in Paste mode. This is useful if you want to cut or copy
5678 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 unexpected effects.
5680 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005681 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 knows about pasting and will mostly do the right thing without 'paste'
5683 being set. The same is true for a terminal where Vim handles the
5684 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005685 This option is reset when starting the GUI. Thus if you set it in
5686 your .vimrc it will work in a terminal, but not in the GUI. Setting
5687 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5688 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 When the 'paste' option is switched on (also when it was already on):
5690 - mapping in Insert mode and Command-line mode is disabled
5691 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005693 - 'expandtab' is reset
5694 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 - 'revins' is reset
5696 - 'ruler' is reset
5697 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005698 - 'smartindent' is reset
5699 - 'smarttab' is reset
5700 - 'softtabstop' is set to 0
5701 - 'textwidth' is set to 0
5702 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005705 - 'indentexpr'
5706 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 NOTE: When you start editing another file while the 'paste' option is
5708 on, settings from the modelines or autocommands may change the
5709 settings again, causing trouble when pasting text. You might want to
5710 set the 'paste' option again.
5711 When the 'paste' option is reset the mentioned options are restored to
5712 the value before the moment 'paste' was switched from off to on.
5713 Resetting 'paste' before ever setting it does not have any effect.
5714 Since mapping doesn't work while 'paste' is active, you need to use
5715 the 'pastetoggle' option to toggle the 'paste' option with some key.
5716
5717 *'pastetoggle'* *'pt'*
5718'pastetoggle' 'pt' string (default "")
5719 global
5720 {not in Vi}
5721 When non-empty, specifies the key sequence that toggles the 'paste'
5722 option. This is like specifying a mapping: >
5723 :map {keys} :set invpaste<CR>
5724< Where {keys} is the value of 'pastetoggle'.
5725 The difference is that it will work even when 'paste' is set.
5726 'pastetoggle' works in Insert mode and Normal mode, but not in
5727 Command-line mode.
5728 Mappings are checked first, thus overrule 'pastetoggle'. However,
5729 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5730 this: >
5731 :map <F10> :set paste<CR>
5732 :map <F11> :set nopaste<CR>
5733 :imap <F10> <C-O>:set paste<CR>
5734 :imap <F11> <nop>
5735 :set pastetoggle=<F11>
5736< This will make <F10> start paste mode and <F11> stop paste mode.
5737 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5738 mode everything is inserted literally, except the 'pastetoggle' key
5739 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005740 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741
5742 *'pex'* *'patchexpr'*
5743'patchexpr' 'pex' string (default "")
5744 global
5745 {not in Vi}
5746 {not available when compiled without the |+diff|
5747 feature}
5748 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005749 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750
Bram Moolenaardbc28022014-07-26 13:40:44 +02005751 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752'patchmode' 'pm' string (default "")
5753 global
5754 {not in Vi}
5755 When non-empty the oldest version of a file is kept. This can be used
5756 to keep the original version of a file if you are changing files in a
5757 source distribution. Only the first time that a file is written a
5758 copy of the original file will be kept. The name of the copy is the
5759 name of the original file with the string in the 'patchmode' option
5760 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005761 ".orig" or ".org". 'backupdir' must not be empty for this to work
5762 (Detail: The backup file is renamed to the patchmode file after the
5763 new file has been successfully written, that's why it must be possible
5764 to write a backup file). If there was no file to be backed up, an
5765 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 When the 'backupskip' pattern matches, a patchmode file is not made.
5767 Using 'patchmode' for compressed files appends the extension at the
5768 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5769 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005770 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005772 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773'path' 'pa' string (default on Unix: ".,/usr/include,,"
5774 on OS/2: ".,/emx/include,,"
5775 other systems: ".,,")
5776 global or local to buffer |global-local|
5777 {not in Vi}
5778 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005779 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5780 provided that the file being searched for has a relative path (not
5781 starting with "/", "./" or "../"). The directories in the 'path'
5782 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 - Use commas to separate directory names: >
5784 :set path=.,/usr/local/include,/usr/include
5785< - Spaces can also be used to separate directory names (for backwards
5786 compatibility with version 3.0). To have a space in a directory
5787 name, precede it with an extra backslash, and escape the space: >
5788 :set path=.,/dir/with\\\ space
5789< - To include a comma in a directory name precede it with an extra
5790 backslash: >
5791 :set path=.,/dir/with\\,comma
5792< - To search relative to the directory of the current file, use: >
5793 :set path=.
5794< - To search in the current directory use an empty string between two
5795 commas: >
5796 :set path=,,
5797< - A directory name may end in a ':' or '/'.
5798 - Environment variables are expanded |:set_env|.
5799 - When using |netrw.vim| URLs can be used. For example, adding
5800 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005801 - Search upwards and downwards in a directory tree using "*", "**" and
5802 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 {not available when compiled without the |+path_extra| feature}
5804 - Careful with '\' characters, type two to get one in the option: >
5805 :set path=.,c:\\include
5806< Or just use '/' instead: >
5807 :set path=.,c:/include
5808< Don't forget "." or files won't even be found in the same directory as
5809 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005810 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 it is something like 256 or 1024 characters.
5812 You can check if all the include files are found, using the value of
5813 'path', see |:checkpath|.
5814 The use of |:set+=| and |:set-=| is preferred when adding or removing
5815 directories from the list. This avoids problems when a future version
5816 uses another default. To remove the current directory use: >
5817 :set path-=
5818< To add the current directory use: >
5819 :set path+=
5820< To use an environment variable, you probably need to replace the
5821 separator. Here is an example to append $INCL, in which directory
5822 names are separated with a semi-colon: >
5823 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5824< Replace the ';' with a ':' or whatever separator is used. Note that
5825 this doesn't work when $INCL contains a comma or white space.
5826
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005827 *'perldll'*
5828'perldll' string (default depends on the build)
5829 global
5830 {not in Vi}
5831 {only available when compiled with the |+perl/dyn|
5832 feature}
5833 Specifies the name of the Perl shared library. The default is
5834 DYNAMIC_PERL_DLL, which was specified at compile time.
5835 Environment variables are expanded |:set_env|.
5836 This option cannot be set from a |modeline| or in the |sandbox|, for
5837 security reasons.
5838
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5840'preserveindent' 'pi' boolean (default off)
5841 local to buffer
5842 {not in Vi}
5843 When changing the indent of the current line, preserve as much of the
5844 indent structure as possible. Normally the indent is replaced by a
5845 series of tabs followed by spaces as required (unless |'expandtab'| is
5846 enabled, in which case only spaces are used). Enabling this option
5847 means the indent will preserve as many existing characters as possible
5848 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005849 'expandtab' does not apply to the preserved white space, a Tab remains
5850 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 NOTE: When using ">>" multiple times the resulting indent is a mix of
5852 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005853 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005854 Also see 'copyindent'.
5855 Use |:retab| to clean up white space.
5856
5857 *'previewheight'* *'pvh'*
5858'previewheight' 'pvh' number (default 12)
5859 global
5860 {not in Vi}
5861 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005862 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 Default height for a preview window. Used for |:ptag| and associated
5864 commands. Used for |CTRL-W_}| when no count is given.
5865
5866 *'previewwindow'* *'nopreviewwindow'*
5867 *'pvw'* *'nopvw'* *E590*
5868'previewwindow' 'pvw' boolean (default off)
5869 local to window
5870 {not in Vi}
5871 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005872 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005873 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 set. It's normally not set directly, but by using one of the commands
5875 |:ptag|, |:pedit|, etc.
5876
5877 *'printdevice'* *'pdev'*
5878'printdevice' 'pdev' string (default empty)
5879 global
5880 {not in Vi}
5881 {only available when compiled with the |+printer|
5882 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005883 The name of the printer to be used for |:hardcopy|.
5884 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005885 This option cannot be set from a |modeline| or in the |sandbox|, for
5886 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887
Bram Moolenaar8299df92004-07-10 09:47:34 +00005888 *'printencoding'* *'penc'*
5889'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 global
5891 {not in Vi}
5892 {only available when compiled with the |+printer|
5893 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005894 Sets the character encoding used when printing.
5895 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896
5897 *'printexpr'* *'pexpr'*
5898'printexpr' 'pexpr' String (default: see below)
5899 global
5900 {not in Vi}
5901 {only available when compiled with the |+printer|
5902 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005903 Expression used to print the PostScript produced with |:hardcopy|.
5904 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005905 This option cannot be set from a |modeline| or in the |sandbox|, for
5906 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907
Bram Moolenaar8299df92004-07-10 09:47:34 +00005908 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909'printfont' 'pfn' string (default "courier")
5910 global
5911 {not in Vi}
5912 {only available when compiled with the |+printer|
5913 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005914 The name of the font that will be used for |:hardcopy|.
5915 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916
5917 *'printheader'* *'pheader'*
5918'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5919 global
5920 {not in Vi}
5921 {only available when compiled with the |+printer|
5922 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005923 The format of the header produced in |:hardcopy| output.
5924 See |pheader-option|.
5925
5926 *'printmbcharset'* *'pmbcs'*
5927'printmbcharset' 'pmbcs' string (default "")
5928 global
5929 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005930 {only available when compiled with the |+printer|,
5931 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005932 The CJK character set to be used for CJK output from |:hardcopy|.
5933 See |pmbcs-option|.
5934
5935 *'printmbfont'* *'pmbfn'*
5936'printmbfont' 'pmbfn' string (default "")
5937 global
5938 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005939 {only available when compiled with the |+printer|,
5940 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005941 List of font names to be used for CJK output from |:hardcopy|.
5942 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005943
5944 *'printoptions'* *'popt'*
5945'printoptions' 'popt' string (default "")
5946 global
5947 {not in Vi}
5948 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005949 List of items that control the format of the output of |:hardcopy|.
5950 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005951
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005952 *'prompt'* *'noprompt'*
5953'prompt' boolean (default on)
5954 global
5955 When on a ":" prompt is used in Ex mode.
5956
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005957 *'pumheight'* *'ph'*
5958'pumheight' 'ph' number (default 0)
5959 global
5960 {not available when compiled without the
5961 |+insert_expand| feature}
5962 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005963 Determines the maximum number of items to show in the popup menu for
5964 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005965 |ins-completion-menu|.
5966
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005967 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005968'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005969 global
5970 {not available when compiled without the
5971 |+insert_expand| feature}
5972 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005973 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005974 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005975
Bram Moolenaard94464e2015-11-02 15:28:18 +01005976 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005977'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005978 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005979 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005980 {only available when compiled with the |+python/dyn|
5981 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005982 Specifies the name of the Python 2.x shared library. The default is
5983 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005984 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005985 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005987
Bram Moolenaar94073162018-01-31 21:49:05 +01005988 *'pythonhome'*
5989'pythonhome' string (default "")
5990 global
5991 {not in Vi}
5992 {only available when compiled with the |+python/dyn|
5993 feature}
5994 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5995 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5996 which was specified at compile time, will be used for the Python 2.x
5997 home directory.
5998 Environment variables are expanded |:set_env|.
5999 This option cannot be set from a |modeline| or in the |sandbox|, for
6000 security reasons.
6001
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006002 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006003'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006004 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006005 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006006 {only available when compiled with the |+python3/dyn|
6007 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006008 Specifies the name of the Python 3 shared library. The default is
6009 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006010 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006011 This option cannot be set from a |modeline| or in the |sandbox|, for
6012 security reasons.
6013
Bram Moolenaar94073162018-01-31 21:49:05 +01006014 *'pythonthreehome'*
6015'pythonthreehome' string (default "")
6016 global
6017 {not in Vi}
6018 {only available when compiled with the |+python3/dyn|
6019 feature}
6020 Specifies the name of the Python 3 home directory. When
6021 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6022 PYTHON3_HOME, which was specified at compile time, will be used for
6023 the Python 3 home directory.
6024 Environment variables are expanded |:set_env|.
6025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
6027
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006028 *'pyxversion'* *'pyx'*
6029'pyxversion' 'pyx' number (default depends on the build)
6030 global
6031 {not in Vi}
6032 {only available when compiled with the |+python| or
6033 the |+python3| feature}
6034 Specifies the python version used for pyx* functions and commands
6035 |python_x|. The default value is as follows:
6036
6037 Compiled with Default ~
6038 |+python| and |+python3| 0
6039 only |+python| 2
6040 only |+python3| 3
6041
6042 Available values are 0, 2 and 3.
6043 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6044 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6045 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6046 to 2 if Python 2 is available.
6047 See also: |has-pythonx|
6048
6049 If Vim is compiled with only |+python| or |+python3| setting
6050 'pyxversion' has no effect. The pyx* functions and commands are
6051 always the same as the compiled version.
6052
6053 This option cannot be set from a |modeline| or in the |sandbox|, for
6054 security reasons.
6055
Bram Moolenaar677ee682005-01-27 14:41:15 +00006056 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006057'quoteescape' 'qe' string (default "\")
6058 local to buffer
6059 {not in Vi}
6060 The characters that are used to escape quotes in a string. Used for
6061 objects like a', a" and a` |a'|.
6062 When one of the characters in this option is found inside a string,
6063 the following character will be skipped. The default value makes the
6064 text "foo\"bar\\" considered to be one string.
6065
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6067'readonly' 'ro' boolean (default off)
6068 local to buffer
6069 If on, writes fail unless you use a '!'. Protects you from
6070 accidentally overwriting a file. Default on when Vim is started
6071 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006072 When using ":w!" the 'readonly' option is reset for the current
6073 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006075 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006076 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006078 *'redrawtime'* *'rdt'*
6079'redrawtime' 'rdt' number (default 2000)
6080 global
6081 {not in Vi}
6082 {only available when compiled with the |+reltime|
6083 feature}
6084 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006085 searching for patterns for 'hlsearch', |:match| highlighting an syntax
6086 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006087 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006088 matches will be highlighted.
6089 For syntax highlighting the time applies per window. When over the
6090 limit syntax highlighting is disabled until |CTRL-L| is used.
6091 This is used to avoid that Vim hangs when using a very complicated
6092 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006093
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006094 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006095'regexpengine' 're' number (default 0)
6096 global
6097 {not in Vi}
6098 This selects the default regexp engine. |two-engines|
6099 The possible values are:
6100 0 automatic selection
6101 1 old engine
6102 2 NFA engine
6103 Note that when using the NFA engine and the pattern contains something
6104 that is not supported the pattern will not match. This is only useful
6105 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006106 Using automatic selection enables Vim to switch the engine, if the
6107 default engine becomes too costly. E.g., when the NFA engine uses too
6108 many states. This should prevent Vim from hanging on a combination of
6109 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006110
Bram Moolenaar64486672010-05-16 15:46:46 +02006111 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6112'relativenumber' 'rnu' boolean (default off)
6113 local to window
6114 {not in Vi}
6115 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006116 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006117 precede some vertical motion commands (e.g. j k + -) with, without
6118 having to calculate it yourself. Especially useful in combination with
6119 other commands (e.g. y d c < > gq gw =).
6120 When the 'n' option is excluded from 'cpoptions' a wrapped
6121 line will not use the column of line numbers (this is the default when
6122 'compatible' isn't set).
6123 The 'numberwidth' option can be used to set the room used for the line
6124 number.
6125 When a long, wrapped line doesn't start with the first character, '-'
6126 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006127 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6128 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006129
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006130 The number in front of the cursor line also depends on the value of
6131 'number', see |number_relativenumber| for all combinations of the two
6132 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006133
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 *'remap'* *'noremap'*
6135'remap' boolean (default on)
6136 global
6137 Allows for mappings to work recursively. If you do not want this for
6138 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006139 NOTE: To avoid portability problems with Vim scripts, always keep
6140 this option at the default "on". Only switch it off when working with
6141 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006143 *'renderoptions'* *'rop'*
6144'renderoptions' 'rop' string (default: empty)
6145 global
6146 {not in Vi}
6147 {only available when compiled with GUI and DIRECTX on
6148 MS-Windows}
6149 Select a text renderer and set its options. The options depend on the
6150 renderer.
6151
6152 Syntax: >
6153 set rop=type:{renderer}(,{name}:{value})*
6154<
6155 Currently, only one optional renderer is available.
6156
6157 render behavior ~
6158 directx Vim will draw text using DirectX (DirectWrite). It makes
6159 drawn glyphs more beautiful than default GDI.
6160 It requires 'encoding' is "utf-8", and only works on
6161 MS-Windows Vista or newer version.
6162
6163 Options:
6164 name meaning type value ~
6165 gamma gamma float 1.0 - 2.2 (maybe)
6166 contrast enhancedContrast float (unknown)
6167 level clearTypeLevel float (unknown)
6168 geom pixelGeometry int 0 - 2 (see below)
6169 renmode renderingMode int 0 - 6 (see below)
6170 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006171 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006172
Bram Moolenaar92467d32017-12-05 13:22:16 +01006173 See this URL for detail (except for scrlines):
6174 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006175
6176 For geom: structure of a device pixel.
6177 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6178 1 - DWRITE_PIXEL_GEOMETRY_RGB
6179 2 - DWRITE_PIXEL_GEOMETRY_BGR
6180
6181 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006182 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006183
6184 For renmode: method of rendering glyphs.
6185 0 - DWRITE_RENDERING_MODE_DEFAULT
6186 1 - DWRITE_RENDERING_MODE_ALIASED
6187 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6188 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6189 4 - DWRITE_RENDERING_MODE_NATURAL
6190 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6191 6 - DWRITE_RENDERING_MODE_OUTLINE
6192
6193 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006194 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006195
6196 For taamode: antialiasing mode used for drawing text.
6197 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6198 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6199 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6200 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6201
6202 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006203 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6204
Bram Moolenaara338adc2018-01-31 20:51:47 +01006205 For scrlines:
6206 This was used for optimizing scrolling behavior, however this
6207 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006208
6209 Example: >
6210 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006211 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006212 set rop=type:directx
6213<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006214 If select a raster font (Courier, Terminal or FixedSys which
6215 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006216 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006217
6218 NOTE: It is known that some fonts and options combination
6219 causes trouble on drawing glyphs.
6220
Bram Moolenaar92467d32017-12-05 13:22:16 +01006221 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006222 special made fonts (True-Type fonts which includes only
6223 bitmap glyphs).
6224 - 'taamode:3' will not work with some vector fonts.
6225
6226 NOTE: With this option, you can display colored emoji
6227 (emoticon) in Windows 8.1 or later. To display colored emoji,
6228 there are some conditions which you should notice.
6229
6230 - If your font includes non-colored emoji already, it will
6231 be used.
6232 - If your font doesn't have emoji, the system chooses an
6233 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6234 will be used.
6235 - When this alternative font didn't have fixed width glyph,
6236 emoji might be rendered beyond the bounding box of drawing
6237 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006238
6239 Other render types are currently not supported.
6240
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 *'report'*
6242'report' number (default 2)
6243 global
6244 Threshold for reporting number of lines changed. When the number of
6245 changed lines is more than 'report' a message will be given for most
6246 ":" commands. If you want it always, set 'report' to 0.
6247 For the ":substitute" command the number of substitutions is used
6248 instead of the number of lines.
6249
6250 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6251'restorescreen' 'rs' boolean (default on)
6252 global
6253 {not in Vi} {only in Windows 95/NT console version}
6254 When set, the screen contents is restored when exiting Vim. This also
6255 happens when executing external commands.
6256
6257 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6258 options in your .vimrc. To disable restoring:
6259 set t_ti= t_te=
6260 To enable restoring (for an xterm):
6261 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6262 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6263
6264 *'revins'* *'ri'* *'norevins'* *'nori'*
6265'revins' 'ri' boolean (default off)
6266 global
6267 {not in Vi}
6268 {only available when compiled with the |+rightleft|
6269 feature}
6270 Inserting characters in Insert mode will work backwards. See "typing
6271 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6272 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006273 NOTE: This option is reset when 'compatible' is set.
6274 This option is reset when 'paste' is set and restored when 'paste' is
6275 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276
6277 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6278'rightleft' 'rl' boolean (default off)
6279 local to window
6280 {not in Vi}
6281 {only available when compiled with the |+rightleft|
6282 feature}
6283 When on, display orientation becomes right-to-left, i.e., characters
6284 that are stored in the file appear from the right to the left.
6285 Using this option, it is possible to edit files for languages that
6286 are written from the right to the left such as Hebrew and Arabic.
6287 This option is per window, so it is possible to edit mixed files
6288 simultaneously, or to view the same file in both ways (this is
6289 useful whenever you have a mixed text file with both right-to-left
6290 and left-to-right strings so that both sets are displayed properly
6291 in different windows). Also see |rileft.txt|.
6292
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006293 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294'rightleftcmd' 'rlc' string (default "search")
6295 local to window
6296 {not in Vi}
6297 {only available when compiled with the |+rightleft|
6298 feature}
6299 Each word in this option enables the command line editing to work in
6300 right-to-left mode for a group of commands:
6301
6302 search "/" and "?" commands
6303
6304 This is useful for languages such as Hebrew, Arabic and Farsi.
6305 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6306
Bram Moolenaard94464e2015-11-02 15:28:18 +01006307 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006308'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006309 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006310 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006311 {only available when compiled with the |+ruby/dyn|
6312 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006313 Specifies the name of the Ruby shared library. The default is
6314 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006315 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006316 This option cannot be set from a |modeline| or in the |sandbox|, for
6317 security reasons.
6318
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006320'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 global
6322 {not in Vi}
6323 {not available when compiled without the
6324 |+cmdline_info| feature}
6325 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006326 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 text in the file is shown on the far right:
6328 Top first line is visible
6329 Bot last line is visible
6330 All first and last line are visible
6331 45% relative position in the file
6332 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006333 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006335 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 this option takes precedence over 'ruler' and 'rulerformat'
6337 If the number of characters displayed is different from the number of
6338 bytes in the text (e.g., for a TAB or a multi-byte character), both
6339 the text column (byte number) and the screen column are shown,
6340 separated with a dash.
6341 For an empty line "0-1" is shown.
6342 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006343 This option is reset when 'paste' is set and restored when 'paste' is
6344 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 If you don't want to see the ruler all the time but want to know where
6346 you are, use "g CTRL-G" |g_CTRL-G|.
6347 NOTE: This option is reset when 'compatible' is set.
6348
6349 *'rulerformat'* *'ruf'*
6350'rulerformat' 'ruf' string (default empty)
6351 global
6352 {not in Vi}
6353 {not available when compiled without the |+statusline|
6354 feature}
6355 When this option is not empty, it determines the content of the ruler
6356 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006357 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 The default ruler width is 17 characters. To make the ruler 15
6359 characters wide, put "%15(" at the start and "%)" at the end.
6360 Example: >
6361 :set rulerformat=%15(%c%V\ %p%%%)
6362<
6363 *'runtimepath'* *'rtp'* *vimfiles*
6364'runtimepath' 'rtp' string (default:
6365 Unix: "$HOME/.vim,
6366 $VIM/vimfiles,
6367 $VIMRUNTIME,
6368 $VIM/vimfiles/after,
6369 $HOME/.vim/after"
6370 Amiga: "home:vimfiles,
6371 $VIM/vimfiles,
6372 $VIMRUNTIME,
6373 $VIM/vimfiles/after,
6374 home:vimfiles/after"
6375 PC, OS/2: "$HOME/vimfiles,
6376 $VIM/vimfiles,
6377 $VIMRUNTIME,
6378 $VIM/vimfiles/after,
6379 $HOME/vimfiles/after"
6380 Macintosh: "$VIM:vimfiles,
6381 $VIMRUNTIME,
6382 $VIM:vimfiles:after"
6383 RISC-OS: "Choices:vimfiles,
6384 $VIMRUNTIME,
6385 Choices:vimfiles/after"
6386 VMS: "sys$login:vimfiles,
6387 $VIM/vimfiles,
6388 $VIMRUNTIME,
6389 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006390 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 global
6392 {not in Vi}
6393 This is a list of directories which will be searched for runtime
6394 files:
6395 filetype.vim filetypes by file name |new-filetype|
6396 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006397 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 colors/ color scheme files |:colorscheme|
6399 compiler/ compiler files |:compiler|
6400 doc/ documentation |write-local-help|
6401 ftplugin/ filetype plugins |write-filetype-plugin|
6402 indent/ indent scripts |indent-expression|
6403 keymap/ key mapping files |mbyte-keymap|
6404 lang/ menu translations |:menutrans|
6405 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006406 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 plugin/ plugin scripts |write-plugin|
6408 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006409 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 syntax/ syntax files |mysyntaxfile|
6411 tutor/ files for vimtutor |tutor|
6412
6413 And any other file searched for with the |:runtime| command.
6414
6415 The defaults for most systems are setup to search five locations:
6416 1. In your home directory, for your personal preferences.
6417 2. In a system-wide Vim directory, for preferences from the system
6418 administrator.
6419 3. In $VIMRUNTIME, for files distributed with Vim.
6420 *after-directory*
6421 4. In the "after" directory in the system-wide Vim directory. This is
6422 for the system administrator to overrule or add to the distributed
6423 defaults (rarely needed)
6424 5. In the "after" directory in your home directory. This is for
6425 personal preferences to overrule or add to the distributed defaults
6426 or system-wide settings (rarely needed).
6427
Bram Moolenaard0796902016-09-16 20:02:31 +02006428 More entries are added when using |packages|. If it gets very long
6429 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6430 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006431
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6433 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006434 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 wildcards.
6436 See |:runtime|.
6437 Example: >
6438 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6439< This will use the directory "~/vimruntime" first (containing your
6440 personal Vim runtime files), then "/mygroup/vim" (shared between a
6441 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6442 files).
6443 You probably should always include $VIMRUNTIME somewhere, to use the
6444 distributed runtime files. You can put a directory before $VIMRUNTIME
6445 to find files which replace a distributed runtime files. You can put
6446 a directory after $VIMRUNTIME to find files which add to distributed
6447 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006448 When Vim is started with |--clean| the home directory entries are not
6449 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 This option cannot be set from a |modeline| or in the |sandbox|, for
6451 security reasons.
6452
6453 *'scroll'* *'scr'*
6454'scroll' 'scr' number (default: half the window height)
6455 local to window
6456 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6457 set to half the number of lines in the window when the window size
6458 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006459 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6461 the number of screen lines instead of file lines, makes a difference
6462 when lines wrap}
6463
6464 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6465'scrollbind' 'scb' boolean (default off)
6466 local to window
6467 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 See also |scroll-binding|. When this option is set, the current
6469 window scrolls as other scrollbind windows (windows that also have
6470 this option set) scroll. This option is useful for viewing the
6471 differences between two versions of a file, see 'diff'.
6472 See |'scrollopt'| for options that determine how this option should be
6473 interpreted.
6474 This option is mostly reset when splitting a window to edit another
6475 file. This means that ":split | edit file" results in two windows
6476 with scroll-binding, but ":split file" does not.
6477
6478 *'scrolljump'* *'sj'*
6479'scrolljump' 'sj' number (default 1)
6480 global
6481 {not in Vi}
6482 Minimal number of lines to scroll when the cursor gets off the
6483 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6484 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006485 When set to a negative number from -1 to -100 this is used as the
6486 percentage of the window height. Thus -50 scrolls half the window
6487 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 NOTE: This option is set to 1 when 'compatible' is set.
6489
6490 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006491'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 global
6493 {not in Vi}
6494 Minimal number of screen lines to keep above and below the cursor.
6495 This will make some context visible around where you are working. If
6496 you set it to a very large value (999) the cursor line will always be
6497 in the middle of the window (except at the start or end of the file or
6498 when long lines wrap).
6499 For scrolling horizontally see 'sidescrolloff'.
6500 NOTE: This option is set to 0 when 'compatible' is set.
6501
6502 *'scrollopt'* *'sbo'*
6503'scrollopt' 'sbo' string (default "ver,jump")
6504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 {not in Vi}
6506 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006507 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6508 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 The following words are available:
6510 ver Bind vertical scrolling for 'scrollbind' windows
6511 hor Bind horizontal scrolling for 'scrollbind' windows
6512 jump Applies to the offset between two windows for vertical
6513 scrolling. This offset is the difference in the first
6514 displayed line of the bound windows. When moving
6515 around in a window, another 'scrollbind' window may
6516 reach a position before the start or after the end of
6517 the buffer. The offset is not changed though, when
6518 moving back the 'scrollbind' window will try to scroll
6519 to the desired position when possible.
6520 When now making that window the current one, two
6521 things can be done with the relative offset:
6522 1. When "jump" is not included, the relative offset is
6523 adjusted for the scroll position in the new current
6524 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006525 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 2. When "jump" is included, the other windows are
6527 scrolled to keep the same relative offset. When
6528 going back to the other window, it still uses the
6529 same relative offset.
6530 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006531 When 'diff' mode is active there always is vertical scroll binding,
6532 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533
6534 *'sections'* *'sect'*
6535'sections' 'sect' string (default "SHNHH HUnhsh")
6536 global
6537 Specifies the nroff macros that separate sections. These are pairs of
6538 two letters (See |object-motions|). The default makes a section start
6539 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6540
6541 *'secure'* *'nosecure'* *E523*
6542'secure' boolean (default off)
6543 global
6544 {not in Vi}
6545 When on, ":autocmd", shell and write commands are not allowed in
6546 ".vimrc" and ".exrc" in the current directory and map commands are
6547 displayed. Switch it off only if you know that you will not run into
6548 problems, or when the 'exrc' option is off. On Unix this option is
6549 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006550 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 'secure' at the end of your ~/.vimrc then.
6552 This option cannot be set from a |modeline| or in the |sandbox|, for
6553 security reasons.
6554
6555 *'selection'* *'sel'*
6556'selection' 'sel' string (default "inclusive")
6557 global
6558 {not in Vi}
6559 This option defines the behavior of the selection. It is only used
6560 in Visual and Select mode.
6561 Possible values:
6562 value past line inclusive ~
6563 old no yes
6564 inclusive yes yes
6565 exclusive yes no
6566 "past line" means that the cursor is allowed to be positioned one
6567 character past the line.
6568 "inclusive" means that the last character of the selection is included
6569 in an operation. For example, when "x" is used to delete the
6570 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006571 When "old" is used and 'virtualedit' allows the cursor to move past
6572 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 Note that when "exclusive" is used and selecting from the end
6574 backwards, you cannot include the last character of a line, when
6575 starting in Normal mode and 'virtualedit' empty.
6576
6577 The 'selection' option is set by the |:behave| command.
6578
6579 *'selectmode'* *'slm'*
6580'selectmode' 'slm' string (default "")
6581 global
6582 {not in Vi}
6583 This is a comma separated list of words, which specifies when to start
6584 Select mode instead of Visual mode, when a selection is started.
6585 Possible values:
6586 mouse when using the mouse
6587 key when using shifted special keys
6588 cmd when using "v", "V" or CTRL-V
6589 See |Select-mode|.
6590 The 'selectmode' option is set by the |:behave| command.
6591
6592 *'sessionoptions'* *'ssop'*
6593'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006594 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 global
6596 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006597 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 feature}
6599 Changes the effect of the |:mksession| command. It is a comma
6600 separated list of words. Each word enables saving and restoring
6601 something:
6602 word save and restore ~
6603 blank empty windows
6604 buffers hidden and unloaded buffers, not just those in windows
6605 curdir the current directory
6606 folds manually created folds, opened/closed folds and local
6607 fold options
6608 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006609 and contain at least one lowercase letter. Only
6610 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 help the help window
6612 localoptions options and mappings local to a window or buffer (not
6613 global values for local options)
6614 options all options and mappings (also global values for local
6615 options)
6616 resize size of the Vim window: 'lines' and 'columns'
6617 sesdir the directory in which the session file is located
6618 will become the current directory (useful with
6619 projects accessed over a network from different
6620 systems)
6621 slash backslashes in file names replaced with forward
6622 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006623 tabpages all tab pages; without this only the current tab page
6624 is restored, so that you can make a session for each
6625 tab page separately
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006626 terminal include terminal windows where the command can be restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 unix with Unix end-of-line format (single <NL>), even when
6628 on Windows or DOS
6629 winpos position of the whole Vim window
6630 winsize window sizes
6631
6632 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006633 When neither "curdir" nor "sesdir" is included, file names are stored
6634 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 "slash" and "unix" are useful on Windows when sharing session files
6636 with Unix. The Unix version of Vim cannot source dos format scripts,
6637 but the Windows version of Vim can source unix format scripts.
6638
6639 *'shell'* *'sh'* *E91*
6640'shell' 'sh' string (default $SHELL or "sh",
6641 MS-DOS and Win32: "command.com" or
6642 "cmd.exe", OS/2: "cmd")
6643 global
6644 Name of the shell to use for ! and :! commands. When changing the
6645 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6646 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 See |option-backslash| about including spaces and backslashes.
6649 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006650
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006652 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6654< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006657 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006659 Example with escaped space (Vim will do this when initializing the
6660 option from $SHELL): >
6661 :set shell=/bin/with\\\ space/sh
6662< The resulting value of 'shell' is "/bin/with\ space/sh", two
6663 backslashes are consumed by `:set`.
6664
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 Under MS-Windows, when the executable ends in ".com" it must be
6666 included. Thus setting the shell to "command.com" or "4dos.com"
6667 works, but "command" and "4dos" do not work for all commands (e.g.,
6668 filtering).
6669 For unknown reasons, when using "4dos.com" the current directory is
6670 changed to "C:\". To avoid this set 'shell' like this: >
6671 :set shell=command.com\ /c\ 4dos
6672< This option cannot be set from a |modeline| or in the |sandbox|, for
6673 security reasons.
6674
6675 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006676'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006677 MS-DOS and Win32, when 'shell' does not
6678 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 global
6680 {not in Vi}
6681 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6682 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6683 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006684 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006685 On Unix it can have more than one flag. Each white space separated
6686 part is passed as an argument to the shell command.
6687 See |option-backslash| about including spaces and backslashes.
6688 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 This option cannot be set from a |modeline| or in the |sandbox|, for
6690 security reasons.
6691
6692 *'shellpipe'* *'sp'*
6693'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6694 global
6695 {not in Vi}
6696 {not available when compiled without the |+quickfix|
6697 feature}
6698 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006699 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 including spaces and backslashes.
6701 The name of the temporary file can be represented by "%s" if necessary
6702 (the file name is appended automatically if no %s appears in the value
6703 of this option).
6704 For the Amiga and MS-DOS the default is ">". The output is directly
6705 saved in a file and not echoed to the screen.
6706 For Unix the default it "| tee". The stdout of the compiler is saved
6707 in a file and echoed to the screen. If the 'shell' option is "csh" or
6708 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006709 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6710 default becomes "2>&1| tee". This means that stderr is also included.
6711 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6712 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 The initialization of this option is done after reading the ".vimrc"
6714 and the other initializations, so that when the 'shell' option is set
6715 there, the 'shellpipe' option changes automatically, unless it was
6716 explicitly set before.
6717 When 'shellpipe' is set to an empty string, no redirection of the
6718 ":make" output will be done. This is useful if you use a 'makeprg'
6719 that writes to 'makeef' by itself. If you want no piping, but do
6720 want to include the 'makeef', set 'shellpipe' to a single space.
6721 Don't forget to precede the space with a backslash: ":set sp=\ ".
6722 In the future pipes may be used for filtering and this option will
6723 become obsolete (at least for Unix).
6724 This option cannot be set from a |modeline| or in the |sandbox|, for
6725 security reasons.
6726
6727 *'shellquote'* *'shq'*
6728'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6729 contains "sh" somewhere: "\"")
6730 global
6731 {not in Vi}
6732 Quoting character(s), put around the command passed to the shell, for
6733 the "!" and ":!" commands. The redirection is kept outside of the
6734 quoting. See 'shellxquote' to include the redirection. It's
6735 probably not useful to set both options.
6736 This is an empty string by default. Only known to be useful for
6737 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6738 or bash, where it should be "\"". The default is adjusted according
6739 the value of 'shell', to reduce the need to set this option by the
6740 user. See |dos-shell|.
6741 This option cannot be set from a |modeline| or in the |sandbox|, for
6742 security reasons.
6743
6744 *'shellredir'* *'srr'*
6745'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6746 global
6747 {not in Vi}
6748 String to be used to put the output of a filter command in a temporary
6749 file. See also |:!|. See |option-backslash| about including spaces
6750 and backslashes.
6751 The name of the temporary file can be represented by "%s" if necessary
6752 (the file name is appended automatically if no %s appears in the value
6753 of this option).
6754 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6755 or "zsh" during initializations, the default becomes ">&". If the
6756 'shell' option is "sh", "ksh" or "bash" the default becomes
6757 ">%s 2>&1". This means that stderr is also included.
6758 For Win32, the Unix checks are done and additionally "cmd" is checked
6759 for, which makes the default ">%s 2>&1". Also, the same names with
6760 ".exe" appended are checked for.
6761 The initialization of this option is done after reading the ".vimrc"
6762 and the other initializations, so that when the 'shell' option is set
6763 there, the 'shellredir' option changes automatically unless it was
6764 explicitly set before.
6765 In the future pipes may be used for filtering and this option will
6766 become obsolete (at least for Unix).
6767 This option cannot be set from a |modeline| or in the |sandbox|, for
6768 security reasons.
6769
6770 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6771'shellslash' 'ssl' boolean (default off)
6772 global
6773 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6774 When set, a forward slash is used when expanding file names. This is
6775 useful when a Unix-like shell is used instead of command.com or
6776 cmd.exe. Backward slashes can still be typed, but they are changed to
6777 forward slashes by Vim.
6778 Note that setting or resetting this option has no effect for some
6779 existing file names, thus this option needs to be set before opening
6780 any file for best results. This might change in the future.
6781 'shellslash' only works when a backslash can be used as a path
6782 separator. To test if this is so use: >
6783 if exists('+shellslash')
6784<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006785 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6786'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6787 global
6788 {not in Vi}
6789 When on, use temp files for shell commands. When off use a pipe.
6790 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006791 Currently a pipe is only supported on Unix and MS-Windows 2K and
6792 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006793 :if has("filterpipe")
6794< The advantage of using a pipe is that nobody can read the temp file
6795 and the 'shell' command does not need to support redirection.
6796 The advantage of using a temp file is that the file type and encoding
6797 can be detected.
6798 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6799 |FilterWritePost| autocommands event are not triggered when
6800 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006801 The `system()` function does not respect this option and always uses
6802 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006803 NOTE: This option is set to the Vim default value when 'compatible'
6804 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006805
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 *'shelltype'* *'st'*
6807'shelltype' 'st' number (default 0)
6808 global
6809 {not in Vi} {only for the Amiga}
6810 On the Amiga this option influences the way how the commands work
6811 which use a shell.
6812 0 and 1: always use the shell
6813 2 and 3: use the shell only to filter lines
6814 4 and 5: use shell only for ':sh' command
6815 When not using the shell, the command is executed directly.
6816
6817 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6818 1 and 3: use "shell cmd" to start external commands
6819
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006820 *'shellxescape'* *'sxe'*
6821'shellxescape' 'sxe' string (default: "";
6822 for MS-DOS and MS-Windows: "\"&|<>()@^")
6823 global
6824 {not in Vi}
6825 When 'shellxquote' is set to "(" then the characters listed in this
6826 option will be escaped with a '^' character. This makes it possible
6827 to execute most external commands with cmd.exe.
6828
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 *'shellxquote'* *'sxq'*
6830'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006831 for Win32, when 'shell' is cmd.exe: "("
6832 for Win32, when 'shell' contains "sh"
6833 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 for Unix, when using system(): "\"")
6835 global
6836 {not in Vi}
6837 Quoting character(s), put around the command passed to the shell, for
6838 the "!" and ":!" commands. Includes the redirection. See
6839 'shellquote' to exclude the redirection. It's probably not useful
6840 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006841 When the value is '(' then ')' is appended. When the value is '"('
6842 then ')"' is appended.
6843 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006844 This is an empty string by default on most systems, but is known to be
6845 useful for on Win32 version, either for cmd.exe which automatically
6846 strips off the first and last quote on a command, or 3rd-party shells
6847 such as the MKS Korn Shell or bash, where it should be "\"". The
6848 default is adjusted according the value of 'shell', to reduce the need
6849 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 This option cannot be set from a |modeline| or in the |sandbox|, for
6851 security reasons.
6852
6853 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6854'shiftround' 'sr' boolean (default off)
6855 global
6856 {not in Vi}
6857 Round indent to multiple of 'shiftwidth'. Applies to > and <
6858 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6859 a multiple of 'shiftwidth' (this is Vi compatible).
6860 NOTE: This option is reset when 'compatible' is set.
6861
6862 *'shiftwidth'* *'sw'*
6863'shiftwidth' 'sw' number (default 8)
6864 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006865 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006867 When zero the 'ts' value will be used. Use the |shiftwidth()|
6868 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869
6870 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006871'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6872 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 global
6874 {not in Vi}
6875 This option helps to avoid all the |hit-enter| prompts caused by file
6876 messages, for example with CTRL-G, and to avoid some other messages.
6877 It is a list of flags:
6878 flag meaning when present ~
6879 f use "(3 of 5)" instead of "(file 3 of 5)"
6880 i use "[noeol]" instead of "[Incomplete last line]"
6881 l use "999L, 888C" instead of "999 lines, 888 characters"
6882 m use "[+]" instead of "[Modified]"
6883 n use "[New]" instead of "[New File]"
6884 r use "[RO]" instead of "[readonly]"
6885 w use "[w]" instead of "written" for file write message
6886 and "[a]" instead of "appended" for ':w >> file' command
6887 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6888 "[unix format]" and "[mac]" instead of "[mac format]".
6889 a all of the above abbreviations
6890
6891 o overwrite message for writing a file with subsequent message
6892 for reading a file (useful for ":wn" or when 'autowrite' on)
6893 O message for reading a file overwrites any previous message.
6894 Also for quickfix message (e.g., ":cn").
6895 s don't give "search hit BOTTOM, continuing at TOP" or "search
6896 hit TOP, continuing at BOTTOM" messages
6897 t truncate file message at the start if it is too long to fit
6898 on the command-line, "<" will appear in the left most column.
6899 Ignored in Ex mode.
6900 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006901 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 Ignored in Ex mode.
6903 W don't give "written" or "[w]" when writing a file
6904 A don't give the "ATTENTION" message when an existing swap file
6905 is found.
6906 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006907 c don't give |ins-completion-menu| messages. For example,
6908 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6909 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006910 q use "recording" instead of "recording @a"
6911 F don't give the file info when editing a file, like `:silent`
6912 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913
6914 This gives you the opportunity to avoid that a change between buffers
6915 requires you to hit <Enter>, but still gives as useful a message as
6916 possible for the space available. To get the whole message that you
6917 would have got with 'shm' empty, use ":file!"
6918 Useful values:
6919 shm= No abbreviation of message.
6920 shm=a Abbreviation, but no loss of information.
6921 shm=at Abbreviation, and truncate message when necessary.
6922
6923 NOTE: This option is set to the Vi default value when 'compatible' is
6924 set and to the Vim default value when 'compatible' is reset.
6925
6926 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6927'shortname' 'sn' boolean (default off)
6928 local to buffer
6929 {not in Vi, not in MS-DOS versions}
6930 Filenames are assumed to be 8 characters plus one extension of 3
6931 characters. Multiple dots in file names are not allowed. When this
6932 option is on, dots in file names are replaced with underscores when
6933 adding an extension (".~" or ".swp"). This option is not available
6934 for MS-DOS, because then it would always be on. This option is useful
6935 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6936 or crossdos. When running the Win32 GUI version under Win32s, this
6937 option is always on by default.
6938
6939 *'showbreak'* *'sbr'* *E595*
6940'showbreak' 'sbr' string (default "")
6941 global
6942 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006943 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 feature}
6945 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006946 values are "> " or "+++ ": >
6947 :set showbreak=>\
6948< Note the backslash to escape the trailing space. It's easier like
6949 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006950 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006951< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 comma (in a future version the comma might be used to separate the
6953 part that is shown at the end and at the start of a line).
6954 The characters are highlighted according to the '@' flag in
6955 'highlight'.
6956 Note that tabs after the showbreak will be displayed differently.
6957 If you want the 'showbreak' to appear in between line numbers, add the
6958 "n" flag to 'cpoptions'.
6959
6960 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006961'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6962 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006963 global
6964 {not in Vi}
6965 {not available when compiled without the
6966 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006967 Show (partial) command in the last line of the screen. Set this
6968 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 In Visual mode the size of the selected area is shown:
6970 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006971 If the number of bytes is different it is also displayed: "2-6"
6972 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006974 - When selecting a block, the size in screen characters:
6975 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 NOTE: This option is set to the Vi default value when 'compatible' is
6977 set and to the Vim default value when 'compatible' is reset.
6978
6979 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6980'showfulltag' 'sft' boolean (default off)
6981 global
6982 {not in Vi}
6983 When completing a word in insert mode (see |ins-completion|) from the
6984 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006985 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 matched a C function, you can see a template for what arguments are
6987 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006988 Note that this doesn't work well together with having "longest" in
6989 'completeopt', because the completion from the search pattern may not
6990 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991
6992 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6993'showmatch' 'sm' boolean (default off)
6994 global
6995 When a bracket is inserted, briefly jump to the matching one. The
6996 jump is only done if the match can be seen on the screen. The time to
6997 show the match can be set with 'matchtime'.
6998 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006999 seen or not).
7000 This option is reset when 'paste' is set and restored when 'paste' is
7001 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 When the 'm' flag is not included in 'cpoptions', typing a character
7003 will immediately move the cursor back to where it belongs.
7004 See the "sm" field in 'guicursor' for setting the cursor shape and
7005 blinking when showing the match.
7006 The 'matchpairs' option can be used to specify the characters to show
7007 matches for. 'rightleft' and 'revins' are used to look for opposite
7008 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007009 Also see the matchparen plugin for highlighting the match when moving
7010 around |pi_paren.txt|.
7011 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012
7013 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7014'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7015 global
7016 If in Insert, Replace or Visual mode put a message on the last line.
7017 Use the 'M' flag in 'highlight' to set the type of highlighting for
7018 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007019 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 doesn't mean XIM is really active, especially when 'imactivatekey' is
7021 not set.
7022 NOTE: This option is set to the Vi default value when 'compatible' is
7023 set and to the Vim default value when 'compatible' is reset.
7024
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007025 *'showtabline'* *'stal'*
7026'showtabline' 'stal' number (default 1)
7027 global
7028 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007029 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007030 feature}
7031 The value of this option specifies when the line with tab page labels
7032 will be displayed:
7033 0: never
7034 1: only if there are at least two tab pages
7035 2: always
7036 This is both for the GUI and non-GUI implementation of the tab pages
7037 line.
7038 See |tab-page| for more information about tab pages.
7039
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 *'sidescroll'* *'ss'*
7041'sidescroll' 'ss' number (default 0)
7042 global
7043 {not in Vi}
7044 The minimal number of columns to scroll horizontally. Used only when
7045 the 'wrap' option is off and the cursor is moved off of the screen.
7046 When it is zero the cursor will be put in the middle of the screen.
7047 When using a slow terminal set it to a large number or 0. When using
7048 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7049 commands.
7050
7051 *'sidescrolloff'* *'siso'*
7052'sidescrolloff' 'siso' number (default 0)
7053 global
7054 {not in Vi}
7055 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007056 right of the cursor if 'nowrap' is set. Setting this option to a
7057 value greater than 0 while having |'sidescroll'| also at a non-zero
7058 value makes some context visible in the line you are scrolling in
7059 horizontally (except at beginning of the line). Setting this option
7060 to a large value (like 999) has the effect of keeping the cursor
7061 horizontally centered in the window, as long as one does not come too
7062 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 NOTE: This option is set to 0 when 'compatible' is set.
7064
7065 Example: Try this together with 'sidescroll' and 'listchars' as
7066 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007067 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007068
7069 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7070 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007071<
7072 *'signcolumn'* *'scl'*
7073'signcolumn' 'scl' string (default "auto")
7074 local to window
7075 {not in Vi}
7076 {not available when compiled without the |+signs|
7077 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007078 Whether or not to draw the signcolumn. Valid values are:
7079 "auto" only when there is a sign to display
7080 "no" never
7081 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082
7083
7084 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7085'smartcase' 'scs' boolean (default off)
7086 global
7087 {not in Vi}
7088 Override the 'ignorecase' option if the search pattern contains upper
7089 case characters. Only used when the search pattern is typed and
7090 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007091 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7093 recalling the search pattern from history and hitting <Enter>.
7094 NOTE: This option is reset when 'compatible' is set.
7095
7096 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7097'smartindent' 'si' boolean (default off)
7098 local to buffer
7099 {not in Vi}
7100 {not available when compiled without the
7101 |+smartindent| feature}
7102 Do smart autoindenting when starting a new line. Works for C-like
7103 programs, but can also be used for other languages. 'cindent' does
7104 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007105 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007106 setting 'si' has no effect. 'indentexpr' is a more advanced
7107 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 Normally 'autoindent' should also be on when using 'smartindent'.
7109 An indent is automatically inserted:
7110 - After a line ending in '{'.
7111 - After a line starting with a keyword from 'cinwords'.
7112 - Before a line starting with '}' (only with the "O" command).
7113 When typing '}' as the first character in a new line, that line is
7114 given the same indent as the matching '{'.
7115 When typing '#' as the first character in a new line, the indent for
7116 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007117 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7119 When using the ">>" command, lines starting with '#' are not shifted
7120 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007121 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007122 This option is reset when 'paste' is set and restored when 'paste' is
7123 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124
7125 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7126'smarttab' 'sta' boolean (default off)
7127 global
7128 {not in Vi}
7129 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007130 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7131 <BS> will delete a 'shiftwidth' worth of space at the start of the
7132 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007133 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007134 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7135 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007136 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007138 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007139 This option is reset when 'paste' is set and restored when 'paste' is
7140 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 NOTE: This option is reset when 'compatible' is set.
7142
7143 *'softtabstop'* *'sts'*
7144'softtabstop' 'sts' number (default 0)
7145 local to buffer
7146 {not in Vi}
7147 Number of spaces that a <Tab> counts for while performing editing
7148 operations, like inserting a <Tab> or using <BS>. It "feels" like
7149 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7150 used. This is useful to keep the 'ts' setting at its standard value
7151 of 8, while being able to edit like it is set to 'sts'. However,
7152 commands like "x" still work on the actual characters.
7153 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007154 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007155 'softtabstop' is set to 0 when the 'paste' option is set and restored
7156 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7158 spaces is minimized by using <Tab>s.
7159 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7160 set.
7161 NOTE: This option is set to 0 when 'compatible' is set.
7162
Bram Moolenaar217ad922005-03-20 22:37:15 +00007163 *'spell'* *'nospell'*
7164'spell' boolean (default off)
7165 local to window
7166 {not in Vi}
7167 {not available when compiled without the |+syntax|
7168 feature}
7169 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007170 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007171
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007172 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007173'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007174 local to buffer
7175 {not in Vi}
7176 {not available when compiled without the |+syntax|
7177 feature}
7178 Pattern to locate the end of a sentence. The following word will be
7179 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007180 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007181 When this check is not wanted make this option empty.
7182 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007183 Be careful with special characters, see |option-backslash| about
7184 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007185 To set this option automatically depending on the language, see
7186 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007187
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007188 *'spellfile'* *'spf'*
7189'spellfile' 'spf' string (default empty)
7190 local to buffer
7191 {not in Vi}
7192 {not available when compiled without the |+syntax|
7193 feature}
7194 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007195 commands. It must end in ".{encoding}.add". You need to include the
7196 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007197 *E765*
7198 It may also be a comma separated list of names. A count before the
7199 |zg| and |zw| commands can be used to access each. This allows using
7200 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007201 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007202 you: Using the first directory in 'runtimepath' that is writable. If
7203 there is no "spell" directory yet it will be created. For the file
7204 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007205 ignoring the region.
7206 The resulting ".spl" file will be used for spell checking, it does not
7207 have to appear in 'spelllang'.
7208 Normally one file is used for all regions, but you can add the region
7209 name if you want to. However, it will then only be used when
7210 'spellfile' is set to it, for entries in 'spelllang' only files
7211 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007212 This option cannot be set from a |modeline| or in the |sandbox|, for
7213 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007214
Bram Moolenaar217ad922005-03-20 22:37:15 +00007215 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007216'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007217 local to buffer
7218 {not in Vi}
7219 {not available when compiled without the |+syntax|
7220 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007221 A comma separated list of word list names. When the 'spell' option is
7222 on spellchecking will be done for these languages. Example: >
7223 set spelllang=en_us,nl,medical
7224< This means US English, Dutch and medical words are recognized. Words
7225 that are not recognized will be highlighted.
7226 The word list name must not include a comma or dot. Using a dash is
7227 recommended to separate the two letter language name from a
7228 specification. Thus "en-rare" is used for rare English words.
7229 A region name must come last and have the form "_xx", where "xx" is
7230 the two-letter, lower case region name. You can use more than one
7231 region by listing them: "en_us,en_ca" supports both US and Canadian
7232 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007233 Britain. (Note: currently en_au and en_nz dictionaries are older than
7234 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007235 If the name "cjk" is included East Asian characters are excluded from
7236 spell checking. This is useful when editing text that also has Asian
7237 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007238 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007239 As a special case the name of a .spl file can be given as-is. The
7240 first "_xx" in the name is removed and used as the region name
7241 (_xx is an underscore, two letters and followed by a non-letter).
7242 This is mainly for testing purposes. You must make sure the correct
7243 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007244 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007245 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7246 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007247 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007248
Bram Moolenaar98692072006-02-04 00:57:42 +00007249 If the |spellfile.vim| plugin is active and you use a language name
7250 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7251 will ask you if you want to download the file.
7252
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007253 After this option has been set successfully, Vim will source the files
7254 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007255 up to the first comma, dot or underscore.
7256 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007257
7258
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007259 *'spellsuggest'* *'sps'*
7260'spellsuggest' 'sps' string (default "best")
7261 global
7262 {not in Vi}
7263 {not available when compiled without the |+syntax|
7264 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007265 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007266 the |spellsuggest()| function. This is a comma-separated list of
7267 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007268
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007269 best Internal method that works best for English. Finds
7270 changes like "fast" and uses a bit of sound-a-like
7271 scoring to improve the ordering.
7272
7273 double Internal method that uses two methods and mixes the
7274 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007275 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007276 word. That only works when the language specifies
7277 sound folding. Can be slow and doesn't always give
7278 better results.
7279
7280 fast Internal method that only checks for simple changes:
7281 character inserts/deletes/swaps. Works well for
7282 simple typing mistakes.
7283
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007284 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007285 Not used for |spellsuggest()|. The number of
7286 suggestions is never more than the value of 'lines'
7287 minus two.
7288
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007289 file:{filename} Read file {filename}, which must have two columns,
7290 separated by a slash. The first column contains the
7291 bad word, the second column the suggested good word.
7292 Example:
7293 theribal/terrible ~
7294 Use this for common mistakes that do not appear at the
7295 top of the suggestion list with the internal methods.
7296 Lines without a slash are ignored, use this for
7297 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007298 The word in the second column must be correct,
7299 otherwise it will not be used. Add the word to an
7300 ".add" file if it is currently flagged as a spelling
7301 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007302 The file is used for all languages.
7303
7304 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7305 trouble with spaces. |v:val| holds the badly spelled
7306 word. The expression must evaluate to a List of
7307 Lists, each with a suggestion and a score.
7308 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007309 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007310 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007311 internal methods use. A lower score is better.
7312 This may invoke |spellsuggest()| if you temporarily
7313 set 'spellsuggest' to exclude the "expr:" part.
7314 Errors are silently ignored, unless you set the
7315 'verbose' option to a non-zero value.
7316
7317 Only one of "best", "double" or "fast" may be used. The others may
7318 appear several times in any order. Example: >
7319 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7320<
7321 This option cannot be set from a |modeline| or in the |sandbox|, for
7322 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007323
7324
Bram Moolenaar071d4272004-06-13 20:20:40 +00007325 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7326'splitbelow' 'sb' boolean (default off)
7327 global
7328 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007329 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 feature}
7331 When on, splitting a window will put the new window below the current
7332 one. |:split|
7333
7334 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7335'splitright' 'spr' boolean (default off)
7336 global
7337 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007338 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 feature}
7340 When on, splitting a window will put the new window right of the
7341 current one. |:vsplit|
7342
7343 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7344'startofline' 'sol' boolean (default on)
7345 global
7346 {not in Vi}
7347 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007348 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007350 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 with a linewise operator, with "%" with a count and to buffer changing
7352 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7353 only has a line number, e.g., ":25" or ":+".
7354 In case of buffer changing commands the cursor is placed at the column
7355 where it was the last time the buffer was edited.
7356 NOTE: This option is set when 'compatible' is set.
7357
Bram Moolenaar00654022011-02-25 14:42:19 +01007358 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007360 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 {not in Vi}
7362 {not available when compiled without the |+statusline|
7363 feature}
7364 When nonempty, this option determines the content of the status line.
7365 Also see |status-line|.
7366
7367 The option consists of printf style '%' items interspersed with
7368 normal text. Each status line item is of the form:
7369 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007370 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007371 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372
Bram Moolenaar238a5642006-02-21 22:12:05 +00007373 When the option starts with "%!" then it is used as an expression,
7374 evaluated and the result is used as the option value. Example: >
7375 :set statusline=%!MyStatusLine()
7376< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007377 Note that the "%!" expression is evaluated in the context of the
7378 current window and buffer, while %{} items are evaluated in the
7379 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007380
7381 When there is error while evaluating the option then it will be made
7382 empty to avoid further errors. Otherwise screen updating would loop.
7383
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 Note that the only effect of 'ruler' when this option is set (and
7385 'laststatus' is 2) is controlling the output of |CTRL-G|.
7386
7387 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007388 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007390 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 minwid Minimum width of the item, padding as set by '-' & '0'.
7392 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007393 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 on the left for text items. Numeric items will be
7395 shifted down to maxwid-2 digits followed by '>'number
7396 where number is the amount of missing digits, much like
7397 an exponential notation.
7398 item A one letter code as described below.
7399
7400 Following is a description of the possible statusline items. The
7401 second character in "item" is the type:
7402 N for number
7403 S for string
7404 F for flags as described below
7405 - not applicable
7406
7407 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007408 f S Path to the file in the buffer, as typed or relative to current
7409 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 F S Full path to the file in the buffer.
7411 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007412 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007414 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007416 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007418 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007420 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007422 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7424 being used: "<keymap>"
7425 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007426 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 B N As above, in hexadecimal.
7428 o N Byte number in file of byte under cursor, first byte is 1.
7429 Mnemonic: Offset from start of file (with one added)
7430 {not available when compiled without |+byte_offset| feature}
7431 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007432 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 l N Line number.
7434 L N Number of lines in buffer.
7435 c N Column number.
7436 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007437 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 p N Percentage through file in lines as in |CTRL-G|.
7439 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007440 percentage described for 'ruler'. Always 3 in length, unless
7441 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007442 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007444 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007445 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 ( - Start of item group. Can be used for setting the width and
7447 alignment of a section. Must be followed by %) somewhere.
7448 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007449 T N For 'tabline': start of tab page N label. Use %T after the last
7450 label. This information is used for mouse clicks.
7451 X N For 'tabline': start of close tab N label. Use %X after the
7452 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7453 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 < - Where to truncate line if too long. Default is at the start.
7455 No width fields allowed.
7456 = - Separation point between left and right aligned items.
7457 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007458 # - Set highlight group. The name must follow and then a # again.
7459 Thus use %#HLname# for highlight group HLname. The same
7460 highlighting is used, also for the statusline of non-current
7461 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007463 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 The difference between User{N} and StatusLine will be applied
7465 to StatusLineNC for the statusline of non-current windows.
7466 The number N must be between 1 and 9. See |hl-User1..9|
7467
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007468 When displaying a flag, Vim removes the leading comma, if any, when
7469 that flag comes right after plaintext. This will make a nice display
7470 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaar582fd852005-03-28 20:58:01 +00007472 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 not set) and a minwid is not set for the group, the whole group will
7474 become empty. This will make a group like the following disappear
7475 completely from the statusline when none of the flags are set. >
7476 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007477< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 Beware that an expression is evaluated each and every time the status
7479 line is displayed. The current buffer and current window will be set
7480 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007481 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007483 real current buffer.
7484
Bram Moolenaar30b65812012-07-12 22:01:11 +02007485 The 'statusline' option will be evaluated in the |sandbox| if set from
7486 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007487
7488 It is not allowed to change text or jump to another window while
7489 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490
7491 If the statusline is not updated when you want it (e.g., after setting
7492 a variable that's used in an expression), you can force an update by
7493 setting an option without changing its value. Example: >
7494 :let &ro = &ro
7495
7496< A result of all digits is regarded a number for display purposes.
7497 Otherwise the result is taken as flag text and applied to the rules
7498 described above.
7499
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007500 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007502 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503
7504 Examples:
7505 Emulate standard status line with 'ruler' set >
7506 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7507< Similar, but add ASCII value of char under the cursor (like "ga") >
7508 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7509< Display byte count and byte value, modified flag in red. >
7510 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7511 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7512< Display a ,GZ flag if a compressed file is loaded >
7513 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7514< In the |:autocmd|'s: >
7515 :let b:gzflag = 1
7516< And: >
7517 :unlet b:gzflag
7518< And define this function: >
7519 :function VarExists(var, val)
7520 : if exists(a:var) | return a:val | else | return '' | endif
7521 :endfunction
7522<
7523 *'suffixes'* *'su'*
7524'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7525 global
7526 {not in Vi}
7527 Files with these suffixes get a lower priority when multiple files
7528 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007529 suffixes. Spaces after the comma are ignored. A dot is also seen as
7530 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 separator, precede it with a backslash (see |option-backslash| about
7532 including spaces and backslashes).
7533 See 'wildignore' for completely ignoring files.
7534 The use of |:set+=| and |:set-=| is preferred when adding or removing
7535 suffixes from the list. This avoids problems when a future version
7536 uses another default.
7537
7538 *'suffixesadd'* *'sua'*
7539'suffixesadd' 'sua' string (default "")
7540 local to buffer
7541 {not in Vi}
7542 {not available when compiled without the
7543 |+file_in_path| feature}
7544 Comma separated list of suffixes, which are used when searching for a
7545 file for the "gf", "[I", etc. commands. Example: >
7546 :set suffixesadd=.java
7547<
7548 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7549'swapfile' 'swf' boolean (default on)
7550 local to buffer
7551 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007552 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 swapfile is not wanted for a specific buffer. For example, with
7554 confidential information that even root must not be able to access.
7555 Careful: All text will be in memory:
7556 - Don't use this for big files.
7557 - Recovery will be impossible!
7558 A swapfile will only be present when |'updatecount'| is non-zero and
7559 'swapfile' is set.
7560 When 'swapfile' is reset, the swap file for the current buffer is
7561 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7562 non-zero, a swap file is immediately created.
7563 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007564 If you want to open a new buffer without creating a swap file for it,
7565 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007566 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567
7568 This option is used together with 'bufhidden' and 'buftype' to
7569 specify special kinds of buffers. See |special-buffers|.
7570
7571 *'swapsync'* *'sws'*
7572'swapsync' 'sws' string (default "fsync")
7573 global
7574 {not in Vi}
7575 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007576 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 When this option is empty parts of the swap file may be in memory and
7578 not written to disk. When the system crashes you may lose more work.
7579 On Unix the system does a sync now and then without Vim asking for it,
7580 so the disadvantage of setting this option off is small. On some
7581 systems the swap file will not be written at all. For a unix system
7582 setting it to "sync" will use the sync() call instead of the default
7583 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007584 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585
7586 *'switchbuf'* *'swb'*
7587'switchbuf' 'swb' string (default "")
7588 global
7589 {not in Vi}
7590 This option controls the behavior when switching between buffers.
7591 Possible values (comma separated list):
7592 useopen If included, jump to the first open window that
7593 contains the specified buffer (if there is one).
7594 Otherwise: Do not examine other windows.
7595 This setting is checked with |quickfix| commands, when
7596 jumping to errors (":cc", ":cn", "cp", etc.). It is
7597 also used in all buffer related split commands, for
7598 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007599 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007600 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007602 a buffer for a |quickfix| command that display errors.
7603 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007604 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007605 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007606 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007608 *'synmaxcol'* *'smc'*
7609'synmaxcol' 'smc' number (default 3000)
7610 local to buffer
7611 {not in Vi}
7612 {not available when compiled without the |+syntax|
7613 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007614 Maximum column in which to search for syntax items. In long lines the
7615 text after this column is not highlighted and following lines may not
7616 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007617 This helps to avoid very slow redrawing for an XML file that is one
7618 long line.
7619 Set to zero to remove the limit.
7620
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 *'syntax'* *'syn'*
7622'syntax' 'syn' string (default empty)
7623 local to buffer
7624 {not in Vi}
7625 {not available when compiled without the |+syntax|
7626 feature}
7627 When this option is set, the syntax with this name is loaded, unless
7628 syntax highlighting has been switched off with ":syntax off".
7629 Otherwise this option does not always reflect the current syntax (the
7630 b:current_syntax variable does).
7631 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007632 not automatically recognized. Example, in an IDL file:
7633 /* vim: set syntax=idl : */ ~
7634 When a dot appears in the value then this separates two filetype
7635 names. Example:
7636 /* vim: set syntax=c.doxygen : */ ~
7637 This will use the "c" syntax first, then the "doxygen" syntax.
7638 Note that the second one must be prepared to be loaded as an addition,
7639 otherwise it will be skipped. More than one dot may appear.
7640 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 :set syntax=OFF
7642< To switch syntax highlighting on according to the current value of the
7643 'filetype' option: >
7644 :set syntax=ON
7645< What actually happens when setting the 'syntax' option is that the
7646 Syntax autocommand event is triggered with the value as argument.
7647 This option is not copied to another buffer, independent of the 's' or
7648 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007649 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007651 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007652'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007653 global
7654 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007655 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007656 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007657 When nonempty, this option determines the content of the tab pages
7658 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007659 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007660
7661 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007662 option and only when there is no GUI tab line. When 'e' is in
7663 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007664 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007665
7666 The value is evaluated like with 'statusline'. You can use
7667 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007668 the text to be displayed. Use "%1T" for the first label, "%2T" for
7669 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007670
7671 Keep in mind that only one of the tab pages is the current one, others
7672 are invisible and you can't jump to their windows.
7673
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007674
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007675 *'tabpagemax'* *'tpm'*
7676'tabpagemax' 'tpm' number (default 10)
7677 global
7678 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007679 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007680 feature}
7681 Maximum number of tab pages to be opened by the |-p| command line
7682 argument or the ":tab all" command. |tabpage|
7683
7684
7685 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686'tabstop' 'ts' number (default 8)
7687 local to buffer
7688 Number of spaces that a <Tab> in the file counts for. Also see
7689 |:retab| command, and 'softtabstop' option.
7690
7691 Note: Setting 'tabstop' to any other value than 8 can make your file
7692 appear wrong in many places (e.g., when printing it).
7693
7694 There are four main ways to use tabs in Vim:
7695 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7696 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007697 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 behave like a tab appears every 4 (or 3) characters.
7699 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7700 'expandtab'. This way you will always insert spaces. The
7701 formatting will never be messed up when 'tabstop' is changed.
7702 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007703 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 works when using Vim to edit the file.
7705 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7706 'noexpandtab'. This should then work (for initial indents only)
7707 for any tabstop setting that people use. It might be nice to have
7708 tabs after the first non-blank inserted as spaces if you do this
7709 though. Otherwise aligned comments will be wrong when 'tabstop' is
7710 changed.
7711
7712 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7713'tagbsearch' 'tbs' boolean (default on)
7714 global
7715 {not in Vi}
7716 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007717 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 searching makes searching for a tag a LOT faster, but a linear search
7719 will find more tags if the tags file wasn't properly sorted.
7720 Vim normally assumes that your tags files are sorted, or indicate that
7721 they are not sorted. Only when this is not the case does the
7722 'tagbsearch' option need to be switched off.
7723
7724 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007725 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 certain files, or retry all files with a linear search. When
7727 'tagbsearch' is off, only a linear search is done.
7728
7729 Linear searching is done anyway, for one file, when Vim finds a line
7730 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007731 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732< [The whitespace before and after the '0' must be a single <Tab>]
7733
7734 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007735 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 instead of a normal tag name, a retry is done with a linear search.
7737 Tags in unsorted tags files, and matches with different case will only
7738 be found in the retry.
7739
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007740 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007741 linear search can be avoided when case is ignored. Use a value of '2'
7742 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7743 sorted with the -f switch to "sort" in most unices, as in the command:
7744 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7745 (at least 5.5) the --sort=foldcase switch can be used for this as
7746 well. Note that case must be folded to uppercase for this to work.
7747
7748 By default, tag searches are case-sensitive. Case is ignored when
7749 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7750 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007751 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7752 'tagcase' is "smart", and the pattern contains only lowercase
7753 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007754
7755 When 'tagbsearch' is off, tags searching is slower when a full match
7756 exists, but faster when no full match exists. Tags in unsorted tags
7757 files may only be found with 'tagbsearch' off.
7758 When the tags file is not sorted, or sorted in a wrong way (not on
7759 ASCII byte value), 'tagbsearch' should be off, or the line given above
7760 must be included in the tags file.
7761 This option doesn't affect commands that find all matching tags (e.g.,
7762 command-line completion and ":help").
7763 {Vi: always uses binary search in some versions}
7764
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007765 *'tagcase'* *'tc'*
7766'tagcase' 'tc' string (default "followic")
7767 global or local to buffer |global-local|
7768 {not in Vi}
7769 This option specifies how case is handled when searching the tags
7770 file:
7771 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007772 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007773 ignore Ignore case
7774 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007775 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007776 NOTE: This option is set to the Vi default value when 'compatible' is
7777 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007778
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 *'taglength'* *'tl'*
7780'taglength' 'tl' number (default 0)
7781 global
7782 If non-zero, tags are significant up to this number of characters.
7783
7784 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7785'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7786 global
7787 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007788 If on and using a tags file in another directory, file names in that
7789 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 NOTE: This option is set to the Vi default value when 'compatible' is
7791 set and to the Vim default value when 'compatible' is reset.
7792
7793 *'tags'* *'tag'* *E433*
7794'tags' 'tag' string (default "./tags,tags", when compiled with
7795 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7796 global or local to buffer |global-local|
7797 Filenames for the tag command, separated by spaces or commas. To
7798 include a space or comma in a file name, precede it with a backslash
7799 (see |option-backslash| about including spaces and backslashes).
7800 When a file name starts with "./", the '.' is replaced with the path
7801 of the current file. But only when the 'd' flag is not included in
7802 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7803 |tags-option|.
7804 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007805 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7806 find all files named "tags" below "/lib". The filename itself cannot
7807 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7808 files called "tags?". {not available when compiled without the
7809 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007810 The |tagfiles()| function can be used to get a list of the file names
7811 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7813 files are also supported. They are automatically recognized. The
7814 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7815 differences are ignored (MS-Windows). |emacs-tags|
7816 The use of |:set+=| and |:set-=| is preferred when adding or removing
7817 file names from the list. This avoids problems when a future version
7818 uses another default.
7819 {Vi: default is "tags /usr/lib/tags"}
7820
7821 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7822'tagstack' 'tgst' boolean (default on)
7823 global
7824 {not in all versions of Vi}
7825 When on, the |tagstack| is used normally. When off, a ":tag" or
7826 ":tselect" command with an argument will not push the tag onto the
7827 tagstack. A following ":tag" without an argument, a ":pop" command or
7828 any other command that uses the tagstack will use the unmodified
7829 tagstack, but does change the pointer to the active entry.
7830 Resetting this option is useful when using a ":tag" command in a
7831 mapping which should not change the tagstack.
7832
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007833 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007834'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007835 global
7836 {not in Vi}
7837 {only available when compiled with the |+tcl/dyn|
7838 feature}
7839 Specifies the name of the Tcl shared library. The default is
7840 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007841 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007842 This option cannot be set from a |modeline| or in the |sandbox|, for
7843 security reasons.
7844
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 *'term'* *E529* *E530* *E531*
7846'term' string (default is $TERM, if that fails:
7847 in the GUI: "builtin_gui"
7848 on Amiga: "amiga"
7849 on BeOS: "beos-ansi"
7850 on Mac: "mac-ansi"
7851 on MiNT: "vt52"
7852 on MS-DOS: "pcterm"
7853 on OS/2: "os2ansi"
7854 on Unix: "ansi"
7855 on VMS: "ansi"
7856 on Win 32: "win32")
7857 global
7858 Name of the terminal. Used for choosing the terminal control
7859 characters. Environment variables are expanded |:set_env|.
7860 For example: >
7861 :set term=$TERM
7862< See |termcap|.
7863
7864 *'termbidi'* *'tbidi'*
7865 *'notermbidi'* *'notbidi'*
7866'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7867 global
7868 {not in Vi}
7869 {only available when compiled with the |+arabic|
7870 feature}
7871 The terminal is in charge of Bi-directionality of text (as specified
7872 by Unicode). The terminal is also expected to do the required shaping
7873 that some languages (such as Arabic) require.
7874 Setting this option implies that 'rightleft' will not be set when
7875 'arabic' is set and the value of 'arabicshape' will be ignored.
7876 Note that setting 'termbidi' has the immediate effect that
7877 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7878 This option is reset when the GUI is started.
7879 For further details see |arabic.txt|.
7880
7881 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007882'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 Macintosh GUI: "macroman")
7884 global
7885 {only available when compiled with the |+multi_byte|
7886 feature}
7887 {not in Vi}
7888 Encoding used for the terminal. This specifies what character
7889 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007890 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007891 display). Except for the Mac when 'macatsui' is off, then
7892 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007894 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7896 Any attempts to set a different value will be rejected, and an error
7897 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007898 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 because the Win32 system always passes Unicode characters.
7900 When empty, the same encoding is used as for the 'encoding' option.
7901 This is the normal value.
7902 Not all combinations for 'termencoding' and 'encoding' are valid. See
7903 |encoding-table|.
7904 The value for this option must be supported by internal conversions or
7905 iconv(). When this is not possible no conversion will be done and you
7906 will probably experience problems with non-ASCII characters.
7907 Example: You are working with the locale set to euc-jp (Japanese) and
7908 want to edit a UTF-8 file: >
7909 :let &termencoding = &encoding
7910 :set encoding=utf-8
7911< You need to do this when your system has no locale support for UTF-8.
7912
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007913 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007914'termguicolors' 'tgc' boolean (default off)
7915 global
7916 {not in Vi}
7917 {not available when compiled without the
7918 |+termguicolors| feature}
7919 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007920 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007921
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007922 Requires a ISO-8613-3 compatible terminal. If setting this option
7923 does not work (produces a colorless UI) reading |xterm-true-color|
7924 might help.
7925
7926 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7927 is required. Use this check to find out: >
7928 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007929< This requires Vim to be built with the |+vtp| feature.
7930
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007931 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007932 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007933
Bram Moolenaar74675a62017-07-15 13:53:23 +02007934 *'termkey'* *'tk'*
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007935'termkey' 'tk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007936 local to window
7937 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007938 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007939 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007940 The <> notation can be used, e.g.: >
7941 :set termkey=<C-L>
7942< The string must be one key stroke but can be multiple bytes.
7943 When not set CTRL-W is used, so that CTRL-W : gets you to the command
7944 line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the
7945 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007946
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007947 *'termsize'* *'tms'*
Bram Moolenaar74675a62017-07-15 13:53:23 +02007948'termsize' 'tms' string (default "")
7949 local to window
7950 {not in Vi}
7951 Size of the |terminal| window. Format: {rows}x{columns}.
7952 - When empty the terminal gets the size from the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007953 - When set (e.g., "24x80") the terminal size is not adjusted to the
7954 window size. If the window is smaller only the top-left part is
7955 displayed.
7956 When rows is zero then use the height of the window.
7957 When columns is zero then use the width of the window.
7958 For example: "30x0" uses 30 rows with the current window width.
7959 Using "0x0" is the same as empty.
7960 Note that the command running in the terminal window may still change
7961 the size of the terminal. In that case the Vim window will be
7962 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007963
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 *'terse'* *'noterse'*
7965'terse' boolean (default off)
7966 global
7967 When set: Add 's' flag to 'shortmess' option (this makes the message
7968 for a search that hits the start or end of the file not being
7969 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7970 shortens a lot of messages}
7971
7972 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7973'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7974 global
7975 {not in Vi}
7976 This option is obsolete. Use 'fileformats'.
7977 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7978 set to the default value for the current system. When 'textauto' is
7979 reset, 'fileformats' is made empty.
7980 NOTE: This option is set to the Vi default value when 'compatible' is
7981 set and to the Vim default value when 'compatible' is reset.
7982
7983 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7984'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7985 others: default off)
7986 local to buffer
7987 {not in Vi}
7988 This option is obsolete. Use 'fileformat'.
7989 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7990 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7991 "unix".
7992
7993 *'textwidth'* *'tw'*
7994'textwidth' 'tw' number (default 0)
7995 local to buffer
7996 {not in Vi}
7997 Maximum width of text that is being inserted. A longer line will be
7998 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007999 this.
8000 'textwidth' is set to 0 when the 'paste' option is set and restored
8001 when 'paste' is reset.
8002 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008004 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 NOTE: This option is set to 0 when 'compatible' is set.
8006
8007 *'thesaurus'* *'tsr'*
8008'thesaurus' 'tsr' string (default "")
8009 global or local to buffer |global-local|
8010 {not in Vi}
8011 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008012 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 the file should contain words with similar meaning, separated by
8014 non-keyword characters (white space is preferred). Maximum line
8015 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008016 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008017 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008018 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008019 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 after a comma are ignored, otherwise spaces are included in the file
8021 name. See |option-backslash| about using backslashes.
8022 The use of |:set+=| and |:set-=| is preferred when adding or removing
8023 directories from the list. This avoids problems when a future version
8024 uses another default.
8025 Backticks cannot be used in this option for security reasons.
8026
8027 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8028'tildeop' 'top' boolean (default off)
8029 global
8030 {not in Vi}
8031 When on: The tilde command "~" behaves like an operator.
8032 NOTE: This option is reset when 'compatible' is set.
8033
8034 *'timeout'* *'to'* *'notimeout'* *'noto'*
8035'timeout' 'to' boolean (default on)
8036 global
8037 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008038'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 global
8040 {not in Vi}
8041 These two options together determine the behavior when part of a
8042 mapped key sequence or keyboard code has been received:
8043
8044 'timeout' 'ttimeout' action ~
8045 off off do not time out
8046 on on or off time out on :mappings and key codes
8047 off on time out on key codes
8048
8049 If both options are off, Vim will wait until either the complete
8050 mapping or key sequence has been received, or it is clear that there
8051 is no mapping or key sequence for the received characters. For
8052 example: if you have mapped "vl" and Vim has received 'v', the next
8053 character is needed to see if the 'v' is followed by an 'l'.
8054 When one of the options is on, Vim will wait for about 1 second for
8055 the next character to arrive. After that the already received
8056 characters are interpreted as single characters. The waiting time can
8057 be changed with the 'timeoutlen' option.
8058 On slow terminals or very busy systems timing out may cause
8059 malfunctioning cursor keys. If both options are off, Vim waits
8060 forever after an entered <Esc> if there are key codes that start
8061 with <Esc>. You will have to type <Esc> twice. If you do not have
8062 problems with key codes, but would like to have :mapped key
8063 sequences not timing out in 1 second, set the 'ttimeout' option and
8064 reset the 'timeout' option.
8065
8066 NOTE: 'ttimeout' is reset when 'compatible' is set.
8067
8068 *'timeoutlen'* *'tm'*
8069'timeoutlen' 'tm' number (default 1000)
8070 global
8071 {not in all versions of Vi}
8072 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008073'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 global
8075 {not in Vi}
8076 The time in milliseconds that is waited for a key code or mapped key
8077 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8078 when part of a command has been typed.
8079 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8080 different timeout value for key codes is desired set 'ttimeoutlen' to
8081 a non-negative number.
8082
8083 ttimeoutlen mapping delay key code delay ~
8084 < 0 'timeoutlen' 'timeoutlen'
8085 >= 0 'timeoutlen' 'ttimeoutlen'
8086
8087 The timeout only happens when the 'timeout' and 'ttimeout' options
8088 tell so. A useful setting would be >
8089 :set timeout timeoutlen=3000 ttimeoutlen=100
8090< (time out on mapping after three seconds, time out on key codes after
8091 a tenth of a second).
8092
8093 *'title'* *'notitle'*
8094'title' boolean (default off, on when title can be restored)
8095 global
8096 {not in Vi}
8097 {not available when compiled without the |+title|
8098 feature}
8099 When on, the title of the window will be set to the value of
8100 'titlestring' (if it is not empty), or to:
8101 filename [+=-] (path) - VIM
8102 Where:
8103 filename the name of the file being edited
8104 - indicates the file cannot be modified, 'ma' off
8105 + indicates the file was modified
8106 = indicates the file is read-only
8107 =+ indicates the file is read-only and modified
8108 (path) is the path of the file being edited
8109 - VIM the server name |v:servername| or "VIM"
8110 Only works if the terminal supports setting window titles
8111 (currently Amiga console, Win32 console, all GUI versions and
8112 terminals with a non- empty 't_ts' option - these are Unix xterm and
8113 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8114 *X11*
8115 When Vim was compiled with HAVE_X11 defined, the original title will
8116 be restored if possible. The output of ":version" will include "+X11"
8117 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8118 works for the icon name |'icon'|.
8119 But: When Vim was started with the |-X| argument, restoring the title
8120 will not work (except in the GUI).
8121 If the title cannot be restored, it is set to the value of 'titleold'.
8122 You might want to restore the title outside of Vim then.
8123 When using an xterm from a remote machine you can use this command:
8124 rsh machine_name xterm -display $DISPLAY &
8125 then the WINDOWID environment variable should be inherited and the
8126 title of the window should change back to what it should be after
8127 exiting Vim.
8128
8129 *'titlelen'*
8130'titlelen' number (default 85)
8131 global
8132 {not in Vi}
8133 {not available when compiled without the |+title|
8134 feature}
8135 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008136 title. When the title is longer, only the end of the path name is
8137 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 Using a percentage makes this adapt to the width of the window. But
8139 it won't work perfectly, because the actual number of characters
8140 available also depends on the font used and other things in the title
8141 bar. When 'titlelen' is zero the full path is used. Otherwise,
8142 values from 1 to 30000 percent can be used.
8143 'titlelen' is also used for the 'titlestring' option.
8144
8145 *'titleold'*
8146'titleold' string (default "Thanks for flying Vim")
8147 global
8148 {not in Vi}
8149 {only available when compiled with the |+title|
8150 feature}
8151 This option will be used for the window title when exiting Vim if the
8152 original title cannot be restored. Only happens if 'title' is on or
8153 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008154 This option cannot be set from a |modeline| or in the |sandbox|, for
8155 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 *'titlestring'*
8157'titlestring' string (default "")
8158 global
8159 {not in Vi}
8160 {not available when compiled without the |+title|
8161 feature}
8162 When this option is not empty, it will be used for the title of the
8163 window. This happens only when the 'title' option is on.
8164 Only works if the terminal supports setting window titles (currently
8165 Amiga console, Win32 console, all GUI versions and terminals with a
8166 non-empty 't_ts' option).
8167 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008168 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 When this option contains printf-style '%' items, they will be
8170 expanded according to the rules used for 'statusline'.
8171 Example: >
8172 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8173 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8174< The value of 'titlelen' is used to align items in the middle or right
8175 of the available space.
8176 Some people prefer to have the file name first: >
8177 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8178< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008179 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008180 separating space only when needed.
8181 NOTE: Use of special characters in 'titlestring' may cause the display
8182 to be garbled (e.g., when it contains a CR or NL character).
8183 {not available when compiled without the |+statusline| feature}
8184
8185 *'toolbar'* *'tb'*
8186'toolbar' 'tb' string (default "icons,tooltips")
8187 global
8188 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8189 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008190 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 possible values are:
8192 icons Toolbar buttons are shown with icons.
8193 text Toolbar buttons shown with text.
8194 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008195 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 tooltips Tooltips are active for toolbar buttons.
8197 Tooltips refer to the popup help text which appears after the mouse
8198 cursor is placed over a toolbar button for a brief moment.
8199
8200 If you want the toolbar to be shown with icons as well as text, do the
8201 following: >
8202 :set tb=icons,text
8203< Motif and Athena cannot display icons and text at the same time. They
8204 will show icons if both are requested.
8205
8206 If none of the strings specified in 'toolbar' are valid or if
8207 'toolbar' is empty, this option is ignored. If you want to disable
8208 the toolbar, you need to set the 'guioptions' option. For example: >
8209 :set guioptions-=T
8210< Also see |gui-toolbar|.
8211
8212 *'toolbariconsize'* *'tbis'*
8213'toolbariconsize' 'tbis' string (default "small")
8214 global
8215 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008216 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008218 tiny Use tiny icons.
8219 small Use small icons (default).
8220 medium Use medium-sized icons.
8221 large Use large icons.
8222 huge Use even larger icons.
8223 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008225 the current theme. Common dimensions are giant=48x48, huge=32x32,
8226 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227
8228 If 'toolbariconsize' is empty, the global default size as determined
8229 by user preferences or the current theme is used.
8230
8231 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8232'ttybuiltin' 'tbi' boolean (default on)
8233 global
8234 {not in Vi}
8235 When on, the builtin termcaps are searched before the external ones.
8236 When off the builtin termcaps are searched after the external ones.
8237 When this option is changed, you should set the 'term' option next for
8238 the change to take effect, for example: >
8239 :set notbi term=$TERM
8240< See also |termcap|.
8241 Rationale: The default for this option is "on", because the builtin
8242 termcap entries are generally better (many systems contain faulty
8243 xterm entries...).
8244
8245 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8246'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8247 sun-cmd, screen, rxvt, dtterm or
8248 iris-ansi; also on when running Vim in
8249 a DOS console)
8250 global
8251 {not in Vi}
8252 Indicates a fast terminal connection. More characters will be sent to
8253 the screen for redrawing, instead of using insert/delete line
8254 commands. Improves smoothness of redrawing when there are multiple
8255 windows and the terminal does not support a scrolling region.
8256 Also enables the extra writing of characters at the end of each screen
8257 line for lines that wrap. This helps when using copy/paste with the
8258 mouse in an xterm and other terminals.
8259
8260 *'ttymouse'* *'ttym'*
8261'ttymouse' 'ttym' string (default depends on 'term')
8262 global
8263 {not in Vi}
8264 {only in Unix and VMS, doesn't work in the GUI; not
8265 available when compiled without |+mouse|}
8266 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008267 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 *xterm-mouse*
8269 xterm xterm-like mouse handling. The mouse generates
8270 "<Esc>[Mscr", where "scr" is three bytes:
8271 "s" = button state
8272 "c" = column plus 33
8273 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008274 This only works up to 223 columns! See "dec",
8275 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008276 xterm2 Works like "xterm", but with the xterm reporting the
8277 mouse position while the mouse is dragged. This works
8278 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008279 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 work. See below for how Vim detects this
8281 automatically.
8282 *netterm-mouse*
8283 netterm NetTerm mouse handling. The mouse generates
8284 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8285 for the row and column.
8286 *dec-mouse*
8287 dec DEC terminal mouse handling. The mouse generates a
8288 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008289 This is also available for an Xterm, if it was
8290 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 *jsbterm-mouse*
8292 jsbterm JSB term mouse handling.
8293 *pterm-mouse*
8294 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008295 *urxvt-mouse*
8296 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008297 The mouse works only if the terminal supports this
8298 encoding style, but it does not have 223 columns limit
8299 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008300 *sgr-mouse*
8301 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008302 mouse reporting. The mouse works even in columns
8303 beyond 223. This option is backward compatible with
8304 "xterm2" because it can also decode "xterm2" style
8305 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306
8307 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008308 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8309 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8311 recognized, if enabled at compile time. DEC terminal mouse codes
8312 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008313 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8314 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008316 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8317 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8318 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008319 Additionally, if vim is compiled with the |+termresponse| feature and
8320 |t_RV| is set to the escape sequence to request the xterm version
8321 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008323 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008324 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008325 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8326 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 :set t_RV=
8328<
8329 *'ttyscroll'* *'tsl'*
8330'ttyscroll' 'tsl' number (default 999)
8331 global
8332 Maximum number of lines to scroll the screen. If there are more lines
8333 to scroll the window is redrawn. For terminals where scrolling is
8334 very slow and redrawing is not slow this can be set to a small number,
8335 e.g., 3, to speed up displaying.
8336
8337 *'ttytype'* *'tty'*
8338'ttytype' 'tty' string (default from $TERM)
8339 global
8340 Alias for 'term', see above.
8341
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008342 *'undodir'* *'udir'*
8343'undodir' 'udir' string (default ".")
8344 global
8345 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008346 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008347 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008348 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008349 "." means using the directory of the file. The undo file name for
8350 "file.txt" is ".file.txt.un~".
8351 For other directories the file name is the full path of the edited
8352 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008353 When writing: The first directory that exists is used. "." always
8354 works, no directories after "." will be used for writing.
8355 When reading all entries are tried to find an undo file. The first
8356 undo file that exists is used. When it cannot be read an error is
8357 given, no further entry is used.
8358 See |undo-persistence|.
8359
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008360 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008361'undofile' 'udf' boolean (default off)
8362 local to buffer
8363 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008364 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008365 When on, Vim automatically saves undo history to an undo file when
8366 writing a buffer to a file, and restores undo history from the same
8367 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008368 The directory where the undo file is stored is specified by 'undodir'.
8369 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008370 The undo file is not read when 'undoreload' causes the buffer from
8371 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008372 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008373 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008374
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 *'undolevels'* *'ul'*
8376'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8377 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008378 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 {not in Vi}
8380 Maximum number of changes that can be undone. Since undo information
8381 is kept in memory, higher numbers will cause more memory to be used
8382 (nevertheless, a single change can use an unlimited amount of memory).
8383 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8384 itself: >
8385 set ul=0
8386< But you can also get Vi compatibility by including the 'u' flag in
8387 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008388 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008389 Set to -1 for no undo at all. You might want to do this only for the
8390 current buffer: >
8391 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008393
8394 The local value is set to -123456 when the global value is to be used.
8395
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008396 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008398 *'undoreload'* *'ur'*
8399'undoreload' 'ur' number (default 10000)
8400 global
8401 {not in Vi}
8402 Save the whole buffer for undo when reloading it. This applies to the
8403 ":e!" command and reloading for when the buffer changed outside of
8404 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008405 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008406 of lines is smaller than the value of this option.
8407 Set this option to zero to disable undo for a reload.
8408
8409 When saving undo for a reload, any undo file is not read.
8410
8411 Note that this causes the whole buffer to be stored in memory. Set
8412 this option to a lower value if you run out of memory.
8413
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 *'updatecount'* *'uc'*
8415'updatecount' 'uc' number (default: 200)
8416 global
8417 {not in Vi}
8418 After typing this many characters the swap file will be written to
8419 disk. When zero, no swap file will be created at all (see chapter on
8420 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8421 Vim with the "-n" option, see |startup|. When editing in readonly
8422 mode this option will be initialized to 10000.
8423 The swapfile can be disabled per buffer with |'swapfile'|.
8424 When 'updatecount' is set from zero to non-zero, swap files are
8425 created for all buffers that have 'swapfile' set. When 'updatecount'
8426 is set to zero, existing swap files are not deleted.
8427 Also see |'swapsync'|.
8428 This option has no meaning in buffers where |'buftype'| is "nofile"
8429 or "nowrite".
8430
8431 *'updatetime'* *'ut'*
8432'updatetime' 'ut' number (default 4000)
8433 global
8434 {not in Vi}
8435 If this many milliseconds nothing is typed the swap file will be
8436 written to disk (see |crash-recovery|). Also used for the
8437 |CursorHold| autocommand event.
8438
8439 *'verbose'* *'vbs'*
8440'verbose' 'vbs' number (default 0)
8441 global
8442 {not in Vi, although some versions have a boolean
8443 verbose option}
8444 When bigger than zero, Vim will give messages about what it is doing.
8445 Currently, these messages are given:
8446 >= 1 When the viminfo file is read or written.
8447 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008448 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 >= 8 Files for which a group of autocommands is executed.
8450 >= 9 Every executed autocommand.
8451 >= 12 Every executed function.
8452 >= 13 When an exception is thrown, caught, finished, or discarded.
8453 >= 14 Anything pending in a ":finally" clause.
8454 >= 15 Every executed Ex command (truncated at 200 characters).
8455
8456 This option can also be set with the "-V" argument. See |-V|.
8457 This option is also set by the |:verbose| command.
8458
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008459 When the 'verbosefile' option is set then the verbose messages are not
8460 displayed.
8461
8462 *'verbosefile'* *'vfile'*
8463'verbosefile' 'vfile' string (default empty)
8464 global
8465 {not in Vi}
8466 When not empty all messages are written in a file with this name.
8467 When the file exists messages are appended.
8468 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008469 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008470 Setting 'verbosefile' to a new value is like making it empty first.
8471 The difference with |:redir| is that verbose messages are not
8472 displayed when 'verbosefile' is set.
8473
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 *'viewdir'* *'vdir'*
8475'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8476 "$VIM/vimfiles/view",
8477 for Unix: "~/.vim/view",
8478 for Macintosh: "$VIM:vimfiles:view"
8479 for VMS: "sys$login:vimfiles/view"
8480 for RiscOS: "Choices:vimfiles/view")
8481 global
8482 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008483 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 feature}
8485 Name of the directory where to store files for |:mkview|.
8486 This option cannot be set from a |modeline| or in the |sandbox|, for
8487 security reasons.
8488
8489 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008490'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 global
8492 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008493 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 feature}
8495 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008496 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 word save and restore ~
8498 cursor cursor position in file and in window
8499 folds manually created folds, opened/closed folds and local
8500 fold options
8501 options options and mappings local to a window or buffer (not
8502 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008503 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 slash backslashes in file names replaced with forward
8505 slashes
8506 unix with Unix end-of-line format (single <NL>), even when
8507 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008508 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509
8510 "slash" and "unix" are useful on Windows when sharing view files
8511 with Unix. The Unix version of Vim cannot source dos format scripts,
8512 but the Windows version of Vim can source unix format scripts.
8513
8514 *'viminfo'* *'vi'* *E526* *E527* *E528*
8515'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008516 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8517 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8518 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008519 global
8520 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008521 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008522 feature}
8523 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008524 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8525 "NONE".
8526 The string should be a comma separated list of parameters, each
8527 consisting of a single character identifying the particular parameter,
8528 followed by a number or string which specifies the value of that
8529 parameter. If a particular character is left out, then the default
8530 value is used for that parameter. The following is a list of the
8531 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008533 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 ! When included, save and restore global variables that start
8535 with an uppercase letter, and don't contain a lowercase
8536 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008537 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008538 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008539 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 " Maximum number of lines saved for each register. Old name of
8541 the '<' item, with the disadvantage that you need to put a
8542 backslash before the ", otherwise it will be recognized as the
8543 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008544 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 % When included, save and restore the buffer list. If Vim is
8546 started with a file name argument, the buffer list is not
8547 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008548 buffer list is restored from the viminfo file. Quickfix
8549 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8550 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008551 When followed by a number, the number specifies the maximum
8552 number of buffers that are stored. Without a number all
8553 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008554 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 ' Maximum number of previously edited files for which the marks
8556 are remembered. This parameter must always be included when
8557 'viminfo' is non-empty.
8558 Including this item also means that the |jumplist| and the
8559 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008560 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008562 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008563 patterns are also saved. When not included, the value of
8564 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008565 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008567 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008568 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 < Maximum number of lines saved for each register. If zero then
8570 registers are not saved. When not included, all lines are
8571 saved. '"' is the old name for this item.
8572 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008573 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008575 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008576 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 c When included, convert the text in the viminfo file from the
8578 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008579 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008580 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 f Whether file marks need to be stored. If zero, file marks ('0
8582 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008583 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008585 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 h Disable the effect of 'hlsearch' when loading the viminfo
8587 file. When not included, it depends on whether ":nohlsearch"
8588 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008589 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008591 the 'n'. Must be at the end of the option! If the
8592 'viminfofile' option is set, that file name overrides the one
8593 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008594 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008595 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 r Removable media. The argument is a string (up to the next
8597 ','). This parameter can be given several times. Each
8598 specifies the start of a path for which no marks will be
8599 stored. This is to avoid removable media. For MS-DOS you
8600 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8601 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8602 ignored. Maximum length of each 'r' argument is 50
8603 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008604 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 s Maximum size of an item in Kbyte. If zero then registers are
8606 not saved. Currently only applies to registers. The default
8607 "s10" will exclude registers with more than 10 Kbyte of text.
8608 Also see the '<' item above: line count limit.
8609
8610 Example: >
8611 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8612<
8613 '50 Marks will be remembered for the last 50 files you
8614 edited.
8615 <1000 Contents of registers (up to 1000 lines each) will be
8616 remembered.
8617 s100 Registers with more than 100 Kbyte text are skipped.
8618 :0 Command-line history will not be saved.
8619 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8620 no / Since '/' is not specified, the default will be used,
8621 that is, save all of the search history, and also the
8622 previous search and substitute patterns.
8623 no % The buffer list will not be saved nor read back.
8624 no h 'hlsearch' highlighting will be restored.
8625
8626 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8627 load the contents of the file, this is not done automatically.
8628
8629 This option cannot be set from a |modeline| or in the |sandbox|, for
8630 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008631 NOTE: This option is set to the Vim default value when 'compatible'
8632 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008634 *'viminfofile'* *'vif'*
8635'viminfofile' 'vif' string (default: "")
8636 global
8637 {not in Vi}
8638 {not available when compiled without the |+viminfo|
8639 feature}
8640 When non-empty, overrides the file name used for viminfo.
8641 When equal to "NONE" no viminfo file will be read or written.
8642 This option can be set with the |-i| command line flag. The |--clean|
8643 command line flag sets it to "NONE".
8644
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 *'virtualedit'* *'ve'*
8646'virtualedit' 've' string (default "")
8647 global
8648 {not in Vi}
8649 {not available when compiled without the
8650 |+virtualedit| feature}
8651 A comma separated list of these words:
8652 block Allow virtual editing in Visual block mode.
8653 insert Allow virtual editing in Insert mode.
8654 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008655 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008656
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008658 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 of the line. Useful for selecting a rectangle in Visual mode and
8660 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008661 "onemore" is not the same, it will only allow moving the cursor just
8662 after the last character of the line. This makes some commands more
8663 consistent. Previously the cursor was always past the end of the line
8664 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008665 break some plugins or Vim scripts. For example because |l| can move
8666 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008667 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008668 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008669 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008670 It doesn't make sense to combine "all" with "onemore", but you will
8671 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008672 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673
8674 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8675'visualbell' 'vb' boolean (default off)
8676 global
8677 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008678 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008680 use: >
8681 :set vb t_vb=
8682< If you want a short flash, you can use this on many terminals: >
8683 :set vb t_vb=[?5h$<100>[?5l
8684< Here $<100> specifies the time, you can use a smaller or bigger value
8685 to get a shorter or longer flash.
8686
8687 Note: Vim will limit the bell to once per half a second. This avoids
8688 having to wait for the flashing to finish when there are lots of
8689 bells, e.g. on key repeat. This also happens without 'visualbell'
8690 set.
8691
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8693 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8694 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008695
8696 Note: When the GUI starts, 't_vb' is reset to its default value. You
8697 might want to set it again in your |gvimrc|.
8698
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 Does not work on the Amiga, you always get a screen flash.
8700 Also see 'errorbells'.
8701
8702 *'warn'* *'nowarn'*
8703'warn' boolean (default on)
8704 global
8705 Give a warning message when a shell command is used while the buffer
8706 has been changed.
8707
8708 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8709'weirdinvert' 'wiv' boolean (default off)
8710 global
8711 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008712 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 It is provided for backwards compatibility with version 4.x.
8714 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8715 vice versa. Has no effect when the GUI is running.
8716
8717 *'whichwrap'* *'ww'*
8718'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8719 global
8720 {not in Vi}
8721 Allow specified keys that move the cursor left/right to move to the
8722 previous/next line when the cursor is on the first/last character in
8723 the line. Concatenate characters to allow this for these keys:
8724 char key mode ~
8725 b <BS> Normal and Visual
8726 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008727 h "h" Normal and Visual (not recommended)
8728 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 < <Left> Normal and Visual
8730 > <Right> Normal and Visual
8731 ~ "~" Normal
8732 [ <Left> Insert and Replace
8733 ] <Right> Insert and Replace
8734 For example: >
8735 :set ww=<,>,[,]
8736< allows wrap only when cursor keys are used.
8737 When the movement keys are used in combination with a delete or change
8738 operator, the <EOL> also counts for a character. This makes "3h"
8739 different from "3dh" when the cursor crosses the end of a line. This
8740 is also true for "x" and "X", because they do the same as "dl" and
8741 "dh". If you use this, you may also want to use the mapping
8742 ":map <BS> X" to make backspace delete the character in front of the
8743 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008744 When 'l' is included and it is used after an operator at the end of a
8745 line then it will not move to the next line. This makes "dl", "cl",
8746 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 NOTE: This option is set to the Vi default value when 'compatible' is
8748 set and to the Vim default value when 'compatible' is reset.
8749
8750 *'wildchar'* *'wc'*
8751'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8752 global
8753 {not in Vi}
8754 Character you have to type to start wildcard expansion in the
8755 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008756 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008757 The character is not recognized when used inside a macro. See
8758 'wildcharm' for that.
8759 Although 'wc' is a number option, you can set it to a special key: >
8760 :set wc=<Esc>
8761< NOTE: This option is set to the Vi default value when 'compatible' is
8762 set and to the Vim default value when 'compatible' is reset.
8763
8764 *'wildcharm'* *'wcm'*
8765'wildcharm' 'wcm' number (default: none (0))
8766 global
8767 {not in Vi}
8768 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008769 recognized when used inside a macro. You can find "spare" command-line
8770 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 you'll never actually type 'wildcharm', just use it in mappings that
8772 automatically invoke completion mode, e.g.: >
8773 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008774 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775< Then after typing :ss you can use CTRL-P & CTRL-N.
8776
8777 *'wildignore'* *'wig'*
8778'wildignore' 'wig' string (default "")
8779 global
8780 {not in Vi}
8781 {not available when compiled without the |+wildignore|
8782 feature}
8783 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008784 patterns is ignored when expanding |wildcards|, completing file or
8785 directory names, and influences the result of |expand()|, |glob()| and
8786 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8788 Also see 'suffixes'.
8789 Example: >
8790 :set wildignore=*.o,*.obj
8791< The use of |:set+=| and |:set-=| is preferred when adding or removing
8792 a pattern from the list. This avoids problems when a future version
8793 uses another default.
8794
Bram Moolenaar94950a92010-12-02 16:01:29 +01008795
Bram Moolenaar81af9252010-12-10 20:35:50 +01008796 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008797'wildignorecase' 'wic' boolean (default off)
8798 global
8799 {not in Vi}
8800 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008801 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008802 Does not apply when the shell is used to expand wildcards, which
8803 happens when there are special characters.
8804
8805
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008807'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008808 global
8809 {not in Vi}
8810 {not available if compiled without the |+wildmenu|
8811 feature}
8812 When 'wildmenu' is on, command-line completion operates in an enhanced
8813 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8814 the possible matches are shown just above the command line, with the
8815 first match highlighted (overwriting the status line, if there is
8816 one). Keys that show the previous/next match, such as <Tab> or
8817 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8818 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8819 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008820 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008821 If there are more matches than can fit in the line, a ">" is shown on
8822 the right and/or a "<" is shown on the left. The status line scrolls
8823 as needed.
8824 The "wildmenu" mode is abandoned when a key is hit that is not used
8825 for selecting a completion.
8826 While the "wildmenu" is active the following keys have special
8827 meanings:
8828
8829 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8830 <Down> - in filename/menu name completion: move into a
8831 subdirectory or submenu.
8832 <CR> - in menu completion, when the cursor is just after a
8833 dot: move into a submenu.
8834 <Up> - in filename/menu name completion: move up into
8835 parent directory or parent menu.
8836
8837 This makes the menus accessible from the console |console-menus|.
8838
8839 If you prefer the <Left> and <Right> keys to move the cursor instead
8840 of selecting a different match, use this: >
8841 :cnoremap <Left> <Space><BS><Left>
8842 :cnoremap <Right> <Space><BS><Right>
8843<
8844 The "WildMenu" highlighting is used for displaying the current match
8845 |hl-WildMenu|.
8846
8847 *'wildmode'* *'wim'*
8848'wildmode' 'wim' string (Vim default: "full")
8849 global
8850 {not in Vi}
8851 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008852 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008853 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 first part specifies the behavior for the first use of 'wildchar',
8855 The second part for the second use, etc.
8856 These are the possible values for each part:
8857 "" Complete only the first match.
8858 "full" Complete the next full match. After the last match,
8859 the original string is used and then the first match
8860 again.
8861 "longest" Complete till longest common string. If this doesn't
8862 result in a longer string, use the next part.
8863 "longest:full" Like "longest", but also start 'wildmenu' if it is
8864 enabled.
8865 "list" When more than one match, list all matches.
8866 "list:full" When more than one match, list all matches and
8867 complete first match.
8868 "list:longest" When more than one match, list all matches and
8869 complete till longest common string.
8870 When there is only a single match, it is fully completed in all cases.
8871
8872 Examples: >
8873 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008874< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 :set wildmode=longest,full
8876< Complete longest common string, then each full match >
8877 :set wildmode=list:full
8878< List all matches and complete each full match >
8879 :set wildmode=list,full
8880< List all matches without completing, then each full match >
8881 :set wildmode=longest,list
8882< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008883 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008884
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008885 *'wildoptions'* *'wop'*
8886'wildoptions' 'wop' string (default "")
8887 global
8888 {not in Vi}
8889 {not available when compiled without the |+wildignore|
8890 feature}
8891 A list of words that change how command line completion is done.
8892 Currently only one word is allowed:
8893 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008894 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008895 is displayed per line. Often used tag kinds are:
8896 d #define
8897 f function
8898 Also see |cmdline-completion|.
8899
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 *'winaltkeys'* *'wak'*
8901'winaltkeys' 'wak' string (default "menu")
8902 global
8903 {not in Vi}
8904 {only used in Win32, Motif, GTK and Photon GUI}
8905 Some GUI versions allow the access to menu entries by using the ALT
8906 key in combination with a character that appears underlined in the
8907 menu. This conflicts with the use of the ALT key for mappings and
8908 entering special characters. This option tells what to do:
8909 no Don't use ALT keys for menus. ALT key combinations can be
8910 mapped, but there is no automatic handling. This can then be
8911 done with the |:simalt| command.
8912 yes ALT key handling is done by the windowing system. ALT key
8913 combinations cannot be mapped.
8914 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008915 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 keys can be mapped.
8917 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8918 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008919 This option is not used for <F10>; on Win32 and with GTK <F10> will
8920 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008922 *'window'* *'wi'*
8923'window' 'wi' number (default screen height - 1)
8924 global
8925 Window height. Do not confuse this with the height of the Vim window,
8926 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008927 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8928 value is smaller than 'lines' minus one. The screen will scroll
8929 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008930 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8931 in a much smarter way, taking care of wrapping lines.
8932 When resizing the Vim window, the value is smaller than 1 or more than
8933 or equal to 'lines' it will be set to 'lines' minus 1.
8934 {Vi also uses the option to specify the number of displayed lines}
8935
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 *'winheight'* *'wh'* *E591*
8937'winheight' 'wh' number (default 1)
8938 global
8939 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008940 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 feature}
8942 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008943 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008944 focus goes to a window that is smaller, its size is increased, at the
8945 cost of the height of other windows.
8946 Set 'winheight' to a small number for normal editing.
8947 Set it to 999 to make the current window fill most of the screen.
8948 Other windows will be only 'winminheight' high. This has the drawback
8949 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8950 to create only two windows, set the option after startup is done,
8951 using the |VimEnter| event: >
8952 au VimEnter * set winheight=999
8953< Minimum value is 1.
8954 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008955 height of the current window.
8956 'winheight' applies to the current window. Use 'winminheight' to set
8957 the minimal height for other windows.
8958
8959 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8960'winfixheight' 'wfh' boolean (default off)
8961 local to window
8962 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008963 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008964 feature}
8965 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008966 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8967 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 The height may be changed anyway when running out of room.
8969
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008970 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8971'winfixwidth' 'wfw' boolean (default off)
8972 local to window
8973 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008974 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008975 feature}
8976 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008977 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008978 The width may be changed anyway when running out of room.
8979
Bram Moolenaar071d4272004-06-13 20:20:40 +00008980 *'winminheight'* *'wmh'*
8981'winminheight' 'wmh' number (default 1)
8982 global
8983 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008984 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008985 feature}
8986 The minimal height of a window, when it's not the current window.
8987 This is a hard minimum, windows will never become smaller.
8988 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8989 status bar) if necessary. They will return to at least one line when
8990 they become active (since the cursor has to have somewhere to go.)
8991 Use 'winheight' to set the minimal height of the current window.
8992 This option is only checked when making a window smaller. Don't use a
8993 large number, it will cause errors when opening more than a few
8994 windows. A value of 0 to 3 is reasonable.
8995
8996 *'winminwidth'* *'wmw'*
8997'winminwidth' 'wmw' number (default 1)
8998 global
8999 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009000 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009001 feature}
9002 The minimal width of a window, when it's not the current window.
9003 This is a hard minimum, windows will never become smaller.
9004 When set to zero, windows may be "squashed" to zero columns (i.e. just
9005 a vertical separator) if necessary. They will return to at least one
9006 line when they become active (since the cursor has to have somewhere
9007 to go.)
9008 Use 'winwidth' to set the minimal width of the current window.
9009 This option is only checked when making a window smaller. Don't use a
9010 large number, it will cause errors when opening more than a few
9011 windows. A value of 0 to 12 is reasonable.
9012
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009013 *'winptydll'*
9014'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9015 global
9016 {not in Vi}
9017 {only available when compiled with the |terminal|
9018 feature on MS-Windows}
9019 Specifies the name of the winpty shared library, used for the
9020 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009021 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009022 a fallback.
9023 Environment variables are expanded |:set_env|.
9024 This option cannot be set from a |modeline| or in the |sandbox|, for
9025 security reasons.
9026
Bram Moolenaar071d4272004-06-13 20:20:40 +00009027 *'winwidth'* *'wiw'* *E592*
9028'winwidth' 'wiw' number (default 20)
9029 global
9030 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009031 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009032 feature}
9033 Minimal number of columns for the current window. This is not a hard
9034 minimum, Vim will use fewer columns if there is not enough room. If
9035 the current window is smaller, its size is increased, at the cost of
9036 the width of other windows. Set it to 999 to make the current window
9037 always fill the screen. Set it to a small number for normal editing.
9038 The width is not adjusted after one of the commands to change the
9039 width of the current window.
9040 'winwidth' applies to the current window. Use 'winminwidth' to set
9041 the minimal width for other windows.
9042
9043 *'wrap'* *'nowrap'*
9044'wrap' boolean (default on)
9045 local to window
9046 {not in Vi}
9047 This option changes how text is displayed. It doesn't change the text
9048 in the buffer, see 'textwidth' for that.
9049 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009050 displaying continues on the next line. When off lines will not wrap
9051 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009052 moved to a part that is not shown, the screen will scroll
9053 horizontally.
9054 The line will be broken in the middle of a word if necessary. See
9055 'linebreak' to get the break at a word boundary.
9056 To make scrolling horizontally a bit more useful, try this: >
9057 :set sidescroll=5
9058 :set listchars+=precedes:<,extends:>
9059< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009060 This option can't be set from a |modeline| when the 'diff' option is
9061 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062
9063 *'wrapmargin'* *'wm'*
9064'wrapmargin' 'wm' number (default 0)
9065 local to buffer
9066 Number of characters from the right window border where wrapping
9067 starts. When typing text beyond this limit, an <EOL> will be inserted
9068 and inserting continues on the next line.
9069 Options that add a margin, such as 'number' and 'foldcolumn', cause
9070 the text width to be further reduced. This is Vi compatible.
9071 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009072 This option is set to 0 when 'paste' is set and restored when 'paste'
9073 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009074 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9075 and less usefully}
9076
9077 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9078'wrapscan' 'ws' boolean (default on) *E384* *E385*
9079 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009080 Searches wrap around the end of the file. Also applies to |]s| and
9081 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009082
9083 *'write'* *'nowrite'*
9084'write' boolean (default on)
9085 global
9086 {not in Vi}
9087 Allows writing files. When not set, writing a file is not allowed.
9088 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009089 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090 argument. Filtering text is still possible, even though this requires
9091 writing a temporary file.
9092
9093 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9094'writeany' 'wa' boolean (default off)
9095 global
9096 Allows writing to any file with no need for "!" override.
9097
9098 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9099'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9100 otherwise)
9101 global
9102 {not in Vi}
9103 Make a backup before overwriting a file. The backup is removed after
9104 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009105 also on.
9106 WARNING: Switching this option off means that when Vim fails to write
9107 your buffer correctly and then, for whatever reason, Vim exits, you
9108 lose both the original file and what you were writing. Only reset
9109 this option if your file system is almost full and it makes the write
9110 fail (and make sure not to exit Vim until the write was successful).
9111 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009112 When the 'backupskip' pattern matches, a backup is not made anyway.
9113 NOTE: This option is set to the default value when 'compatible' is
9114 set.
9115
9116 *'writedelay'* *'wd'*
9117'writedelay' 'wd' number (default 0)
9118 global
9119 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009120 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009121 screen. When non-zero, characters are sent to the terminal one by
9122 one. For MS-DOS pcterm this does not work. For debugging purposes.
9123
9124 vim:tw=78:ts=8:ft=help:norl: