blob: d37fa641a49c91589705fe699be1cf45b6e153ec [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*options.txt* For Vim version 8.1. Last change: 2018 May 15
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100405 {not available when compiled without the |+eval|
406 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
420NOTE: expanding environment variables and "~/" is only done with the ":set"
421command, not when assigning a value to an option with ":let".
422
Bram Moolenaarc572da52017-08-27 16:52:01 +0200423 *$HOME-windows*
424On MS-Windows, if $HOME is not defined as an environment variable, then
425at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200426If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428This expanded value is not exported to the environment, this matters when
429running an external command: >
430 :echo system('set | findstr ^HOME=')
431and >
432 :echo luaeval('os.getenv("HOME")')
433should echo nothing (an empty string) despite exists('$HOME') being true.
434When setting $HOME to a non-empty string it will be exported to the
435subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200436
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Note the maximum length of an expanded option is limited. How much depends on
439the system, mostly it is something like 256 or 1024 characters.
440
441 *:fix* *:fixdel*
442:fix[del] Set the value of 't_kD':
443 't_kb' is 't_kD' becomes ~
444 CTRL-? CTRL-H
445 not CTRL-? CTRL-?
446
447 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
448
449 If your delete key terminal code is wrong, but the
450 code for backspace is alright, you can put this in
451 your .vimrc: >
452 :fixdel
453< This works no matter what the actual code for
454 backspace is.
455
456 If the backspace key terminal code is wrong you can
457 use this: >
458 :if &term == "termname"
459 : set t_kb=^V<BS>
460 : fixdel
461 :endif
462< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000463 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464 with your terminal name.
465
466 If your <Delete> key sends a strange key sequence (not
467 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
468 :if &term == "termname"
469 : set t_kD=^V<Delete>
470 :endif
471< Where "^V" is CTRL-V and "<Delete>" is the delete key
472 (don't type eight characters!). Replace "termname"
473 with your terminal name.
474
475 *Linux-backspace*
476 Note about Linux: By default the backspace key
477 produces CTRL-?, which is wrong. You can fix it by
478 putting this line in your rc.local: >
479 echo "keycode 14 = BackSpace" | loadkeys
480<
481 *NetBSD-backspace*
482 Note about NetBSD: If your backspace doesn't produce
483 the right code, try this: >
484 xmodmap -e "keycode 22 = BackSpace"
485< If this works, add this in your .Xmodmap file: >
486 keysym 22 = BackSpace
487< You need to restart for this to take effect.
488
489==============================================================================
4902. Automatically setting options *auto-setting*
491
492Besides changing options with the ":set" command, there are three alternatives
493to set options automatically for one or more files:
494
4951. When starting Vim initializations are read from various places. See
496 |initialization|. Most of them are performed for all editing sessions,
497 and some of them depend on the directory where Vim is started.
498 You can create an initialization file with |:mkvimrc|, |:mkview| and
499 |:mksession|.
5002. If you start editing a new file, the automatic commands are executed.
501 This can be used to set options for files matching a particular pattern and
502 many other things. See |autocommand|.
5033. If you start editing a new file, and the 'modeline' option is on, a
504 number of lines at the beginning and end of the file are checked for
505 modelines. This is explained here.
506
507 *modeline* *vim:* *vi:* *ex:* *E520*
508There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200511[text] any text or empty
512{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514[white] optional white space
515{options} a list of option settings, separated with white space
516 or ':', where each part between ':' is the argument
517 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaar14b69452013-06-29 23:05:20 +0200519Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000520 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523The second form (this is compatible with some versions of Vi):
524
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[text] any text or empty
528{white} at least one blank character (<Space> or <Tab>)
529{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
530[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531se[t] the string "set " or "se " (note the space); When
532 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533{options} a list of options, separated with white space, which
534 is the argument for a ":set" command
535: a colon
536[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar14b69452013-06-29 23:05:20 +0200538Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
543chance that a normal word like "lex:" is caught. There is one exception:
544"vi:" and "vim:" can also be at the start of the line (for compatibility with
545version 3.0). Using "ex:" at the start of the line will be ignored (this
546could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 *modeline-local*
549The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000550buffer and window that contain the file. Although it's possible to set global
551options from a modeline, this is unusual. If you have two windows open and
552the files in it set the same global option to a different value, the result
553depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000555When editing a file that was already loaded, only the window-local options
556from the modeline are used. Thus if you manually changed a buffer-local
557option after opening the file, it won't be changed if you edit the same buffer
558in another window. But window-local options will be set.
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-version*
561If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 vim{vers}: version {vers} or later
564 vim<{vers}: version before {vers}
565 vim={vers}: version {vers}
566 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100567{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
568For example, to use a modeline only for Vim 7.0:
569 /* vim700: set foldmethod=marker */ ~
570To use a modeline for Vim after version 7.2:
571 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572There can be no blanks between "vim" and the ":".
573
574
575The number of lines that are checked can be set with the 'modelines' option.
576If 'modeline' is off or 'modelines' is 0 no lines are checked.
577
578Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000579like:
580 /* vi:ts=4: */ ~
581will give an error message for the trailing "*/". This line is OK:
582 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584If an error is detected the rest of the line is skipped.
585
586If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000587backslash in front of the ':' will be removed. Example:
588 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589This sets the 'dir' option to "c:\tmp". Only a single backslash before the
590':' is removed. Thus to include "\:" you have to specify "\\:".
591
592No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000593might create a Trojan horse text file with modelines). And not all options
594can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000595|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000596causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
597are wrapped unexpectedly. So disable modelines before editing untrusted text.
598The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
600Hint: If you would like to do something else than setting an option, you could
601define an autocommand that checks the file for a specific string. For
602example: >
603 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
604And define a function SetVar() that does something with the line containing
605"VAR".
606
607==============================================================================
6083. Options summary *option-summary*
609
610In the list below all the options are mentioned with their full name and with
611an abbreviation if there is one. Both forms may be used.
612
613In this document when a boolean option is "set" that means that ":set option"
614is entered. When an option is "reset", ":set nooption" is used.
615
616For some options there are two default values: The "Vim default", which is
617used when 'compatible' is not set, and the "Vi default", which is used when
618'compatible' is set.
619
620Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000621are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622different value in each window. For example the 'list' option can be set in
623one window and reset in another for the same text, giving both types of view
624at the same time. There are a few options that are specific to a certain
625file. These can have a different value for each file or buffer. For example
626the 'textwidth' option can be 78 for a normal text file and 0 for a C
627program.
628
629 global one option for all buffers and windows
630 local to window each window has its own copy of this option
631 local to buffer each buffer has its own copy of this option
632
633When creating a new window the option values from the currently active window
634are used as a default value for the window-specific options. For the
635buffer-specific options this depends on the 's' and 'S' flags in the
636'cpoptions' option. If 's' is included (which is the default) the values for
637buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000638first entered. If 'S' is present the options are copied each time the buffer
639is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640present, the options are copied from the currently active buffer when the
641buffer is created.
642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000645Not all options are supported in all versions. This depends on the supported
646features and sometimes on the system. A remark about this is in curly braces
647below. When an option is not supported it may still be set without getting an
648error, this is called a hidden option. You can't get the value of a hidden
649option though, it is not stored.
650
651To test if option "foo" can be used with ":set" use something like this: >
652 if exists('&foo')
653This also returns true for a hidden option. To test if option "foo" is really
654supported use something like this: >
655 if exists('+foo')
656<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *E355*
658A jump table for the options with a short description can be found at |Q_op|.
659
660 *'aleph'* *'al'* *aleph* *Aleph*
661'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
662 global
663 {not in Vi}
664 {only available when compiled with the |+rightleft|
665 feature}
666 The ASCII code for the first letter of the Hebrew alphabet. The
667 routine that maps the keyboard in Hebrew mode, both in Insert mode
668 (when hkmap is set) and on the command-line (when hitting CTRL-_)
669 outputs the Hebrew characters in the range [aleph..aleph+26].
670 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
671 See |rileft.txt|.
672
673 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
674'allowrevins' 'ari' boolean (default off)
675 global
676 {not in Vi}
677 {only available when compiled with the |+rightleft|
678 feature}
679 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
680 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
681 into reverse Insert mode, and don't know how to get out. See
682 'revins'.
683 NOTE: This option is reset when 'compatible' is set.
684
685 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
686'altkeymap' 'akm' boolean (default off)
687 global
688 {not in Vi}
689 {only available when compiled with the |+farsi|
690 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 the keyboard map between Farsi and English, when 'allowrevins' set.
693
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 is useful to start the Vim in native mode i.e. English (left-to-right
696 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000697 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
702 {not in Vi}
703 {only available when compiled with the |+multi_byte|
704 feature}
705 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
706 Tells Vim what to do with characters with East Asian Width Class
707 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
708 letters, Cyrillic letters).
709
710 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 expected by most users.
713 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200714 *E834* *E835*
715 The value "double" cannot be used if 'listchars' or 'fillchars'
716 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
729 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
730 when the system locale is set to one of CJK locales. See Unicode
731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
741 {not in Vi}
742 {only available when compiled with GUI enabled
743 on Mac OS X}
744 This option only has an effect in the GUI version of Vim on Mac OS X
745 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
746 which can be easier to read at certain sizes on certain displays.
747 Setting this option can sometimes cause problems if 'guifont' is set
748 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
752'autochdir' 'acd' boolean (default off)
753 global
754 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200755 {only available when compiled with it, use
756 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000757 When on, Vim will change the current working directory whenever you
758 open a file, switch buffers, delete a buffer or open/close a window.
759 It will change to the directory containing the file which was opened
760 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000761 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
764'arabic' 'arab' boolean (default off)
765 local to window
766 {not in Vi}
767 {only available when compiled with the |+arabic|
768 feature}
769 This option can be set to start editing Arabic text.
770 Setting this option will:
771 - Set the 'rightleft' option, unless 'termbidi' is set.
772 - Set the 'arabicshape' option, unless 'termbidi' is set.
773 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
774 between typing English and Arabic key mapping.
775 - Set the 'delcombine' option
776 Note that 'encoding' must be "utf-8" for working with Arabic text.
777
778 Resetting this option will:
779 - Reset the 'rightleft' option.
780 - Disable the use of 'keymap' (without changing its value).
781 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200782 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Also see |arabic.txt|.
785
786 *'arabicshape'* *'arshape'*
787 *'noarabicshape'* *'noarshape'*
788'arabicshape' 'arshape' boolean (default on)
789 global
790 {not in Vi}
791 {only available when compiled with the |+arabic|
792 feature}
793 When on and 'termbidi' is off, the required visual character
794 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200795 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 one which encompasses:
797 a) the changing/morphing of characters based on their location
798 within a word (initial, medial, final and stand-alone).
799 b) the enabling of the ability to compose characters
800 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100801 When disabled the display shows each character's true stand-alone
802 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Arabic is a complex language which requires other settings, for
804 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100805 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
808'autoindent' 'ai' boolean (default off)
809 local to buffer
810 Copy indent from current line when starting a new line (typing <CR>
811 in Insert mode or when using the "o" or "O" command). If you do not
812 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000813 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
814 to another line has the same effect, unless the 'I' flag is included
815 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000816 When autoindent is on, formatting (with the "gq" command or when you
817 reach 'textwidth' in Insert mode) uses the indentation of the first
818 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 When 'smartindent' or 'cindent' is on the indent is changed in
820 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200821 The 'autoindent' option is reset when the 'paste' option is set and
822 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {small difference from Vi: After the indent is deleted when typing
824 <Esc> or <CR>, the cursor position when moving up or down is after the
825 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
826
827 *'autoread'* *'ar'* *'noautoread'* *'noar'*
828'autoread' 'ar' boolean (default off)
829 global or local to buffer |global-local|
830 {not in Vi}
831 When a file has been detected to have been changed outside of Vim and
832 it has not been changed inside of Vim, automatically read it again.
833 When the file has been deleted this is not done. |timestamp|
834 If this option has a local value, use this command to switch back to
835 using the global value: >
836 :set autoread<
837<
838 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
839'autowrite' 'aw' boolean (default off)
840 global
841 Write the contents of the file, if it has been modified, on each
842 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000843 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
845 Note that for some commands the 'autowrite' option is not used, see
846 'autowriteall' for that.
847
848 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
849'autowriteall' 'awa' boolean (default off)
850 global
851 {not in Vi}
852 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
853 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
854 Setting this option also implies that Vim behaves like 'autowrite' has
855 been set.
856
857 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200858'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 global
860 {not in Vi}
861 When set to "dark", Vim will try to use colors that look good on a
862 dark background. When set to "light", Vim will try to use colors that
863 look good on a light background. Any other value is illegal.
864 Vim tries to set the default value according to the terminal used.
865 This will not always be correct.
866 Setting this option does not change the background color, it tells Vim
867 what the background color looks like. For changing the background
868 color, see |:hi-normal|.
869
870 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000871 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000872 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100873 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 setting 'background' will cause the color scheme to be reloaded. If
875 the color scheme adjusts to the value of 'background' this will work.
876 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878
879 When setting 'background' to the default value with: >
880 :set background&
881< Vim will guess the value. In the GUI this should work correctly,
882 in other cases Vim might not be able to guess the right value.
883
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200884 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200885 color from the terminal. If the returned RGB value is dark/light and
886 'background' is not dark/light, 'background' will be set and the
887 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200888 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100889 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200890
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 When starting the GUI, the default value for 'background' will be
892 "light". When the value is not set in the .gvimrc, and Vim detects
893 that the background is actually quite dark, 'background' is set to
894 "dark". But this happens only AFTER the .gvimrc file has been read
895 (because the window needs to be opened to find the actual background
896 color). To get around this, force the GUI window to be opened by
897 putting a ":gui" command in the .gvimrc file, before where the value
898 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200899
900 For MS-DOS, Windows and OS/2 the default is "dark".
901 For other systems "dark" is used when 'term' is "linux",
902 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
903 background. Otherwise the default is "light".
904
Bram Moolenaarc572da52017-08-27 16:52:01 +0200905 The |:terminal| command and the |term_start()| function use the
906 'background' value to decide whether the terminal window will start
907 with a white or black background.
908
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 Normally this option would be set in the .vimrc file. Possibly
910 depending on the terminal name. Example: >
911 :if &term == "pcterm"
912 : set background=dark
913 :endif
914< When this option is set, the default settings for the highlight groups
915 will change. To use other settings, place ":highlight" commands AFTER
916 the setting of the 'background' option.
917 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
918 to select the colors for syntax highlighting. After changing this
919 option, you must load syntax.vim again to see the result. This can be
920 done with ":syntax on".
921
922 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200923'backspace' 'bs' string (default "", set to "indent,eol,start"
924 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 global
926 {not in Vi}
927 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
928 mode. This is a list of items, separated by commas. Each item allows
929 a way to backspace over something:
930 value effect ~
931 indent allow backspacing over autoindent
932 eol allow backspacing over line breaks (join lines)
933 start allow backspacing over the start of insert; CTRL-W and CTRL-U
934 stop once at the start of insert.
935
936 When the value is empty, Vi compatible backspacing is used.
937
938 For backwards compatibility with version 5.4 and earlier:
939 value effect ~
940 0 same as ":set backspace=" (Vi compatible)
941 1 same as ":set backspace=indent,eol"
942 2 same as ":set backspace=indent,eol,start"
943
944 See |:fixdel| if your <BS> or <Del> key does not do what you want.
945 NOTE: This option is set to "" when 'compatible' is set.
946
947 *'backup'* *'bk'* *'nobackup'* *'nobk'*
948'backup' 'bk' boolean (default off)
949 global
950 {not in Vi}
951 Make a backup before overwriting a file. Leave it around after the
952 file has been successfully written. If you do not want to keep the
953 backup file, but you do want a backup while the file is being
954 written, reset this option and set the 'writebackup' option (this is
955 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000956 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 |backup-table| for more explanations.
958 When the 'backupskip' pattern matches, a backup is not made anyway.
959 When 'patchmode' is set, the backup may be renamed to become the
960 oldest version of a file.
961 NOTE: This option is reset when 'compatible' is set.
962
963 *'backupcopy'* *'bkc'*
964'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200965 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 {not in Vi}
967 When writing a file and a backup is made, this option tells how it's
968 done. This is a comma separated list of words.
969
970 The main values are:
971 "yes" make a copy of the file and overwrite the original one
972 "no" rename the file and write a new one
973 "auto" one of the previous, what works best
974
975 Extra values that can be combined with the ones above are:
976 "breaksymlink" always break symlinks when writing
977 "breakhardlink" always break hardlinks when writing
978
979 Making a copy and overwriting the original file:
980 - Takes extra time to copy the file.
981 + When the file has special attributes, is a (hard/symbolic) link or
982 has a resource fork, all this is preserved.
983 - When the file is a link the backup will have the name of the link,
984 not of the real file.
985
986 Renaming the file and writing a new one:
987 + It's fast.
988 - Sometimes not all attributes of the file can be copied to the new
989 file.
990 - When the file is a link the new file will not be a link.
991
992 The "auto" value is the middle way: When Vim sees that renaming file
993 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000994 the file is not a link) that is used. When problems are expected, a
995 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 The "breaksymlink" and "breakhardlink" values can be used in
998 combination with any of "yes", "no" and "auto". When included, they
999 force Vim to always break either symbolic or hard links by doing
1000 exactly what the "no" option does, renaming the original file to
1001 become the backup and writing a new file in its place. This can be
1002 useful for example in source trees where all the files are symbolic or
1003 hard links and any changes should stay in the local source tree, not
1004 be propagated back to the original source.
1005 *crontab*
1006 One situation where "no" and "auto" will cause problems: A program
1007 that opens a file, invokes Vim to edit that file, and then tests if
1008 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001009 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 example.
1011
1012 When a copy is made, the original file is truncated and then filled
1013 with the new text. This means that protection bits, owner and
1014 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001015 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 group of the backup is set to the group of the original file. If this
1017 fails, the protection bits for the group are made the same as for
1018 others.
1019
1020 When the file is renamed this is the other way around: The backup has
1021 the same attributes of the original file, and the newly written file
1022 is owned by the current user. When the file was a (hard/symbolic)
1023 link, the new file will not! That's why the "auto" value doesn't
1024 rename when the file is a link. The owner and group of the newly
1025 written file will be set to the same ones as the original file, but
1026 the system may refuse to do this. In that case the "auto" value will
1027 again not rename the file.
1028
Bram Moolenaar036986f2017-03-16 17:41:02 +01001029 NOTE: This option is set to the Vi default value when 'compatible' is
1030 set and to the Vim default value when 'compatible' is reset.
1031
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 *'backupdir'* *'bdir'*
1033'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001034 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 for Unix: ".,~/tmp,~/")
1036 global
1037 {not in Vi}
1038 List of directories for the backup file, separated with commas.
1039 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001040 where this is possible. The directory must exist, Vim will not
1041 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001042 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 impossible!). Writing may fail because of this.
1044 - A directory "." means to put the backup file in the same directory
1045 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001046 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 put the backup file relative to where the edited file is. The
1048 leading "." is replaced with the path name of the edited file.
1049 ("." inside a directory name has no special meaning).
1050 - Spaces after the comma are ignored, other spaces are considered part
1051 of the directory name. To have a space at the start of a directory
1052 name, precede it with a backslash.
1053 - To include a comma in a directory name precede it with a backslash.
1054 - A directory name may end in an '/'.
1055 - Environment variables are expanded |:set_env|.
1056 - Careful with '\' characters, type one before a space, type two to
1057 get one in the option (see |option-backslash|), for example: >
1058 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1059< - For backwards compatibility with Vim version 3.0 a '>' at the start
1060 of the option is removed.
1061 See also 'backup' and 'writebackup' options.
1062 If you want to hide your backup files on Unix, consider this value: >
1063 :set backupdir=./.backup,~/.backup,.,/tmp
1064< You must create a ".backup" directory in each directory and in your
1065 home directory for this to work properly.
1066 The use of |:set+=| and |:set-=| is preferred when adding or removing
1067 directories from the list. This avoids problems when a future version
1068 uses another default.
1069 This option cannot be set from a |modeline| or in the |sandbox|, for
1070 security reasons.
1071
1072 *'backupext'* *'bex'* *E589*
1073'backupext' 'bex' string (default "~", for VMS: "_")
1074 global
1075 {not in Vi}
1076 String which is appended to a file name to make the name of the
1077 backup file. The default is quite unusual, because this avoids
1078 accidentally overwriting existing files with a backup file. You might
1079 prefer using ".bak", but make sure that you don't have files with
1080 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001081 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001083 If you like to keep a lot of backups, you could use a BufWritePre
1084 autocommand to change 'backupext' just before writing the file to
1085 include a timestamp. >
1086 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1087< Use 'backupdir' to put the backup in a different directory.
1088
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001090'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1091 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1092 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 global
1094 {not in Vi}
1095 {not available when compiled without the |+wildignore|
1096 feature}
1097 A list of file patterns. When one of the patterns matches with the
1098 name of the file which is written, no backup file is created. Both
1099 the specified file name and the full path name of the file are used.
1100 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1101 Watch out for special characters, see |option-backslash|.
1102 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001103 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001104
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001105 WARNING: Not having a backup file means that when Vim fails to write
1106 your buffer correctly and then, for whatever reason, Vim exits, you
1107 lose both the original file and what you were writing. Only disable
1108 backups if you don't care about losing the file.
1109
Bram Moolenaar02467872007-05-06 13:22:01 +00001110 Note that environment variables are not expanded. If you want to use
1111 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001112 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001113
1114< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001115 backup would be made by renaming the original file crontab won't see
1116 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
1118 *'balloondelay'* *'bdlay'*
1119'balloondelay' 'bdlay' number (default: 600)
1120 global
1121 {not in Vi}
1122 {only available when compiled with the |+balloon_eval|
1123 feature}
1124 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1125
1126 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1127'ballooneval' 'beval' boolean (default off)
1128 global
1129 {not in Vi}
1130 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001131 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001132 Switch on the |balloon-eval| functionality for the GUI.
1133
1134 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1135 *'nobevalterm'*
1136'balloonevalterm' 'bevalterm' boolean (default off)
1137 global
1138 {not in Vi}
1139 {only available when compiled with the
1140 |+balloon_eval_term| feature}
1141 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001143 *'balloonexpr'* *'bexpr'*
1144'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001145 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001146 {not in Vi}
1147 {only available when compiled with the |+balloon_eval|
1148 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001149 Expression for text to show in evaluation balloon. It is only used
1150 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001151
1152 v:beval_bufnr number of the buffer in which balloon is going to show
1153 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001154 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001155 v:beval_lnum line number
1156 v:beval_col column number (byte index)
1157 v:beval_text word under or after the mouse pointer
1158
1159 The evaluation of the expression must not have side effects!
1160 Example: >
1161 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001162 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001163 \', column ' . v:beval_col .
1164 \ ' of file ' . bufname(v:beval_bufnr) .
1165 \ ' on word "' . v:beval_text . '"'
1166 endfunction
1167 set bexpr=MyBalloonExpr()
1168 set ballooneval
1169<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001170 Also see |balloon_show()|, can be used if the content of the balloon
1171 is to be fetched asynchronously.
1172
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001173 NOTE: The balloon is displayed only if the cursor is on a text
1174 character. If the result of evaluating 'balloonexpr' is not empty,
1175 Vim does not try to send a message to an external debugger (Netbeans
1176 or Sun Workshop).
1177
Bram Moolenaar30b65812012-07-12 22:01:11 +02001178 The expression will be evaluated in the |sandbox| when set from a
1179 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001180
1181 It is not allowed to change text or jump to another window while
1182 evaluating 'balloonexpr' |textlock|.
1183
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001184 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001185 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001186< When they are supported "\n" characters will start a new line. If the
1187 expression evaluates to a |List| this is equal to using each List item
1188 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001189 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001190
Bram Moolenaar165bc692015-07-21 17:53:25 +02001191 *'belloff'* *'bo'*
1192'belloff' 'bo' string (default "")
1193 global
1194 {not in Vi}
1195 Specifies for which events the bell will not be rung. It is a comma
1196 separated list of items. For each item that is present, the bell
1197 will be silenced. This is most useful to specify specific events in
1198 insert mode to be silenced.
1199
1200 item meaning when present ~
1201 all All events.
1202 backspace When hitting <BS> or <Del> and deleting results in an
1203 error.
1204 cursor Fail to move around using the cursor keys or
1205 <PageUp>/<PageDown> in |Insert-mode|.
1206 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1207 |i_CTRL-X_CTRL-T|.
1208 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1209 |i_CTRL-E|.
1210 ctrlg Unknown Char after <C-G> in Insert mode.
1211 error Other Error occurred (e.g. try to join last line)
1212 (mostly used in |Normal-mode| or |Cmdline-mode|).
1213 esc hitting <Esc> in |Normal-mode|.
1214 ex In |Visual-mode|, hitting |Q| results in an error.
1215 hangul Error occurred when using hangul input.
1216 insertmode Pressing <Esc> in 'insertmode'.
1217 lang Calling the beep module for Lua/Mzscheme/TCL.
1218 mess No output available for |g<|.
1219 showmatch Error occurred for 'showmatch' function.
1220 operator Empty region error |cpo-E|.
1221 register Unknown register after <C-R> in |Insert-mode|.
1222 shell Bell from shell output |:!|.
1223 spell Error happened on spell suggest.
1224 wildmode More matches in |cmdline-completion| available
1225 (depends on the 'wildmode' setting).
1226
Bram Moolenaar036986f2017-03-16 17:41:02 +01001227 This is most useful to fine tune when in Insert mode the bell should
1228 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001229 indicate that an error occurred. It can be silenced by adding the
1230 "error" keyword.
1231
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1233'binary' 'bin' boolean (default off)
1234 local to buffer
1235 {not in Vi}
1236 This option should be set before editing a binary file. You can also
1237 use the |-b| Vim argument. When this option is switched on a few
1238 options will be changed (also when it already was on):
1239 'textwidth' will be set to 0
1240 'wrapmargin' will be set to 0
1241 'modeline' will be off
1242 'expandtab' will be off
1243 Also, 'fileformat' and 'fileformats' options will not be used, the
1244 file is read and written like 'fileformat' was "unix" (a single <NL>
1245 separates lines).
1246 The 'fileencoding' and 'fileencodings' options will not be used, the
1247 file is read without conversion.
1248 NOTE: When you start editing a(nother) file while the 'bin' option is
1249 on, settings from autocommands may change the settings again (e.g.,
1250 'textwidth'), causing trouble when editing. You might want to set
1251 'bin' again when the file has been loaded.
1252 The previous values of these options are remembered and restored when
1253 'bin' is switched from on to off. Each buffer has its own set of
1254 saved option values.
1255 To edit a file with 'binary' set you can use the |++bin| argument.
1256 This avoids you have to do ":set bin", which would have effect for all
1257 files you edit.
1258 When writing a file the <EOL> for the last line is only written if
1259 there was one in the original file (normally Vim appends an <EOL> to
1260 the last line if there is none; this would make the file longer). See
1261 the 'endofline' option.
1262
1263 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1264'bioskey' 'biosk' boolean (default on)
1265 global
1266 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001267 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268
1269 *'bomb'* *'nobomb'*
1270'bomb' boolean (default off)
1271 local to buffer
1272 {not in Vi}
1273 {only available when compiled with the |+multi_byte|
1274 feature}
1275 When writing a file and the following conditions are met, a BOM (Byte
1276 Order Mark) is prepended to the file:
1277 - this option is on
1278 - the 'binary' option is off
1279 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1280 endian variants.
1281 Some applications use the BOM to recognize the encoding of the file.
1282 Often used for UCS-2 files on MS-Windows. For other applications it
1283 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001284 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1286 check for the presence of the BOM is done and 'bomb' set accordingly.
1287 Unless 'binary' is set, it is removed from the first line, so that you
1288 don't see it when editing. When you don't change the options, the BOM
1289 will be restored when writing the file.
1290
1291 *'breakat'* *'brk'*
1292'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1293 global
1294 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001295 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001296 feature}
1297 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001298 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1299 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001301 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302'breakindent' 'bri' boolean (default off)
1303 local to window
1304 {not in Vi}
1305 {not available when compiled without the |+linebreak|
1306 feature}
1307 Every wrapped line will continue visually indented (same amount of
1308 space as the beginning of that line), thus preserving horizontal blocks
1309 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001310 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001311
1312 *'breakindentopt'* *'briopt'*
1313'breakindentopt' 'briopt' string (default empty)
1314 local to window
1315 {not in Vi}
1316 {not available when compiled without the |+linebreak|
1317 feature}
1318 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001319 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001320 min:{n} Minimum text width that will be kept after
1321 applying 'breakindent', even if the resulting
1322 text should normally be narrower. This prevents
1323 text indented almost to the right window border
1324 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001325 shift:{n} After applying 'breakindent', the wrapped line's
1326 beginning will be shifted by the given number of
1327 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001328 indentation (negative) or emphasizing the line
1329 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001330 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001331 additional indent.
1332 The default value for min is 20 and shift is 0.
1333
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001335'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001337 {not in Vi} {only for Motif, Athena, GTK, Mac and
1338 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001340 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001341 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 buffer Use the directory of the related buffer.
1343 current Use the current directory.
1344 {path} Use the specified directory
1345
1346 *'bufhidden'* *'bh'*
1347'bufhidden' 'bh' string (default: "")
1348 local to buffer
1349 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 This option specifies what happens when a buffer is no longer
1351 displayed in a window:
1352 <empty> follow the global 'hidden' option
1353 hide hide the buffer (don't unload it), also when 'hidden'
1354 is not set
1355 unload unload the buffer, also when 'hidden' is set or using
1356 |:hide|
1357 delete delete the buffer from the buffer list, also when
1358 'hidden' is set or using |:hide|, like using
1359 |:bdelete|
1360 wipe wipe out the buffer from the buffer list, also when
1361 'hidden' is set or using |:hide|, like using
1362 |:bwipeout|
1363
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001364 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001365 are lost without a warning. Also, these values may break autocommands
1366 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 This option is used together with 'buftype' and 'swapfile' to specify
1368 special kinds of buffers. See |special-buffers|.
1369
1370 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1371'buflisted' 'bl' boolean (default: on)
1372 local to buffer
1373 {not in Vi}
1374 When this option is set, the buffer shows up in the buffer list. If
1375 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1376 This option is reset by Vim for buffers that are only used to remember
1377 a file name or marks. Vim sets it when starting to edit a buffer.
1378 But not when moving to a buffer with ":buffer".
1379
1380 *'buftype'* *'bt'* *E382*
1381'buftype' 'bt' string (default: "")
1382 local to buffer
1383 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 The value of this option specifies the type of a buffer:
1385 <empty> normal buffer
1386 nofile buffer which is not related to a file and will not be
1387 written
1388 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001389 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001390 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001392 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 help help buffer (you are not supposed to set this
1394 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001395 terminal buffer for a |terminal| (you are not supposed to set
1396 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001397 prompt buffer where only the last line can be edited, meant
1398 to be used by a plugin, see |prompt-buffer|
1399 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400
1401 This option is used together with 'bufhidden' and 'swapfile' to
1402 specify special kinds of buffers. See |special-buffers|.
1403
1404 Be careful with changing this option, it can have many side effects!
1405
Bram Moolenaar280f1262006-01-30 00:14:18 +00001406 A "quickfix" buffer is only used for the error list and the location
1407 list. This value is set by the |:cwindow| and |:lwindow| commands and
1408 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409
1410 "nofile" and "nowrite" buffers are similar:
1411 both: The buffer is not to be written to disk, ":w" doesn't
1412 work (":w filename" does work though).
1413 both: The buffer is never considered to be |'modified'|.
1414 There is no warning when the changes will be lost, for
1415 example when you quit Vim.
1416 both: A swap file is only created when using too much memory
1417 (when 'swapfile' has been reset there is never a swap
1418 file).
1419 nofile only: The buffer name is fixed, it is not handled like a
1420 file name. It is not modified in response to a |:cd|
1421 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001422 both: When using ":e bufname" and already editing "bufname"
1423 the buffer is made empty and autocommands are
1424 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001425 *E676*
1426 "acwrite" implies that the buffer name is not related to a file, like
1427 "nofile", but it will be written. Thus, in contrast to "nofile" and
1428 "nowrite", ":w" does work and a modified buffer can't be abandoned
1429 without saving. For writing there must be matching |BufWriteCmd|,
1430 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431
1432 *'casemap'* *'cmp'*
1433'casemap' 'cmp' string (default: "internal,keepascii")
1434 global
1435 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001436 {only available when compiled with the |+multi_byte|
1437 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 Specifies details about changing the case of letters. It may contain
1439 these words, separated by a comma:
1440 internal Use internal case mapping functions, the current
1441 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001442 matters when 'encoding' is a Unicode encoding,
1443 "latin1" or "iso-8859-15". When "internal" is
1444 omitted, the towupper() and towlower() system library
1445 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1447 case mapping, the current locale is not effective.
1448 This probably only matters for Turkish.
1449
1450 *'cdpath'* *'cd'* *E344* *E346*
1451'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1452 global
1453 {not in Vi}
1454 {not available when compiled without the
1455 |+file_in_path| feature}
1456 This is a list of directories which will be searched when using the
1457 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001458 for has a relative path, not an absolute part starting with "/", "./"
1459 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 The 'cdpath' option's value has the same form and semantics as
1461 |'path'|. Also see |file-searching|.
1462 The default value is taken from $CDPATH, with a "," prepended to look
1463 in the current directory first.
1464 If the default value taken from $CDPATH is not what you want, include
1465 a modified version of the following command in your vimrc file to
1466 override it: >
1467 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1468< This option cannot be set from a |modeline| or in the |sandbox|, for
1469 security reasons.
1470 (parts of 'cdpath' can be passed to the shell to expand file names).
1471
1472 *'cedit'*
1473'cedit' string (Vi default: "", Vim default: CTRL-F)
1474 global
1475 {not in Vi}
1476 {not available when compiled without the |+vertsplit|
1477 feature}
1478 The key used in Command-line Mode to open the command-line window.
1479 The default is CTRL-F when 'compatible' is off.
1480 Only non-printable keys are allowed.
1481 The key can be specified as a single character, but it is difficult to
1482 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001483 :exe "set cedit=\<C-Y>"
1484 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485< |Nvi| also has this option, but it only uses the first character.
1486 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001487 NOTE: This option is set to the Vim default value when 'compatible'
1488 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489
1490 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1491'charconvert' 'ccv' string (default "")
1492 global
1493 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001494 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 {not in Vi}
1496 An expression that is used for character encoding conversion. It is
1497 evaluated when a file that is to be read or has been written has a
1498 different encoding from what is desired.
1499 'charconvert' is not used when the internal iconv() function is
1500 supported and is able to do the conversion. Using iconv() is
1501 preferred, because it is much faster.
1502 'charconvert' is not used when reading stdin |--|, because there is no
1503 file to convert from. You will have to save the text in a file first.
1504 The expression must return zero or an empty string for success,
1505 non-zero for failure.
1506 The possible encoding names encountered are in 'encoding'.
1507 Additionally, names given in 'fileencodings' and 'fileencoding' are
1508 used.
1509 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1510 is done internally by Vim, 'charconvert' is not used for this.
1511 'charconvert' is also used to convert the viminfo file, if the 'c'
1512 flag is present in 'viminfo'. Also used for Unicode conversion.
1513 Example: >
1514 set charconvert=CharConvert()
1515 fun CharConvert()
1516 system("recode "
1517 \ . v:charconvert_from . ".." . v:charconvert_to
1518 \ . " <" . v:fname_in . " >" v:fname_out)
1519 return v:shell_error
1520 endfun
1521< The related Vim variables are:
1522 v:charconvert_from name of the current encoding
1523 v:charconvert_to name of the desired encoding
1524 v:fname_in name of the input file
1525 v:fname_out name of the output file
1526 Note that v:fname_in and v:fname_out will never be the same.
1527 Note that v:charconvert_from and v:charconvert_to may be different
1528 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1529 Encryption is not done by Vim when using 'charconvert'. If you want
1530 to encrypt the file after conversion, 'charconvert' should take care
1531 of this.
1532 This option cannot be set from a |modeline| or in the |sandbox|, for
1533 security reasons.
1534
1535 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1536'cindent' 'cin' boolean (default off)
1537 local to buffer
1538 {not in Vi}
1539 {not available when compiled without the |+cindent|
1540 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001541 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 that trigger reindenting in insert mode and 'cinoptions' to set your
1543 preferred indent style.
1544 If 'indentexpr' is not empty, it overrules 'cindent'.
1545 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1546 the "=" operator indents using this algorithm rather than calling an
1547 external program.
1548 See |C-indenting|.
1549 When you don't like the way 'cindent' works, try the 'smartindent'
1550 option or 'indentexpr'.
1551 This option is not used when 'paste' is set.
1552 NOTE: This option is reset when 'compatible' is set.
1553
1554 *'cinkeys'* *'cink'*
1555'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1556 local to buffer
1557 {not in Vi}
1558 {not available when compiled without the |+cindent|
1559 feature}
1560 A list of keys that, when typed in Insert mode, cause reindenting of
1561 the current line. Only used if 'cindent' is on and 'indentexpr' is
1562 empty.
1563 For the format of this option see |cinkeys-format|.
1564 See |C-indenting|.
1565
1566 *'cinoptions'* *'cino'*
1567'cinoptions' 'cino' string (default "")
1568 local to buffer
1569 {not in Vi}
1570 {not available when compiled without the |+cindent|
1571 feature}
1572 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1573 program. See |cinoptions-values| for the values of this option, and
1574 |C-indenting| for info on C indenting in general.
1575
1576
1577 *'cinwords'* *'cinw'*
1578'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1579 local to buffer
1580 {not in Vi}
1581 {not available when compiled without both the
1582 |+cindent| and the |+smartindent| features}
1583 These keywords start an extra indent in the next line when
1584 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1585 an appropriate place (inside {}).
1586 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1587 matter, include the keyword both the uppercase and lowercase:
1588 "if,If,IF".
1589
1590 *'clipboard'* *'cb'*
1591'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1592 for X-windows, "" otherwise)
1593 global
1594 {not in Vi}
1595 {only in GUI versions or when the |+xterm_clipboard|
1596 feature is included}
1597 This option is a list of comma separated names.
1598 These names are recognized:
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 unnamed When included, Vim will use the clipboard register '*'
1602 for all yank, delete, change and put operations which
1603 would normally go to the unnamed register. When a
1604 register is explicitly specified, it will always be
1605 used regardless of whether "unnamed" is in 'clipboard'
1606 or not. The clipboard register can always be
1607 explicitly accessed using the "* notation. Also see
1608 |gui-clipboard|.
1609
Bram Moolenaar30b65812012-07-12 22:01:11 +02001610 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001611 unnamedplus A variant of the "unnamed" flag which uses the
1612 clipboard register '+' (|quoteplus|) instead of
1613 register '*' for all yank, delete, change and put
1614 operations which would normally go to the unnamed
1615 register. When "unnamed" is also included to the
1616 option, yank operations (but not delete, change or
1617 put) will additionally copy the text into register
1618 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001619 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001620 Availability can be checked with: >
1621 if has('unnamedplus')
1622<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001623 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 autoselect Works like the 'a' flag in 'guioptions': If present,
1625 then whenever Visual mode is started, or the Visual
1626 area extended, Vim tries to become the owner of the
1627 windowing system's global selection or put the
1628 selected text on the clipboard used by the selection
1629 register "*. See |guioptions_a| and |quotestar| for
1630 details. When the GUI is active, the 'a' flag in
1631 'guioptions' is used, when the GUI is not active, this
1632 "autoselect" flag is used.
1633 Also applies to the modeless selection.
1634
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001635 *clipboard-autoselectplus*
1636 autoselectplus Like "autoselect" but using the + register instead of
1637 the * register. Compare to the 'P' flag in
1638 'guioptions'.
1639
1640 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 autoselectml Like "autoselect", but for the modeless selection
1642 only. Compare to the 'A' flag in 'guioptions'.
1643
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001644 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001645 html When the clipboard contains HTML, use this when
1646 pasting. When putting text on the clipboard, mark it
1647 as HTML. This works to copy rendered HTML from
1648 Firefox, paste it as raw HTML in Vim, select the HTML
1649 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001650 You probably want to add this only temporarily,
1651 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001652 Only supported for GTK version 2 and later.
1653 Only available with the |+multi_byte| feature.
1654
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001655 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 exclude:{pattern}
1657 Defines a pattern that is matched against the name of
1658 the terminal 'term'. If there is a match, no
1659 connection will be made to the X server. This is
1660 useful in this situation:
1661 - Running Vim in a console.
1662 - $DISPLAY is set to start applications on another
1663 display.
1664 - You do not want to connect to the X server in the
1665 console, but do want this in a terminal emulator.
1666 To never connect to the X server use: >
1667 exclude:.*
1668< This has the same effect as using the |-X| argument.
1669 Note that when there is no connection to the X server
1670 the window title won't be restored and the clipboard
1671 cannot be accessed.
1672 The value of 'magic' is ignored, {pattern} is
1673 interpreted as if 'magic' was on.
1674 The rest of the option value will be used for
1675 {pattern}, this must be the last entry.
1676
1677 *'cmdheight'* *'ch'*
1678'cmdheight' 'ch' number (default 1)
1679 global
1680 {not in Vi}
1681 Number of screen lines to use for the command-line. Helps avoiding
1682 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001683 The value of this option is stored with the tab page, so that each tab
1684 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685
1686 *'cmdwinheight'* *'cwh'*
1687'cmdwinheight' 'cwh' number (default 7)
1688 global
1689 {not in Vi}
1690 {not available when compiled without the |+vertsplit|
1691 feature}
1692 Number of screen lines to use for the command-line window. |cmdwin|
1693
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001694 *'colorcolumn'* *'cc'*
1695'colorcolumn' 'cc' string (default "")
1696 local to window
1697 {not in Vi}
1698 {not available when compiled without the |+syntax|
1699 feature}
1700 'colorcolumn' is a comma separated list of screen columns that are
1701 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1702 text. Will make screen redrawing slower.
1703 The screen column can be an absolute number, or a number preceded with
1704 '+' or '-', which is added to or subtracted from 'textwidth'. >
1705
1706 :set cc=+1 " highlight column after 'textwidth'
1707 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1708 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1709<
1710 When 'textwidth' is zero then the items with '-' and '+' are not used.
1711 A maximum of 256 columns are highlighted.
1712
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 *'columns'* *'co'* *E594*
1714'columns' 'co' number (default 80 or terminal width)
1715 global
1716 {not in Vi}
1717 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001718 initialization and does not have to be set by hand. Also see
1719 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 When Vim is running in the GUI or in a resizable window, setting this
1721 option will cause the window size to be changed. When you only want
1722 to use the size for the GUI, put the command in your |gvimrc| file.
1723 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 number of columns of the display, the display may be messed up. For
1725 the GUI it is always possible and Vim limits the number of columns to
1726 what fits on the screen. You can use this command to get the widest
1727 window possible: >
1728 :set columns=9999
1729< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
1731 *'comments'* *'com'* *E524* *E525*
1732'comments' 'com' string (default
1733 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1734 local to buffer
1735 {not in Vi}
1736 {not available when compiled without the |+comments|
1737 feature}
1738 A comma separated list of strings that can start a comment line. See
1739 |format-comments|. See |option-backslash| about using backslashes to
1740 insert a space.
1741
1742 *'commentstring'* *'cms'* *E537*
1743'commentstring' 'cms' string (default "/*%s*/")
1744 local to buffer
1745 {not in Vi}
1746 {not available when compiled without the |+folding|
1747 feature}
1748 A template for a comment. The "%s" in the value is replaced with the
1749 comment text. Currently only used to add markers for folding, see
1750 |fold-marker|.
1751
1752 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001753'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001754 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 global
1756 {not in Vi}
1757 This option has the effect of making Vim either more Vi-compatible, or
1758 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001759
Bram Moolenaar071d4272004-06-13 20:20:40 +00001760 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001761 other options are also changed as a side effect.
1762 NOTE: Setting or resetting this option can have a lot of unexpected
1763 effects: Mappings are interpreted in another way, undo behaves
1764 differently, etc. If you set this option in your vimrc file, you
1765 should probably put it at the very start.
1766
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 By default this option is on and the Vi defaults are used for the
1768 options. This default was chosen for those people who want to use Vim
1769 just like Vi, and don't even (want to) know about the 'compatible'
1770 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001771 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001772 this option is switched off, and all options that have not been
1773 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001774 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001775 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001776 happen for the system-wide vimrc or gvimrc file, nor for a file given
1777 with the |-u| argument). Also see |compatible-default| and
1778 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 You can also set this option with the "-C" argument, and reset it with
1780 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001781 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 When this option is set, numerous other options are set to make Vim as
1784 Vi-compatible as possible. When this option is unset, various options
1785 are set to make Vim more useful. The table below lists all the
1786 options affected.
1787 The {?} column indicates when the options are affected:
1788 + Means that the option is set to the value given in {set value} when
1789 'compatible' is set.
1790 & Means that the option is set to the value given in {set value} when
1791 'compatible' is set AND is set to its Vim default value when
1792 'compatible' is unset.
1793 - Means the option is NOT changed when setting 'compatible' but IS
1794 set to its Vim default when 'compatible' is unset.
1795 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796
Bram Moolenaar036986f2017-03-16 17:41:02 +01001797 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001798
1799 'allowrevins' + off no CTRL-_ command
1800 'antialias' + off don't use antialiased fonts
1801 'arabic' + off reset arabic-related options
1802 'arabicshape' + on correct character shapes
1803 'backspace' + "" normal backspace
1804 'backup' + off no backup file
1805 'backupcopy' & Unix: "yes" backup file is a copy
1806 else: "auto" copy or rename backup file
1807 'balloonexpr' + "" text to show in evaluation balloon
1808 'breakindent' + off don't indent when wrapping lines
1809 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1810 'cindent' + off no C code indentation
1811 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1812 'copyindent' + off don't copy indent structure
1813 'cpoptions' & (all flags) Vi-compatible flags
1814 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001815 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001817 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001818 'cscopeverbose' + off see |cscopeverbose|
1819 'delcombine' + off unicode: delete whole char combination
1820 'digraph' + off no digraphs
1821 'esckeys' & off no <Esc>-keys in Insert mode
1822 'expandtab' + off tabs not expanded to spaces
1823 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'formatexpr' + "" use 'formatprg' for auto-formatting
1826 'formatoptions' & "vt" Vi compatible formatting
1827 'gdefault' + off no default 'g' flag for ":s"
1828 'history' & 0 no commandline history
1829 'hkmap' + off no Hebrew keyboard mapping
1830 'hkmapp' + off no phonetic Hebrew keyboard mapping
1831 'hlsearch' + off no highlighting of search matches
1832 'incsearch' + off no incremental searching
1833 'indentexpr' + "" no indenting by expression
1834 'insertmode' + off do not start in Insert mode
1835 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 'joinspaces' + on insert 2 spaces after period
1838 'modeline' & off no modelines
1839 'more' & off no pauses in listings
1840 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1841 'numberwidth' & 8 min number of columns for line number
1842 'preserveindent'+ off don't preserve current indent structure
1843 when changing it
1844 'revins' + off no reverse insert
1845 'ruler' + off no ruler
1846 'scrolljump' + 1 no jump scroll
1847 'scrolloff' + 0 no scroll offset
1848 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1849 'shiftround' + off indent not rounded to shiftwidth
1850 'shortmess' & "" no shortening of messages
1851 'showcmd' & off command characters not shown
1852 'showmode' & off current mode not shown
1853 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1854 'smartcase' + off no automatic ignore case switch
1855 'smartindent' + off no smart indentation
1856 'smarttab' + off no smart tab size
1857 'softtabstop' + 0 tabs are always 'tabstop' positions
1858 'startofline' + on goto startofline with some commands
1859 'tagcase' & "followic" 'ignorecase' when searching tags file
1860 'tagrelative' & off tag file names are not relative
1861 'termguicolors' + off don't use highlight-(guifg|guibg)
1862 'textauto' & off no automatic textmode detection
1863 'textwidth' + 0 no automatic line wrap
1864 'tildeop' + off tilde is not an operator
1865 'ttimeout' + off no terminal timeout
1866 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001867 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001868 'virtualedit' + "" cursor can only be placed on characters
1869 'whichwrap' & "" left-right movements don't wrap
1870 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001872 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873
1874 *'complete'* *'cpt'* *E535*
1875'complete' 'cpt' string (default: ".,w,b,u,t,i")
1876 local to buffer
1877 {not in Vi}
1878 This option specifies how keyword completion |ins-completion| works
1879 when CTRL-P or CTRL-N are used. It is also used for whole-line
1880 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1881 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001882 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 w scan buffers from other windows
1884 b scan other loaded buffers that are in the buffer list
1885 u scan the unloaded buffers that are in the buffer list
1886 U scan the buffers that are not in the buffer list
1887 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001888 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 k{dict} scan the file {dict}. Several "k" flags can be given,
1890 patterns are valid too. For example: >
1891 :set cpt=k/usr/dict/*,k~/spanish
1892< s scan the files given with the 'thesaurus' option
1893 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1894 are valid too.
1895 i scan current and included files
1896 d scan current and included files for defined name or macro
1897 |i_CTRL-X_CTRL-D|
1898 ] tag completion
1899 t same as "]"
1900
1901 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1902 not executed, this may lead to unexpected completions from some files
1903 (gzipped files for example). Unloaded buffers are not scanned for
1904 whole-line completion.
1905
1906 The default is ".,w,b,u,t,i", which means to scan:
1907 1. the current buffer
1908 2. buffers in other windows
1909 3. other loaded buffers
1910 4. unloaded buffers
1911 5. tags
1912 6. included files
1913
1914 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001915 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1916 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001918 *'completefunc'* *'cfu'*
1919'completefunc' 'cfu' string (default: empty)
1920 local to buffer
1921 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001922 {not available when compiled without the |+eval|
1923 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001924 This option specifies a function to be used for Insert mode completion
1925 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001926 See |complete-functions| for an explanation of how the function is
1927 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001928 This option cannot be set from a |modeline| or in the |sandbox|, for
1929 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001930
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001931 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001932'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001933 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001934 {not available when compiled without the
1935 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001936 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001937 A comma separated list of options for Insert mode completion
1938 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001939
1940 menu Use a popup menu to show the possible completions. The
1941 menu is only shown when there is more than one match and
1942 sufficient colors are available. |ins-completion-menu|
1943
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001944 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001945 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001946 match, e.g., what file it comes from.
1947
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001948 longest Only insert the longest common text of the matches. If
1949 the menu is displayed you can use CTRL-L to add more
1950 characters. Whether case is ignored depends on the kind
1951 of completion. For buffer text the 'ignorecase' option is
1952 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001953
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001954 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001955 completion in the preview window. Only works in
1956 combination with "menu" or "menuone".
1957
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001958 noinsert Do not insert any text for a match until the user selects
1959 a match from the menu. Only works in combination with
1960 "menu" or "menuone". No effect if "longest" is present.
1961
1962 noselect Do not select a match in the menu, force the user to
1963 select one from the menu. Only works in combination with
1964 "menu" or "menuone".
1965
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001966
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001967 *'concealcursor'* *'cocu'*
1968'concealcursor' 'cocu' string (default: "")
1969 local to window
1970 {not in Vi}
1971 {not available when compiled without the |+conceal|
1972 feature}
1973 Sets the modes in which text in the cursor line can also be concealed.
1974 When the current mode is listed then concealing happens just like in
1975 other lines.
1976 n Normal mode
1977 v Visual mode
1978 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001979 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001980
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001981 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001982 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001983 are moving around text is concealed, but when starting to insert text
1984 or selecting a Visual area the concealed text is displayed, so that
1985 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001986 Keep in mind that the cursor position is not always where it's
1987 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001988
1989
1990'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001991 number (default 0)
1992 local to window
1993 {not in Vi}
1994 {not available when compiled without the |+conceal|
1995 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001996 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1997 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001998
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001999 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002000 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002001 1 Each block of concealed text is replaced with one
2002 character. If the syntax item does not have a custom
2003 replacement character defined (see |:syn-cchar|) the
2004 character defined in 'listchars' is used (default is a
2005 space).
2006 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007 2 Concealed text is completely hidden unless it has a
2008 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002009 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002010 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002011
Bram Moolenaara7781e02010-07-19 20:13:22 +02002012 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002013 edit and copy the text. This can be changed with the 'concealcursor'
2014 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002015
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2017'confirm' 'cf' boolean (default off)
2018 global
2019 {not in Vi}
2020 When 'confirm' is on, certain operations that would normally
2021 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2022 instead raise a |dialog| asking if you wish to save the current
2023 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2024 If 'confirm' is off you can still activate confirmation for one
2025 command only (this is most useful in mappings) with the |:confirm|
2026 command.
2027 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2028
2029 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2030'conskey' 'consk' boolean (default off)
2031 global
2032 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002033 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034
2035 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2036'copyindent' 'ci' boolean (default off)
2037 local to buffer
2038 {not in Vi}
2039 Copy the structure of the existing lines indent when autoindenting a
2040 new line. Normally the new indent is reconstructed by a series of
2041 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2042 in which case only spaces are used). Enabling this option makes the
2043 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002044 existing line. 'expandtab' has no effect on these characters, a Tab
2045 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002047 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 Also see 'preserveindent'.
2049
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002050 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051'cpoptions' 'cpo' string (Vim default: "aABceFs",
2052 Vi default: all flags)
2053 global
2054 {not in Vi}
2055 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002056 this indicates Vi-compatible behavior. This is used for things where
2057 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 'cpoptions' stands for "compatible-options".
2059 Commas can be added for readability.
2060 To avoid problems with flags that are added in the future, use the
2061 "+=" and "-=" feature of ":set" |add-option-flags|.
2062 NOTE: This option is set to the Vi default value when 'compatible' is
2063 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002064 NOTE: This option is set to the POSIX default value at startup when
2065 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002066 variable exists |posix|. This means Vim tries to behave like the
2067 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068
2069 contains behavior ~
2070 *cpo-a*
2071 a When included, a ":read" command with a file name
2072 argument will set the alternate file name for the
2073 current window.
2074 *cpo-A*
2075 A When included, a ":write" command with a file name
2076 argument will set the alternate file name for the
2077 current window.
2078 *cpo-b*
2079 b "\|" in a ":map" command is recognized as the end of
2080 the map command. The '\' is included in the mapping,
2081 the text after the '|' is interpreted as the next
2082 command. Use a CTRL-V instead of a backslash to
2083 include the '|' in the mapping. Applies to all
2084 mapping, abbreviation, menu and autocmd commands.
2085 See also |map_bar|.
2086 *cpo-B*
2087 B A backslash has no special meaning in mappings,
2088 abbreviations and the "to" part of the menu commands.
2089 Remove this flag to be able to use a backslash like a
2090 CTRL-V. For example, the command ":map X \<Esc>"
2091 results in X being mapped to:
2092 'B' included: "\^[" (^[ is a real <Esc>)
2093 'B' excluded: "<Esc>" (5 characters)
2094 ('<' excluded in both cases)
2095 *cpo-c*
2096 c Searching continues at the end of any match at the
2097 cursor position, but not further than the start of the
2098 next line. When not present searching continues
2099 one character from the cursor position. With 'c'
2100 "abababababab" only gets three matches when repeating
2101 "/abab", without 'c' there are five matches.
2102 *cpo-C*
2103 C Do not concatenate sourced lines that start with a
2104 backslash. See |line-continuation|.
2105 *cpo-d*
2106 d Using "./" in the 'tags' option doesn't mean to use
2107 the tags file relative to the current file, but the
2108 tags file in the current directory.
2109 *cpo-D*
2110 D Can't use CTRL-K to enter a digraph after Normal mode
2111 commands with a character argument, like |r|, |f| and
2112 |t|.
2113 *cpo-e*
2114 e When executing a register with ":@r", always add a
2115 <CR> to the last line, also when the register is not
2116 linewise. If this flag is not present, the register
2117 is not linewise and the last line does not end in a
2118 <CR>, then the last line is put on the command-line
2119 and can be edited before hitting <CR>.
2120 *cpo-E*
2121 E It is an error when using "y", "d", "c", "g~", "gu" or
2122 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002123 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 This makes "y0" fail in the first column.
2125 *cpo-f*
2126 f When included, a ":read" command with a file name
2127 argument will set the file name for the current buffer,
2128 if the current buffer doesn't have a file name yet.
2129 *cpo-F*
2130 F When included, a ":write" command with a file name
2131 argument will set the file name for the current
2132 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002133 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 *cpo-g*
2135 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002136 *cpo-H*
2137 H When using "I" on a line with only blanks, insert
2138 before the last blank. Without this flag insert after
2139 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 *cpo-i*
2141 i When included, interrupting the reading of a file will
2142 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002143 *cpo-I*
2144 I When moving the cursor up or down just after inserting
2145 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-j*
2147 j When joining lines, only add two spaces after a '.',
2148 not after '!' or '?'. Also see 'joinspaces'.
2149 *cpo-J*
2150 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002151 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 white space.
2153 *cpo-k*
2154 k Disable the recognition of raw key codes in
2155 mappings, abbreviations, and the "to" part of menu
2156 commands. For example, if <Key> sends ^[OA (where ^[
2157 is <Esc>), the command ":map X ^[OA" results in X
2158 being mapped to:
2159 'k' included: "^[OA" (3 characters)
2160 'k' excluded: "<Key>" (one key code)
2161 Also see the '<' flag below.
2162 *cpo-K*
2163 K Don't wait for a key code to complete when it is
2164 halfway a mapping. This breaks mapping <F1><F1> when
2165 only part of the second <F1> has been read. It
2166 enables cancelling the mapping by typing <F1><Esc>.
2167 *cpo-l*
2168 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002169 literally, only "\]", "\^", "\-" and "\\" are special.
2170 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2172 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002173 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 *cpo-L*
2175 L When the 'list' option is set, 'wrapmargin',
2176 'textwidth', 'softtabstop' and Virtual Replace mode
2177 (see |gR|) count a <Tab> as two characters, instead of
2178 the normal behavior of a <Tab>.
2179 *cpo-m*
2180 m When included, a showmatch will always wait half a
2181 second. When not included, a showmatch will wait half
2182 a second or until a character is typed. |'showmatch'|
2183 *cpo-M*
2184 M When excluded, "%" matching will take backslashes into
2185 account. Thus in "( \( )" and "\( ( \)" the outer
2186 parenthesis match. When included "%" ignores
2187 backslashes, which is Vi compatible.
2188 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002189 n When included, the column used for 'number' and
2190 'relativenumber' will also be used for text of wrapped
2191 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 *cpo-o*
2193 o Line offset to search command is not remembered for
2194 next search.
2195 *cpo-O*
2196 O Don't complain if a file is being overwritten, even
2197 when it didn't exist when editing it. This is a
2198 protection against a file unexpectedly created by
2199 someone else. Vi didn't complain about this.
2200 *cpo-p*
2201 p Vi compatible Lisp indenting. When not present, a
2202 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002203 *cpo-P*
2204 P When included, a ":write" command that appends to a
2205 file will set the file name for the current buffer, if
2206 the current buffer doesn't have a file name yet and
2207 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002208 *cpo-q*
2209 q When joining multiple lines leave the cursor at the
2210 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 *cpo-r*
2212 r Redo ("." command) uses "/" to repeat a search
2213 command, instead of the actually used search string.
2214 *cpo-R*
2215 R Remove marks from filtered lines. Without this flag
2216 marks are kept like |:keepmarks| was used.
2217 *cpo-s*
2218 s Set buffer options when entering the buffer for the
2219 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002220 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 set when the buffer is created.
2222 *cpo-S*
2223 S Set buffer options always when entering a buffer
2224 (except 'readonly', 'fileformat', 'filetype' and
2225 'syntax'). This is the (most) Vi compatible setting.
2226 The options are set to the values in the current
2227 buffer. When you change an option and go to another
2228 buffer, the value is copied. Effectively makes the
2229 buffer options global to all buffers.
2230
2231 's' 'S' copy buffer options
2232 no no when buffer created
2233 yes no when buffer first entered (default)
2234 X yes each time when buffer entered (vi comp.)
2235 *cpo-t*
2236 t Search pattern for the tag command is remembered for
2237 "n" command. Otherwise Vim only puts the pattern in
2238 the history for search pattern, but doesn't change the
2239 last used search pattern.
2240 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002241 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 *cpo-v*
2243 v Backspaced characters remain visible on the screen in
2244 Insert mode. Without this flag the characters are
2245 erased from the screen right away. With this flag the
2246 screen newly typed text overwrites backspaced
2247 characters.
2248 *cpo-w*
2249 w When using "cw" on a blank character, only change one
2250 character and not all blanks until the start of the
2251 next word.
2252 *cpo-W*
2253 W Don't overwrite a readonly file. When omitted, ":w!"
2254 overwrites a readonly file, if possible.
2255 *cpo-x*
2256 x <Esc> on the command-line executes the command-line.
2257 The default in Vim is to abandon the command-line,
2258 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002259 *cpo-X*
2260 X When using a count with "R" the replaced text is
2261 deleted only once. Also when repeating "R" with "."
2262 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263 *cpo-y*
2264 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002265 *cpo-Z*
2266 Z When using "w!" while the 'readonly' option is set,
2267 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 *cpo-!*
2269 ! When redoing a filter command, use the last used
2270 external command, whatever it was. Otherwise the last
2271 used -filter- command is used.
2272 *cpo-$*
2273 $ When making a change to one line, don't redisplay the
2274 line, but put a '$' at the end of the changed text.
2275 The changed text will be overwritten when you type the
2276 new text. The line is redisplayed if you type any
2277 command that moves the cursor from the insertion
2278 point.
2279 *cpo-%*
2280 % Vi-compatible matching is done for the "%" command.
2281 Does not recognize "#if", "#endif", etc.
2282 Does not recognize "/*" and "*/".
2283 Parens inside single and double quotes are also
2284 counted, causing a string that contains a paren to
2285 disturb the matching. For example, in a line like
2286 "if (strcmp("foo(", s))" the first paren does not
2287 match the last one. When this flag is not included,
2288 parens inside single and double quotes are treated
2289 specially. When matching a paren outside of quotes,
2290 everything inside quotes is ignored. When matching a
2291 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002292 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002293 This flag is also used for other features, such as
2294 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002295 *cpo--*
2296 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002297 it would go above the first line or below the last
2298 line. Without it the cursor moves to the first or
2299 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002300 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002301 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002302 *cpo-+*
2303 + When included, a ":write file" command will reset the
2304 'modified' flag of the buffer, even though the buffer
2305 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002306 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 * Use ":*" in the same way as ":@". When not included,
2308 ":*" is an alias for ":'<,'>", select the Visual area.
2309 *cpo-<*
2310 < Disable the recognition of special key codes in |<>|
2311 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002312 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 ":map X <Tab>" results in X being mapped to:
2314 '<' included: "<Tab>" (5 characters)
2315 '<' excluded: "^I" (^I is a real <Tab>)
2316 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317 *cpo->*
2318 > When appending to a register, put a line break before
2319 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002320 *cpo-;*
2321 ; When using |,| or |;| to repeat the last |t| search
2322 and the cursor is right in front of the searched
2323 character, the cursor won't move. When not included,
2324 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002325 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002326
2327 POSIX flags. These are not included in the Vi default value, except
2328 when $VIM_POSIX was set on startup. |posix|
2329
2330 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002331 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002332 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002333 *cpo-&*
2334 & When ":preserve" was used keep the swap file when
2335 exiting normally while this buffer is still loaded.
2336 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002337 *cpo-\*
2338 \ Backslash in a [] range in a search pattern is taken
2339 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002340 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2341 '\' excluded: "/[ \-]" finds <Space> and '-'
2342 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002343 *cpo-/*
2344 / When "%" is used as the replacement string in a |:s|
2345 command, use the previous replacement string. |:s%|
2346 *cpo-{*
2347 { The |{| and |}| commands also stop at a "{" character
2348 at the start of a line.
2349 *cpo-.*
2350 . The ":chdir" and ":cd" commands fail if the current
2351 buffer is modified, unless ! is used. Vim doesn't
2352 need this, since it remembers the full path of an
2353 opened file.
2354 *cpo-bar*
2355 | The value of the $LINES and $COLUMNS environment
2356 variables overrule the terminal size values obtained
2357 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002358
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002360 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002361'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002362 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002363 {not in Vi}
2364 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002365 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002366 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002367 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002368 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002369 blowfish Blowfish method. Medium strong encryption but it has
2370 an implementation flaw. Requires Vim 7.3 or later,
2371 files can NOT be read by Vim 7.2 and older. This adds
2372 a "seed" to the file, every time you write the file
2373 the encrypted bytes will be different.
2374 *blowfish2*
2375 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002376 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002377 and older. This adds a "seed" to the file, every time
2378 you write the file the encrypted bytes will be
2379 different. The whole undo file is encrypted, not just
2380 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002381
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002382 You should use "blowfish2", also to re-encrypt older files.
2383
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002384 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002385 to the detected method of the file being read. Thus if you write it
2386 without changing 'cryptmethod' the same method will be used.
2387 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002388 explicitly write it, you don't get a warning unless there are other
2389 modifications. Also see |:X|.
2390
2391 When setting the global value to an empty string, it will end up with
2392 the value "zip". When setting the local value to an empty string the
2393 buffer will use the global value.
2394
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002395 When a new encryption method is added in a later version of Vim, and
2396 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002397 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002398
2399
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 *'cscopepathcomp'* *'cspc'*
2401'cscopepathcomp' 'cspc' number (default 0)
2402 global
2403 {not available when compiled without the |+cscope|
2404 feature}
2405 {not in Vi}
2406 Determines how many components of the path to show in a list of tags.
2407 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002408 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409
2410 *'cscopeprg'* *'csprg'*
2411'cscopeprg' 'csprg' string (default "cscope")
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
2415 {not in Vi}
2416 Specifies the command to execute cscope. See |cscopeprg|.
2417 This option cannot be set from a |modeline| or in the |sandbox|, for
2418 security reasons.
2419
2420 *'cscopequickfix'* *'csqf'*
2421'cscopequickfix' 'csqf' string (default "")
2422 global
2423 {not available when compiled without the |+cscope|
2424 or |+quickfix| features}
2425 {not in Vi}
2426 Specifies whether to use quickfix window to show cscope results.
2427 See |cscopequickfix|.
2428
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002429 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002430'cscoperelative' 'csre' boolean (default off)
2431 global
2432 {not available when compiled without the |+cscope|
2433 feature}
2434 {not in Vi}
2435 In the absence of a prefix (-P) for cscope. setting this option enables
2436 to use the basename of cscope.out path as the prefix.
2437 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002438 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002439
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2441'cscopetag' 'cst' boolean (default off)
2442 global
2443 {not available when compiled without the |+cscope|
2444 feature}
2445 {not in Vi}
2446 Use cscope for tag commands. See |cscope-options|.
2447 NOTE: This option is reset when 'compatible' is set.
2448
2449 *'cscopetagorder'* *'csto'*
2450'cscopetagorder' 'csto' number (default 0)
2451 global
2452 {not available when compiled without the |+cscope|
2453 feature}
2454 {not in Vi}
2455 Determines the order in which ":cstag" performs a search. See
2456 |cscopetagorder|.
2457 NOTE: This option is set to 0 when 'compatible' is set.
2458
2459 *'cscopeverbose'* *'csverb'*
2460 *'nocscopeverbose'* *'nocsverb'*
2461'cscopeverbose' 'csverb' boolean (default off)
2462 global
2463 {not available when compiled without the |+cscope|
2464 feature}
2465 {not in Vi}
2466 Give messages when adding a cscope database. See |cscopeverbose|.
2467 NOTE: This option is reset when 'compatible' is set.
2468
Bram Moolenaar860cae12010-06-05 23:22:07 +02002469 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2470'cursorbind' 'crb' boolean (default off)
2471 local to window
2472 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002473 When this option is set, as the cursor in the current
2474 window moves other cursorbound windows (windows that also have
2475 this option set) move their cursors to the corresponding line and
2476 column. This option is useful for viewing the
2477 differences between two versions of a file (see 'diff'); in diff mode,
2478 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002479 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002480
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002481
2482 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2483'cursorcolumn' 'cuc' boolean (default off)
2484 local to window
2485 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002486 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002487 feature}
2488 Highlight the screen column of the cursor with CursorColumn
2489 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2490 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002491 If you only want the highlighting in the current window you can use
2492 these autocommands: >
2493 au WinLeave * set nocursorline nocursorcolumn
2494 au WinEnter * set cursorline cursorcolumn
2495<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002496
2497 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2498'cursorline' 'cul' boolean (default off)
2499 local to window
2500 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002501 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002502 feature}
2503 Highlight the screen line of the cursor with CursorLine
2504 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2505 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002506 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002507 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002508
2509
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 *'debug'*
2511'debug' string (default "")
2512 global
2513 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002514 These values can be used:
2515 msg Error messages that would otherwise be omitted will be given
2516 anyway.
2517 throw Error messages that would otherwise be omitted will be given
2518 anyway and also throw an exception and set |v:errmsg|.
2519 beep A message will be given when otherwise only a beep would be
2520 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002521 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002522 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2523 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'define'* *'def'*
2526'define' 'def' string (default "^\s*#\s*define")
2527 global or local to buffer |global-local|
2528 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002529 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530 pattern, just like for the "/" command. This option is used for the
2531 commands like "[i" and "[d" |include-search|. The 'isident' option is
2532 used to recognize the defined name after the match:
2533 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2534 See |option-backslash| about inserting backslashes to include a space
2535 or backslash.
2536 The default value is for C programs. For C++ this value would be
2537 useful, to include const type declarations: >
2538 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2539< When using the ":set" command, you need to double the backslashes!
2540
2541 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2542'delcombine' 'deco' boolean (default off)
2543 global
2544 {not in Vi}
2545 {only available when compiled with the |+multi_byte|
2546 feature}
2547 If editing Unicode and this option is set, backspace and Normal mode
2548 "x" delete each combining character on its own. When it is off (the
2549 default) the character along with its combining characters are
2550 deleted.
2551 Note: When 'delcombine' is set "xx" may work different from "2x"!
2552
2553 This is useful for Arabic, Hebrew and many other languages where one
2554 may have combining characters overtop of base characters, and want
2555 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002556 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557
2558 *'dictionary'* *'dict'*
2559'dictionary' 'dict' string (default "")
2560 global or local to buffer |global-local|
2561 {not in Vi}
2562 List of file names, separated by commas, that are used to lookup words
2563 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2564 contain a list of words. This can be one word per line, or several
2565 words per line, separated by non-keyword characters (white space is
2566 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002567
2568 When this option is empty or an entry "spell" is present, and spell
2569 checking is enabled, words in the word lists for the currently active
2570 'spelllang' are used. See |spell|.
2571
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 after a comma are ignored, otherwise spaces are included in the file
2574 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002575 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Where to find a list of words?
2577 - On FreeBSD, there is the file "/usr/share/dict/words".
2578 - In the Simtel archive, look in the "msdos/linguist" directory.
2579 - In "miscfiles" of the GNU collection.
2580 The use of |:set+=| and |:set-=| is preferred when adding or removing
2581 directories from the list. This avoids problems when a future version
2582 uses another default.
2583 Backticks cannot be used in this option for security reasons.
2584
2585 *'diff'* *'nodiff'*
2586'diff' boolean (default off)
2587 local to window
2588 {not in Vi}
2589 {not available when compiled without the |+diff|
2590 feature}
2591 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002592 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 *'dex'* *'diffexpr'*
2595'diffexpr' 'dex' string (default "")
2596 global
2597 {not in Vi}
2598 {not available when compiled without the |+diff|
2599 feature}
2600 Expression which is evaluated to obtain an ed-style diff file from two
2601 versions of a file. See |diff-diffexpr|.
2602 This option cannot be set from a |modeline| or in the |sandbox|, for
2603 security reasons.
2604
2605 *'dip'* *'diffopt'*
2606'diffopt' 'dip' string (default "filler")
2607 global
2608 {not in Vi}
2609 {not available when compiled without the |+diff|
2610 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002611 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 All are optional. Items must be separated by a comma.
2613
2614 filler Show filler lines, to keep the text
2615 synchronized with a window that has inserted
2616 lines at the same position. Mostly useful
2617 when windows are side-by-side and 'scrollbind'
2618 is set.
2619
2620 context:{n} Use a context of {n} lines between a change
2621 and a fold that contains unchanged lines.
2622 When omitted a context of six lines is used.
2623 See |fold-diff|.
2624
2625 icase Ignore changes in case of text. "a" and "A"
2626 are considered the same. Adds the "-i" flag
2627 to the "diff" command if 'diffexpr' is empty.
2628
2629 iwhite Ignore changes in amount of white space. Adds
2630 the "-b" flag to the "diff" command if
2631 'diffexpr' is empty. Check the documentation
2632 of the "diff" command for what this does
2633 exactly. It should ignore adding trailing
2634 white space, but not leading white space.
2635
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002636 horizontal Start diff mode with horizontal splits (unless
2637 explicitly specified otherwise).
2638
2639 vertical Start diff mode with vertical splits (unless
2640 explicitly specified otherwise).
2641
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002642 hiddenoff Do not use diff mode for a buffer when it
2643 becomes hidden.
2644
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002645 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2646 starting diff mode. Without this 2 is used.
2647
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 Examples: >
2649
2650 :set diffopt=filler,context:4
2651 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002652 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653<
2654 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2655'digraph' 'dg' boolean (default off)
2656 global
2657 {not in Vi}
2658 {not available when compiled without the |+digraphs|
2659 feature}
2660 Enable the entering of digraphs in Insert mode with {char1} <BS>
2661 {char2}. See |digraphs|.
2662 NOTE: This option is reset when 'compatible' is set.
2663
2664 *'directory'* *'dir'*
2665'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002666 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 for Unix: ".,~/tmp,/var/tmp,/tmp")
2668 global
2669 List of directory names for the swap file, separated with commas.
2670 - The swap file will be created in the first directory where this is
2671 possible.
2672 - Empty means that no swap file will be used (recovery is
2673 impossible!).
2674 - A directory "." means to put the swap file in the same directory as
2675 the edited file. On Unix, a dot is prepended to the file name, so
2676 it doesn't show in a directory listing. On MS-Windows the "hidden"
2677 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002678 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 put the swap file relative to where the edited file is. The leading
2680 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002681 - For Unix and Win32, if a directory ends in two path separators "//"
2682 or "\\", the swap file name will be built from the complete path to
2683 the file with all path separators substituted to percent '%' signs.
2684 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002685 On Win32, when a separating comma is following, you must use "//",
2686 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 - Spaces after the comma are ignored, other spaces are considered part
2688 of the directory name. To have a space at the start of a directory
2689 name, precede it with a backslash.
2690 - To include a comma in a directory name precede it with a backslash.
2691 - A directory name may end in an ':' or '/'.
2692 - Environment variables are expanded |:set_env|.
2693 - Careful with '\' characters, type one before a space, type two to
2694 get one in the option (see |option-backslash|), for example: >
2695 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2696< - For backwards compatibility with Vim version 3.0 a '>' at the start
2697 of the option is removed.
2698 Using "." first in the list is recommended. This means that editing
2699 the same file twice will result in a warning. Using "/tmp" on Unix is
2700 discouraged: When the system crashes you lose the swap file.
2701 "/var/tmp" is often not cleared when rebooting, thus is a better
2702 choice than "/tmp". But it can contain a lot of files, your swap
2703 files get lost in the crowd. That is why a "tmp" directory in your
2704 home directory is tried first.
2705 The use of |:set+=| and |:set-=| is preferred when adding or removing
2706 directories from the list. This avoids problems when a future version
2707 uses another default.
2708 This option cannot be set from a |modeline| or in the |sandbox|, for
2709 security reasons.
2710 {Vi: directory to put temp file in, defaults to "/tmp"}
2711
2712 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002713'display' 'dy' string (default "", set to "truncate" in
2714 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 global
2716 {not in Vi}
2717 Change the way text is displayed. This is comma separated list of
2718 flags:
2719 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002720 in a window will be displayed. "@@@" is put in the
2721 last columns of the last screen line to indicate the
2722 rest of the line is not displayed.
2723 truncate Like "lastline", but "@@@" is displayed in the first
2724 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 uhex Show unprintable characters hexadecimal as <xx>
2726 instead of using ^C and ~C.
2727
Bram Moolenaard0796902016-09-16 20:02:31 +02002728 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002729 doesn't fit is replaced with "@" lines.
2730
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 *'eadirection'* *'ead'*
2732'eadirection' 'ead' string (default "both")
2733 global
2734 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002735 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 feature}
2737 Tells when the 'equalalways' option applies:
2738 ver vertically, width of windows is not affected
2739 hor horizontally, height of windows is not affected
2740 both width and height of windows is affected
2741
2742 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2743'edcompatible' 'ed' boolean (default off)
2744 global
2745 Makes the 'g' and 'c' flags of the ":substitute" command to be
2746 toggled each time the flag is given. See |complex-change|. See
2747 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002748 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749
Bram Moolenaar03413f42016-04-12 21:07:15 +02002750 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002751'emoji' 'emo' boolean (default: on)
2752 global
2753 {not in Vi}
2754 {only available when compiled with the |+multi_byte|
2755 feature}
2756 When on all Unicode emoji characters are considered to be full width.
2757
2758
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 *'encoding'* *'enc'* *E543*
2760'encoding' 'enc' string (default: "latin1" or value from $LANG)
2761 global
2762 {only available when compiled with the |+multi_byte|
2763 feature}
2764 {not in Vi}
2765 Sets the character encoding used inside Vim. It applies to text in
2766 the buffers, registers, Strings in expressions, text stored in the
2767 viminfo file, etc. It sets the kind of characters which Vim can work
2768 with. See |encoding-names| for the possible values.
2769
2770 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002771 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002773 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774
Bram Moolenaar865242e2010-07-14 21:12:05 +02002775 This option cannot be set from a |modeline|. It would most likely
2776 corrupt the text.
2777
Bram Moolenaar3df01732017-02-17 22:47:16 +01002778 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2779 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 'encoding', "utf-8" is the natural choice for the environment and
2781 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 versions, and to avoid changing the encoding of newly created files
2784 without your knowledge (in case 'fileencodings' is empty).
2785
2786 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002787 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 iconv() or as specified with 'charconvert'.
2789
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002790 If you need to know whether 'encoding' is a multi-byte encoding, you
2791 can use: >
2792 if has("multi_byte_encoding")
2793<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 Normally 'encoding' will be equal to your current locale. This will
2795 be the default if Vim recognizes your environment settings. If
2796 'encoding' is not set to the current locale, 'termencoding' must be
2797 set to convert typed and displayed text. See |encoding-table|.
2798
2799 When you set this option, it fires the |EncodingChanged| autocommand
2800 event so that you can set up fonts if necessary.
2801
2802 When the option is set, the value is converted to lowercase. Thus
2803 you can set it with uppercase values too. Underscores are translated
2804 to '-' signs.
2805 When the encoding is recognized, it is changed to the standard name.
2806 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2807 "iso-8859-2" and "utf8" becomes "utf-8".
2808
2809 Note: "latin1" is also used when the encoding could not be detected.
2810 This only works when editing files in the same encoding! When the
2811 actual character set is not latin1, make sure 'fileencoding' and
2812 'fileencodings' are empty. When conversion is needed, switch to using
2813 utf-8.
2814
2815 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2816 You don't notice this while editing, but it does matter for the
2817 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2818 setting 'encoding' to one of these values instead of utf-8 only has
2819 effect for encoding used for files when 'fileencoding' is empty.
2820
Bram Moolenaar661b1822005-07-28 22:36:45 +00002821 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2822 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823
2824 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2825'endofline' 'eol' boolean (default on)
2826 local to buffer
2827 {not in Vi}
2828 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002829 is on, or 'fixeol' option is off, no <EOL> will be written for the
2830 last line in the file. This option is automatically set or reset when
2831 starting to edit a new file, depending on whether file has an <EOL>
2832 for the last line in the file. Normally you don't have to set or
2833 reset this option.
2834 When 'binary' is off and 'fixeol' is on the value is not used when
2835 writing the file. When 'binary' is on or 'fixeol' is off it is used
2836 to remember the presence of a <EOL> for the last line in the file, so
2837 that when you write the file the situation from the original file can
2838 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839
2840 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2841'equalalways' 'ea' boolean (default on)
2842 global
2843 {not in Vi}
2844 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002845 splitting or closing a window. This also happens the moment the
2846 option is switched on. When off, splitting a window will reduce the
2847 size of the current window and leave the other windows the same. When
2848 closing a window the extra lines are given to the window next to it
2849 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 When mixing vertically and horizontally split windows, a minimal size
2851 is computed and some windows may be larger if there is room. The
2852 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002853 Changing the height and width of a window can be avoided by setting
2854 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002855 If a window size is specified when creating a new window sizes are
2856 currently not equalized (it's complicated, but may be implemented in
2857 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858
2859 *'equalprg'* *'ep'*
2860'equalprg' 'ep' string (default "")
2861 global or local to buffer |global-local|
2862 {not in Vi}
2863 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002864 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002865 or 'indentexpr'. When Vim was compiled without internal formatting,
2866 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002867 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 about including spaces and backslashes.
2869 This option cannot be set from a |modeline| or in the |sandbox|, for
2870 security reasons.
2871
2872 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2873'errorbells' 'eb' boolean (default off)
2874 global
2875 Ring the bell (beep or screen flash) for error messages. This only
2876 makes a difference for error messages, the bell will be used always
2877 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002878 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002879 screen flash or do nothing. See 'belloff' to finetune when to ring the
2880 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881
2882 *'errorfile'* *'ef'*
2883'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2884 others: "errors.err")
2885 global
2886 {not in Vi}
2887 {not available when compiled without the |+quickfix|
2888 feature}
2889 Name of the errorfile for the QuickFix mode (see |:cf|).
2890 When the "-q" command-line argument is used, 'errorfile' is set to the
2891 following argument. See |-q|.
2892 NOT used for the ":make" command. See 'makeef' for that.
2893 Environment variables are expanded |:set_env|.
2894 See |option-backslash| about including spaces and backslashes.
2895 This option cannot be set from a |modeline| or in the |sandbox|, for
2896 security reasons.
2897
2898 *'errorformat'* *'efm'*
2899'errorformat' 'efm' string (default is very long)
2900 global or local to buffer |global-local|
2901 {not in Vi}
2902 {not available when compiled without the |+quickfix|
2903 feature}
2904 Scanf-like description of the format for the lines in the error file
2905 (see |errorformat|).
2906
2907 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2908'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2909 global
2910 {not in Vi}
2911 Function keys that start with an <Esc> are recognized in Insert
2912 mode. When this option is off, the cursor and function keys cannot be
2913 used in Insert mode if they start with an <Esc>. The advantage of
2914 this is that the single <Esc> is recognized immediately, instead of
2915 after one second. Instead of resetting this option, you might want to
2916 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2917 when 'esckeys' is off, you can still map anything, but the cursor keys
2918 won't work by default.
2919 NOTE: This option is set to the Vi default value when 'compatible' is
2920 set and to the Vim default value when 'compatible' is reset.
2921
2922 *'eventignore'* *'ei'*
2923'eventignore' 'ei' string (default "")
2924 global
2925 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002927 When set to "all" or when "all" is one of the items, all autocommand
2928 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 Otherwise this is a comma separated list of event names. Example: >
2930 :set ei=WinEnter,WinLeave
2931<
2932 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2933'expandtab' 'et' boolean (default off)
2934 local to buffer
2935 {not in Vi}
2936 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002937 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2939 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002940 This option is reset when the 'paste' option is set and restored when
2941 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 NOTE: This option is reset when 'compatible' is set.
2943
2944 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2945'exrc' 'ex' boolean (default off)
2946 global
2947 {not in Vi}
2948 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002949 directory.
2950
2951 Setting this option is a potential security leak. E.g., consider
2952 unpacking a package or fetching files from github, a .vimrc in there
2953 might be a trojan horse. BETTER NOT SET THIS OPTION!
2954 Instead, define an autocommand in your .vimrc to set options for a
2955 matching directory.
2956
2957 If you do switch this option on you should also consider setting the
2958 'secure' option (see |initialization|).
2959 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 This option cannot be set from a |modeline| or in the |sandbox|, for
2961 security reasons.
2962
2963 *'fileencoding'* *'fenc'* *E213*
2964'fileencoding' 'fenc' string (default: "")
2965 local to buffer
2966 {only available when compiled with the |+multi_byte|
2967 feature}
2968 {not in Vi}
2969 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002972 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When 'fileencoding' is empty, the same value as 'encoding' will be
2974 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002975 No error will be given when the value is set, only when it is used,
2976 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002977 Conversion will also be done when 'encoding' and 'fileencoding' are
2978 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2979 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002981 'encoding' is "utf-8" or another Unicode encoding, conversion
2982 is most likely done in a way that the reverse conversion
2983 results in the same text. When 'encoding' is not "utf-8" some
2984 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002985
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 See 'encoding' for the possible values. Additionally, values may be
2987 specified that can be handled by the converter, see
2988 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 When reading a file 'fileencoding' will be set from 'fileencodings'.
2991 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002992 'fileencoding', use the |++enc| argument. One exception: when
2993 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002994 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002995
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2997 When the option is set, the value is converted to lowercase. Thus
2998 you can set it with uppercase values too. '_' characters are
2999 replaced with '-'. If a name is recognized from the list for
3000 'encoding', it is replaced by the standard name. For example
3001 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003002
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 When this option is set, after starting to edit a file, the 'modified'
3004 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003005
3006 Keep in mind that changing 'fenc' from a modeline happens
3007 AFTER the text has been read, thus it applies to when the file will be
3008 written. If you do set 'fenc' in a modeline, you might want to set
3009 'nomodified' to avoid not being able to ":q".
3010
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 This option can not be changed when 'modifiable' is off.
3012
3013 *'fe'*
3014 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 old short name was 'fe', which is no longer used.
3017
3018 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003019'fileencodings' 'fencs' string (default: "ucs-bom",
3020 "ucs-bom,utf-8,default,latin1" when
3021 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 global
3023 {only available when compiled with the |+multi_byte|
3024 feature}
3025 {not in Vi}
3026 This is a list of character encodings considered when starting to edit
3027 an existing file. When a file is read, Vim tries to use the first
3028 mentioned character encoding. If an error is detected, the next one
3029 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003030 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 an empty string, which means the value of 'encoding' is used.
3032 WARNING: Conversion can cause loss of information! When
3033 'encoding' is "utf-8" (or one of the other Unicode variants)
3034 conversion is most likely done in a way that the reverse
3035 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003036 "utf-8" some non-ASCII characters may be lost! You can use
3037 the |++bad| argument to specify what is done with characters
3038 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 For an empty file or a file with only ASCII characters most encodings
3040 will work and the first entry of 'fileencodings' will be used (except
3041 "ucs-bom", which requires the BOM to be present). If you prefer
3042 another encoding use an BufReadPost autocommand event to test if your
3043 preferred encoding is to be used. Example: >
3044 au BufReadPost * if search('\S', 'w') == 0 |
3045 \ set fenc=iso-2022-jp | endif
3046< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3047 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003048 When the |++enc| argument is used then the value of 'fileencodings' is
3049 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003050 Note that 'fileencodings' is not used for a new file, the global value
3051 of 'fileencoding' is used instead. You can set it with: >
3052 :setglobal fenc=iso-8859-2
3053< This means that a non-existing file may get a different encoding than
3054 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 The special value "ucs-bom" can be used to check for a Unicode BOM
3056 (Byte Order Mark) at the start of the file. It must not be preceded
3057 by "utf-8" or another Unicode encoding for this to work properly.
3058 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3059 because Vim cannot detect an error, thus the encoding is always
3060 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003061 The special value "default" can be used for the encoding from the
3062 environment. This is the default value for 'encoding'. It is useful
3063 when 'encoding' is set to "utf-8" and your environment uses a
3064 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003065 When 'encoding' is "utf-8" and a file contains an illegal byte
3066 sequence it won't be recognized as UTF-8. You can use the |8g8|
3067 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 WRONG VALUES: WHAT'S WRONG:
3069 latin1,utf-8 "latin1" will always be used
3070 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3071 file
3072 cp1250,latin1 "cp1250" will always be used
3073 If 'fileencodings' is empty, 'fileencoding' is not modified.
3074 See 'fileencoding' for the possible values.
3075 Setting this option does not have an effect until the next time a file
3076 is read.
3077
3078 *'fileformat'* *'ff'*
3079'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3080 Unix default: "unix",
3081 Macintosh default: "mac")
3082 local to buffer
3083 {not in Vi}
3084 This gives the <EOL> of the current buffer, which is used for
3085 reading/writing the buffer from/to a file:
3086 dos <CR> <NL>
3087 unix <NL>
3088 mac <CR>
3089 When "dos" is used, CTRL-Z at the end of a file is ignored.
3090 See |file-formats| and |file-read|.
3091 For the character encoding of the file see 'fileencoding'.
3092 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003093 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 This option is set automatically when starting to edit a file and
3095 'fileformats' is not empty and 'binary' is off.
3096 When this option is set, after starting to edit a file, the 'modified'
3097 option is set, because the file would be different when written.
3098 This option can not be changed when 'modifiable' is off.
3099 For backwards compatibility: When this option is set to "dos",
3100 'textmode' is set, otherwise 'textmode' is reset.
3101
3102 *'fileformats'* *'ffs'*
3103'fileformats' 'ffs' string (default:
3104 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3105 Vim Unix: "unix,dos",
3106 Vim Mac: "mac,unix,dos",
3107 Vi Cygwin: "unix,dos",
3108 Vi others: "")
3109 global
3110 {not in Vi}
3111 This gives the end-of-line (<EOL>) formats that will be tried when
3112 starting to edit a new buffer and when reading a file into an existing
3113 buffer:
3114 - When empty, the format defined with 'fileformat' will be used
3115 always. It is not set automatically.
3116 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003117 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 'fileformats' name will be used when a file is read into an existing
3119 buffer, no matter what 'fileformat' for that buffer is set to.
3120 - When more than one name is present, separated by commas, automatic
3121 <EOL> detection will be done when reading a file. When starting to
3122 edit a file, a check is done for the <EOL>:
3123 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3124 'fileformat' is set to "dos".
3125 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003126 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003128 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3129 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003130 This means that "mac" is only chosen when:
3131 "unix" is not present or no <NL> is found in the file, and
3132 "dos" is not present or no <CR><NL> is found in the file.
3133 Except: if "unix" was chosen, but there is a <CR> before
3134 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003135 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 4. If 'fileformat' is still not set, the first name from
3137 'fileformats' is used.
3138 When reading a file into an existing buffer, the same is done, but
3139 this happens like 'fileformat' has been set appropriately for that
3140 file only, the option is not changed.
3141 When 'binary' is set, the value of 'fileformats' is not used.
3142
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003143 When Vim starts up with an empty buffer the first item is used. You
3144 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003145
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3147 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3148 done:
3149 - When 'fileformats' is empty, there is no automatic detection. Dos
3150 format will be used.
3151 - When 'fileformats' is set to one or more names, automatic detection
3152 is done. This is based on the first <NL> in the file: If there is a
3153 <CR> in front of it, Dos format is used, otherwise Unix format is
3154 used.
3155 Also see |file-formats|.
3156 For backwards compatibility: When this option is set to an empty
3157 string or one format (no comma is included), 'textauto' is reset,
3158 otherwise 'textauto' is set.
3159 NOTE: This option is set to the Vi default value when 'compatible' is
3160 set and to the Vim default value when 'compatible' is reset.
3161
Bram Moolenaarbf884932013-04-05 22:26:15 +02003162 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3163'fileignorecase' 'fic' boolean (default on for systems where case in file
3164 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003165 global
3166 {not in Vi}
3167 When set case is ignored when using file names and directories.
3168 See 'wildignorecase' for only ignoring case when doing completion.
3169
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 *'filetype'* *'ft'*
3171'filetype' 'ft' string (default: "")
3172 local to buffer
3173 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 When this option is set, the FileType autocommand event is triggered.
3175 All autocommands that match with the value of this option will be
3176 executed. Thus the value of 'filetype' is used in place of the file
3177 name.
3178 Otherwise this option does not always reflect the current file type.
3179 This option is normally set when the file type is detected. To enable
3180 this use the ":filetype on" command. |:filetype|
3181 Setting this option to a different value is most useful in a modeline,
3182 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003183 Example, for in an IDL file:
3184 /* vim: set filetype=idl : */ ~
3185 |FileType| |filetypes|
3186 When a dot appears in the value then this separates two filetype
3187 names. Example:
3188 /* vim: set filetype=c.doxygen : */ ~
3189 This will use the "c" filetype first, then the "doxygen" filetype.
3190 This works both for filetype plugins and for syntax files. More than
3191 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This option is not copied to another buffer, independent of the 's' or
3193 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003194 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195
3196 *'fillchars'* *'fcs'*
3197'fillchars' 'fcs' string (default "vert:|,fold:-")
3198 global
3199 {not in Vi}
3200 {not available when compiled without the |+windows|
3201 and |+folding| features}
3202 Characters to fill the statuslines and vertical separators.
3203 It is a comma separated list of items:
3204
3205 item default Used for ~
3206 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003207 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 vert:c '|' vertical separators |:vsplit|
3209 fold:c '-' filling 'foldtext'
3210 diff:c '-' deleted lines of the 'diff' option
3211
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003212 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003213 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 otherwise.
3215
3216 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003217 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218< This is similar to the default, except that these characters will also
3219 be used when there is highlighting.
3220
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003221 for "stl" and "stlnc" only single-byte values are supported.
3222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 The highlighting used for these items:
3224 item highlight group ~
3225 stl:c StatusLine |hl-StatusLine|
3226 stlnc:c StatusLineNC |hl-StatusLineNC|
3227 vert:c VertSplit |hl-VertSplit|
3228 fold:c Folded |hl-Folded|
3229 diff:c DiffDelete |hl-DiffDelete|
3230
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003231 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3232'fixendofline' 'fixeol' boolean (default on)
3233 local to buffer
3234 {not in Vi}
3235 When writing a file and this option is on, <EOL> at the end of file
3236 will be restored if missing. Turn this option off if you want to
3237 preserve the situation from the original file.
3238 When the 'binary' option is set the value of this option doesn't
3239 matter.
3240 See the 'endofline' option.
3241
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3243'fkmap' 'fk' boolean (default off) *E198*
3244 global
3245 {not in Vi}
3246 {only available when compiled with the |+rightleft|
3247 feature}
3248 When on, the keyboard is mapped for the Farsi character set.
3249 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003250 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251
3252 *'foldclose'* *'fcl'*
3253'foldclose' 'fcl' string (default "")
3254 global
3255 {not in Vi}
3256 {not available when compiled without the |+folding|
3257 feature}
3258 When set to "all", a fold is closed when the cursor isn't in it and
3259 its level is higher than 'foldlevel'. Useful if you want folds to
3260 automatically close when moving out of them.
3261
3262 *'foldcolumn'* *'fdc'*
3263'foldcolumn' 'fdc' number (default 0)
3264 local to window
3265 {not in Vi}
3266 {not available when compiled without the |+folding|
3267 feature}
3268 When non-zero, a column with the specified width is shown at the side
3269 of the window which indicates open and closed folds. The maximum
3270 value is 12.
3271 See |folding|.
3272
3273 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3274'foldenable' 'fen' boolean (default on)
3275 local to window
3276 {not in Vi}
3277 {not available when compiled without the |+folding|
3278 feature}
3279 When off, all folds are open. This option can be used to quickly
3280 switch between showing all text unfolded and viewing the text with
3281 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003282 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 'foldenable' is off.
3284 This option is set by commands that create a new fold or close a fold.
3285 See |folding|.
3286
3287 *'foldexpr'* *'fde'*
3288'foldexpr' 'fde' string (default: "0")
3289 local to window
3290 {not in Vi}
3291 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003292 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003294 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003295
Bram Moolenaar30b65812012-07-12 22:01:11 +02003296 The expression will be evaluated in the |sandbox| if set from a
3297 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003298 This option can't be set from a |modeline| when the 'diff' option is
3299 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003300
3301 It is not allowed to change text or jump to another window while
3302 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
3304 *'foldignore'* *'fdi'*
3305'foldignore' 'fdi' string (default: "#")
3306 local to window
3307 {not in Vi}
3308 {not available when compiled without the |+folding|
3309 feature}
3310 Used only when 'foldmethod' is "indent". Lines starting with
3311 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003312 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 The default "#" works well for C programs. See |fold-indent|.
3314
3315 *'foldlevel'* *'fdl'*
3316'foldlevel' 'fdl' number (default: 0)
3317 local to window
3318 {not in Vi}
3319 {not available when compiled without the |+folding|
3320 feature}
3321 Sets the fold level: Folds with a higher level will be closed.
3322 Setting this option to zero will close all folds. Higher numbers will
3323 close fewer folds.
3324 This option is set by commands like |zm|, |zM| and |zR|.
3325 See |fold-foldlevel|.
3326
3327 *'foldlevelstart'* *'fdls'*
3328'foldlevelstart' 'fdls' number (default: -1)
3329 global
3330 {not in Vi}
3331 {not available when compiled without the |+folding|
3332 feature}
3333 Sets 'foldlevel' when starting to edit another buffer in a window.
3334 Useful to always start editing with all folds closed (value zero),
3335 some folds closed (one) or no folds closed (99).
3336 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003337 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 ignores this option and closes all folds.
3339 It is also done before BufReadPre autocommands, to allow an autocmd to
3340 overrule the 'foldlevel' value for specific files.
3341 When the value is negative, it is not used.
3342
3343 *'foldmarker'* *'fmr'* *E536*
3344'foldmarker' 'fmr' string (default: "{{{,}}}")
3345 local to window
3346 {not in Vi}
3347 {not available when compiled without the |+folding|
3348 feature}
3349 The start and end marker used when 'foldmethod' is "marker". There
3350 must be one comma, which separates the start and end marker. The
3351 marker is a literal string (a regular expression would be too slow).
3352 See |fold-marker|.
3353
3354 *'foldmethod'* *'fdm'*
3355'foldmethod' 'fdm' string (default: "manual")
3356 local to window
3357 {not in Vi}
3358 {not available when compiled without the |+folding|
3359 feature}
3360 The kind of folding used for the current window. Possible values:
3361 |fold-manual| manual Folds are created manually.
3362 |fold-indent| indent Lines with equal indent form a fold.
3363 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3364 |fold-marker| marker Markers are used to specify folds.
3365 |fold-syntax| syntax Syntax highlighting items specify folds.
3366 |fold-diff| diff Fold text that is not changed.
3367
3368 *'foldminlines'* *'fml'*
3369'foldminlines' 'fml' number (default: 1)
3370 local to window
3371 {not in Vi}
3372 {not available when compiled without the |+folding|
3373 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003374 Sets the number of screen lines above which a fold can be displayed
3375 closed. Also for manually closed folds. With the default value of
3376 one a fold can only be closed if it takes up two or more screen lines.
3377 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003378 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 "zc" to close a fold, which is displayed open because it's smaller
3380 than 'foldminlines', a following "zc" may close a containing fold.
3381
3382 *'foldnestmax'* *'fdn'*
3383'foldnestmax' 'fdn' number (default: 20)
3384 local to window
3385 {not in Vi}
3386 {not available when compiled without the |+folding|
3387 feature}
3388 Sets the maximum nesting of folds for the "indent" and "syntax"
3389 methods. This avoids that too many folds will be created. Using more
3390 than 20 doesn't work, because the internal limit is 20.
3391
3392 *'foldopen'* *'fdo'*
3393'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3394 search,tag,undo")
3395 global
3396 {not in Vi}
3397 {not available when compiled without the |+folding|
3398 feature}
3399 Specifies for which type of commands folds will be opened, if the
3400 command moves the cursor into a closed fold. It is a comma separated
3401 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003402 NOTE: When the command is part of a mapping this option is not used.
3403 Add the |zv| command to the mapping to get the same effect.
3404 (rationale: the mapping may want to control opening folds itself)
3405
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 item commands ~
3407 all any
3408 block "(", "{", "[[", "[{", etc.
3409 hor horizontal movements: "l", "w", "fx", etc.
3410 insert any command in Insert mode
3411 jump far jumps: "G", "gg", etc.
3412 mark jumping to a mark: "'m", CTRL-O, etc.
3413 percent "%"
3414 quickfix ":cn", ":crew", ":make", etc.
3415 search search for a pattern: "/", "n", "*", "gd", etc.
3416 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003417 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 tag jumping to a tag: ":ta", CTRL-T, etc.
3419 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 When a movement command is used for an operator (e.g., "dl" or "y%")
3421 this option is not used. This means the operator will include the
3422 whole closed fold.
3423 Note that vertical movements are not here, because it would make it
3424 very difficult to move onto a closed fold.
3425 In insert mode the folds containing the cursor will always be open
3426 when text is inserted.
3427 To close folds you can re-apply 'foldlevel' with the |zx| command or
3428 set the 'foldclose' option to "all".
3429
3430 *'foldtext'* *'fdt'*
3431'foldtext' 'fdt' string (default: "foldtext()")
3432 local to window
3433 {not in Vi}
3434 {not available when compiled without the |+folding|
3435 feature}
3436 An expression which is used to specify the text displayed for a closed
3437 fold. See |fold-foldtext|.
3438
Bram Moolenaar30b65812012-07-12 22:01:11 +02003439 The expression will be evaluated in the |sandbox| if set from a
3440 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003441
3442 It is not allowed to change text or jump to another window while
3443 evaluating 'foldtext' |textlock|.
3444
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003445 *'formatexpr'* *'fex'*
3446'formatexpr' 'fex' string (default "")
3447 local to buffer
3448 {not in Vi}
3449 {not available when compiled without the |+eval|
3450 feature}
3451 Expression which is evaluated to format a range of lines for the |gq|
3452 operator or automatic formatting (see 'formatoptions'). When this
3453 option is empty 'formatprg' is used.
3454
3455 The |v:lnum| variable holds the first line to be formatted.
3456 The |v:count| variable holds the number of lines to be formatted.
3457 The |v:char| variable holds the character that is going to be
3458 inserted if the expression is being evaluated due to
3459 automatic formatting. This can be empty. Don't insert
3460 it yet!
3461
3462 Example: >
3463 :set formatexpr=mylang#Format()
3464< This will invoke the mylang#Format() function in the
3465 autoload/mylang.vim file in 'runtimepath'. |autoload|
3466
3467 The expression is also evaluated when 'textwidth' is set and adding
3468 text beyond that limit. This happens under the same conditions as
3469 when internal formatting is used. Make sure the cursor is kept in the
3470 same spot relative to the text then! The |mode()| function will
3471 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003472
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003473 When the expression evaluates to non-zero Vim will fall back to using
3474 the internal format mechanism.
3475
3476 The expression will be evaluated in the |sandbox| when set from a
3477 modeline, see |sandbox-option|. That stops the option from working,
3478 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003479 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003480
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 *'formatoptions'* *'fo'*
3482'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3483 local to buffer
3484 {not in Vi}
3485 This is a sequence of letters which describes how automatic
3486 formatting is to be done. See |fo-table|. When the 'paste' option is
3487 on, no formatting is done (like 'formatoptions' is empty). Commas can
3488 be inserted for readability.
3489 To avoid problems with flags that are added in the future, use the
3490 "+=" and "-=" feature of ":set" |add-option-flags|.
3491 NOTE: This option is set to the Vi default value when 'compatible' is
3492 set and to the Vim default value when 'compatible' is reset.
3493
Bram Moolenaar86b68352004-12-27 21:59:20 +00003494 *'formatlistpat'* *'flp'*
3495'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3496 local to buffer
3497 {not in Vi}
3498 A pattern that is used to recognize a list header. This is used for
3499 the "n" flag in 'formatoptions'.
3500 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003501 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003502 while still checking more characters. There must be a character
3503 following the pattern, when it matches the whole line it is handled
3504 like there is no match.
3505 The default recognizes a number, followed by an optional punctuation
3506 character and white space.
3507
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 *'formatprg'* *'fp'*
3509'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003510 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 {not in Vi}
3512 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003513 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003515 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003516 If the 'formatexpr' option is not empty it will be used instead.
3517 Otherwise, if 'formatprg' option is an empty string, the internal
3518 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003519 Environment variables are expanded |:set_env|. See |option-backslash|
3520 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003521 This option cannot be set from a |modeline| or in the |sandbox|, for
3522 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523
Bram Moolenaard94464e2015-11-02 15:28:18 +01003524 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003525'fsync' 'fs' boolean (default on)
3526 global
3527 {not in Vi}
3528 When on, the library function fsync() will be called after writing a
3529 file. This will flush a file to disk, ensuring that it is safely
3530 written even on filesystems which do metadata-only journaling. This
3531 will force the harddrive to spin up on Linux systems running in laptop
3532 mode, so it may be undesirable in some situations. Be warned that
3533 turning this off increases the chances of data loss after a crash. On
3534 systems without an fsync() implementation, this variable is always
3535 off.
3536 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003537 'fsync' also applies to |writefile()|, unless a flag is used to
3538 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003539
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3541'gdefault' 'gd' boolean (default off)
3542 global
3543 {not in Vi}
3544 When on, the ":substitute" flag 'g' is default on. This means that
3545 all matches in a line are substituted instead of one. When a 'g' flag
3546 is given to a ":substitute" command, this will toggle the substitution
3547 of all or one match. See |complex-change|.
3548
3549 command 'gdefault' on 'gdefault' off ~
3550 :s/// subst. all subst. one
3551 :s///g subst. one subst. all
3552 :s///gg subst. all subst. one
3553
3554 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003555 DEPRECATED: Setting this option may break plugins that are not aware
3556 of this option. Also, many users get confused that adding the /g flag
3557 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003560'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 global
3562 {not in Vi}
3563 Format to recognize for the ":grep" command output.
3564 This is a scanf-like string that uses the same format as the
3565 'errorformat' option: see |errorformat|.
3566
3567 *'grepprg'* *'gp'*
3568'grepprg' 'gp' string (default "grep -n ",
3569 Unix: "grep -n $* /dev/null",
3570 Win32: "findstr /n" or "grep -n",
3571 VMS: "SEARCH/NUMBERS ")
3572 global or local to buffer |global-local|
3573 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003574 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 and '#' characters, which are expanded like when used in a command-
3576 line. The placeholder "$*" is allowed to specify where the arguments
3577 will be included. Environment variables are expanded |:set_env|. See
3578 |option-backslash| about including spaces and backslashes.
3579 When your "grep" accepts the "-H" argument, use this to make ":grep"
3580 also work well with a single file: >
3581 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003582< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003583 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3584 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003585 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 apply equally to 'grepprg'.
3587 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3588 otherwise it's "grep -n".
3589 This option cannot be set from a |modeline| or in the |sandbox|, for
3590 security reasons.
3591
3592 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3593'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3594 ve:ver35-Cursor,
3595 o:hor50-Cursor,
3596 i-ci:ver25-Cursor/lCursor,
3597 r-cr:hor20-Cursor/lCursor,
3598 sm:block-Cursor
3599 -blinkwait175-blinkoff150-blinkon175",
3600 for MS-DOS and Win32 console:
3601 "n-v-c:block,o:hor50,i-ci:hor15,
3602 r-cr:hor30,sm:block")
3603 global
3604 {not in Vi}
3605 {only available when compiled with GUI enabled, and
3606 for MS-DOS and Win32 console}
3607 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003608 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 the height of the cursor can be changed. This can be done by
3610 specifying a block cursor, or a percentage for a vertical or
3611 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003612 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3613 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003615 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 mode-list and an argument-list:
3617 mode-list:argument-list,mode-list:argument-list,..
3618 The mode-list is a dash separated list of these modes:
3619 n Normal mode
3620 v Visual mode
3621 ve Visual mode with 'selection' "exclusive" (same as 'v',
3622 if not specified)
3623 o Operator-pending mode
3624 i Insert mode
3625 r Replace mode
3626 c Command-line Normal (append) mode
3627 ci Command-line Insert mode
3628 cr Command-line Replace mode
3629 sm showmatch in Insert mode
3630 a all modes
3631 The argument-list is a dash separated list of these arguments:
3632 hor{N} horizontal bar, {N} percent of the character height
3633 ver{N} vertical bar, {N} percent of the character width
3634 block block cursor, fills the whole character
3635 [only one of the above three should be present]
3636 blinkwait{N} *cursor-blinking*
3637 blinkon{N}
3638 blinkoff{N}
3639 blink times for cursor: blinkwait is the delay before
3640 the cursor starts blinking, blinkon is the time that
3641 the cursor is shown and blinkoff is the time that the
3642 cursor is not shown. The times are in msec. When one
3643 of the numbers is zero, there is no blinking. The
3644 default is: "blinkwait700-blinkon400-blinkoff250".
3645 These numbers are used for a missing entry. This
3646 means that blinking is enabled by default. To switch
3647 blinking off you can use "blinkon0". The cursor only
3648 blinks when Vim is waiting for input, not while
3649 executing a command.
3650 To make the cursor blink in an xterm, see
3651 |xterm-blink|.
3652 {group-name}
3653 a highlight group name, that sets the color and font
3654 for the cursor
3655 {group-name}/{group-name}
3656 Two highlight group names, the first is used when
3657 no language mappings are used, the other when they
3658 are. |language-mapping|
3659
3660 Examples of parts:
3661 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3662 block cursor with colors from the "nCursor"
3663 highlight group
3664 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3665 In Insert and Command-line Insert mode, use a
3666 30% vertical bar cursor with colors from the
3667 "iCursor" highlight group. Blink a bit
3668 faster.
3669
3670 The 'a' mode is different. It will set the given argument-list for
3671 all modes. It does not reset anything to defaults. This can be used
3672 to do a common setting for all modes. For example, to switch off
3673 blinking: "a:blinkon0"
3674
3675 Examples of cursor highlighting: >
3676 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3677 :highlight Cursor gui=NONE guifg=bg guibg=fg
3678<
3679 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003680 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681'guifont' 'gfn' string (default "")
3682 global
3683 {not in Vi}
3684 {only available when compiled with GUI enabled}
3685 This is a list of fonts which will be used for the GUI version of Vim.
3686 In its simplest form the value is just one font name. When
3687 the font cannot be found you will get an error message. To try other
3688 font names a list can be specified, font names separated with commas.
3689 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003690
Bram Moolenaar05159a02005-02-26 23:04:13 +00003691 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3692 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003693
Bram Moolenaar3df01732017-02-17 22:47:16 +01003694 Note: As to the GTK GUIs, no error is given against any invalid names,
3695 and the first element of the list is always picked up and made use of.
3696 This is because, instead of identifying a given name with a font, the
3697 GTK GUIs use it to construct a pattern and try to look up a font which
3698 best matches the pattern among available fonts, and this way, the
3699 matching never fails. An invalid name doesn't matter because a number
3700 of font properties other than name will do to get the matching done.
3701
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 Spaces after a comma are ignored. To include a comma in a font name
3703 precede it with a backslash. Setting an option requires an extra
3704 backslash before a space and a backslash. See also
3705 |option-backslash|. For example: >
3706 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003707< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003709
3710 If none of the fonts can be loaded, Vim will keep the current setting.
3711 If an empty font list is given, Vim will try using other resource
3712 settings (for X, it will use the Vim.font resource), and finally it
3713 will try some builtin default which should always be there ("7x13" in
3714 the case of X). The font names given should be "normal" fonts. Vim
3715 will try to find the related bold and italic fonts.
3716
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003717 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003718 :set guifont=*
3719< will bring up a font requester, where you can pick the font you want.
3720
3721 The font name depends on the GUI used. See |setting-guifont| for a
3722 way to set 'guifont' for various systems.
3723
Bram Moolenaar3df01732017-02-17 22:47:16 +01003724 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003726< That's all. XLFDs are not used. For Chinese this is reported to work
3727 well: >
3728 if has("gui_gtk2")
3729 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3730 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3731 endif
3732<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003733 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3734
Bram Moolenaar05159a02005-02-26 23:04:13 +00003735 For Mac OSX you can use something like this: >
3736 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003737< Also see 'macatsui', it can help fix display problems.
3738 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003740 width). An exception is GTK: all fonts are accepted, but mono-spaced
3741 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003742
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 To preview a font on X11, you might be able to use the "xfontsel"
3744 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003745
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 For the Win32 GUI *E244* *E245*
3747 - takes these options in the font name:
3748 hXX - height is XX (points, can be floating-point)
3749 wXX - width is XX (points, can be floating-point)
3750 b - bold
3751 i - italic
3752 u - underline
3753 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003754 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3756 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3757 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003758 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003759 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003760 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003761 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003762 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763
3764 Use a ':' to separate the options.
3765 - A '_' can be used in the place of a space, so you don't need to use
3766 backslashes to escape the spaces.
3767 - Examples: >
3768 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3769 :set guifont=Andale_Mono:h7.5:w4.5
3770< See also |font-sizes|.
3771
3772 *'guifontset'* *'gfs'*
3773 *E250* *E252* *E234* *E597* *E598*
3774'guifontset' 'gfs' string (default "")
3775 global
3776 {not in Vi}
3777 {only available when compiled with GUI enabled and
3778 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003779 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 When not empty, specifies two (or more) fonts to be used. The first
3781 one for normal English, the second one for your special language. See
3782 |xfontset|.
3783 Setting this option also means that all font names will be handled as
3784 a fontset name. Also the ones used for the "font" argument of the
3785 |:highlight| command.
3786 The fonts must match with the current locale. If fonts for the
3787 character sets that the current locale uses are not included, setting
3788 'guifontset' will fail.
3789 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3790 the comma-separated names are alternative names, one of which will be
3791 used. In 'guifontset' the whole string is one fontset name,
3792 including the commas. It is not possible to specify alternative
3793 fontset names.
3794 This example works on many X11 systems: >
3795 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3796<
3797 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3798'guifontwide' 'gfw' string (default "")
3799 global
3800 {not in Vi}
3801 {only available when compiled with GUI enabled}
3802 When not empty, specifies a comma-separated list of fonts to be used
3803 for double-width characters. The first font that can be loaded is
3804 used.
3805 Note: The size of these fonts must be exactly twice as wide as the one
3806 specified with 'guifont' and the same height.
3807
Bram Moolenaar3df01732017-02-17 22:47:16 +01003808 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809
3810 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3811 'guifontset' is empty or invalid.
3812 When 'guifont' is set and a valid font is found in it and
3813 'guifontwide' is empty Vim will attempt to find a matching
3814 double-width font and set 'guifontwide' to it.
3815
Bram Moolenaar3df01732017-02-17 22:47:16 +01003816 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817
3818 If set and valid, 'guifontwide' is always used for double width
3819 characters, even if 'encoding' is not set to "utf-8".
3820 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003821 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 font for characters not available in 'guifont'. Thus you do not need
3823 to set 'guifontwide' at all unless you want to override the choice
3824 made by Pango/Xft.
3825
Bram Moolenaar0f272122013-01-23 18:37:40 +01003826 Windows +multibyte only: *guifontwide_win_mbyte*
3827
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003828 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003829
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 *'guiheadroom'* *'ghr'*
3831'guiheadroom' 'ghr' number (default 50)
3832 global
3833 {not in Vi} {only for GTK and X11 GUI}
3834 The number of pixels subtracted from the screen height when fitting
3835 the GUI window on the screen. Set this before the GUI is started,
3836 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003837 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 lines will be left for window decorations and other items on the
3839 screen. Set it to a negative value to allow windows taller than the
3840 screen.
3841
3842 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003843'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3844 removed in |defaults.vim|),
3845 "aegimrLtT" (GTK, Motif and Athena),
3846 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 global
3848 {not in Vi}
3849 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003850 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 sequence of letters which describes what components and options of the
3852 GUI should be used.
3853 To avoid problems with flags that are added in the future, use the
3854 "+=" and "-=" feature of ":set" |add-option-flags|.
3855
Bram Moolenaar13568252018-03-16 20:46:58 +01003856 Valid characters are as follows:
3857 *'go-!'*
3858 '!' External commands are executed in a terminal window. Without
3859 this flag the MS-Windows GUI will open a console window to
3860 execute the command. The Unix GUI will simulate a dumb
3861 terminal to list the command output.
3862 The terminal window will be positioned at the bottom, and grow
3863 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003864 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 'a' Autoselect: If present, then whenever VISUAL mode is started,
3866 or the Visual area extended, Vim tries to become the owner of
3867 the windowing system's global selection. This means that the
3868 Visually highlighted text is available for pasting into other
3869 applications as well as into Vim itself. When the Visual mode
3870 ends, possibly due to an operation on the text, or when an
3871 application wants to paste the selection, the highlighted text
3872 is automatically yanked into the "* selection register.
3873 Thus the selection is still available for pasting into other
3874 applications after the VISUAL mode has ended.
3875 If not present, then Vim won't become the owner of the
3876 windowing system's global selection unless explicitly told to
3877 by a yank or delete operation for the "* register.
3878 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003879 *'go-P'*
3880 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003881 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003882 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003883 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 applies to the modeless selection.
3885
3886 'guioptions' autoselect Visual autoselect modeless ~
3887 "" - -
3888 "a" yes yes
3889 "A" - yes
3890 "aA" yes yes
3891
Bram Moolenaar02467872007-05-06 13:22:01 +00003892 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 'c' Use console dialogs instead of popup dialogs for simple
3894 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003895 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003896 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003897 'guitablabel' can be used to change the text in the labels.
3898 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003899 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003900 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003901 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'f' Foreground: Don't use fork() to detach the GUI from the shell
3903 where it was started. Use this for programs that wait for the
3904 editor to finish (e.g., an e-mail program). Alternatively you
3905 can use "gvim -f" or ":gui -f" to start the GUI in the
3906 foreground. |gui-fork|
3907 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003908 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003909 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3911 corner of the window. It's black&white on non-GTK, because of
3912 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003913 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003915 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003916 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003918 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003920 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003921 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 'g' Grey menu items: Make menu items that are not active grey. If
3923 'g' is not included inactive menu items are not shown at all.
3924 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003925 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 't' Include tearoff menu items. Currently only works for Win32,
3927 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003928 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003929 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003930 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003931 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003933 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 'R' Right-hand scrollbar is present when there is a vertically
3935 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003936 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003938 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 'L' Left-hand scrollbar is present when there is a vertically
3940 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003941 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3943 the longest visible line, or on the cursor line if the 'h'
3944 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'h' Limit horizontal scrollbar size to the length of the cursor
3947 line. Reduces computations. |gui-horiz-scroll|
3948
3949 And yes, you may even have scrollbars on the left AND the right if
3950 you really want to :-). See |gui-scrollbars| for more information.
3951
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003952 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 'v' Use a vertical button layout for dialogs. When not included,
3954 a horizontal layout is preferred, but when it doesn't fit a
3955 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003956 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 'p' Use Pointer callbacks for X11 GUI. This is required for some
3958 window managers. If the cursor is not blinking or hollow at
3959 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003960 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003962 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003964 *'go-k'*
3965 'k' Keep the GUI window size when adding/removing a scrollbar, or
3966 toolbar, tabline, etc. Instead, the behavior is similar to
3967 when the window is maximized and will adjust 'lines' and
3968 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003969 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003970 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003971
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 *'guipty'* *'noguipty'*
3973'guipty' boolean (default on)
3974 global
3975 {not in Vi}
3976 {only available when compiled with GUI enabled}
3977 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3978 I/O to/from shell commands. See |gui-pty|.
3979
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003980 *'guitablabel'* *'gtl'*
3981'guitablabel' 'gtl' string (default empty)
3982 global
3983 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003984 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003985 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003986 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003987 pages line. When empty and when the result is empty Vim will use a
3988 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003989
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003990 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003991 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003992 The expression will be evaluated in the |sandbox| when set from a
3993 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003994
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003995 Only used when the GUI tab pages line is displayed. 'e' must be
3996 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3997 used.
3998
Bram Moolenaar57657d82006-04-21 22:12:41 +00003999 *'guitabtooltip'* *'gtt'*
4000'guitabtooltip' 'gtt' string (default empty)
4001 global
4002 {not in Vi}
4003 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004004 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004005 When nonempty describes the text to use in a tooltip for the GUI tab
4006 pages line. When empty Vim will use a default tooltip.
4007 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004008 You can include a line break. Simplest method is to use |:let|: >
4009 :let &guitabtooltip = "line one\nline two"
4010<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004011
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 *'helpfile'* *'hf'*
4013'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4014 (others) "$VIMRUNTIME/doc/help.txt")
4015 global
4016 {not in Vi}
4017 Name of the main help file. All distributed help files should be
4018 placed together in one directory. Additionally, all "doc" directories
4019 in 'runtimepath' will be used.
4020 Environment variables are expanded |:set_env|. For example:
4021 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004022 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 spaces and backslashes.
4024 This option cannot be set from a |modeline| or in the |sandbox|, for
4025 security reasons.
4026
4027 *'helpheight'* *'hh'*
4028'helpheight' 'hh' number (default 20)
4029 global
4030 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004031 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 feature}
4033 Minimal initial height of the help window when it is opened with the
4034 ":help" command. The initial height of the help window is half of the
4035 current window, or (when the 'ea' option is on) the same as other
4036 windows. When the height is less than 'helpheight', the height is
4037 set to 'helpheight'. Set to zero to disable.
4038
4039 *'helplang'* *'hlg'*
4040'helplang' 'hlg' string (default: messages language or empty)
4041 global
4042 {only available when compiled with the |+multi_lang|
4043 feature}
4044 {not in Vi}
4045 Comma separated list of languages. Vim will use the first language
4046 for which the desired help can be found. The English help will always
4047 be used as a last resort. You can add "en" to prefer English over
4048 another language, but that will only find tags that exist in that
4049 language and not in the English help.
4050 Example: >
4051 :set helplang=de,it
4052< This will first search German, then Italian and finally English help
4053 files.
4054 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4055 try to find the tag in the current language before using this option.
4056 See |help-translated|.
4057
4058 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4059'hidden' 'hid' boolean (default off)
4060 global
4061 {not in Vi}
4062 When off a buffer is unloaded when it is |abandon|ed. When on a
4063 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4064 displayed in another window, it does not become hidden, of course.
4065 The commands that move through the buffer list sometimes make a buffer
4066 hidden although the 'hidden' option is off: When the buffer is
4067 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004068 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004069 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004070 This option is set for one command with ":hide {command}" |:hide|.
4071 WARNING: It's easy to forget that you have changes in hidden buffers.
4072 Think twice when using ":q!" or ":qa!".
4073
4074 *'highlight'* *'hl'*
4075'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004076 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4077 d:Directory,e:ErrorMsg,i:IncSearch,
4078 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4079 N:CursorLineNr,r:Question,s:StatusLine,
4080 S:StatusLineNC,c:VertSplit,t:Title,
4081 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4082 F:FoldColumn,A:DiffAdd,C:DiffChange,
4083 D:DiffDelete,T:DiffText,>:SignColumn,
4084 B:SpellBad,P:SpellCap,R:SpellRare,
4085 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004086 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4087 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004088 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004089 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 global
4091 {not in Vi}
4092 This option can be used to set highlighting mode for various
4093 occasions. It is a comma separated list of character pairs. The
4094 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004095 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004097 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4098 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 characters from 'showbreak'
4100 |hl-Directory| d directories in CTRL-D listing and other special
4101 things in listings
4102 |hl-ErrorMsg| e error messages
4103 h (obsolete, ignored)
4104 |hl-IncSearch| i 'incsearch' highlighting
4105 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4106 |hl-MoreMsg| m |more-prompt|
4107 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004108 |hl-LineNr| n line number for ":number" and ":#" commands, and
4109 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004110 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4111 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 |hl-Question| r |hit-enter| prompt and yes/no questions
4113 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004114 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4116 |hl-VertSplit| c column used to separate vertically split windows
4117 |hl-Visual| v Visual mode
4118 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4119 Selection" Only X11 Gui's |gui-x11| and
4120 |xterm-clipboard|.
4121 |hl-WarningMsg| w warning messages
4122 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4123 |hl-Folded| f line used for closed folds
4124 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004125 |hl-DiffAdd| A added line in diff mode
4126 |hl-DiffChange| C changed line in diff mode
4127 |hl-DiffDelete| D deleted line in diff mode
4128 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004130 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004131 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004132 |hl-SpellRare| R rare word |spell|
4133 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004134 |hl-Conceal| - the placeholders used for concealed characters
4135 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004136 |hl-Pmenu| + popup menu normal line
4137 |hl-PmenuSel| = popup menu normal line
4138 |hl-PmenuSbar| x popup menu scrollbar
4139 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140
4141 The display modes are:
4142 r reverse (termcap entry "mr" and "me")
4143 i italic (termcap entry "ZH" and "ZR")
4144 b bold (termcap entry "md" and "me")
4145 s standout (termcap entry "so" and "se")
4146 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004147 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004148 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 n no highlighting
4150 - no highlighting
4151 : use a highlight group
4152 The default is used for occasions that are not included.
4153 If you want to change what the display modes do, see |dos-colors|
4154 for an example.
4155 When using the ':' display mode, this must be followed by the name of
4156 a highlight group. A highlight group can be used to define any type
4157 of highlighting, including using color. See |:highlight| on how to
4158 define one. The default uses a different group for each occasion.
4159 See |highlight-default| for the default highlight groups.
4160
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004162'history' 'hi' number (Vim default: 50, Vi default: 0,
4163 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 global
4165 {not in Vi}
4166 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004167 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004169 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 NOTE: This option is set to the Vi default value when 'compatible' is
4171 set and to the Vim default value when 'compatible' is reset.
4172
4173 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4174'hkmap' 'hk' boolean (default off)
4175 global
4176 {not in Vi}
4177 {only available when compiled with the |+rightleft|
4178 feature}
4179 When on, the keyboard is mapped for the Hebrew character set.
4180 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4181 toggle this option. See |rileft.txt|.
4182 NOTE: This option is reset when 'compatible' is set.
4183
4184 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4185'hkmapp' 'hkp' boolean (default off)
4186 global
4187 {not in Vi}
4188 {only available when compiled with the |+rightleft|
4189 feature}
4190 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4191 This is useful if you have a non-Hebrew keyboard.
4192 See |rileft.txt|.
4193 NOTE: This option is reset when 'compatible' is set.
4194
Bram Moolenaar036986f2017-03-16 17:41:02 +01004195 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4196'hlsearch' 'hls' boolean (default off)
4197 global
4198 {not in Vi}
4199 {not available when compiled without the
4200 |+extra_search| feature}
4201 When there is a previous search pattern, highlight all its matches.
4202 The type of highlighting used can be set with the 'l' occasion in the
4203 'highlight' option. This uses the "Search" highlight group by
4204 default. Note that only the matching text is highlighted, any offsets
4205 are not applied.
4206 See also: 'incsearch' and |:match|.
4207 When you get bored looking at the highlighted matches, you can turn it
4208 off with |:nohlsearch|. This does not change the option value, as
4209 soon as you use a search command, the highlighting comes back.
4210 'redrawtime' specifies the maximum time spent on finding matches.
4211 When the search pattern can match an end-of-line, Vim will try to
4212 highlight all of the matched text. However, this depends on where the
4213 search starts. This will be the first line in the window or the first
4214 line below a closed fold. A match in a previous line which is not
4215 drawn may not continue in a newly drawn line.
4216 You can specify whether the highlight status is restored on startup
4217 with the 'h' flag in 'viminfo' |viminfo-h|.
4218 NOTE: This option is reset when 'compatible' is set.
4219
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 *'icon'* *'noicon'*
4221'icon' boolean (default off, on when title can be restored)
4222 global
4223 {not in Vi}
4224 {not available when compiled without the |+title|
4225 feature}
4226 When on, the icon text of the window will be set to the value of
4227 'iconstring' (if it is not empty), or to the name of the file
4228 currently being edited. Only the last part of the name is used.
4229 Overridden by the 'iconstring' option.
4230 Only works if the terminal supports setting window icons (currently
4231 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4232 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4233 builtin termcap).
4234 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004235 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004237 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238
4239 *'iconstring'*
4240'iconstring' string (default "")
4241 global
4242 {not in Vi}
4243 {not available when compiled without the |+title|
4244 feature}
4245 When this option is not empty, it will be used for the icon text of
4246 the window. This happens only when the 'icon' option is on.
4247 Only works if the terminal supports setting window icon text
4248 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4249 Does not work for MS Windows.
4250 When Vim was compiled with HAVE_X11 defined, the original icon will be
4251 restored if possible |X11|.
4252 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004253 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 'titlestring' for example settings.
4255 {not available when compiled without the |+statusline| feature}
4256
4257 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4258'ignorecase' 'ic' boolean (default off)
4259 global
4260 Ignore case in search patterns. Also used when searching in the tags
4261 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004262 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 Can be overruled by using "\c" or "\C" in the pattern, see
4264 |/ignorecase|.
4265
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004266 *'imactivatefunc'* *'imaf'*
4267'imactivatefunc' 'imaf' string (default "")
4268 global
4269 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004270 {only available when compiled with the |+multi_byte|
4271 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004272 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004273 activate or deactivate the Input Method.
4274 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004275
4276 Example: >
4277 function ImActivateFunc(active)
4278 if a:active
4279 ... do something
4280 else
4281 ... do something
4282 endif
4283 " return value is not used
4284 endfunction
4285 set imactivatefunc=ImActivateFunc
4286<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 *'imactivatekey'* *'imak'*
4288'imactivatekey' 'imak' string (default "")
4289 global
4290 {not in Vi}
4291 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004292 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 Specifies the key that your Input Method in X-Windows uses for
4294 activation. When this is specified correctly, vim can fully control
4295 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4296 You can't use this option to change the activation key, the option
4297 tells Vim what the key is.
4298 Format:
4299 [MODIFIER_FLAG-]KEY_STRING
4300
4301 These characters can be used for MODIFIER_FLAG (case is ignored):
4302 S Shift key
4303 L Lock key
4304 C Control key
4305 1 Mod1 key
4306 2 Mod2 key
4307 3 Mod3 key
4308 4 Mod4 key
4309 5 Mod5 key
4310 Combinations are allowed, for example "S-C-space" or "SC-space" are
4311 both shift+ctrl+space.
4312 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4313
4314 Example: >
4315 :set imactivatekey=S-space
4316< "S-space" means shift+space. This is the activation key for kinput2 +
4317 canna (Japanese), and ami (Korean).
4318
4319 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4320'imcmdline' 'imc' boolean (default off)
4321 global
4322 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004323 {only available when compiled with the |+multi_byte|
4324 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 When set the Input Method is always on when starting to edit a command
4326 line, unless entering a search pattern (see 'imsearch' for that).
4327 Setting this option is useful when your input method allows entering
4328 English characters directly, e.g., when it's used to type accented
4329 characters with dead keys.
4330
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004331 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4333 global
4334 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004335 {only available when compiled with the |+multi_byte|
4336 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 When set the Input Method is never used. This is useful to disable
4338 the IM when it doesn't work properly.
4339 Currently this option is on by default for SGI/IRIX machines. This
4340 may change in later releases.
4341
4342 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004343'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 local to buffer
4345 {not in Vi}
4346 Specifies whether :lmap or an Input Method (IM) is to be used in
4347 Insert mode. Valid values:
4348 0 :lmap is off and IM is off
4349 1 :lmap is ON and IM is off
4350 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 To always reset the option to zero when leaving Insert mode with <Esc>
4352 this can be used: >
4353 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4354< This makes :lmap and IM turn off automatically when leaving Insert
4355 mode.
4356 Note that this option changes when using CTRL-^ in Insert mode
4357 |i_CTRL-^|.
4358 The value is set to 1 when setting 'keymap' to a valid keymap name.
4359 It is also used for the argument of commands like "r" and "f".
4360 The value 0 may not work correctly with Athena and Motif with some XIM
4361 methods. Use 'imdisable' to disable XIM then.
4362
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004363 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4364 via external command if vim is not compiled with the |+xim|,
4365 |+multi_byte_ime| or |global-ime|.
4366
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004368'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 local to buffer
4370 {not in Vi}
4371 Specifies whether :lmap or an Input Method (IM) is to be used when
4372 entering a search pattern. Valid values:
4373 -1 the value of 'iminsert' is used, makes it look like
4374 'iminsert' is also used when typing a search pattern
4375 0 :lmap is off and IM is off
4376 1 :lmap is ON and IM is off
4377 2 :lmap is off and IM is ON
4378 Note that this option changes when using CTRL-^ in Command-line mode
4379 |c_CTRL-^|.
4380 The value is set to 1 when it is not -1 and setting the 'keymap'
4381 option to a valid keymap name.
4382 The value 0 may not work correctly with Athena and Motif with some XIM
4383 methods. Use 'imdisable' to disable XIM then.
4384
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004385 *'imstatusfunc'* *'imsf'*
4386'imstatusfunc' 'imsf' string (default "")
4387 global
4388 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004389 {only available when compiled with the |+multi_byte|
4390 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004391 This option specifies a function that is called to obtain the status
4392 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004393 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004394
4395 Example: >
4396 function ImStatusFunc()
4397 let is_active = ...do something
4398 return is_active ? 1 : 0
4399 endfunction
4400 set imstatusfunc=ImStatusFunc
4401<
4402 NOTE: This function is invoked very often. Keep it fast.
4403
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004404 *'imstyle'* *'imst'*
4405'imstyle' 'imst' number (default 1)
4406 global
4407 {not in Vi}
4408 {only available when compiled with |+xim| and
4409 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004410 This option specifies the input style of Input Method:
4411 0 use on-the-spot style
4412 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004413 See: |xim-input-style|
4414
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004415 For a long time on-the-spot style had been used in the GTK version of
4416 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004417 |single-repeat|, etc. Therefore over-the-spot style becomes the
4418 default now. This should work fine for most people, however if you
4419 have any problem with it, try using on-the-spot style.
4420
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 *'include'* *'inc'*
4422'include' 'inc' string (default "^\s*#\s*include")
4423 global or local to buffer |global-local|
4424 {not in Vi}
4425 {not available when compiled without the
4426 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004427 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 pattern, just like for the "/" command (See |pattern|). The default
4429 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004430 "]I", "[d", etc.
4431 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004432 comes after the matched pattern. But if "\zs" appears in the pattern
4433 then the text matched from "\zs" to the end, or until "\ze" if it
4434 appears, is used as the file name. Use this to include characters
4435 that are not in 'isfname', such as a space. You can then use
4436 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004437 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438
4439 *'includeexpr'* *'inex'*
4440'includeexpr' 'inex' string (default "")
4441 local to buffer
4442 {not in Vi}
4443 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004444 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004446 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 :set includeexpr=substitute(v:fname,'\\.','/','g')
4448< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004449
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004451 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 Also used for |<cfile>|.
4453
Bram Moolenaar30b65812012-07-12 22:01:11 +02004454 The expression will be evaluated in the |sandbox| when set from a
4455 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004456
4457 It is not allowed to change text or jump to another window while
4458 evaluating 'includeexpr' |textlock|.
4459
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004461'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4462 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 global
4464 {not in Vi}
4465 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004466 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004467 While typing a search command, show where the pattern, as it was typed
4468 so far, matches. The matched string is highlighted. If the pattern
4469 is invalid or not found, nothing is shown. The screen will be updated
4470 often, this is only useful on fast terminals.
4471 Note that the match will be shown, but the cursor will return to its
4472 original position when no match is found and when pressing <Esc>. You
4473 still need to finish the search command with <Enter> to move the
4474 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004475 You can use the CTRL-G and CTRL-T keys to move to the next and
4476 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004477 When compiled with the |+reltime| feature Vim only searches for about
4478 half a second. With a complicated pattern and/or a lot of text the
4479 match may not be found. This is to avoid that Vim hangs while you
4480 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004481 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004482 When 'hlsearch' is on, all matched strings are highlighted too while
4483 typing a search command. See also: 'hlsearch'.
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004484 If you don't want turn 'hlsearch' on, but want to highlight all matches
4485 while searching, you can turn on and off 'hlsearch' with autocmd.
4486 Example: >
4487 augroup vimrc-incsearch-highlight
4488 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004489 autocmd CmdlineEnter /,\? :set hlsearch
4490 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004491 augroup END
4492<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004493 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004494 to the command line. If 'ignorecase' and 'smartcase' are set and the
4495 command line has no uppercase characters, the added character is
4496 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004497 CTRL-R CTRL-W can be used to add the word at the end of the current
4498 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 NOTE: This option is reset when 'compatible' is set.
4500
4501 *'indentexpr'* *'inde'*
4502'indentexpr' 'inde' string (default "")
4503 local to buffer
4504 {not in Vi}
4505 {not available when compiled without the |+cindent|
4506 or |+eval| features}
4507 Expression which is evaluated to obtain the proper indent for a line.
4508 It is used when a new line is created, for the |=| operator and
4509 in Insert mode as specified with the 'indentkeys' option.
4510 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004511 'smartindent' indenting. When 'lisp' is set, this option is
4512 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 When 'paste' is set this option is not used for indenting.
4514 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004515 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 when the expression is evaluated (but it may be moved around).
4517 The expression must return the number of spaces worth of indent. It
4518 can return "-1" to keep the current indent (this means 'autoindent' is
4519 used for the indent).
4520 Functions useful for computing the indent are |indent()|, |cindent()|
4521 and |lispindent()|.
4522 The evaluation of the expression must not have side effects! It must
4523 not change the text, jump to another window, etc. Afterwards the
4524 cursor position is always restored, thus the cursor may be moved.
4525 Normally this option would be set to call a function: >
4526 :set indentexpr=GetMyIndent()
4527< Error messages will be suppressed, unless the 'debug' option contains
4528 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004529 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004530 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531
Bram Moolenaar30b65812012-07-12 22:01:11 +02004532 The expression will be evaluated in the |sandbox| when set from a
4533 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004534
4535 It is not allowed to change text or jump to another window while
4536 evaluating 'indentexpr' |textlock|.
4537
4538
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 *'indentkeys'* *'indk'*
4540'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4541 local to buffer
4542 {not in Vi}
4543 {not available when compiled without the |+cindent|
4544 feature}
4545 A list of keys that, when typed in Insert mode, cause reindenting of
4546 the current line. Only happens if 'indentexpr' isn't empty.
4547 The format is identical to 'cinkeys', see |indentkeys-format|.
4548 See |C-indenting| and |indent-expression|.
4549
4550 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4551'infercase' 'inf' boolean (default off)
4552 local to buffer
4553 {not in Vi}
4554 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004555 'ignorecase' is also on, the case of the match is adjusted depending
4556 on the typed text. If the typed text contains a lowercase letter
4557 where the match has an upper case letter, the completed part is made
4558 lowercase. If the typed text has no lowercase letters and the match
4559 has a lowercase letter where the typed text has an uppercase letter,
4560 and there is a letter before it, the completed part is made uppercase.
4561 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
4563 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4564'insertmode' 'im' boolean (default off)
4565 global
4566 {not in Vi}
4567 Makes Vim work in a way that Insert mode is the default mode. Useful
4568 if you want to use Vim as a modeless editor. Used for |evim|.
4569 These Insert mode commands will be useful:
4570 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004571 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 this is a mapping, it is executed as if 'insertmode' was off.
4573 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004575 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4576 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577
4578 These items change when 'insertmode' is set:
4579 - when starting to edit of a file, Vim goes to Insert mode.
4580 - <Esc> in Insert mode is a no-op and beeps.
4581 - <Esc> in Normal mode makes Vim go to Insert mode.
4582 - CTRL-L in Insert mode is a command, it is not inserted.
4583 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4584 However, when <Esc> is used inside a mapping, it behaves like
4585 'insertmode' was not set. This was done to be able to use the same
4586 mappings with 'insertmode' set or not set.
4587 When executing commands with |:normal| 'insertmode' is not used.
4588
4589 NOTE: This option is reset when 'compatible' is set.
4590
4591 *'isfname'* *'isf'*
4592'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4593 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4594 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4595 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4596 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4597 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4598 global
4599 {not in Vi}
4600 The characters specified by this option are included in file names and
4601 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004602 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 Multi-byte characters 256 and above are always included, only the
4604 characters up to 255 are specified with this option.
4605 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004606 Think twice before adding white space to this option. Although a
4607 space may appear inside a file name, the effect will be that Vim
4608 doesn't know where a file name starts or ends when doing completion.
4609 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610
4611 Note that on systems using a backslash as path separator, Vim tries to
4612 do its best to make it work as you would expect. That is a bit
4613 tricky, since Vi originally used the backslash to escape special
4614 characters. Vim will not remove a backslash in front of a normal file
4615 name character on these systems, but it will on Unix and alikes. The
4616 '&' and '^' are not included by default, because these are special for
4617 cmd.exe.
4618
4619 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004620 Each part can be a single character number or a range. A range is two
4621 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 decimal number between 0 and 255 or the ASCII character itself (does
4623 not work for digits). Example:
4624 "_,-,128-140,#-43" (include '_' and '-' and the range
4625 128 to 140 and '#' to 43)
4626 If a part starts with '^', the following character number or range
4627 will be excluded from the option. The option is interpreted from left
4628 to right. Put the excluded character after the range where it is
4629 included. To include '^' itself use it as the last character of the
4630 option or the end of a range. Example:
4631 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4632 If the character is '@', all characters where isalpha() returns TRUE
4633 are included. Normally these are the characters a to z and A to Z,
4634 plus accented characters. To include '@' itself use "@-@". Examples:
4635 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004636 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637 "a-z,A-Z,@-@" All letters plus the '@' character.
4638 A comma can be included by using it where a character number is
4639 expected. Example:
4640 "48-57,,,_" Digits, comma and underscore.
4641 A comma can be excluded by prepending a '^'. Example:
4642 " -~,^,,9" All characters from space to '~', excluding
4643 comma, plus <Tab>.
4644 See |option-backslash| about including spaces and backslashes.
4645
4646 *'isident'* *'isi'*
4647'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4648 "@,48-57,_,128-167,224-235"
4649 otherwise: "@,48-57,_,192-255")
4650 global
4651 {not in Vi}
4652 The characters given by this option are included in identifiers.
4653 Identifiers are used in recognizing environment variables and after a
4654 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004655 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 option.
4657 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004658 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4660
4661 *'iskeyword'* *'isk'*
4662'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4663 "@,48-57,_,128-167,224-235"
4664 otherwise: "@,48-57,_,192-255"
4665 Vi default: "@,48-57,_")
4666 local to buffer
4667 {not in Vi}
4668 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004669 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 'isfname' for a description of the format of this option. For C
4671 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4672 For a help file it is set to all non-blank printable characters except
4673 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4674 command).
4675 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004676 This option also influences syntax highlighting, unless the syntax
4677 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 NOTE: This option is set to the Vi default value when 'compatible' is
4679 set and to the Vim default value when 'compatible' is reset.
4680
4681 *'isprint'* *'isp'*
4682'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4683 "@,~-255"; otherwise: "@,161-255")
4684 global
4685 {not in Vi}
4686 The characters given by this option are displayed directly on the
4687 screen. It is also used for "\p" in a |pattern|. The characters from
4688 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4689 even when they are not included in 'isprint' or excluded. See
4690 'isfname' for a description of the format of this option.
4691
4692 Non-printable characters are displayed with two characters:
4693 0 - 31 "^@" - "^_"
4694 32 - 126 always single characters
4695 127 "^?"
4696 128 - 159 "~@" - "~_"
4697 160 - 254 "| " - "|~"
4698 255 "~?"
4699 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4700 displayed as <xx>, with the hexadecimal value of the byte.
4701 When 'display' contains "uhex" all unprintable characters are
4702 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004703 The SpecialKey highlighting will be used for unprintable characters.
4704 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705
4706 Multi-byte characters 256 and above are always included, only the
4707 characters up to 255 are specified with this option. When a character
4708 is printable but it is not available in the current font, a
4709 replacement character will be shown.
4710 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4711 There is no option to specify these characters.
4712
4713 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4714'joinspaces' 'js' boolean (default on)
4715 global
4716 {not in Vi}
4717 Insert two spaces after a '.', '?' and '!' with a join command.
4718 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4719 Otherwise only one space is inserted.
4720 NOTE: This option is set when 'compatible' is set.
4721
4722 *'key'*
4723'key' string (default "")
4724 local to buffer
4725 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004726 {only available when compiled with the |+cryptv|
4727 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004729 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 Careful: Do not set the key value by hand, someone might see the typed
4731 key. Use the |:X| command. But you can make 'key' empty: >
4732 :set key=
4733< It is not possible to get the value of this option with ":set key" or
4734 "echo &key". This is to avoid showing it to someone who shouldn't
4735 know. It also means you cannot see it yourself once you have set it,
4736 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004737 You can use "&key" in an expression to detect whether encryption is
4738 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739
4740 *'keymap'* *'kmp'* *E544*
4741'keymap' 'kmp' string (default "")
4742 local to buffer
4743 {not in Vi}
4744 {only available when compiled with the |+keymap|
4745 feature}
4746 Name of a keyboard mapping. See |mbyte-keymap|.
4747 Setting this option to a valid keymap name has the side effect of
4748 setting 'iminsert' to one, so that the keymap becomes effective.
4749 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004750 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751
4752 *'keymodel'* *'km'*
4753'keymodel' 'km' string (default "")
4754 global
4755 {not in Vi}
4756 List of comma separated words, which enable special things that keys
4757 can do. These values can be used:
4758 startsel Using a shifted special key starts selection (either
4759 Select mode or Visual mode, depending on "key" being
4760 present in 'selectmode').
4761 stopsel Using a not-shifted special key stops selection.
4762 Special keys in this context are the cursor keys, <End>, <Home>,
4763 <PageUp> and <PageDown>.
4764 The 'keymodel' option is set by the |:behave| command.
4765
4766 *'keywordprg'* *'kp'*
4767'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004768 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 global or local to buffer |global-local|
4770 {not in Vi}
4771 Program to use for the |K| command. Environment variables are
4772 expanded |:set_env|. ":help" may be used to access the Vim internal
4773 help. (Note that previously setting the global option to the empty
4774 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004775 When the first character is ":", the command is invoked as a Vim
4776 Ex command prefixed with [count].
4777 When "man", "man -s" or an Ex command is used, Vim will automatically
4778 translate a count for the "K" command and pass it as the first
4779 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004780 See |option-backslash| about including spaces and backslashes.
4781 Example: >
4782 :set keywordprg=man\ -s
4783< This option cannot be set from a |modeline| or in the |sandbox|, for
4784 security reasons.
4785
4786 *'langmap'* *'lmap'* *E357* *E358*
4787'langmap' 'lmap' string (default "")
4788 global
4789 {not in Vi}
4790 {only available when compiled with the |+langmap|
4791 feature}
4792 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004793 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004794 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 care of translating these special characters to the original meaning
4796 of the key. This means you don't have to change the keyboard mode to
4797 be able to execute Normal mode commands.
4798 This is the opposite of the 'keymap' option, where characters are
4799 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004800 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004801 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004802 This option cannot be set from a |modeline| or in the |sandbox|, for
4803 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004805 Example (for Greek, in UTF-8): *greek* >
4806 :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 +00004807< Example (exchanges meaning of z and y for commands): >
4808 :set langmap=zy,yz,ZY,YZ
4809<
4810 The 'langmap' option is a list of parts, separated with commas. Each
4811 part can be in one of two forms:
4812 1. A list of pairs. Each pair is a "from" character immediately
4813 followed by the "to" character. Examples: "aA", "aAbBcC".
4814 2. A list of "from" characters, a semi-colon and a list of "to"
4815 characters. Example: "abc;ABC"
4816 Example: "aA,fgh;FGH,cCdDeE"
4817 Special characters need to be preceded with a backslash. These are
4818 ";", ',' and backslash itself.
4819
4820 This will allow you to activate vim actions without having to switch
4821 back and forth between the languages. Your language characters will
4822 be understood as normal vim English characters (according to the
4823 langmap mappings) in the following cases:
4824 o Normal/Visual mode (commands, buffer/register names, user mappings)
4825 o Insert/Replace Mode: Register names after CTRL-R
4826 o Insert/Replace Mode: Mappings
4827 Characters entered in Command-line mode will NOT be affected by
4828 this option. Note that this option can be changed at any time
4829 allowing to switch between mappings for different languages/encodings.
4830 Use a mapping to avoid having to type it each time!
4831
4832 *'langmenu'* *'lm'*
4833'langmenu' 'lm' string (default "")
4834 global
4835 {not in Vi}
4836 {only available when compiled with the |+menu| and
4837 |+multi_lang| features}
4838 Language to use for menu translation. Tells which file is loaded
4839 from the "lang" directory in 'runtimepath': >
4840 "lang/menu_" . &langmenu . ".vim"
4841< (without the spaces). For example, to always use the Dutch menus, no
4842 matter what $LANG is set to: >
4843 :set langmenu=nl_NL.ISO_8859-1
4844< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004845 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 If your $LANG is set to a non-English language but you do want to use
4847 the English menus: >
4848 :set langmenu=none
4849< This option must be set before loading menus, switching on filetype
4850 detection or syntax highlighting. Once the menus are defined setting
4851 this option has no effect. But you could do this: >
4852 :source $VIMRUNTIME/delmenu.vim
4853 :set langmenu=de_DE.ISO_8859-1
4854 :source $VIMRUNTIME/menu.vim
4855< Warning: This deletes all menus that you defined yourself!
4856
Bram Moolenaard94464e2015-11-02 15:28:18 +01004857 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004858'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004859 global
4860 {not in Vi}
4861 {only available when compiled with the |+langmap|
4862 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004863 This is just like 'langremap' but with the value inverted. It only
4864 exists for backwards compatibility. When setting 'langremap' then
4865 'langnoremap' is set to the inverted value, and the other way around.
4866
4867 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4868'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4869 global
4870 {not in Vi}
4871 {only available when compiled with the |+langmap|
4872 feature}
4873 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004874 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004875 'langmap' disables some of your mappings, try resetting this option.
4876 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004877 that works for you to avoid mappings to break.
4878
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879 *'laststatus'* *'ls'*
4880'laststatus' 'ls' number (default 1)
4881 global
4882 {not in Vi}
4883 The value of this option influences when the last window will have a
4884 status line:
4885 0: never
4886 1: only if there are at least two windows
4887 2: always
4888 The screen looks nicer with a status line if you have several
4889 windows, but it takes another screen line. |status-line|
4890
4891 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4892'lazyredraw' 'lz' boolean (default off)
4893 global
4894 {not in Vi}
4895 When this option is set, the screen will not be redrawn while
4896 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004897 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 update use |:redraw|.
4899
4900 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4901'linebreak' 'lbr' boolean (default off)
4902 local to window
4903 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004904 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004906 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 than at the last character that fits on the screen. Unlike
4908 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004909 it only affects the way the file is displayed, not its contents.
4910 If 'breakindent' is set, line is visually indented. Then, the value
4911 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004912 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 Note that <Tab> characters after an <EOL> are mostly not displayed
4914 with the right amount of white space.
4915
4916 *'lines'* *E593*
4917'lines' number (default 24 or terminal height)
4918 global
4919 Number of lines of the Vim window.
4920 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004921 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 When Vim is running in the GUI or in a resizable window, setting this
4923 option will cause the window size to be changed. When you only want
4924 to use the size for the GUI, put the command in your |gvimrc| file.
4925 Vim limits the number of lines to what fits on the screen. You can
4926 use this command to get the tallest window possible: >
4927 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004928< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004929 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 When you set this option and Vim is unable to change the physical
4931 number of lines of the display, the display may be messed up.
4932
4933 *'linespace'* *'lsp'*
4934'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4935 global
4936 {not in Vi}
4937 {only in the GUI}
4938 Number of pixel lines inserted between characters. Useful if the font
4939 uses the full character cell height, making lines touch each other.
4940 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004941 With some fonts there can be too much room between lines (to have
4942 space for ascents and descents). Then it makes sense to set
4943 'linespace' to a negative value. This may cause display problems
4944 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
4946 *'lisp'* *'nolisp'*
4947'lisp' boolean (default off)
4948 local to buffer
4949 {not available when compiled without the |+lispindent|
4950 feature}
4951 Lisp mode: When <Enter> is typed in insert mode set the indent for
4952 the next line to Lisp standards (well, sort of). Also happens with
4953 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4954 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4955 better. Also see 'lispwords'.
4956 The '-' character is included in keyword characters. Redefines the
4957 "=" operator to use this same indentation algorithm rather than
4958 calling an external program if 'equalprg' is empty.
4959 This option is not used when 'paste' is set.
4960 {Vi: Does it a little bit differently}
4961
4962 *'lispwords'* *'lw'*
4963'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004964 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 {not in Vi}
4966 {not available when compiled without the |+lispindent|
4967 feature}
4968 Comma separated list of words that influence the Lisp indenting.
4969 |'lisp'|
4970
4971 *'list'* *'nolist'*
4972'list' boolean (default off)
4973 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004974 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4975 line. Useful to see the difference between tabs and spaces and for
4976 trailing blanks. Further changed by the 'listchars' option.
4977
4978 The cursor is displayed at the start of the space a Tab character
4979 occupies, not at the end as usual in Normal mode. To get this cursor
4980 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004981 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004982<
4983 Note that list mode will also affect formatting (set with 'textwidth'
4984 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 changing the way tabs are displayed.
4986
4987 *'listchars'* *'lcs'*
4988'listchars' 'lcs' string (default "eol:$")
4989 global
4990 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004991 Strings to use in 'list' mode and for the |:list| command. It is a
4992 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004993 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 eol:c Character to show at the end of each line. When
4995 omitted, there is no extra character at the end of the
4996 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004997 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004998 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005000 fill the space that the tab normally occupies.
5001 "tab:>-" will show a tab that takes four spaces as
5002 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005003 *lcs-space*
5004 space:c Character to show for a space. When omitted, spaces
5005 are left blank.
5006 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005007 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005008 trailing spaces are blank. Overrides the "space"
5009 setting for trailing spaces.
5010 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 extends:c Character to show in the last column, when 'wrap' is
5012 off and the line continues beyond the right of the
5013 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005014 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 precedes:c Character to show in the first column, when 'wrap'
5016 is off and there is text preceding the character
5017 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005018 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005019 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005020 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005021 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005022 nbsp:c Character to show for a non-breakable space character
5023 (0xA0 (160 decimal) and U+202F). Left blank when
5024 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005026 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005028 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029
5030 Examples: >
5031 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005032 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 :set lcs=extends:>,precedes:<
5034< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005035 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005036 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037
5038 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5039'loadplugins' 'lpl' boolean (default on)
5040 global
5041 {not in Vi}
5042 When on the plugin scripts are loaded when starting up |load-plugins|.
5043 This option can be reset in your |vimrc| file to disable the loading
5044 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005045 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5046 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047
Bram Moolenaard94464e2015-11-02 15:28:18 +01005048 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005049'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005050 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005051 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005052 {only available when compiled with the |+lua/dyn|
5053 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005054 Specifies the name of the Lua shared library. The default is
5055 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005056 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005057 This option cannot be set from a |modeline| or in the |sandbox|, for
5058 security reasons.
5059
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005060 *'macatsui'* *'nomacatsui'*
5061'macatsui' boolean (default on)
5062 global
5063 {only available in Mac GUI version}
5064 This is a workaround for when drawing doesn't work properly. When set
5065 and compiled with multi-byte support ATSUI text drawing is used. When
5066 not set ATSUI text drawing is not used. Switch this option off when
5067 you experience drawing problems. In a future version the problems may
5068 be solved and this option becomes obsolete. Therefore use this method
5069 to unset it: >
5070 if exists('&macatsui')
5071 set nomacatsui
5072 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005073< Another option to check if you have drawing problems is
5074 'termencoding'.
5075
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076 *'magic'* *'nomagic'*
5077'magic' boolean (default on)
5078 global
5079 Changes the special characters that can be used in search patterns.
5080 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005081 WARNING: Switching this option off most likely breaks plugins! That
5082 is because many patterns assume it's on and will fail when it's off.
5083 Only switch it off when working with old Vi scripts. In any other
5084 situation write patterns that work when 'magic' is on. Include "\M"
5085 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086
5087 *'makeef'* *'mef'*
5088'makeef' 'mef' string (default: "")
5089 global
5090 {not in Vi}
5091 {not available when compiled without the |+quickfix|
5092 feature}
5093 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5094 and the |:grep| command.
5095 When it is empty, an internally generated temp file will be used.
5096 When "##" is included, it is replaced by a number to make the name
5097 unique. This makes sure that the ":make" command doesn't overwrite an
5098 existing file.
5099 NOT used for the ":cf" command. See 'errorfile' for that.
5100 Environment variables are expanded |:set_env|.
5101 See |option-backslash| about including spaces and backslashes.
5102 This option cannot be set from a |modeline| or in the |sandbox|, for
5103 security reasons.
5104
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005105 *'makeencoding'* *'menc'*
5106'makeencoding' 'menc' string (default "")
5107 global or local to buffer |global-local|
5108 {only available when compiled with the |+multi_byte|
5109 feature}
5110 {not in Vi}
5111 Encoding used for reading the output of external commands. When empty,
5112 encoding is not converted.
5113 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5114 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5115 and `:laddfile`.
5116
5117 This would be mostly useful when you use MS-Windows and set 'encoding'
5118 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5119 'makeencoding' to "char" has the same effect as setting to the system
5120 locale encoding. Example: >
5121 :set encoding=utf-8
5122 :set makeencoding=char " system locale is used
5123<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 *'makeprg'* *'mp'*
5125'makeprg' 'mp' string (default "make", VMS: "MMS")
5126 global or local to buffer |global-local|
5127 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005128 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005129 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5130 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005131 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005132 Environment variables are expanded |:set_env|. See |option-backslash|
5133 about including spaces and backslashes.
5134 Note that a '|' must be escaped twice: once for ":set" and once for
5135 the interpretation of a command. When you use a filter called
5136 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 :set makeprg=gmake\ \\\|\ myfilter
5138< The placeholder "$*" can be given (even multiple times) to specify
5139 where the arguments will be included, for example: >
5140 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5141< This option cannot be set from a |modeline| or in the |sandbox|, for
5142 security reasons.
5143
5144 *'matchpairs'* *'mps'*
5145'matchpairs' 'mps' string (default "(:),{:},[:]")
5146 local to buffer
5147 {not in Vi}
5148 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005149 other.
5150 Only character pairs are allowed that are different, thus you cannot
5151 jump between two double quotes.
5152 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005153 The pairs must be separated by a comma. Example for including '<' and
5154 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 :set mps+=<:>
5156
5157< A more exotic example, to jump between the '=' and ';' in an
5158 assignment, useful for languages like C and Java: >
5159 :au FileType c,cpp,java set mps+==:;
5160
5161< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005162 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164 *'matchtime'* *'mat'*
5165'matchtime' 'mat' number (default 5)
5166 global
5167 {not in Vi}{in Nvi}
5168 Tenths of a second to show the matching paren, when 'showmatch' is
5169 set. Note that this is not in milliseconds, like other options that
5170 set a time. This is to be compatible with Nvi.
5171
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005172 *'maxcombine'* *'mco'*
5173'maxcombine' 'mco' number (default 2)
5174 global
5175 {not in Vi}
5176 {only available when compiled with the |+multi_byte|
5177 feature}
5178 The maximum number of combining characters supported for displaying.
5179 Only used when 'encoding' is "utf-8".
5180 The default is OK for most languages. Hebrew may require 4.
5181 Maximum value is 6.
5182 Even when this option is set to 2 you can still edit text with more
5183 combining characters, you just can't see them. Use |g8| or |ga|.
5184 See |mbyte-combining|.
5185
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 *'maxfuncdepth'* *'mfd'*
5187'maxfuncdepth' 'mfd' number (default 100)
5188 global
5189 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005190 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005191 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 Maximum depth of function calls for user functions. This normally
5193 catches endless recursion. When using a recursive function with
5194 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5195 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005196 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005197 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 See also |:function|.
5199
5200 *'maxmapdepth'* *'mmd'* *E223*
5201'maxmapdepth' 'mmd' number (default 1000)
5202 global
5203 {not in Vi}
5204 Maximum number of times a mapping is done without resulting in a
5205 character to be used. This normally catches endless mappings, like
5206 ":map x y" with ":map y x". It still does not catch ":map g wg",
5207 because the 'w' is used before the next mapping is done. See also
5208 |key-mapping|.
5209
5210 *'maxmem'* *'mm'*
5211'maxmem' 'mm' number (default between 256 to 5120 (system
5212 dependent) or half the amount of memory
5213 available)
5214 global
5215 {not in Vi}
5216 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5217 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005218 other memory to be freed.
5219 The maximum usable value is about 2000000. Use this to work without a
5220 limit.
5221 The value is ignored when 'swapfile' is off.
5222 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005224 *'maxmempattern'* *'mmp'*
5225'maxmempattern' 'mmp' number (default 1000)
5226 global
5227 {not in Vi}
5228 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005229 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005230 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005231 When Vim runs into the limit it gives an error message and mostly
5232 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005233 Running into the limit often means that the pattern is very
5234 inefficient or too complex. This may already happen with the pattern
5235 "\(.\)*" on a very long line. ".*" works much better.
5236 Vim may run out of memory before hitting the 'maxmempattern' limit.
5237
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 *'maxmemtot'* *'mmt'*
5239'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5240 dependent) or half the amount of memory
5241 available)
5242 global
5243 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005244 Maximum amount of memory in Kbyte to use for all buffers together.
5245 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005246 without a limit.
5247 On 64 bit machines higher values might work. But hey, do you really
5248 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005249 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005250 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005251 Buffers with 'swapfile' off still count to the total amount of memory
5252 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005253 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254
5255 *'menuitems'* *'mis'*
5256'menuitems' 'mis' number (default 25)
5257 global
5258 {not in Vi}
5259 {not available when compiled without the |+menu|
5260 feature}
5261 Maximum number of items to use in a menu. Used for menus that are
5262 generated from a list of items, e.g., the Buffers menu. Changing this
5263 option has no direct effect, the menu must be refreshed first.
5264
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005265 *'mkspellmem'* *'msm'*
5266'mkspellmem' 'msm' string (default "460000,2000,500")
5267 global
5268 {not in Vi}
5269 {not available when compiled without the |+syntax|
5270 feature}
5271 Parameters for |:mkspell|. This tunes when to start compressing the
5272 word tree. Compression can be slow when there are many words, but
5273 it's needed to avoid running out of memory. The amount of memory used
5274 per word depends very much on how similar the words are, that's why
5275 this tuning is complicated.
5276
5277 There are three numbers, separated by commas:
5278 {start},{inc},{added}
5279
5280 For most languages the uncompressed word tree fits in memory. {start}
5281 gives the amount of memory in Kbyte that can be used before any
5282 compression is done. It should be a bit smaller than the amount of
5283 memory that is available to Vim.
5284
5285 When going over the {start} limit the {inc} number specifies the
5286 amount of memory in Kbyte that can be allocated before another
5287 compression is done. A low number means compression is done after
5288 less words are added, which is slow. A high number means more memory
5289 will be allocated.
5290
5291 After doing compression, {added} times 1024 words can be added before
5292 the {inc} limit is ignored and compression is done when any extra
5293 amount of memory is needed. A low number means there is a smaller
5294 chance of hitting the {inc} limit, less memory is used but it's
5295 slower.
5296
5297 The languages for which these numbers are important are Italian and
5298 Hungarian. The default works for when you have about 512 Mbyte. If
5299 you have 1 Gbyte you could use: >
5300 :set mkspellmem=900000,3000,800
5301< If you have less than 512 Mbyte |:mkspell| may fail for some
5302 languages, no matter what you set 'mkspellmem' to.
5303
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005305'modeline' 'ml' boolean (Vim default: on (off for root),
5306 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 local to buffer
5308 *'modelines'* *'mls'*
5309'modelines' 'mls' number (default 5)
5310 global
5311 {not in Vi}
5312 If 'modeline' is on 'modelines' gives the number of lines that is
5313 checked for set commands. If 'modeline' is off or 'modelines' is zero
5314 no lines are checked. See |modeline|.
5315 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5316 set and to the Vim default value when 'compatible' is reset.
5317
5318 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5319'modifiable' 'ma' boolean (default on)
5320 local to buffer
5321 {not in Vi} *E21*
5322 When off the buffer contents cannot be changed. The 'fileformat' and
5323 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005324 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5327'modified' 'mod' boolean (default off)
5328 local to buffer
5329 {not in Vi}
5330 When on, the buffer is considered to be modified. This option is set
5331 when:
5332 1. A change was made to the text since it was last written. Using the
5333 |undo| command to go back to the original text will reset the
5334 option. But undoing changes that were made before writing the
5335 buffer will set the option again, since the text is different from
5336 when it was written.
5337 2. 'fileformat' or 'fileencoding' is different from its original
5338 value. The original value is set when the buffer is read or
5339 written. A ":set nomodified" command also resets the original
5340 values to the current values and the 'modified' option will be
5341 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005342 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005343 This option is not set when a change is made to the buffer as the
5344 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5345 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5346 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5348 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005349 Note that the text may actually be the same, e.g. 'modified' is set
5350 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005351
5352 *'more'* *'nomore'*
5353'more' boolean (Vim default: on, Vi default: off)
5354 global
5355 {not in Vi}
5356 When on, listings pause when the whole screen is filled. You will get
5357 the |more-prompt|. When this option is off there are no pauses, the
5358 listing continues until finished.
5359 NOTE: This option is set to the Vi default value when 'compatible' is
5360 set and to the Vim default value when 'compatible' is reset.
5361
5362 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005363'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5364 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 global
5366 {not in Vi}
5367 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005368 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5369 sysmouse and Linux console with gpm). For using the mouse in the
5370 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005372 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 v Visual mode
5374 i Insert mode
5375 c Command-line mode
5376 h all previous modes when editing a help file
5377 a all previous modes
5378 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 Normally you would enable the mouse in all four modes with: >
5380 :set mouse=a
5381< When the mouse is not enabled, the GUI will still use the mouse for
5382 modeless selection. This doesn't move the text cursor.
5383
5384 See |mouse-using|. Also see |'clipboard'|.
5385
5386 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 the mouse buttons can still be used by keeping the shift key pressed.
5389 Also see the 'clipboard' option.
5390
5391 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5392'mousefocus' 'mousef' boolean (default off)
5393 global
5394 {not in Vi}
5395 {only works in the GUI}
5396 The window that the mouse pointer is on is automatically activated.
5397 When changing the window layout or window focus in another way, the
5398 mouse pointer is moved to the window with keyboard focus. Off is the
5399 default because it makes using the pull down menus a little goofy, as
5400 a pointer transit may activate a window unintentionally.
5401
5402 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5403'mousehide' 'mh' boolean (default on)
5404 global
5405 {not in Vi}
5406 {only works in the GUI}
5407 When on, the mouse pointer is hidden when characters are typed.
5408 The mouse pointer is restored when the mouse is moved.
5409
5410 *'mousemodel'* *'mousem'*
5411'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5412 global
5413 {not in Vi}
5414 Sets the model to use for the mouse. The name mostly specifies what
5415 the right mouse button is used for:
5416 extend Right mouse button extends a selection. This works
5417 like in an xterm.
5418 popup Right mouse button pops up a menu. The shifted left
5419 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005420 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 popup_setpos Like "popup", but the cursor will be moved to the
5422 position where the mouse was clicked, and thus the
5423 selected operation will act upon the clicked object.
5424 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005425 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 course, that right clicking outside a selection will
5427 end Visual mode.
5428 Overview of what button does what for each model:
5429 mouse extend popup(_setpos) ~
5430 left click place cursor place cursor
5431 left drag start selection start selection
5432 shift-left search word extend selection
5433 right click extend selection popup menu (place cursor)
5434 right drag extend selection -
5435 middle click paste paste
5436
5437 In the "popup" model the right mouse button produces a pop-up menu.
5438 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005439 In a terminal the popup menu works if Vim is compiled with the
5440 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441
5442 Note that you can further refine the meaning of buttons with mappings.
5443 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5444 selection (because that's handled in the GUI code directly).
5445
5446 The 'mousemodel' option is set by the |:behave| command.
5447
5448 *'mouseshape'* *'mouses'* *E547*
5449'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005450 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 global
5452 {not in Vi}
5453 {only available when compiled with the |+mouseshape|
5454 feature}
5455 This option tells Vim what the mouse pointer should look like in
5456 different modes. The option is a comma separated list of parts, much
5457 like used for 'guicursor'. Each part consist of a mode/location-list
5458 and an argument-list:
5459 mode-list:shape,mode-list:shape,..
5460 The mode-list is a dash separated list of these modes/locations:
5461 In a normal window: ~
5462 n Normal mode
5463 v Visual mode
5464 ve Visual mode with 'selection' "exclusive" (same as 'v',
5465 if not specified)
5466 o Operator-pending mode
5467 i Insert mode
5468 r Replace mode
5469
5470 Others: ~
5471 c appending to the command-line
5472 ci inserting in the command-line
5473 cr replacing in the command-line
5474 m at the 'Hit ENTER' or 'More' prompts
5475 ml idem, but cursor in the last line
5476 e any mode, pointer below last window
5477 s any mode, pointer on a status line
5478 sd any mode, while dragging a status line
5479 vs any mode, pointer on a vertical separator line
5480 vd any mode, while dragging a vertical separator line
5481 a everywhere
5482
5483 The shape is one of the following:
5484 avail name looks like ~
5485 w x arrow Normal mouse pointer
5486 w x blank no pointer at all (use with care!)
5487 w x beam I-beam
5488 w x updown up-down sizing arrows
5489 w x leftright left-right sizing arrows
5490 w x busy The system's usual busy pointer
5491 w x no The system's usual 'no input' pointer
5492 x udsizing indicates up-down resizing
5493 x lrsizing indicates left-right resizing
5494 x crosshair like a big thin +
5495 x hand1 black hand
5496 x hand2 white hand
5497 x pencil what you write with
5498 x question big ?
5499 x rightup-arrow arrow pointing right-up
5500 w x up-arrow arrow pointing up
5501 x <number> any X11 pointer number (see X11/cursorfont.h)
5502
5503 The "avail" column contains a 'w' if the shape is available for Win32,
5504 x for X11.
5505 Any modes not specified or shapes not available use the normal mouse
5506 pointer.
5507
5508 Example: >
5509 :set mouseshape=s:udsizing,m:no
5510< will make the mouse turn to a sizing arrow over the status lines and
5511 indicate no input when the hit-enter prompt is displayed (since
5512 clicking the mouse has no effect in this state.)
5513
5514 *'mousetime'* *'mouset'*
5515'mousetime' 'mouset' number (default 500)
5516 global
5517 {not in Vi}
5518 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5519 time in msec between two mouse clicks for the second click to be
5520 recognized as a multi click.
5521
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005522 *'mzschemedll'*
5523'mzschemedll' string (default depends on the build)
5524 global
5525 {not in Vi}
5526 {only available when compiled with the |+mzscheme/dyn|
5527 feature}
5528 Specifies the name of the MzScheme shared library. The default is
5529 DYNAMIC_MZSCH_DLL which was specified at compile time.
5530 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005531 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005532 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005533 This option cannot be set from a |modeline| or in the |sandbox|, for
5534 security reasons.
5535
5536 *'mzschemegcdll'*
5537'mzschemegcdll' string (default depends on the build)
5538 global
5539 {not in Vi}
5540 {only available when compiled with the |+mzscheme/dyn|
5541 feature}
5542 Specifies the name of the MzScheme GC shared library. The default is
5543 DYNAMIC_MZGC_DLL which was specified at compile time.
5544 The value can be equal to 'mzschemedll' if it includes the GC code.
5545 Environment variables are expanded |:set_env|.
5546 This option cannot be set from a |modeline| or in the |sandbox|, for
5547 security reasons.
5548
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005549 *'mzquantum'* *'mzq'*
5550'mzquantum' 'mzq' number (default 100)
5551 global
5552 {not in Vi}
5553 {not available when compiled without the |+mzscheme|
5554 feature}
5555 The number of milliseconds between polls for MzScheme threads.
5556 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005557 NOTE: This option is set to the Vim default value when 'compatible'
5558 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005559
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005561'nrformats' 'nf' string (default "bin,octal,hex",
5562 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005563 local to buffer
5564 {not in Vi}
5565 This defines what bases Vim will consider for numbers when using the
5566 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5567 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005568 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005570 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005571 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005573 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 considered to be hexadecimal. Example: Using CTRL-X on
5575 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005576 bin If included, numbers starting with "0b" or "0B" will be
5577 considered to be binary. Example: Using CTRL-X on
5578 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 Numbers which simply begin with a digit in the range 1-9 are always
5580 considered decimal. This also happens for numbers that are not
5581 recognized as octal or hex.
5582
5583 *'number'* *'nu'* *'nonumber'* *'nonu'*
5584'number' 'nu' boolean (default off)
5585 local to window
5586 Print the line number in front of each line. When the 'n' option is
5587 excluded from 'cpoptions' a wrapped line will not use the column of
5588 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005589 The 'numberwidth' option can be used to set the room used for the line
5590 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 When a long, wrapped line doesn't start with the first character, '-'
5592 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005593 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5594 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005595 *number_relativenumber*
5596 The 'relativenumber' option changes the displayed number to be
5597 relative to the cursor. Together with 'number' there are these
5598 four combinations (cursor in line 3):
5599
Bram Moolenaar3848e002016-03-19 18:42:29 +01005600 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005601 'nornu' 'nornu' 'rnu' 'rnu'
5602
5603 |apple | 1 apple | 2 apple | 2 apple
5604 |pear | 2 pear | 1 pear | 1 pear
5605 |nobody | 3 nobody | 0 nobody |3 nobody
5606 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005608 *'numberwidth'* *'nuw'*
5609'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5610 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005611 {not in Vi}
5612 {only available when compiled with the |+linebreak|
5613 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005614 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005615 when the 'number' or 'relativenumber' option is set or printing lines
5616 with a line number. Since one space is always between the number and
5617 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005618 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005619 fit the highest line number in the buffer respectively the number of
5620 rows in the window, depending on whether 'number' or 'relativenumber'
5621 is set. Thus with the Vim default of 4 there is room for a line number
5622 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005623 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005624 NOTE: This option is set to the Vi default value when 'compatible' is
5625 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005626
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005627 *'omnifunc'* *'ofu'*
5628'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005629 local to buffer
5630 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005631 {not available when compiled without the |+eval|
5632 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005633 This option specifies a function to be used for Insert mode omni
5634 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005635 See |complete-functions| for an explanation of how the function is
5636 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005637 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005638 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005639 This option cannot be set from a |modeline| or in the |sandbox|, for
5640 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005641
5642
Bram Moolenaar02467872007-05-06 13:22:01 +00005643 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005644'opendevice' 'odev' boolean (default off)
5645 global
5646 {not in Vi}
5647 {only for MS-DOS, MS-Windows and OS/2}
5648 Enable reading and writing from devices. This may get Vim stuck on a
5649 device that can be opened but doesn't actually do the I/O. Therefore
5650 it is off by default.
5651 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5652 result in editing a device.
5653
5654
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005655 *'operatorfunc'* *'opfunc'*
5656'operatorfunc' 'opfunc' string (default: empty)
5657 global
5658 {not in Vi}
5659 This option specifies a function to be called by the |g@| operator.
5660 See |:map-operator| for more info and an example.
5661
5662 This option cannot be set from a |modeline| or in the |sandbox|, for
5663 security reasons.
5664
5665
Bram Moolenaar251e1912011-06-19 05:09:16 +02005666 *'osfiletype'* *'oft'*
5667'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 local to buffer
5669 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005670 This option was supported on RISC OS, which has been removed.
5671
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005673 *'packpath'* *'pp'*
5674'packpath' 'pp' string (default: see 'runtimepath')
5675 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005676 Directories used to find packages. See |packages|.
5677
5678
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005680'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 global
5682 Specifies the nroff macros that separate paragraphs. These are pairs
5683 of two letters (see |object-motions|).
5684
5685 *'paste'* *'nopaste'*
5686'paste' boolean (default off)
5687 global
5688 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005689 Put Vim in Paste mode. This is useful if you want to cut or copy
5690 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 unexpected effects.
5692 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005693 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005694 knows about pasting and will mostly do the right thing without 'paste'
5695 being set. The same is true for a terminal where Vim handles the
5696 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005697 This option is reset when starting the GUI. Thus if you set it in
5698 your .vimrc it will work in a terminal, but not in the GUI. Setting
5699 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5700 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 When the 'paste' option is switched on (also when it was already on):
5702 - mapping in Insert mode and Command-line mode is disabled
5703 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005705 - 'expandtab' is reset
5706 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 - 'revins' is reset
5708 - 'ruler' is reset
5709 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005710 - 'smartindent' is reset
5711 - 'smarttab' is reset
5712 - 'softtabstop' is set to 0
5713 - 'textwidth' is set to 0
5714 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005717 - 'indentexpr'
5718 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 NOTE: When you start editing another file while the 'paste' option is
5720 on, settings from the modelines or autocommands may change the
5721 settings again, causing trouble when pasting text. You might want to
5722 set the 'paste' option again.
5723 When the 'paste' option is reset the mentioned options are restored to
5724 the value before the moment 'paste' was switched from off to on.
5725 Resetting 'paste' before ever setting it does not have any effect.
5726 Since mapping doesn't work while 'paste' is active, you need to use
5727 the 'pastetoggle' option to toggle the 'paste' option with some key.
5728
5729 *'pastetoggle'* *'pt'*
5730'pastetoggle' 'pt' string (default "")
5731 global
5732 {not in Vi}
5733 When non-empty, specifies the key sequence that toggles the 'paste'
5734 option. This is like specifying a mapping: >
5735 :map {keys} :set invpaste<CR>
5736< Where {keys} is the value of 'pastetoggle'.
5737 The difference is that it will work even when 'paste' is set.
5738 'pastetoggle' works in Insert mode and Normal mode, but not in
5739 Command-line mode.
5740 Mappings are checked first, thus overrule 'pastetoggle'. However,
5741 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5742 this: >
5743 :map <F10> :set paste<CR>
5744 :map <F11> :set nopaste<CR>
5745 :imap <F10> <C-O>:set paste<CR>
5746 :imap <F11> <nop>
5747 :set pastetoggle=<F11>
5748< This will make <F10> start paste mode and <F11> stop paste mode.
5749 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5750 mode everything is inserted literally, except the 'pastetoggle' key
5751 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005752 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
5754 *'pex'* *'patchexpr'*
5755'patchexpr' 'pex' string (default "")
5756 global
5757 {not in Vi}
5758 {not available when compiled without the |+diff|
5759 feature}
5760 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005761 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762
Bram Moolenaardbc28022014-07-26 13:40:44 +02005763 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764'patchmode' 'pm' string (default "")
5765 global
5766 {not in Vi}
5767 When non-empty the oldest version of a file is kept. This can be used
5768 to keep the original version of a file if you are changing files in a
5769 source distribution. Only the first time that a file is written a
5770 copy of the original file will be kept. The name of the copy is the
5771 name of the original file with the string in the 'patchmode' option
5772 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005773 ".orig" or ".org". 'backupdir' must not be empty for this to work
5774 (Detail: The backup file is renamed to the patchmode file after the
5775 new file has been successfully written, that's why it must be possible
5776 to write a backup file). If there was no file to be backed up, an
5777 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 When the 'backupskip' pattern matches, a patchmode file is not made.
5779 Using 'patchmode' for compressed files appends the extension at the
5780 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5781 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005782 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005784 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785'path' 'pa' string (default on Unix: ".,/usr/include,,"
5786 on OS/2: ".,/emx/include,,"
5787 other systems: ".,,")
5788 global or local to buffer |global-local|
5789 {not in Vi}
5790 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005791 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5792 provided that the file being searched for has a relative path (not
5793 starting with "/", "./" or "../"). The directories in the 'path'
5794 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 - Use commas to separate directory names: >
5796 :set path=.,/usr/local/include,/usr/include
5797< - Spaces can also be used to separate directory names (for backwards
5798 compatibility with version 3.0). To have a space in a directory
5799 name, precede it with an extra backslash, and escape the space: >
5800 :set path=.,/dir/with\\\ space
5801< - To include a comma in a directory name precede it with an extra
5802 backslash: >
5803 :set path=.,/dir/with\\,comma
5804< - To search relative to the directory of the current file, use: >
5805 :set path=.
5806< - To search in the current directory use an empty string between two
5807 commas: >
5808 :set path=,,
5809< - A directory name may end in a ':' or '/'.
5810 - Environment variables are expanded |:set_env|.
5811 - When using |netrw.vim| URLs can be used. For example, adding
5812 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005813 - Search upwards and downwards in a directory tree using "*", "**" and
5814 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815 {not available when compiled without the |+path_extra| feature}
5816 - Careful with '\' characters, type two to get one in the option: >
5817 :set path=.,c:\\include
5818< Or just use '/' instead: >
5819 :set path=.,c:/include
5820< Don't forget "." or files won't even be found in the same directory as
5821 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 it is something like 256 or 1024 characters.
5824 You can check if all the include files are found, using the value of
5825 'path', see |:checkpath|.
5826 The use of |:set+=| and |:set-=| is preferred when adding or removing
5827 directories from the list. This avoids problems when a future version
5828 uses another default. To remove the current directory use: >
5829 :set path-=
5830< To add the current directory use: >
5831 :set path+=
5832< To use an environment variable, you probably need to replace the
5833 separator. Here is an example to append $INCL, in which directory
5834 names are separated with a semi-colon: >
5835 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5836< Replace the ';' with a ':' or whatever separator is used. Note that
5837 this doesn't work when $INCL contains a comma or white space.
5838
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005839 *'perldll'*
5840'perldll' string (default depends on the build)
5841 global
5842 {not in Vi}
5843 {only available when compiled with the |+perl/dyn|
5844 feature}
5845 Specifies the name of the Perl shared library. The default is
5846 DYNAMIC_PERL_DLL, which was specified at compile time.
5847 Environment variables are expanded |:set_env|.
5848 This option cannot be set from a |modeline| or in the |sandbox|, for
5849 security reasons.
5850
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5852'preserveindent' 'pi' boolean (default off)
5853 local to buffer
5854 {not in Vi}
5855 When changing the indent of the current line, preserve as much of the
5856 indent structure as possible. Normally the indent is replaced by a
5857 series of tabs followed by spaces as required (unless |'expandtab'| is
5858 enabled, in which case only spaces are used). Enabling this option
5859 means the indent will preserve as many existing characters as possible
5860 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005861 'expandtab' does not apply to the preserved white space, a Tab remains
5862 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 NOTE: When using ">>" multiple times the resulting indent is a mix of
5864 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005865 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 Also see 'copyindent'.
5867 Use |:retab| to clean up white space.
5868
5869 *'previewheight'* *'pvh'*
5870'previewheight' 'pvh' number (default 12)
5871 global
5872 {not in Vi}
5873 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005874 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 Default height for a preview window. Used for |:ptag| and associated
5876 commands. Used for |CTRL-W_}| when no count is given.
5877
5878 *'previewwindow'* *'nopreviewwindow'*
5879 *'pvw'* *'nopvw'* *E590*
5880'previewwindow' 'pvw' boolean (default off)
5881 local to window
5882 {not in Vi}
5883 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005884 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005885 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 set. It's normally not set directly, but by using one of the commands
5887 |:ptag|, |:pedit|, etc.
5888
5889 *'printdevice'* *'pdev'*
5890'printdevice' 'pdev' string (default empty)
5891 global
5892 {not in Vi}
5893 {only available when compiled with the |+printer|
5894 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005895 The name of the printer to be used for |:hardcopy|.
5896 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005897 This option cannot be set from a |modeline| or in the |sandbox|, for
5898 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899
Bram Moolenaar8299df92004-07-10 09:47:34 +00005900 *'printencoding'* *'penc'*
5901'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 global
5903 {not in Vi}
5904 {only available when compiled with the |+printer|
5905 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005906 Sets the character encoding used when printing.
5907 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908
5909 *'printexpr'* *'pexpr'*
5910'printexpr' 'pexpr' String (default: see below)
5911 global
5912 {not in Vi}
5913 {only available when compiled with the |+printer|
5914 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005915 Expression used to print the PostScript produced with |:hardcopy|.
5916 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005917 This option cannot be set from a |modeline| or in the |sandbox|, for
5918 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919
Bram Moolenaar8299df92004-07-10 09:47:34 +00005920 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921'printfont' 'pfn' string (default "courier")
5922 global
5923 {not in Vi}
5924 {only available when compiled with the |+printer|
5925 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005926 The name of the font that will be used for |:hardcopy|.
5927 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928
5929 *'printheader'* *'pheader'*
5930'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5931 global
5932 {not in Vi}
5933 {only available when compiled with the |+printer|
5934 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005935 The format of the header produced in |:hardcopy| output.
5936 See |pheader-option|.
5937
5938 *'printmbcharset'* *'pmbcs'*
5939'printmbcharset' 'pmbcs' string (default "")
5940 global
5941 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005942 {only available when compiled with the |+printer|,
5943 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005944 The CJK character set to be used for CJK output from |:hardcopy|.
5945 See |pmbcs-option|.
5946
5947 *'printmbfont'* *'pmbfn'*
5948'printmbfont' 'pmbfn' string (default "")
5949 global
5950 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005951 {only available when compiled with the |+printer|,
5952 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005953 List of font names to be used for CJK output from |:hardcopy|.
5954 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955
5956 *'printoptions'* *'popt'*
5957'printoptions' 'popt' string (default "")
5958 global
5959 {not in Vi}
5960 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005961 List of items that control the format of the output of |:hardcopy|.
5962 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005964 *'prompt'* *'noprompt'*
5965'prompt' boolean (default on)
5966 global
5967 When on a ":" prompt is used in Ex mode.
5968
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005969 *'pumheight'* *'ph'*
5970'pumheight' 'ph' number (default 0)
5971 global
5972 {not available when compiled without the
5973 |+insert_expand| feature}
5974 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005975 Determines the maximum number of items to show in the popup menu for
5976 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005977 |ins-completion-menu|.
5978
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005979 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005980'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005981 global
5982 {not available when compiled without the
5983 |+insert_expand| feature}
5984 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005985 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005986 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005987
Bram Moolenaard94464e2015-11-02 15:28:18 +01005988 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005989'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005990 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005991 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005992 {only available when compiled with the |+python/dyn|
5993 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005994 Specifies the name of the Python 2.x shared library. The default is
5995 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005996 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005997 This option cannot be set from a |modeline| or in the |sandbox|, for
5998 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005999
Bram Moolenaar94073162018-01-31 21:49:05 +01006000 *'pythonhome'*
6001'pythonhome' string (default "")
6002 global
6003 {not in Vi}
6004 {only available when compiled with the |+python/dyn|
6005 feature}
6006 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6007 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6008 which was specified at compile time, will be used for the Python 2.x
6009 home directory.
6010 Environment variables are expanded |:set_env|.
6011 This option cannot be set from a |modeline| or in the |sandbox|, for
6012 security reasons.
6013
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006014 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006015'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006016 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006017 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006018 {only available when compiled with the |+python3/dyn|
6019 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006020 Specifies the name of the Python 3 shared library. The default is
6021 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006022 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006023 This option cannot be set from a |modeline| or in the |sandbox|, for
6024 security reasons.
6025
Bram Moolenaar94073162018-01-31 21:49:05 +01006026 *'pythonthreehome'*
6027'pythonthreehome' string (default "")
6028 global
6029 {not in Vi}
6030 {only available when compiled with the |+python3/dyn|
6031 feature}
6032 Specifies the name of the Python 3 home directory. When
6033 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6034 PYTHON3_HOME, which was specified at compile time, will be used for
6035 the Python 3 home directory.
6036 Environment variables are expanded |:set_env|.
6037 This option cannot be set from a |modeline| or in the |sandbox|, for
6038 security reasons.
6039
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006040 *'pyxversion'* *'pyx'*
6041'pyxversion' 'pyx' number (default depends on the build)
6042 global
6043 {not in Vi}
6044 {only available when compiled with the |+python| or
6045 the |+python3| feature}
6046 Specifies the python version used for pyx* functions and commands
6047 |python_x|. The default value is as follows:
6048
6049 Compiled with Default ~
6050 |+python| and |+python3| 0
6051 only |+python| 2
6052 only |+python3| 3
6053
6054 Available values are 0, 2 and 3.
6055 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6056 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6057 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6058 to 2 if Python 2 is available.
6059 See also: |has-pythonx|
6060
6061 If Vim is compiled with only |+python| or |+python3| setting
6062 'pyxversion' has no effect. The pyx* functions and commands are
6063 always the same as the compiled version.
6064
6065 This option cannot be set from a |modeline| or in the |sandbox|, for
6066 security reasons.
6067
Bram Moolenaar677ee682005-01-27 14:41:15 +00006068 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006069'quoteescape' 'qe' string (default "\")
6070 local to buffer
6071 {not in Vi}
6072 The characters that are used to escape quotes in a string. Used for
6073 objects like a', a" and a` |a'|.
6074 When one of the characters in this option is found inside a string,
6075 the following character will be skipped. The default value makes the
6076 text "foo\"bar\\" considered to be one string.
6077
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6079'readonly' 'ro' boolean (default off)
6080 local to buffer
6081 If on, writes fail unless you use a '!'. Protects you from
6082 accidentally overwriting a file. Default on when Vim is started
6083 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006084 When using ":w!" the 'readonly' option is reset for the current
6085 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006087 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006088 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006090 *'redrawtime'* *'rdt'*
6091'redrawtime' 'rdt' number (default 2000)
6092 global
6093 {not in Vi}
6094 {only available when compiled with the |+reltime|
6095 feature}
6096 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006097 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006098 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006099 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006100 matches will be highlighted.
6101 For syntax highlighting the time applies per window. When over the
6102 limit syntax highlighting is disabled until |CTRL-L| is used.
6103 This is used to avoid that Vim hangs when using a very complicated
6104 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006105
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006106 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006107'regexpengine' 're' number (default 0)
6108 global
6109 {not in Vi}
6110 This selects the default regexp engine. |two-engines|
6111 The possible values are:
6112 0 automatic selection
6113 1 old engine
6114 2 NFA engine
6115 Note that when using the NFA engine and the pattern contains something
6116 that is not supported the pattern will not match. This is only useful
6117 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006118 Using automatic selection enables Vim to switch the engine, if the
6119 default engine becomes too costly. E.g., when the NFA engine uses too
6120 many states. This should prevent Vim from hanging on a combination of
6121 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006122
Bram Moolenaar64486672010-05-16 15:46:46 +02006123 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6124'relativenumber' 'rnu' boolean (default off)
6125 local to window
6126 {not in Vi}
6127 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006128 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006129 precede some vertical motion commands (e.g. j k + -) with, without
6130 having to calculate it yourself. Especially useful in combination with
6131 other commands (e.g. y d c < > gq gw =).
6132 When the 'n' option is excluded from 'cpoptions' a wrapped
6133 line will not use the column of line numbers (this is the default when
6134 'compatible' isn't set).
6135 The 'numberwidth' option can be used to set the room used for the line
6136 number.
6137 When a long, wrapped line doesn't start with the first character, '-'
6138 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006139 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6140 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006141
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006142 The number in front of the cursor line also depends on the value of
6143 'number', see |number_relativenumber| for all combinations of the two
6144 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006145
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 *'remap'* *'noremap'*
6147'remap' boolean (default on)
6148 global
6149 Allows for mappings to work recursively. If you do not want this for
6150 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006151 NOTE: To avoid portability problems with Vim scripts, always keep
6152 this option at the default "on". Only switch it off when working with
6153 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006155 *'renderoptions'* *'rop'*
6156'renderoptions' 'rop' string (default: empty)
6157 global
6158 {not in Vi}
6159 {only available when compiled with GUI and DIRECTX on
6160 MS-Windows}
6161 Select a text renderer and set its options. The options depend on the
6162 renderer.
6163
6164 Syntax: >
6165 set rop=type:{renderer}(,{name}:{value})*
6166<
6167 Currently, only one optional renderer is available.
6168
6169 render behavior ~
6170 directx Vim will draw text using DirectX (DirectWrite). It makes
6171 drawn glyphs more beautiful than default GDI.
6172 It requires 'encoding' is "utf-8", and only works on
6173 MS-Windows Vista or newer version.
6174
6175 Options:
6176 name meaning type value ~
6177 gamma gamma float 1.0 - 2.2 (maybe)
6178 contrast enhancedContrast float (unknown)
6179 level clearTypeLevel float (unknown)
6180 geom pixelGeometry int 0 - 2 (see below)
6181 renmode renderingMode int 0 - 6 (see below)
6182 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006183 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006184
Bram Moolenaar92467d32017-12-05 13:22:16 +01006185 See this URL for detail (except for scrlines):
6186 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006187
6188 For geom: structure of a device pixel.
6189 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6190 1 - DWRITE_PIXEL_GEOMETRY_RGB
6191 2 - DWRITE_PIXEL_GEOMETRY_BGR
6192
6193 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006194 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006195
6196 For renmode: method of rendering glyphs.
6197 0 - DWRITE_RENDERING_MODE_DEFAULT
6198 1 - DWRITE_RENDERING_MODE_ALIASED
6199 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6200 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6201 4 - DWRITE_RENDERING_MODE_NATURAL
6202 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6203 6 - DWRITE_RENDERING_MODE_OUTLINE
6204
6205 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006206 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006207
6208 For taamode: antialiasing mode used for drawing text.
6209 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6210 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6211 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6212 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6213
6214 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006215 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6216
Bram Moolenaara338adc2018-01-31 20:51:47 +01006217 For scrlines:
6218 This was used for optimizing scrolling behavior, however this
6219 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006220
6221 Example: >
6222 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006223 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006224 set rop=type:directx
6225<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006226 If select a raster font (Courier, Terminal or FixedSys which
6227 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006228 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006229
6230 NOTE: It is known that some fonts and options combination
6231 causes trouble on drawing glyphs.
6232
Bram Moolenaar92467d32017-12-05 13:22:16 +01006233 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006234 special made fonts (True-Type fonts which includes only
6235 bitmap glyphs).
6236 - 'taamode:3' will not work with some vector fonts.
6237
6238 NOTE: With this option, you can display colored emoji
6239 (emoticon) in Windows 8.1 or later. To display colored emoji,
6240 there are some conditions which you should notice.
6241
6242 - If your font includes non-colored emoji already, it will
6243 be used.
6244 - If your font doesn't have emoji, the system chooses an
6245 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6246 will be used.
6247 - When this alternative font didn't have fixed width glyph,
6248 emoji might be rendered beyond the bounding box of drawing
6249 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006250
6251 Other render types are currently not supported.
6252
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 *'report'*
6254'report' number (default 2)
6255 global
6256 Threshold for reporting number of lines changed. When the number of
6257 changed lines is more than 'report' a message will be given for most
6258 ":" commands. If you want it always, set 'report' to 0.
6259 For the ":substitute" command the number of substitutions is used
6260 instead of the number of lines.
6261
6262 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6263'restorescreen' 'rs' boolean (default on)
6264 global
6265 {not in Vi} {only in Windows 95/NT console version}
6266 When set, the screen contents is restored when exiting Vim. This also
6267 happens when executing external commands.
6268
6269 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6270 options in your .vimrc. To disable restoring:
6271 set t_ti= t_te=
6272 To enable restoring (for an xterm):
6273 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6274 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6275
6276 *'revins'* *'ri'* *'norevins'* *'nori'*
6277'revins' 'ri' boolean (default off)
6278 global
6279 {not in Vi}
6280 {only available when compiled with the |+rightleft|
6281 feature}
6282 Inserting characters in Insert mode will work backwards. See "typing
6283 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6284 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006285 NOTE: This option is reset when 'compatible' is set.
6286 This option is reset when 'paste' is set and restored when 'paste' is
6287 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288
6289 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6290'rightleft' 'rl' boolean (default off)
6291 local to window
6292 {not in Vi}
6293 {only available when compiled with the |+rightleft|
6294 feature}
6295 When on, display orientation becomes right-to-left, i.e., characters
6296 that are stored in the file appear from the right to the left.
6297 Using this option, it is possible to edit files for languages that
6298 are written from the right to the left such as Hebrew and Arabic.
6299 This option is per window, so it is possible to edit mixed files
6300 simultaneously, or to view the same file in both ways (this is
6301 useful whenever you have a mixed text file with both right-to-left
6302 and left-to-right strings so that both sets are displayed properly
6303 in different windows). Also see |rileft.txt|.
6304
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006305 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306'rightleftcmd' 'rlc' string (default "search")
6307 local to window
6308 {not in Vi}
6309 {only available when compiled with the |+rightleft|
6310 feature}
6311 Each word in this option enables the command line editing to work in
6312 right-to-left mode for a group of commands:
6313
6314 search "/" and "?" commands
6315
6316 This is useful for languages such as Hebrew, Arabic and Farsi.
6317 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6318
Bram Moolenaard94464e2015-11-02 15:28:18 +01006319 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006320'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006321 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006322 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006323 {only available when compiled with the |+ruby/dyn|
6324 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006325 Specifies the name of the Ruby shared library. The default is
6326 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006327 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006332'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 global
6334 {not in Vi}
6335 {not available when compiled without the
6336 |+cmdline_info| feature}
6337 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006338 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 text in the file is shown on the far right:
6340 Top first line is visible
6341 Bot last line is visible
6342 All first and last line are visible
6343 45% relative position in the file
6344 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006345 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006347 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 this option takes precedence over 'ruler' and 'rulerformat'
6349 If the number of characters displayed is different from the number of
6350 bytes in the text (e.g., for a TAB or a multi-byte character), both
6351 the text column (byte number) and the screen column are shown,
6352 separated with a dash.
6353 For an empty line "0-1" is shown.
6354 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006355 This option is reset when 'paste' is set and restored when 'paste' is
6356 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 If you don't want to see the ruler all the time but want to know where
6358 you are, use "g CTRL-G" |g_CTRL-G|.
6359 NOTE: This option is reset when 'compatible' is set.
6360
6361 *'rulerformat'* *'ruf'*
6362'rulerformat' 'ruf' string (default empty)
6363 global
6364 {not in Vi}
6365 {not available when compiled without the |+statusline|
6366 feature}
6367 When this option is not empty, it determines the content of the ruler
6368 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006369 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 The default ruler width is 17 characters. To make the ruler 15
6371 characters wide, put "%15(" at the start and "%)" at the end.
6372 Example: >
6373 :set rulerformat=%15(%c%V\ %p%%%)
6374<
6375 *'runtimepath'* *'rtp'* *vimfiles*
6376'runtimepath' 'rtp' string (default:
6377 Unix: "$HOME/.vim,
6378 $VIM/vimfiles,
6379 $VIMRUNTIME,
6380 $VIM/vimfiles/after,
6381 $HOME/.vim/after"
6382 Amiga: "home:vimfiles,
6383 $VIM/vimfiles,
6384 $VIMRUNTIME,
6385 $VIM/vimfiles/after,
6386 home:vimfiles/after"
6387 PC, OS/2: "$HOME/vimfiles,
6388 $VIM/vimfiles,
6389 $VIMRUNTIME,
6390 $VIM/vimfiles/after,
6391 $HOME/vimfiles/after"
6392 Macintosh: "$VIM:vimfiles,
6393 $VIMRUNTIME,
6394 $VIM:vimfiles:after"
6395 RISC-OS: "Choices:vimfiles,
6396 $VIMRUNTIME,
6397 Choices:vimfiles/after"
6398 VMS: "sys$login:vimfiles,
6399 $VIM/vimfiles,
6400 $VIMRUNTIME,
6401 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006402 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 global
6404 {not in Vi}
6405 This is a list of directories which will be searched for runtime
6406 files:
6407 filetype.vim filetypes by file name |new-filetype|
6408 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006409 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 colors/ color scheme files |:colorscheme|
6411 compiler/ compiler files |:compiler|
6412 doc/ documentation |write-local-help|
6413 ftplugin/ filetype plugins |write-filetype-plugin|
6414 indent/ indent scripts |indent-expression|
6415 keymap/ key mapping files |mbyte-keymap|
6416 lang/ menu translations |:menutrans|
6417 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006418 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 plugin/ plugin scripts |write-plugin|
6420 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006421 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 syntax/ syntax files |mysyntaxfile|
6423 tutor/ files for vimtutor |tutor|
6424
6425 And any other file searched for with the |:runtime| command.
6426
6427 The defaults for most systems are setup to search five locations:
6428 1. In your home directory, for your personal preferences.
6429 2. In a system-wide Vim directory, for preferences from the system
6430 administrator.
6431 3. In $VIMRUNTIME, for files distributed with Vim.
6432 *after-directory*
6433 4. In the "after" directory in the system-wide Vim directory. This is
6434 for the system administrator to overrule or add to the distributed
6435 defaults (rarely needed)
6436 5. In the "after" directory in your home directory. This is for
6437 personal preferences to overrule or add to the distributed defaults
6438 or system-wide settings (rarely needed).
6439
Bram Moolenaard0796902016-09-16 20:02:31 +02006440 More entries are added when using |packages|. If it gets very long
6441 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6442 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006443
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6445 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006446 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 wildcards.
6448 See |:runtime|.
6449 Example: >
6450 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6451< This will use the directory "~/vimruntime" first (containing your
6452 personal Vim runtime files), then "/mygroup/vim" (shared between a
6453 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6454 files).
6455 You probably should always include $VIMRUNTIME somewhere, to use the
6456 distributed runtime files. You can put a directory before $VIMRUNTIME
6457 to find files which replace a distributed runtime files. You can put
6458 a directory after $VIMRUNTIME to find files which add to distributed
6459 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006460 When Vim is started with |--clean| the home directory entries are not
6461 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006462 This option cannot be set from a |modeline| or in the |sandbox|, for
6463 security reasons.
6464
6465 *'scroll'* *'scr'*
6466'scroll' 'scr' number (default: half the window height)
6467 local to window
6468 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6469 set to half the number of lines in the window when the window size
6470 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006471 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6473 the number of screen lines instead of file lines, makes a difference
6474 when lines wrap}
6475
6476 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6477'scrollbind' 'scb' boolean (default off)
6478 local to window
6479 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 See also |scroll-binding|. When this option is set, the current
6481 window scrolls as other scrollbind windows (windows that also have
6482 this option set) scroll. This option is useful for viewing the
6483 differences between two versions of a file, see 'diff'.
6484 See |'scrollopt'| for options that determine how this option should be
6485 interpreted.
6486 This option is mostly reset when splitting a window to edit another
6487 file. This means that ":split | edit file" results in two windows
6488 with scroll-binding, but ":split file" does not.
6489
6490 *'scrolljump'* *'sj'*
6491'scrolljump' 'sj' number (default 1)
6492 global
6493 {not in Vi}
6494 Minimal number of lines to scroll when the cursor gets off the
6495 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6496 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006497 When set to a negative number from -1 to -100 this is used as the
6498 percentage of the window height. Thus -50 scrolls half the window
6499 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 NOTE: This option is set to 1 when 'compatible' is set.
6501
6502 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006503'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 global
6505 {not in Vi}
6506 Minimal number of screen lines to keep above and below the cursor.
6507 This will make some context visible around where you are working. If
6508 you set it to a very large value (999) the cursor line will always be
6509 in the middle of the window (except at the start or end of the file or
6510 when long lines wrap).
6511 For scrolling horizontally see 'sidescrolloff'.
6512 NOTE: This option is set to 0 when 'compatible' is set.
6513
6514 *'scrollopt'* *'sbo'*
6515'scrollopt' 'sbo' string (default "ver,jump")
6516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 {not in Vi}
6518 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006519 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6520 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 The following words are available:
6522 ver Bind vertical scrolling for 'scrollbind' windows
6523 hor Bind horizontal scrolling for 'scrollbind' windows
6524 jump Applies to the offset between two windows for vertical
6525 scrolling. This offset is the difference in the first
6526 displayed line of the bound windows. When moving
6527 around in a window, another 'scrollbind' window may
6528 reach a position before the start or after the end of
6529 the buffer. The offset is not changed though, when
6530 moving back the 'scrollbind' window will try to scroll
6531 to the desired position when possible.
6532 When now making that window the current one, two
6533 things can be done with the relative offset:
6534 1. When "jump" is not included, the relative offset is
6535 adjusted for the scroll position in the new current
6536 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006537 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 2. When "jump" is included, the other windows are
6539 scrolled to keep the same relative offset. When
6540 going back to the other window, it still uses the
6541 same relative offset.
6542 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006543 When 'diff' mode is active there always is vertical scroll binding,
6544 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545
6546 *'sections'* *'sect'*
6547'sections' 'sect' string (default "SHNHH HUnhsh")
6548 global
6549 Specifies the nroff macros that separate sections. These are pairs of
6550 two letters (See |object-motions|). The default makes a section start
6551 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6552
6553 *'secure'* *'nosecure'* *E523*
6554'secure' boolean (default off)
6555 global
6556 {not in Vi}
6557 When on, ":autocmd", shell and write commands are not allowed in
6558 ".vimrc" and ".exrc" in the current directory and map commands are
6559 displayed. Switch it off only if you know that you will not run into
6560 problems, or when the 'exrc' option is off. On Unix this option is
6561 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006562 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 'secure' at the end of your ~/.vimrc then.
6564 This option cannot be set from a |modeline| or in the |sandbox|, for
6565 security reasons.
6566
6567 *'selection'* *'sel'*
6568'selection' 'sel' string (default "inclusive")
6569 global
6570 {not in Vi}
6571 This option defines the behavior of the selection. It is only used
6572 in Visual and Select mode.
6573 Possible values:
6574 value past line inclusive ~
6575 old no yes
6576 inclusive yes yes
6577 exclusive yes no
6578 "past line" means that the cursor is allowed to be positioned one
6579 character past the line.
6580 "inclusive" means that the last character of the selection is included
6581 in an operation. For example, when "x" is used to delete the
6582 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006583 When "old" is used and 'virtualedit' allows the cursor to move past
6584 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 Note that when "exclusive" is used and selecting from the end
6586 backwards, you cannot include the last character of a line, when
6587 starting in Normal mode and 'virtualedit' empty.
6588
6589 The 'selection' option is set by the |:behave| command.
6590
6591 *'selectmode'* *'slm'*
6592'selectmode' 'slm' string (default "")
6593 global
6594 {not in Vi}
6595 This is a comma separated list of words, which specifies when to start
6596 Select mode instead of Visual mode, when a selection is started.
6597 Possible values:
6598 mouse when using the mouse
6599 key when using shifted special keys
6600 cmd when using "v", "V" or CTRL-V
6601 See |Select-mode|.
6602 The 'selectmode' option is set by the |:behave| command.
6603
6604 *'sessionoptions'* *'ssop'*
6605'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006606 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 global
6608 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006609 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 feature}
6611 Changes the effect of the |:mksession| command. It is a comma
6612 separated list of words. Each word enables saving and restoring
6613 something:
6614 word save and restore ~
6615 blank empty windows
6616 buffers hidden and unloaded buffers, not just those in windows
6617 curdir the current directory
6618 folds manually created folds, opened/closed folds and local
6619 fold options
6620 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006621 and contain at least one lowercase letter. Only
6622 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 help the help window
6624 localoptions options and mappings local to a window or buffer (not
6625 global values for local options)
6626 options all options and mappings (also global values for local
6627 options)
6628 resize size of the Vim window: 'lines' and 'columns'
6629 sesdir the directory in which the session file is located
6630 will become the current directory (useful with
6631 projects accessed over a network from different
6632 systems)
6633 slash backslashes in file names replaced with forward
6634 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006635 tabpages all tab pages; without this only the current tab page
6636 is restored, so that you can make a session for each
6637 tab page separately
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006638 terminal include terminal windows where the command can be restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 unix with Unix end-of-line format (single <NL>), even when
6640 on Windows or DOS
6641 winpos position of the whole Vim window
6642 winsize window sizes
6643
6644 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006645 When neither "curdir" nor "sesdir" is included, file names are stored
6646 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 "slash" and "unix" are useful on Windows when sharing session files
6648 with Unix. The Unix version of Vim cannot source dos format scripts,
6649 but the Windows version of Vim can source unix format scripts.
6650
6651 *'shell'* *'sh'* *E91*
6652'shell' 'sh' string (default $SHELL or "sh",
6653 MS-DOS and Win32: "command.com" or
6654 "cmd.exe", OS/2: "cmd")
6655 global
6656 Name of the shell to use for ! and :! commands. When changing the
6657 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6658 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006659 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 See |option-backslash| about including spaces and backslashes.
6661 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006662
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006664 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6666< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006667 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006669 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006671 Example with escaped space (Vim will do this when initializing the
6672 option from $SHELL): >
6673 :set shell=/bin/with\\\ space/sh
6674< The resulting value of 'shell' is "/bin/with\ space/sh", two
6675 backslashes are consumed by `:set`.
6676
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 Under MS-Windows, when the executable ends in ".com" it must be
6678 included. Thus setting the shell to "command.com" or "4dos.com"
6679 works, but "command" and "4dos" do not work for all commands (e.g.,
6680 filtering).
6681 For unknown reasons, when using "4dos.com" the current directory is
6682 changed to "C:\". To avoid this set 'shell' like this: >
6683 :set shell=command.com\ /c\ 4dos
6684< This option cannot be set from a |modeline| or in the |sandbox|, for
6685 security reasons.
6686
6687 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006688'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006689 MS-DOS and Win32, when 'shell' does not
6690 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 global
6692 {not in Vi}
6693 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6694 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6695 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006696 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006697 On Unix it can have more than one flag. Each white space separated
6698 part is passed as an argument to the shell command.
6699 See |option-backslash| about including spaces and backslashes.
6700 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 This option cannot be set from a |modeline| or in the |sandbox|, for
6702 security reasons.
6703
6704 *'shellpipe'* *'sp'*
6705'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6706 global
6707 {not in Vi}
6708 {not available when compiled without the |+quickfix|
6709 feature}
6710 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006711 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 including spaces and backslashes.
6713 The name of the temporary file can be represented by "%s" if necessary
6714 (the file name is appended automatically if no %s appears in the value
6715 of this option).
6716 For the Amiga and MS-DOS the default is ">". The output is directly
6717 saved in a file and not echoed to the screen.
6718 For Unix the default it "| tee". The stdout of the compiler is saved
6719 in a file and echoed to the screen. If the 'shell' option is "csh" or
6720 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006721 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6722 default becomes "2>&1| tee". This means that stderr is also included.
6723 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6724 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 The initialization of this option is done after reading the ".vimrc"
6726 and the other initializations, so that when the 'shell' option is set
6727 there, the 'shellpipe' option changes automatically, unless it was
6728 explicitly set before.
6729 When 'shellpipe' is set to an empty string, no redirection of the
6730 ":make" output will be done. This is useful if you use a 'makeprg'
6731 that writes to 'makeef' by itself. If you want no piping, but do
6732 want to include the 'makeef', set 'shellpipe' to a single space.
6733 Don't forget to precede the space with a backslash: ":set sp=\ ".
6734 In the future pipes may be used for filtering and this option will
6735 become obsolete (at least for Unix).
6736 This option cannot be set from a |modeline| or in the |sandbox|, for
6737 security reasons.
6738
6739 *'shellquote'* *'shq'*
6740'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6741 contains "sh" somewhere: "\"")
6742 global
6743 {not in Vi}
6744 Quoting character(s), put around the command passed to the shell, for
6745 the "!" and ":!" commands. The redirection is kept outside of the
6746 quoting. See 'shellxquote' to include the redirection. It's
6747 probably not useful to set both options.
6748 This is an empty string by default. Only known to be useful for
6749 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6750 or bash, where it should be "\"". The default is adjusted according
6751 the value of 'shell', to reduce the need to set this option by the
6752 user. See |dos-shell|.
6753 This option cannot be set from a |modeline| or in the |sandbox|, for
6754 security reasons.
6755
6756 *'shellredir'* *'srr'*
6757'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6758 global
6759 {not in Vi}
6760 String to be used to put the output of a filter command in a temporary
6761 file. See also |:!|. See |option-backslash| about including spaces
6762 and backslashes.
6763 The name of the temporary file can be represented by "%s" if necessary
6764 (the file name is appended automatically if no %s appears in the value
6765 of this option).
6766 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6767 or "zsh" during initializations, the default becomes ">&". If the
6768 'shell' option is "sh", "ksh" or "bash" the default becomes
6769 ">%s 2>&1". This means that stderr is also included.
6770 For Win32, the Unix checks are done and additionally "cmd" is checked
6771 for, which makes the default ">%s 2>&1". Also, the same names with
6772 ".exe" appended are checked for.
6773 The initialization of this option is done after reading the ".vimrc"
6774 and the other initializations, so that when the 'shell' option is set
6775 there, the 'shellredir' option changes automatically unless it was
6776 explicitly set before.
6777 In the future pipes may be used for filtering and this option will
6778 become obsolete (at least for Unix).
6779 This option cannot be set from a |modeline| or in the |sandbox|, for
6780 security reasons.
6781
6782 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6783'shellslash' 'ssl' boolean (default off)
6784 global
6785 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6786 When set, a forward slash is used when expanding file names. This is
6787 useful when a Unix-like shell is used instead of command.com or
6788 cmd.exe. Backward slashes can still be typed, but they are changed to
6789 forward slashes by Vim.
6790 Note that setting or resetting this option has no effect for some
6791 existing file names, thus this option needs to be set before opening
6792 any file for best results. This might change in the future.
6793 'shellslash' only works when a backslash can be used as a path
6794 separator. To test if this is so use: >
6795 if exists('+shellslash')
6796<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006797 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6798'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6799 global
6800 {not in Vi}
6801 When on, use temp files for shell commands. When off use a pipe.
6802 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006803 Currently a pipe is only supported on Unix and MS-Windows 2K and
6804 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006805 :if has("filterpipe")
6806< The advantage of using a pipe is that nobody can read the temp file
6807 and the 'shell' command does not need to support redirection.
6808 The advantage of using a temp file is that the file type and encoding
6809 can be detected.
6810 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6811 |FilterWritePost| autocommands event are not triggered when
6812 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006813 The `system()` function does not respect this option and always uses
6814 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006815 NOTE: This option is set to the Vim default value when 'compatible'
6816 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006817
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 *'shelltype'* *'st'*
6819'shelltype' 'st' number (default 0)
6820 global
6821 {not in Vi} {only for the Amiga}
6822 On the Amiga this option influences the way how the commands work
6823 which use a shell.
6824 0 and 1: always use the shell
6825 2 and 3: use the shell only to filter lines
6826 4 and 5: use shell only for ':sh' command
6827 When not using the shell, the command is executed directly.
6828
6829 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6830 1 and 3: use "shell cmd" to start external commands
6831
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006832 *'shellxescape'* *'sxe'*
6833'shellxescape' 'sxe' string (default: "";
6834 for MS-DOS and MS-Windows: "\"&|<>()@^")
6835 global
6836 {not in Vi}
6837 When 'shellxquote' is set to "(" then the characters listed in this
6838 option will be escaped with a '^' character. This makes it possible
6839 to execute most external commands with cmd.exe.
6840
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 *'shellxquote'* *'sxq'*
6842'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006843 for Win32, when 'shell' is cmd.exe: "("
6844 for Win32, when 'shell' contains "sh"
6845 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 for Unix, when using system(): "\"")
6847 global
6848 {not in Vi}
6849 Quoting character(s), put around the command passed to the shell, for
6850 the "!" and ":!" commands. Includes the redirection. See
6851 'shellquote' to exclude the redirection. It's probably not useful
6852 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006853 When the value is '(' then ')' is appended. When the value is '"('
6854 then ')"' is appended.
6855 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006856 This is an empty string by default on most systems, but is known to be
6857 useful for on Win32 version, either for cmd.exe which automatically
6858 strips off the first and last quote on a command, or 3rd-party shells
6859 such as the MKS Korn Shell or bash, where it should be "\"". The
6860 default is adjusted according the value of 'shell', to reduce the need
6861 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 This option cannot be set from a |modeline| or in the |sandbox|, for
6863 security reasons.
6864
6865 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6866'shiftround' 'sr' boolean (default off)
6867 global
6868 {not in Vi}
6869 Round indent to multiple of 'shiftwidth'. Applies to > and <
6870 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6871 a multiple of 'shiftwidth' (this is Vi compatible).
6872 NOTE: This option is reset when 'compatible' is set.
6873
6874 *'shiftwidth'* *'sw'*
6875'shiftwidth' 'sw' number (default 8)
6876 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006877 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006879 When zero the 'ts' value will be used. Use the |shiftwidth()|
6880 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881
6882 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006883'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6884 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 global
6886 {not in Vi}
6887 This option helps to avoid all the |hit-enter| prompts caused by file
6888 messages, for example with CTRL-G, and to avoid some other messages.
6889 It is a list of flags:
6890 flag meaning when present ~
6891 f use "(3 of 5)" instead of "(file 3 of 5)"
6892 i use "[noeol]" instead of "[Incomplete last line]"
6893 l use "999L, 888C" instead of "999 lines, 888 characters"
6894 m use "[+]" instead of "[Modified]"
6895 n use "[New]" instead of "[New File]"
6896 r use "[RO]" instead of "[readonly]"
6897 w use "[w]" instead of "written" for file write message
6898 and "[a]" instead of "appended" for ':w >> file' command
6899 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6900 "[unix format]" and "[mac]" instead of "[mac format]".
6901 a all of the above abbreviations
6902
6903 o overwrite message for writing a file with subsequent message
6904 for reading a file (useful for ":wn" or when 'autowrite' on)
6905 O message for reading a file overwrites any previous message.
6906 Also for quickfix message (e.g., ":cn").
6907 s don't give "search hit BOTTOM, continuing at TOP" or "search
6908 hit TOP, continuing at BOTTOM" messages
6909 t truncate file message at the start if it is too long to fit
6910 on the command-line, "<" will appear in the left most column.
6911 Ignored in Ex mode.
6912 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006913 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 Ignored in Ex mode.
6915 W don't give "written" or "[w]" when writing a file
6916 A don't give the "ATTENTION" message when an existing swap file
6917 is found.
6918 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006919 c don't give |ins-completion-menu| messages. For example,
6920 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6921 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006922 q use "recording" instead of "recording @a"
6923 F don't give the file info when editing a file, like `:silent`
6924 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925
6926 This gives you the opportunity to avoid that a change between buffers
6927 requires you to hit <Enter>, but still gives as useful a message as
6928 possible for the space available. To get the whole message that you
6929 would have got with 'shm' empty, use ":file!"
6930 Useful values:
6931 shm= No abbreviation of message.
6932 shm=a Abbreviation, but no loss of information.
6933 shm=at Abbreviation, and truncate message when necessary.
6934
6935 NOTE: This option is set to the Vi default value when 'compatible' is
6936 set and to the Vim default value when 'compatible' is reset.
6937
6938 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6939'shortname' 'sn' boolean (default off)
6940 local to buffer
6941 {not in Vi, not in MS-DOS versions}
6942 Filenames are assumed to be 8 characters plus one extension of 3
6943 characters. Multiple dots in file names are not allowed. When this
6944 option is on, dots in file names are replaced with underscores when
6945 adding an extension (".~" or ".swp"). This option is not available
6946 for MS-DOS, because then it would always be on. This option is useful
6947 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6948 or crossdos. When running the Win32 GUI version under Win32s, this
6949 option is always on by default.
6950
6951 *'showbreak'* *'sbr'* *E595*
6952'showbreak' 'sbr' string (default "")
6953 global
6954 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006955 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 feature}
6957 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006958 values are "> " or "+++ ": >
6959 :set showbreak=>\
6960< Note the backslash to escape the trailing space. It's easier like
6961 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006962 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006963< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 comma (in a future version the comma might be used to separate the
6965 part that is shown at the end and at the start of a line).
6966 The characters are highlighted according to the '@' flag in
6967 'highlight'.
6968 Note that tabs after the showbreak will be displayed differently.
6969 If you want the 'showbreak' to appear in between line numbers, add the
6970 "n" flag to 'cpoptions'.
6971
6972 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006973'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6974 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 global
6976 {not in Vi}
6977 {not available when compiled without the
6978 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006979 Show (partial) command in the last line of the screen. Set this
6980 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 In Visual mode the size of the selected area is shown:
6982 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006983 If the number of bytes is different it is also displayed: "2-6"
6984 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006986 - When selecting a block, the size in screen characters:
6987 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988 NOTE: This option is set to the Vi default value when 'compatible' is
6989 set and to the Vim default value when 'compatible' is reset.
6990
6991 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6992'showfulltag' 'sft' boolean (default off)
6993 global
6994 {not in Vi}
6995 When completing a word in insert mode (see |ins-completion|) from the
6996 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006997 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 matched a C function, you can see a template for what arguments are
6999 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007000 Note that this doesn't work well together with having "longest" in
7001 'completeopt', because the completion from the search pattern may not
7002 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003
7004 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7005'showmatch' 'sm' boolean (default off)
7006 global
7007 When a bracket is inserted, briefly jump to the matching one. The
7008 jump is only done if the match can be seen on the screen. The time to
7009 show the match can be set with 'matchtime'.
7010 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007011 seen or not).
7012 This option is reset when 'paste' is set and restored when 'paste' is
7013 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 When the 'm' flag is not included in 'cpoptions', typing a character
7015 will immediately move the cursor back to where it belongs.
7016 See the "sm" field in 'guicursor' for setting the cursor shape and
7017 blinking when showing the match.
7018 The 'matchpairs' option can be used to specify the characters to show
7019 matches for. 'rightleft' and 'revins' are used to look for opposite
7020 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007021 Also see the matchparen plugin for highlighting the match when moving
7022 around |pi_paren.txt|.
7023 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024
7025 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7026'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7027 global
7028 If in Insert, Replace or Visual mode put a message on the last line.
7029 Use the 'M' flag in 'highlight' to set the type of highlighting for
7030 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007031 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 doesn't mean XIM is really active, especially when 'imactivatekey' is
7033 not set.
7034 NOTE: This option is set to the Vi default value when 'compatible' is
7035 set and to the Vim default value when 'compatible' is reset.
7036
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007037 *'showtabline'* *'stal'*
7038'showtabline' 'stal' number (default 1)
7039 global
7040 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007041 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007042 feature}
7043 The value of this option specifies when the line with tab page labels
7044 will be displayed:
7045 0: never
7046 1: only if there are at least two tab pages
7047 2: always
7048 This is both for the GUI and non-GUI implementation of the tab pages
7049 line.
7050 See |tab-page| for more information about tab pages.
7051
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 *'sidescroll'* *'ss'*
7053'sidescroll' 'ss' number (default 0)
7054 global
7055 {not in Vi}
7056 The minimal number of columns to scroll horizontally. Used only when
7057 the 'wrap' option is off and the cursor is moved off of the screen.
7058 When it is zero the cursor will be put in the middle of the screen.
7059 When using a slow terminal set it to a large number or 0. When using
7060 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7061 commands.
7062
7063 *'sidescrolloff'* *'siso'*
7064'sidescrolloff' 'siso' number (default 0)
7065 global
7066 {not in Vi}
7067 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007068 right of the cursor if 'nowrap' is set. Setting this option to a
7069 value greater than 0 while having |'sidescroll'| also at a non-zero
7070 value makes some context visible in the line you are scrolling in
7071 horizontally (except at beginning of the line). Setting this option
7072 to a large value (like 999) has the effect of keeping the cursor
7073 horizontally centered in the window, as long as one does not come too
7074 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 NOTE: This option is set to 0 when 'compatible' is set.
7076
7077 Example: Try this together with 'sidescroll' and 'listchars' as
7078 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007079 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080
7081 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7082 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007083<
7084 *'signcolumn'* *'scl'*
7085'signcolumn' 'scl' string (default "auto")
7086 local to window
7087 {not in Vi}
7088 {not available when compiled without the |+signs|
7089 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007090 Whether or not to draw the signcolumn. Valid values are:
7091 "auto" only when there is a sign to display
7092 "no" never
7093 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094
7095
7096 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7097'smartcase' 'scs' boolean (default off)
7098 global
7099 {not in Vi}
7100 Override the 'ignorecase' option if the search pattern contains upper
7101 case characters. Only used when the search pattern is typed and
7102 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007103 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7105 recalling the search pattern from history and hitting <Enter>.
7106 NOTE: This option is reset when 'compatible' is set.
7107
7108 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7109'smartindent' 'si' boolean (default off)
7110 local to buffer
7111 {not in Vi}
7112 {not available when compiled without the
7113 |+smartindent| feature}
7114 Do smart autoindenting when starting a new line. Works for C-like
7115 programs, but can also be used for other languages. 'cindent' does
7116 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007117 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007118 setting 'si' has no effect. 'indentexpr' is a more advanced
7119 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 Normally 'autoindent' should also be on when using 'smartindent'.
7121 An indent is automatically inserted:
7122 - After a line ending in '{'.
7123 - After a line starting with a keyword from 'cinwords'.
7124 - Before a line starting with '}' (only with the "O" command).
7125 When typing '}' as the first character in a new line, that line is
7126 given the same indent as the matching '{'.
7127 When typing '#' as the first character in a new line, the indent for
7128 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007129 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7131 When using the ">>" command, lines starting with '#' are not shifted
7132 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007133 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007134 This option is reset when 'paste' is set and restored when 'paste' is
7135 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136
7137 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7138'smarttab' 'sta' boolean (default off)
7139 global
7140 {not in Vi}
7141 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007142 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7143 <BS> will delete a 'shiftwidth' worth of space at the start of the
7144 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007145 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007146 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7147 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007148 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007150 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007151 This option is reset when 'paste' is set and restored when 'paste' is
7152 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 NOTE: This option is reset when 'compatible' is set.
7154
7155 *'softtabstop'* *'sts'*
7156'softtabstop' 'sts' number (default 0)
7157 local to buffer
7158 {not in Vi}
7159 Number of spaces that a <Tab> counts for while performing editing
7160 operations, like inserting a <Tab> or using <BS>. It "feels" like
7161 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7162 used. This is useful to keep the 'ts' setting at its standard value
7163 of 8, while being able to edit like it is set to 'sts'. However,
7164 commands like "x" still work on the actual characters.
7165 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007166 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007167 'softtabstop' is set to 0 when the 'paste' option is set and restored
7168 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7170 spaces is minimized by using <Tab>s.
7171 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7172 set.
7173 NOTE: This option is set to 0 when 'compatible' is set.
7174
Bram Moolenaar217ad922005-03-20 22:37:15 +00007175 *'spell'* *'nospell'*
7176'spell' boolean (default off)
7177 local to window
7178 {not in Vi}
7179 {not available when compiled without the |+syntax|
7180 feature}
7181 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007182 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007183
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007184 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007185'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007186 local to buffer
7187 {not in Vi}
7188 {not available when compiled without the |+syntax|
7189 feature}
7190 Pattern to locate the end of a sentence. The following word will be
7191 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007192 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007193 When this check is not wanted make this option empty.
7194 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007195 Be careful with special characters, see |option-backslash| about
7196 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007197 To set this option automatically depending on the language, see
7198 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007199
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007200 *'spellfile'* *'spf'*
7201'spellfile' 'spf' string (default empty)
7202 local to buffer
7203 {not in Vi}
7204 {not available when compiled without the |+syntax|
7205 feature}
7206 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007207 commands. It must end in ".{encoding}.add". You need to include the
7208 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007209 *E765*
7210 It may also be a comma separated list of names. A count before the
7211 |zg| and |zw| commands can be used to access each. This allows using
7212 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007213 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007214 you: Using the first directory in 'runtimepath' that is writable. If
7215 there is no "spell" directory yet it will be created. For the file
7216 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007217 ignoring the region.
7218 The resulting ".spl" file will be used for spell checking, it does not
7219 have to appear in 'spelllang'.
7220 Normally one file is used for all regions, but you can add the region
7221 name if you want to. However, it will then only be used when
7222 'spellfile' is set to it, for entries in 'spelllang' only files
7223 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007224 This option cannot be set from a |modeline| or in the |sandbox|, for
7225 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007226
Bram Moolenaar217ad922005-03-20 22:37:15 +00007227 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007228'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007229 local to buffer
7230 {not in Vi}
7231 {not available when compiled without the |+syntax|
7232 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007233 A comma separated list of word list names. When the 'spell' option is
7234 on spellchecking will be done for these languages. Example: >
7235 set spelllang=en_us,nl,medical
7236< This means US English, Dutch and medical words are recognized. Words
7237 that are not recognized will be highlighted.
7238 The word list name must not include a comma or dot. Using a dash is
7239 recommended to separate the two letter language name from a
7240 specification. Thus "en-rare" is used for rare English words.
7241 A region name must come last and have the form "_xx", where "xx" is
7242 the two-letter, lower case region name. You can use more than one
7243 region by listing them: "en_us,en_ca" supports both US and Canadian
7244 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007245 Britain. (Note: currently en_au and en_nz dictionaries are older than
7246 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007247 If the name "cjk" is included East Asian characters are excluded from
7248 spell checking. This is useful when editing text that also has Asian
7249 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007250 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007251 As a special case the name of a .spl file can be given as-is. The
7252 first "_xx" in the name is removed and used as the region name
7253 (_xx is an underscore, two letters and followed by a non-letter).
7254 This is mainly for testing purposes. You must make sure the correct
7255 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007256 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007257 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7258 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007259 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007260
Bram Moolenaar98692072006-02-04 00:57:42 +00007261 If the |spellfile.vim| plugin is active and you use a language name
7262 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7263 will ask you if you want to download the file.
7264
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007265 After this option has been set successfully, Vim will source the files
7266 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007267 up to the first comma, dot or underscore.
7268 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007269
7270
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007271 *'spellsuggest'* *'sps'*
7272'spellsuggest' 'sps' string (default "best")
7273 global
7274 {not in Vi}
7275 {not available when compiled without the |+syntax|
7276 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007277 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007278 the |spellsuggest()| function. This is a comma-separated list of
7279 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007280
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007281 best Internal method that works best for English. Finds
7282 changes like "fast" and uses a bit of sound-a-like
7283 scoring to improve the ordering.
7284
7285 double Internal method that uses two methods and mixes the
7286 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007287 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007288 word. That only works when the language specifies
7289 sound folding. Can be slow and doesn't always give
7290 better results.
7291
7292 fast Internal method that only checks for simple changes:
7293 character inserts/deletes/swaps. Works well for
7294 simple typing mistakes.
7295
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007296 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007297 Not used for |spellsuggest()|. The number of
7298 suggestions is never more than the value of 'lines'
7299 minus two.
7300
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007301 file:{filename} Read file {filename}, which must have two columns,
7302 separated by a slash. The first column contains the
7303 bad word, the second column the suggested good word.
7304 Example:
7305 theribal/terrible ~
7306 Use this for common mistakes that do not appear at the
7307 top of the suggestion list with the internal methods.
7308 Lines without a slash are ignored, use this for
7309 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007310 The word in the second column must be correct,
7311 otherwise it will not be used. Add the word to an
7312 ".add" file if it is currently flagged as a spelling
7313 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007314 The file is used for all languages.
7315
7316 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7317 trouble with spaces. |v:val| holds the badly spelled
7318 word. The expression must evaluate to a List of
7319 Lists, each with a suggestion and a score.
7320 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007321 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007322 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007323 internal methods use. A lower score is better.
7324 This may invoke |spellsuggest()| if you temporarily
7325 set 'spellsuggest' to exclude the "expr:" part.
7326 Errors are silently ignored, unless you set the
7327 'verbose' option to a non-zero value.
7328
7329 Only one of "best", "double" or "fast" may be used. The others may
7330 appear several times in any order. Example: >
7331 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7332<
7333 This option cannot be set from a |modeline| or in the |sandbox|, for
7334 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007335
7336
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7338'splitbelow' 'sb' boolean (default off)
7339 global
7340 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007341 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 feature}
7343 When on, splitting a window will put the new window below the current
7344 one. |:split|
7345
7346 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7347'splitright' 'spr' boolean (default off)
7348 global
7349 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007350 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 feature}
7352 When on, splitting a window will put the new window right of the
7353 current one. |:vsplit|
7354
7355 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7356'startofline' 'sol' boolean (default on)
7357 global
7358 {not in Vi}
7359 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007360 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007361 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007362 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 with a linewise operator, with "%" with a count and to buffer changing
7364 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7365 only has a line number, e.g., ":25" or ":+".
7366 In case of buffer changing commands the cursor is placed at the column
7367 where it was the last time the buffer was edited.
7368 NOTE: This option is set when 'compatible' is set.
7369
Bram Moolenaar00654022011-02-25 14:42:19 +01007370 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007372 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 {not in Vi}
7374 {not available when compiled without the |+statusline|
7375 feature}
7376 When nonempty, this option determines the content of the status line.
7377 Also see |status-line|.
7378
7379 The option consists of printf style '%' items interspersed with
7380 normal text. Each status line item is of the form:
7381 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007382 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007383 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384
Bram Moolenaar238a5642006-02-21 22:12:05 +00007385 When the option starts with "%!" then it is used as an expression,
7386 evaluated and the result is used as the option value. Example: >
7387 :set statusline=%!MyStatusLine()
7388< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007389 Note that the "%!" expression is evaluated in the context of the
7390 current window and buffer, while %{} items are evaluated in the
7391 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007392
7393 When there is error while evaluating the option then it will be made
7394 empty to avoid further errors. Otherwise screen updating would loop.
7395
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 Note that the only effect of 'ruler' when this option is set (and
7397 'laststatus' is 2) is controlling the output of |CTRL-G|.
7398
7399 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007400 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007402 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 minwid Minimum width of the item, padding as set by '-' & '0'.
7404 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007405 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 on the left for text items. Numeric items will be
7407 shifted down to maxwid-2 digits followed by '>'number
7408 where number is the amount of missing digits, much like
7409 an exponential notation.
7410 item A one letter code as described below.
7411
7412 Following is a description of the possible statusline items. The
7413 second character in "item" is the type:
7414 N for number
7415 S for string
7416 F for flags as described below
7417 - not applicable
7418
7419 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007420 f S Path to the file in the buffer, as typed or relative to current
7421 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 F S Full path to the file in the buffer.
7423 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007424 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007426 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007427 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007428 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007430 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007432 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007433 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007434 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7436 being used: "<keymap>"
7437 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007438 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 B N As above, in hexadecimal.
7440 o N Byte number in file of byte under cursor, first byte is 1.
7441 Mnemonic: Offset from start of file (with one added)
7442 {not available when compiled without |+byte_offset| feature}
7443 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007444 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 l N Line number.
7446 L N Number of lines in buffer.
7447 c N Column number.
7448 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007449 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 p N Percentage through file in lines as in |CTRL-G|.
7451 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007452 percentage described for 'ruler'. Always 3 in length, unless
7453 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007454 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007456 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007457 Note that there is no '%' before the closing '}'. The
7458 expression cannot contain a '}' character, call a function to
7459 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 ( - Start of item group. Can be used for setting the width and
7461 alignment of a section. Must be followed by %) somewhere.
7462 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007463 T N For 'tabline': start of tab page N label. Use %T after the last
7464 label. This information is used for mouse clicks.
7465 X N For 'tabline': start of close tab N label. Use %X after the
7466 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7467 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 < - Where to truncate line if too long. Default is at the start.
7469 No width fields allowed.
7470 = - Separation point between left and right aligned items.
7471 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007472 # - Set highlight group. The name must follow and then a # again.
7473 Thus use %#HLname# for highlight group HLname. The same
7474 highlighting is used, also for the statusline of non-current
7475 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007477 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 The difference between User{N} and StatusLine will be applied
7479 to StatusLineNC for the statusline of non-current windows.
7480 The number N must be between 1 and 9. See |hl-User1..9|
7481
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007482 When displaying a flag, Vim removes the leading comma, if any, when
7483 that flag comes right after plaintext. This will make a nice display
7484 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485
Bram Moolenaar582fd852005-03-28 20:58:01 +00007486 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 not set) and a minwid is not set for the group, the whole group will
7488 become empty. This will make a group like the following disappear
7489 completely from the statusline when none of the flags are set. >
7490 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007491< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 Beware that an expression is evaluated each and every time the status
7493 line is displayed. The current buffer and current window will be set
7494 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007495 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007497 real current buffer.
7498
Bram Moolenaar30b65812012-07-12 22:01:11 +02007499 The 'statusline' option will be evaluated in the |sandbox| if set from
7500 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007501
7502 It is not allowed to change text or jump to another window while
7503 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504
7505 If the statusline is not updated when you want it (e.g., after setting
7506 a variable that's used in an expression), you can force an update by
7507 setting an option without changing its value. Example: >
7508 :let &ro = &ro
7509
7510< A result of all digits is regarded a number for display purposes.
7511 Otherwise the result is taken as flag text and applied to the rules
7512 described above.
7513
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007514 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007516 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517
7518 Examples:
7519 Emulate standard status line with 'ruler' set >
7520 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7521< Similar, but add ASCII value of char under the cursor (like "ga") >
7522 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7523< Display byte count and byte value, modified flag in red. >
7524 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7525 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7526< Display a ,GZ flag if a compressed file is loaded >
7527 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7528< In the |:autocmd|'s: >
7529 :let b:gzflag = 1
7530< And: >
7531 :unlet b:gzflag
7532< And define this function: >
7533 :function VarExists(var, val)
7534 : if exists(a:var) | return a:val | else | return '' | endif
7535 :endfunction
7536<
7537 *'suffixes'* *'su'*
7538'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7539 global
7540 {not in Vi}
7541 Files with these suffixes get a lower priority when multiple files
7542 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007543 suffixes. Spaces after the comma are ignored. A dot is also seen as
7544 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 separator, precede it with a backslash (see |option-backslash| about
7546 including spaces and backslashes).
7547 See 'wildignore' for completely ignoring files.
7548 The use of |:set+=| and |:set-=| is preferred when adding or removing
7549 suffixes from the list. This avoids problems when a future version
7550 uses another default.
7551
7552 *'suffixesadd'* *'sua'*
7553'suffixesadd' 'sua' string (default "")
7554 local to buffer
7555 {not in Vi}
7556 {not available when compiled without the
7557 |+file_in_path| feature}
7558 Comma separated list of suffixes, which are used when searching for a
7559 file for the "gf", "[I", etc. commands. Example: >
7560 :set suffixesadd=.java
7561<
7562 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7563'swapfile' 'swf' boolean (default on)
7564 local to buffer
7565 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007566 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007567 swapfile is not wanted for a specific buffer. For example, with
7568 confidential information that even root must not be able to access.
7569 Careful: All text will be in memory:
7570 - Don't use this for big files.
7571 - Recovery will be impossible!
7572 A swapfile will only be present when |'updatecount'| is non-zero and
7573 'swapfile' is set.
7574 When 'swapfile' is reset, the swap file for the current buffer is
7575 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7576 non-zero, a swap file is immediately created.
7577 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007578 If you want to open a new buffer without creating a swap file for it,
7579 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007580 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581
7582 This option is used together with 'bufhidden' and 'buftype' to
7583 specify special kinds of buffers. See |special-buffers|.
7584
7585 *'swapsync'* *'sws'*
7586'swapsync' 'sws' string (default "fsync")
7587 global
7588 {not in Vi}
7589 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007590 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 When this option is empty parts of the swap file may be in memory and
7592 not written to disk. When the system crashes you may lose more work.
7593 On Unix the system does a sync now and then without Vim asking for it,
7594 so the disadvantage of setting this option off is small. On some
7595 systems the swap file will not be written at all. For a unix system
7596 setting it to "sync" will use the sync() call instead of the default
7597 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007598 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599
7600 *'switchbuf'* *'swb'*
7601'switchbuf' 'swb' string (default "")
7602 global
7603 {not in Vi}
7604 This option controls the behavior when switching between buffers.
7605 Possible values (comma separated list):
7606 useopen If included, jump to the first open window that
7607 contains the specified buffer (if there is one).
7608 Otherwise: Do not examine other windows.
7609 This setting is checked with |quickfix| commands, when
7610 jumping to errors (":cc", ":cn", "cp", etc.). It is
7611 also used in all buffer related split commands, for
7612 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007613 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007614 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007615 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007616 a buffer for a |quickfix| command that display errors.
7617 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007618 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007619 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007620 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007622 *'synmaxcol'* *'smc'*
7623'synmaxcol' 'smc' number (default 3000)
7624 local to buffer
7625 {not in Vi}
7626 {not available when compiled without the |+syntax|
7627 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007628 Maximum column in which to search for syntax items. In long lines the
7629 text after this column is not highlighted and following lines may not
7630 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007631 This helps to avoid very slow redrawing for an XML file that is one
7632 long line.
7633 Set to zero to remove the limit.
7634
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 *'syntax'* *'syn'*
7636'syntax' 'syn' string (default empty)
7637 local to buffer
7638 {not in Vi}
7639 {not available when compiled without the |+syntax|
7640 feature}
7641 When this option is set, the syntax with this name is loaded, unless
7642 syntax highlighting has been switched off with ":syntax off".
7643 Otherwise this option does not always reflect the current syntax (the
7644 b:current_syntax variable does).
7645 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007646 not automatically recognized. Example, in an IDL file:
7647 /* vim: set syntax=idl : */ ~
7648 When a dot appears in the value then this separates two filetype
7649 names. Example:
7650 /* vim: set syntax=c.doxygen : */ ~
7651 This will use the "c" syntax first, then the "doxygen" syntax.
7652 Note that the second one must be prepared to be loaded as an addition,
7653 otherwise it will be skipped. More than one dot may appear.
7654 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 :set syntax=OFF
7656< To switch syntax highlighting on according to the current value of the
7657 'filetype' option: >
7658 :set syntax=ON
7659< What actually happens when setting the 'syntax' option is that the
7660 Syntax autocommand event is triggered with the value as argument.
7661 This option is not copied to another buffer, independent of the 's' or
7662 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007663 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007665 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007666'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007667 global
7668 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007669 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007670 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007671 When nonempty, this option determines the content of the tab pages
7672 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007673 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007674
7675 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007676 option and only when there is no GUI tab line. When 'e' is in
7677 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007678 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007679
7680 The value is evaluated like with 'statusline'. You can use
7681 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007682 the text to be displayed. Use "%1T" for the first label, "%2T" for
7683 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007684
7685 Keep in mind that only one of the tab pages is the current one, others
7686 are invisible and you can't jump to their windows.
7687
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007688
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007689 *'tabpagemax'* *'tpm'*
7690'tabpagemax' 'tpm' number (default 10)
7691 global
7692 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007693 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007694 feature}
7695 Maximum number of tab pages to be opened by the |-p| command line
7696 argument or the ":tab all" command. |tabpage|
7697
7698
7699 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700'tabstop' 'ts' number (default 8)
7701 local to buffer
7702 Number of spaces that a <Tab> in the file counts for. Also see
7703 |:retab| command, and 'softtabstop' option.
7704
7705 Note: Setting 'tabstop' to any other value than 8 can make your file
7706 appear wrong in many places (e.g., when printing it).
7707
7708 There are four main ways to use tabs in Vim:
7709 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7710 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007711 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 behave like a tab appears every 4 (or 3) characters.
7713 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7714 'expandtab'. This way you will always insert spaces. The
7715 formatting will never be messed up when 'tabstop' is changed.
7716 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007717 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 works when using Vim to edit the file.
7719 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7720 'noexpandtab'. This should then work (for initial indents only)
7721 for any tabstop setting that people use. It might be nice to have
7722 tabs after the first non-blank inserted as spaces if you do this
7723 though. Otherwise aligned comments will be wrong when 'tabstop' is
7724 changed.
7725
7726 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7727'tagbsearch' 'tbs' boolean (default on)
7728 global
7729 {not in Vi}
7730 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007731 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 searching makes searching for a tag a LOT faster, but a linear search
7733 will find more tags if the tags file wasn't properly sorted.
7734 Vim normally assumes that your tags files are sorted, or indicate that
7735 they are not sorted. Only when this is not the case does the
7736 'tagbsearch' option need to be switched off.
7737
7738 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007739 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 certain files, or retry all files with a linear search. When
7741 'tagbsearch' is off, only a linear search is done.
7742
7743 Linear searching is done anyway, for one file, when Vim finds a line
7744 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007745 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746< [The whitespace before and after the '0' must be a single <Tab>]
7747
7748 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007749 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 instead of a normal tag name, a retry is done with a linear search.
7751 Tags in unsorted tags files, and matches with different case will only
7752 be found in the retry.
7753
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007754 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007755 linear search can be avoided when case is ignored. Use a value of '2'
7756 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7757 sorted with the -f switch to "sort" in most unices, as in the command:
7758 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7759 (at least 5.5) the --sort=foldcase switch can be used for this as
7760 well. Note that case must be folded to uppercase for this to work.
7761
7762 By default, tag searches are case-sensitive. Case is ignored when
7763 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7764 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007765 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7766 'tagcase' is "smart", and the pattern contains only lowercase
7767 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768
7769 When 'tagbsearch' is off, tags searching is slower when a full match
7770 exists, but faster when no full match exists. Tags in unsorted tags
7771 files may only be found with 'tagbsearch' off.
7772 When the tags file is not sorted, or sorted in a wrong way (not on
7773 ASCII byte value), 'tagbsearch' should be off, or the line given above
7774 must be included in the tags file.
7775 This option doesn't affect commands that find all matching tags (e.g.,
7776 command-line completion and ":help").
7777 {Vi: always uses binary search in some versions}
7778
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007779 *'tagcase'* *'tc'*
7780'tagcase' 'tc' string (default "followic")
7781 global or local to buffer |global-local|
7782 {not in Vi}
7783 This option specifies how case is handled when searching the tags
7784 file:
7785 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007786 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007787 ignore Ignore case
7788 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007789 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007790 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.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007792
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 *'taglength'* *'tl'*
7794'taglength' 'tl' number (default 0)
7795 global
7796 If non-zero, tags are significant up to this number of characters.
7797
7798 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7799'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7800 global
7801 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007802 If on and using a tags file in another directory, file names in that
7803 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 NOTE: This option is set to the Vi default value when 'compatible' is
7805 set and to the Vim default value when 'compatible' is reset.
7806
7807 *'tags'* *'tag'* *E433*
7808'tags' 'tag' string (default "./tags,tags", when compiled with
7809 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7810 global or local to buffer |global-local|
7811 Filenames for the tag command, separated by spaces or commas. To
7812 include a space or comma in a file name, precede it with a backslash
7813 (see |option-backslash| about including spaces and backslashes).
7814 When a file name starts with "./", the '.' is replaced with the path
7815 of the current file. But only when the 'd' flag is not included in
7816 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7817 |tags-option|.
7818 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007819 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7820 find all files named "tags" below "/lib". The filename itself cannot
7821 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7822 files called "tags?". {not available when compiled without the
7823 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007824 The |tagfiles()| function can be used to get a list of the file names
7825 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7827 files are also supported. They are automatically recognized. The
7828 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7829 differences are ignored (MS-Windows). |emacs-tags|
7830 The use of |:set+=| and |:set-=| is preferred when adding or removing
7831 file names from the list. This avoids problems when a future version
7832 uses another default.
7833 {Vi: default is "tags /usr/lib/tags"}
7834
7835 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7836'tagstack' 'tgst' boolean (default on)
7837 global
7838 {not in all versions of Vi}
7839 When on, the |tagstack| is used normally. When off, a ":tag" or
7840 ":tselect" command with an argument will not push the tag onto the
7841 tagstack. A following ":tag" without an argument, a ":pop" command or
7842 any other command that uses the tagstack will use the unmodified
7843 tagstack, but does change the pointer to the active entry.
7844 Resetting this option is useful when using a ":tag" command in a
7845 mapping which should not change the tagstack.
7846
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007847 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007848'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007849 global
7850 {not in Vi}
7851 {only available when compiled with the |+tcl/dyn|
7852 feature}
7853 Specifies the name of the Tcl shared library. The default is
7854 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007855 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007856 This option cannot be set from a |modeline| or in the |sandbox|, for
7857 security reasons.
7858
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 *'term'* *E529* *E530* *E531*
7860'term' string (default is $TERM, if that fails:
7861 in the GUI: "builtin_gui"
7862 on Amiga: "amiga"
7863 on BeOS: "beos-ansi"
7864 on Mac: "mac-ansi"
7865 on MiNT: "vt52"
7866 on MS-DOS: "pcterm"
7867 on OS/2: "os2ansi"
7868 on Unix: "ansi"
7869 on VMS: "ansi"
7870 on Win 32: "win32")
7871 global
7872 Name of the terminal. Used for choosing the terminal control
7873 characters. Environment variables are expanded |:set_env|.
7874 For example: >
7875 :set term=$TERM
7876< See |termcap|.
7877
7878 *'termbidi'* *'tbidi'*
7879 *'notermbidi'* *'notbidi'*
7880'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7881 global
7882 {not in Vi}
7883 {only available when compiled with the |+arabic|
7884 feature}
7885 The terminal is in charge of Bi-directionality of text (as specified
7886 by Unicode). The terminal is also expected to do the required shaping
7887 that some languages (such as Arabic) require.
7888 Setting this option implies that 'rightleft' will not be set when
7889 'arabic' is set and the value of 'arabicshape' will be ignored.
7890 Note that setting 'termbidi' has the immediate effect that
7891 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7892 This option is reset when the GUI is started.
7893 For further details see |arabic.txt|.
7894
7895 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007896'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 Macintosh GUI: "macroman")
7898 global
7899 {only available when compiled with the |+multi_byte|
7900 feature}
7901 {not in Vi}
7902 Encoding used for the terminal. This specifies what character
7903 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007904 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007905 display). Except for the Mac when 'macatsui' is off, then
7906 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007908 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7910 Any attempts to set a different value will be rejected, and an error
7911 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007912 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 because the Win32 system always passes Unicode characters.
7914 When empty, the same encoding is used as for the 'encoding' option.
7915 This is the normal value.
7916 Not all combinations for 'termencoding' and 'encoding' are valid. See
7917 |encoding-table|.
7918 The value for this option must be supported by internal conversions or
7919 iconv(). When this is not possible no conversion will be done and you
7920 will probably experience problems with non-ASCII characters.
7921 Example: You are working with the locale set to euc-jp (Japanese) and
7922 want to edit a UTF-8 file: >
7923 :let &termencoding = &encoding
7924 :set encoding=utf-8
7925< You need to do this when your system has no locale support for UTF-8.
7926
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007927 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007928'termguicolors' 'tgc' boolean (default off)
7929 global
7930 {not in Vi}
7931 {not available when compiled without the
7932 |+termguicolors| feature}
7933 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007934 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007935
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007936 Requires a ISO-8613-3 compatible terminal. If setting this option
7937 does not work (produces a colorless UI) reading |xterm-true-color|
7938 might help.
7939
7940 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7941 is required. Use this check to find out: >
7942 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007943< This requires Vim to be built with the |+vtp| feature.
7944
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007945 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007946 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007947
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007948 *'termwinscroll'* *'twsl'*
7949'termwinscroll' 'twsl' number (default 10000)
7950 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02007951 {not in Vi}
7952 {not available when compiled without the
7953 |+terminal| feature}
7954 Number of scrollback lines to keep. When going over this limit the
7955 first 10% of the scrollback lines are deleted. This is just to reduce
7956 the memory usage. See |Terminal-Normal|.
7957
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007958 *'termwinkey'* *'twk'*
7959'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007960 local to window
7961 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007962 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007963 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007964 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007965 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007966< The string must be one key stroke but can be multiple bytes.
7967 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007968 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007969 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007970
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007971 *'termwinsize'* *'tws'*
7972'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007973 local to window
7974 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02007975 Size of the |terminal| window. Format: {rows}x{columns} or
7976 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007977 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007978 - When set with a "x" (e.g., "24x80") the terminal size is not
7979 adjusted to the window size. If the window is smaller only the
7980 top-left part is displayed.
7981 - When set with a "*" (e.g., "10*50") the terminal size follows the
7982 window size, but will not be smaller than the specified rows and/or
7983 columns.
7984 - When rows is zero then use the height of the window.
7985 - When columns is zero then use the width of the window.
7986 - Using "0x0" or "0*0" is the same as empty.
7987
7988 Examples:
7989 "30x0" uses 30 rows and the current window width.
7990 "20*0" uses at least 20 rows and the current window width.
7991 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007992 Note that the command running in the terminal window may still change
7993 the size of the terminal. In that case the Vim window will be
7994 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007995
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 *'terse'* *'noterse'*
7997'terse' boolean (default off)
7998 global
7999 When set: Add 's' flag to 'shortmess' option (this makes the message
8000 for a search that hits the start or end of the file not being
8001 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8002 shortens a lot of messages}
8003
8004 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8005'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8006 global
8007 {not in Vi}
8008 This option is obsolete. Use 'fileformats'.
8009 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8010 set to the default value for the current system. When 'textauto' is
8011 reset, 'fileformats' is made empty.
8012 NOTE: This option is set to the Vi default value when 'compatible' is
8013 set and to the Vim default value when 'compatible' is reset.
8014
8015 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8016'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8017 others: default off)
8018 local to buffer
8019 {not in Vi}
8020 This option is obsolete. Use 'fileformat'.
8021 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8022 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8023 "unix".
8024
8025 *'textwidth'* *'tw'*
8026'textwidth' 'tw' number (default 0)
8027 local to buffer
8028 {not in Vi}
8029 Maximum width of text that is being inserted. A longer line will be
8030 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008031 this.
8032 'textwidth' is set to 0 when the 'paste' option is set and restored
8033 when 'paste' is reset.
8034 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008036 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 NOTE: This option is set to 0 when 'compatible' is set.
8038
8039 *'thesaurus'* *'tsr'*
8040'thesaurus' 'tsr' string (default "")
8041 global or local to buffer |global-local|
8042 {not in Vi}
8043 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008044 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008045 the file should contain words with similar meaning, separated by
8046 non-keyword characters (white space is preferred). Maximum line
8047 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008048 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008049 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008050 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008051 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 after a comma are ignored, otherwise spaces are included in the file
8053 name. See |option-backslash| about using backslashes.
8054 The use of |:set+=| and |:set-=| is preferred when adding or removing
8055 directories from the list. This avoids problems when a future version
8056 uses another default.
8057 Backticks cannot be used in this option for security reasons.
8058
8059 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8060'tildeop' 'top' boolean (default off)
8061 global
8062 {not in Vi}
8063 When on: The tilde command "~" behaves like an operator.
8064 NOTE: This option is reset when 'compatible' is set.
8065
8066 *'timeout'* *'to'* *'notimeout'* *'noto'*
8067'timeout' 'to' boolean (default on)
8068 global
8069 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008070'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 global
8072 {not in Vi}
8073 These two options together determine the behavior when part of a
8074 mapped key sequence or keyboard code has been received:
8075
8076 'timeout' 'ttimeout' action ~
8077 off off do not time out
8078 on on or off time out on :mappings and key codes
8079 off on time out on key codes
8080
8081 If both options are off, Vim will wait until either the complete
8082 mapping or key sequence has been received, or it is clear that there
8083 is no mapping or key sequence for the received characters. For
8084 example: if you have mapped "vl" and Vim has received 'v', the next
8085 character is needed to see if the 'v' is followed by an 'l'.
8086 When one of the options is on, Vim will wait for about 1 second for
8087 the next character to arrive. After that the already received
8088 characters are interpreted as single characters. The waiting time can
8089 be changed with the 'timeoutlen' option.
8090 On slow terminals or very busy systems timing out may cause
8091 malfunctioning cursor keys. If both options are off, Vim waits
8092 forever after an entered <Esc> if there are key codes that start
8093 with <Esc>. You will have to type <Esc> twice. If you do not have
8094 problems with key codes, but would like to have :mapped key
8095 sequences not timing out in 1 second, set the 'ttimeout' option and
8096 reset the 'timeout' option.
8097
8098 NOTE: 'ttimeout' is reset when 'compatible' is set.
8099
8100 *'timeoutlen'* *'tm'*
8101'timeoutlen' 'tm' number (default 1000)
8102 global
8103 {not in all versions of Vi}
8104 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008105'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 global
8107 {not in Vi}
8108 The time in milliseconds that is waited for a key code or mapped key
8109 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8110 when part of a command has been typed.
8111 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8112 different timeout value for key codes is desired set 'ttimeoutlen' to
8113 a non-negative number.
8114
8115 ttimeoutlen mapping delay key code delay ~
8116 < 0 'timeoutlen' 'timeoutlen'
8117 >= 0 'timeoutlen' 'ttimeoutlen'
8118
8119 The timeout only happens when the 'timeout' and 'ttimeout' options
8120 tell so. A useful setting would be >
8121 :set timeout timeoutlen=3000 ttimeoutlen=100
8122< (time out on mapping after three seconds, time out on key codes after
8123 a tenth of a second).
8124
8125 *'title'* *'notitle'*
8126'title' boolean (default off, on when title can be restored)
8127 global
8128 {not in Vi}
8129 {not available when compiled without the |+title|
8130 feature}
8131 When on, the title of the window will be set to the value of
8132 'titlestring' (if it is not empty), or to:
8133 filename [+=-] (path) - VIM
8134 Where:
8135 filename the name of the file being edited
8136 - indicates the file cannot be modified, 'ma' off
8137 + indicates the file was modified
8138 = indicates the file is read-only
8139 =+ indicates the file is read-only and modified
8140 (path) is the path of the file being edited
8141 - VIM the server name |v:servername| or "VIM"
8142 Only works if the terminal supports setting window titles
8143 (currently Amiga console, Win32 console, all GUI versions and
8144 terminals with a non- empty 't_ts' option - these are Unix xterm and
8145 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8146 *X11*
8147 When Vim was compiled with HAVE_X11 defined, the original title will
8148 be restored if possible. The output of ":version" will include "+X11"
8149 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8150 works for the icon name |'icon'|.
8151 But: When Vim was started with the |-X| argument, restoring the title
8152 will not work (except in the GUI).
8153 If the title cannot be restored, it is set to the value of 'titleold'.
8154 You might want to restore the title outside of Vim then.
8155 When using an xterm from a remote machine you can use this command:
8156 rsh machine_name xterm -display $DISPLAY &
8157 then the WINDOWID environment variable should be inherited and the
8158 title of the window should change back to what it should be after
8159 exiting Vim.
8160
8161 *'titlelen'*
8162'titlelen' number (default 85)
8163 global
8164 {not in Vi}
8165 {not available when compiled without the |+title|
8166 feature}
8167 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008168 title. When the title is longer, only the end of the path name is
8169 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 Using a percentage makes this adapt to the width of the window. But
8171 it won't work perfectly, because the actual number of characters
8172 available also depends on the font used and other things in the title
8173 bar. When 'titlelen' is zero the full path is used. Otherwise,
8174 values from 1 to 30000 percent can be used.
8175 'titlelen' is also used for the 'titlestring' option.
8176
8177 *'titleold'*
8178'titleold' string (default "Thanks for flying Vim")
8179 global
8180 {not in Vi}
8181 {only available when compiled with the |+title|
8182 feature}
8183 This option will be used for the window title when exiting Vim if the
8184 original title cannot be restored. Only happens if 'title' is on or
8185 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008186 This option cannot be set from a |modeline| or in the |sandbox|, for
8187 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 *'titlestring'*
8189'titlestring' string (default "")
8190 global
8191 {not in Vi}
8192 {not available when compiled without the |+title|
8193 feature}
8194 When this option is not empty, it will be used for the title of the
8195 window. This happens only when the 'title' option is on.
8196 Only works if the terminal supports setting window titles (currently
8197 Amiga console, Win32 console, all GUI versions and terminals with a
8198 non-empty 't_ts' option).
8199 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008200 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 When this option contains printf-style '%' items, they will be
8202 expanded according to the rules used for 'statusline'.
8203 Example: >
8204 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8205 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8206< The value of 'titlelen' is used to align items in the middle or right
8207 of the available space.
8208 Some people prefer to have the file name first: >
8209 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8210< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008211 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 separating space only when needed.
8213 NOTE: Use of special characters in 'titlestring' may cause the display
8214 to be garbled (e.g., when it contains a CR or NL character).
8215 {not available when compiled without the |+statusline| feature}
8216
8217 *'toolbar'* *'tb'*
8218'toolbar' 'tb' string (default "icons,tooltips")
8219 global
8220 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8221 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008222 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223 possible values are:
8224 icons Toolbar buttons are shown with icons.
8225 text Toolbar buttons shown with text.
8226 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008227 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008228 tooltips Tooltips are active for toolbar buttons.
8229 Tooltips refer to the popup help text which appears after the mouse
8230 cursor is placed over a toolbar button for a brief moment.
8231
8232 If you want the toolbar to be shown with icons as well as text, do the
8233 following: >
8234 :set tb=icons,text
8235< Motif and Athena cannot display icons and text at the same time. They
8236 will show icons if both are requested.
8237
8238 If none of the strings specified in 'toolbar' are valid or if
8239 'toolbar' is empty, this option is ignored. If you want to disable
8240 the toolbar, you need to set the 'guioptions' option. For example: >
8241 :set guioptions-=T
8242< Also see |gui-toolbar|.
8243
8244 *'toolbariconsize'* *'tbis'*
8245'toolbariconsize' 'tbis' string (default "small")
8246 global
8247 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008248 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008250 tiny Use tiny icons.
8251 small Use small icons (default).
8252 medium Use medium-sized icons.
8253 large Use large icons.
8254 huge Use even larger icons.
8255 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008257 the current theme. Common dimensions are giant=48x48, huge=32x32,
8258 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259
8260 If 'toolbariconsize' is empty, the global default size as determined
8261 by user preferences or the current theme is used.
8262
8263 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8264'ttybuiltin' 'tbi' boolean (default on)
8265 global
8266 {not in Vi}
8267 When on, the builtin termcaps are searched before the external ones.
8268 When off the builtin termcaps are searched after the external ones.
8269 When this option is changed, you should set the 'term' option next for
8270 the change to take effect, for example: >
8271 :set notbi term=$TERM
8272< See also |termcap|.
8273 Rationale: The default for this option is "on", because the builtin
8274 termcap entries are generally better (many systems contain faulty
8275 xterm entries...).
8276
8277 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8278'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8279 sun-cmd, screen, rxvt, dtterm or
8280 iris-ansi; also on when running Vim in
8281 a DOS console)
8282 global
8283 {not in Vi}
8284 Indicates a fast terminal connection. More characters will be sent to
8285 the screen for redrawing, instead of using insert/delete line
8286 commands. Improves smoothness of redrawing when there are multiple
8287 windows and the terminal does not support a scrolling region.
8288 Also enables the extra writing of characters at the end of each screen
8289 line for lines that wrap. This helps when using copy/paste with the
8290 mouse in an xterm and other terminals.
8291
8292 *'ttymouse'* *'ttym'*
8293'ttymouse' 'ttym' string (default depends on 'term')
8294 global
8295 {not in Vi}
8296 {only in Unix and VMS, doesn't work in the GUI; not
8297 available when compiled without |+mouse|}
8298 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008299 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 *xterm-mouse*
8301 xterm xterm-like mouse handling. The mouse generates
8302 "<Esc>[Mscr", where "scr" is three bytes:
8303 "s" = button state
8304 "c" = column plus 33
8305 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008306 This only works up to 223 columns! See "dec",
8307 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 xterm2 Works like "xterm", but with the xterm reporting the
8309 mouse position while the mouse is dragged. This works
8310 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008311 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 work. See below for how Vim detects this
8313 automatically.
8314 *netterm-mouse*
8315 netterm NetTerm mouse handling. The mouse generates
8316 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8317 for the row and column.
8318 *dec-mouse*
8319 dec DEC terminal mouse handling. The mouse generates a
8320 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008321 This is also available for an Xterm, if it was
8322 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 *jsbterm-mouse*
8324 jsbterm JSB term mouse handling.
8325 *pterm-mouse*
8326 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008327 *urxvt-mouse*
8328 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008329 The mouse works only if the terminal supports this
8330 encoding style, but it does not have 223 columns limit
8331 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008332 *sgr-mouse*
8333 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008334 mouse reporting. The mouse works even in columns
8335 beyond 223. This option is backward compatible with
8336 "xterm2" because it can also decode "xterm2" style
8337 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338
8339 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008340 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8341 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8343 recognized, if enabled at compile time. DEC terminal mouse codes
8344 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008345 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8346 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008348 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8349 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8350 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008351 Additionally, if vim is compiled with the |+termresponse| feature and
8352 |t_RV| is set to the escape sequence to request the xterm version
8353 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008355 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008356 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008357 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8358 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 :set t_RV=
8360<
8361 *'ttyscroll'* *'tsl'*
8362'ttyscroll' 'tsl' number (default 999)
8363 global
8364 Maximum number of lines to scroll the screen. If there are more lines
8365 to scroll the window is redrawn. For terminals where scrolling is
8366 very slow and redrawing is not slow this can be set to a small number,
8367 e.g., 3, to speed up displaying.
8368
8369 *'ttytype'* *'tty'*
8370'ttytype' 'tty' string (default from $TERM)
8371 global
8372 Alias for 'term', see above.
8373
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008374 *'undodir'* *'udir'*
8375'undodir' 'udir' string (default ".")
8376 global
8377 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008378 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008379 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008380 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008381 "." means using the directory of the file. The undo file name for
8382 "file.txt" is ".file.txt.un~".
8383 For other directories the file name is the full path of the edited
8384 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008385 When writing: The first directory that exists is used. "." always
8386 works, no directories after "." will be used for writing.
8387 When reading all entries are tried to find an undo file. The first
8388 undo file that exists is used. When it cannot be read an error is
8389 given, no further entry is used.
8390 See |undo-persistence|.
8391
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008392 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008393'undofile' 'udf' boolean (default off)
8394 local to buffer
8395 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008396 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008397 When on, Vim automatically saves undo history to an undo file when
8398 writing a buffer to a file, and restores undo history from the same
8399 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008400 The directory where the undo file is stored is specified by 'undodir'.
8401 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008402 The undo file is not read when 'undoreload' causes the buffer from
8403 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008404 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008405 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008406
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 *'undolevels'* *'ul'*
8408'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8409 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008410 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 {not in Vi}
8412 Maximum number of changes that can be undone. Since undo information
8413 is kept in memory, higher numbers will cause more memory to be used
8414 (nevertheless, a single change can use an unlimited amount of memory).
8415 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8416 itself: >
8417 set ul=0
8418< But you can also get Vi compatibility by including the 'u' flag in
8419 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008420 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008421 Set to -1 for no undo at all. You might want to do this only for the
8422 current buffer: >
8423 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008425
8426 The local value is set to -123456 when the global value is to be used.
8427
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008428 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008430 *'undoreload'* *'ur'*
8431'undoreload' 'ur' number (default 10000)
8432 global
8433 {not in Vi}
8434 Save the whole buffer for undo when reloading it. This applies to the
8435 ":e!" command and reloading for when the buffer changed outside of
8436 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008437 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008438 of lines is smaller than the value of this option.
8439 Set this option to zero to disable undo for a reload.
8440
8441 When saving undo for a reload, any undo file is not read.
8442
8443 Note that this causes the whole buffer to be stored in memory. Set
8444 this option to a lower value if you run out of memory.
8445
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 *'updatecount'* *'uc'*
8447'updatecount' 'uc' number (default: 200)
8448 global
8449 {not in Vi}
8450 After typing this many characters the swap file will be written to
8451 disk. When zero, no swap file will be created at all (see chapter on
8452 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8453 Vim with the "-n" option, see |startup|. When editing in readonly
8454 mode this option will be initialized to 10000.
8455 The swapfile can be disabled per buffer with |'swapfile'|.
8456 When 'updatecount' is set from zero to non-zero, swap files are
8457 created for all buffers that have 'swapfile' set. When 'updatecount'
8458 is set to zero, existing swap files are not deleted.
8459 Also see |'swapsync'|.
8460 This option has no meaning in buffers where |'buftype'| is "nofile"
8461 or "nowrite".
8462
8463 *'updatetime'* *'ut'*
8464'updatetime' 'ut' number (default 4000)
8465 global
8466 {not in Vi}
8467 If this many milliseconds nothing is typed the swap file will be
8468 written to disk (see |crash-recovery|). Also used for the
8469 |CursorHold| autocommand event.
8470
8471 *'verbose'* *'vbs'*
8472'verbose' 'vbs' number (default 0)
8473 global
8474 {not in Vi, although some versions have a boolean
8475 verbose option}
8476 When bigger than zero, Vim will give messages about what it is doing.
8477 Currently, these messages are given:
8478 >= 1 When the viminfo file is read or written.
8479 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008480 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 >= 8 Files for which a group of autocommands is executed.
8482 >= 9 Every executed autocommand.
8483 >= 12 Every executed function.
8484 >= 13 When an exception is thrown, caught, finished, or discarded.
8485 >= 14 Anything pending in a ":finally" clause.
8486 >= 15 Every executed Ex command (truncated at 200 characters).
8487
8488 This option can also be set with the "-V" argument. See |-V|.
8489 This option is also set by the |:verbose| command.
8490
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008491 When the 'verbosefile' option is set then the verbose messages are not
8492 displayed.
8493
8494 *'verbosefile'* *'vfile'*
8495'verbosefile' 'vfile' string (default empty)
8496 global
8497 {not in Vi}
8498 When not empty all messages are written in a file with this name.
8499 When the file exists messages are appended.
8500 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008501 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008502 Setting 'verbosefile' to a new value is like making it empty first.
8503 The difference with |:redir| is that verbose messages are not
8504 displayed when 'verbosefile' is set.
8505
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 *'viewdir'* *'vdir'*
8507'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8508 "$VIM/vimfiles/view",
8509 for Unix: "~/.vim/view",
8510 for Macintosh: "$VIM:vimfiles:view"
8511 for VMS: "sys$login:vimfiles/view"
8512 for RiscOS: "Choices:vimfiles/view")
8513 global
8514 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008515 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008516 feature}
8517 Name of the directory where to store files for |:mkview|.
8518 This option cannot be set from a |modeline| or in the |sandbox|, for
8519 security reasons.
8520
8521 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008522'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 global
8524 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008525 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 feature}
8527 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008528 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 word save and restore ~
8530 cursor cursor position in file and in window
8531 folds manually created folds, opened/closed folds and local
8532 fold options
8533 options options and mappings local to a window or buffer (not
8534 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008535 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008536 slash backslashes in file names replaced with forward
8537 slashes
8538 unix with Unix end-of-line format (single <NL>), even when
8539 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008540 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541
8542 "slash" and "unix" are useful on Windows when sharing view files
8543 with Unix. The Unix version of Vim cannot source dos format scripts,
8544 but the Windows version of Vim can source unix format scripts.
8545
8546 *'viminfo'* *'vi'* *E526* *E527* *E528*
8547'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008548 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8549 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8550 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551 global
8552 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008553 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 feature}
8555 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008556 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8557 "NONE".
8558 The string should be a comma separated list of parameters, each
8559 consisting of a single character identifying the particular parameter,
8560 followed by a number or string which specifies the value of that
8561 parameter. If a particular character is left out, then the default
8562 value is used for that parameter. The following is a list of the
8563 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008565 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 ! When included, save and restore global variables that start
8567 with an uppercase letter, and don't contain a lowercase
8568 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008569 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008570 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008571 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008572 " Maximum number of lines saved for each register. Old name of
8573 the '<' item, with the disadvantage that you need to put a
8574 backslash before the ", otherwise it will be recognized as the
8575 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008576 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 % When included, save and restore the buffer list. If Vim is
8578 started with a file name argument, the buffer list is not
8579 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008580 buffer list is restored from the viminfo file. Quickfix
8581 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8582 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008583 When followed by a number, the number specifies the maximum
8584 number of buffers that are stored. Without a number all
8585 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008586 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587 ' Maximum number of previously edited files for which the marks
8588 are remembered. This parameter must always be included when
8589 'viminfo' is non-empty.
8590 Including this item also means that the |jumplist| and the
8591 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008592 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008594 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 patterns are also saved. When not included, the value of
8596 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008597 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008599 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008600 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 < Maximum number of lines saved for each register. If zero then
8602 registers are not saved. When not included, all lines are
8603 saved. '"' is the old name for this item.
8604 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008605 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008607 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008608 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 c When included, convert the text in the viminfo file from the
8610 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008611 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008612 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 f Whether file marks need to be stored. If zero, file marks ('0
8614 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008615 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008617 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 h Disable the effect of 'hlsearch' when loading the viminfo
8619 file. When not included, it depends on whether ":nohlsearch"
8620 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008621 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008623 the 'n'. Must be at the end of the option! If the
8624 'viminfofile' option is set, that file name overrides the one
8625 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008626 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008627 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 r Removable media. The argument is a string (up to the next
8629 ','). This parameter can be given several times. Each
8630 specifies the start of a path for which no marks will be
8631 stored. This is to avoid removable media. For MS-DOS you
8632 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8633 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8634 ignored. Maximum length of each 'r' argument is 50
8635 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008636 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 s Maximum size of an item in Kbyte. If zero then registers are
8638 not saved. Currently only applies to registers. The default
8639 "s10" will exclude registers with more than 10 Kbyte of text.
8640 Also see the '<' item above: line count limit.
8641
8642 Example: >
8643 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8644<
8645 '50 Marks will be remembered for the last 50 files you
8646 edited.
8647 <1000 Contents of registers (up to 1000 lines each) will be
8648 remembered.
8649 s100 Registers with more than 100 Kbyte text are skipped.
8650 :0 Command-line history will not be saved.
8651 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8652 no / Since '/' is not specified, the default will be used,
8653 that is, save all of the search history, and also the
8654 previous search and substitute patterns.
8655 no % The buffer list will not be saved nor read back.
8656 no h 'hlsearch' highlighting will be restored.
8657
8658 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8659 load the contents of the file, this is not done automatically.
8660
8661 This option cannot be set from a |modeline| or in the |sandbox|, for
8662 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008663 NOTE: This option is set to the Vim default value when 'compatible'
8664 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008666 *'viminfofile'* *'vif'*
8667'viminfofile' 'vif' string (default: "")
8668 global
8669 {not in Vi}
8670 {not available when compiled without the |+viminfo|
8671 feature}
8672 When non-empty, overrides the file name used for viminfo.
8673 When equal to "NONE" no viminfo file will be read or written.
8674 This option can be set with the |-i| command line flag. The |--clean|
8675 command line flag sets it to "NONE".
8676
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 *'virtualedit'* *'ve'*
8678'virtualedit' 've' string (default "")
8679 global
8680 {not in Vi}
8681 {not available when compiled without the
8682 |+virtualedit| feature}
8683 A comma separated list of these words:
8684 block Allow virtual editing in Visual block mode.
8685 insert Allow virtual editing in Insert mode.
8686 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008687 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008688
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008690 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 of the line. Useful for selecting a rectangle in Visual mode and
8692 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008693 "onemore" is not the same, it will only allow moving the cursor just
8694 after the last character of the line. This makes some commands more
8695 consistent. Previously the cursor was always past the end of the line
8696 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008697 break some plugins or Vim scripts. For example because |l| can move
8698 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008699 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008700 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008701 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008702 It doesn't make sense to combine "all" with "onemore", but you will
8703 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008704 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705
8706 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8707'visualbell' 'vb' boolean (default off)
8708 global
8709 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008710 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008711 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008712 use: >
8713 :set vb t_vb=
8714< If you want a short flash, you can use this on many terminals: >
8715 :set vb t_vb=[?5h$<100>[?5l
8716< Here $<100> specifies the time, you can use a smaller or bigger value
8717 to get a shorter or longer flash.
8718
8719 Note: Vim will limit the bell to once per half a second. This avoids
8720 having to wait for the flashing to finish when there are lots of
8721 bells, e.g. on key repeat. This also happens without 'visualbell'
8722 set.
8723
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8725 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8726 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008727
8728 Note: When the GUI starts, 't_vb' is reset to its default value. You
8729 might want to set it again in your |gvimrc|.
8730
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 Does not work on the Amiga, you always get a screen flash.
8732 Also see 'errorbells'.
8733
8734 *'warn'* *'nowarn'*
8735'warn' boolean (default on)
8736 global
8737 Give a warning message when a shell command is used while the buffer
8738 has been changed.
8739
8740 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8741'weirdinvert' 'wiv' boolean (default off)
8742 global
8743 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008744 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745 It is provided for backwards compatibility with version 4.x.
8746 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8747 vice versa. Has no effect when the GUI is running.
8748
8749 *'whichwrap'* *'ww'*
8750'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8751 global
8752 {not in Vi}
8753 Allow specified keys that move the cursor left/right to move to the
8754 previous/next line when the cursor is on the first/last character in
8755 the line. Concatenate characters to allow this for these keys:
8756 char key mode ~
8757 b <BS> Normal and Visual
8758 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008759 h "h" Normal and Visual (not recommended)
8760 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008761 < <Left> Normal and Visual
8762 > <Right> Normal and Visual
8763 ~ "~" Normal
8764 [ <Left> Insert and Replace
8765 ] <Right> Insert and Replace
8766 For example: >
8767 :set ww=<,>,[,]
8768< allows wrap only when cursor keys are used.
8769 When the movement keys are used in combination with a delete or change
8770 operator, the <EOL> also counts for a character. This makes "3h"
8771 different from "3dh" when the cursor crosses the end of a line. This
8772 is also true for "x" and "X", because they do the same as "dl" and
8773 "dh". If you use this, you may also want to use the mapping
8774 ":map <BS> X" to make backspace delete the character in front of the
8775 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008776 When 'l' is included and it is used after an operator at the end of a
8777 line then it will not move to the next line. This makes "dl", "cl",
8778 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 NOTE: This option is set to the Vi default value when 'compatible' is
8780 set and to the Vim default value when 'compatible' is reset.
8781
8782 *'wildchar'* *'wc'*
8783'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8784 global
8785 {not in Vi}
8786 Character you have to type to start wildcard expansion in the
8787 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008788 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008789 The character is not recognized when used inside a macro. See
8790 'wildcharm' for that.
8791 Although 'wc' is a number option, you can set it to a special key: >
8792 :set wc=<Esc>
8793< NOTE: This option is set to the Vi default value when 'compatible' is
8794 set and to the Vim default value when 'compatible' is reset.
8795
8796 *'wildcharm'* *'wcm'*
8797'wildcharm' 'wcm' number (default: none (0))
8798 global
8799 {not in Vi}
8800 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008801 recognized when used inside a macro. You can find "spare" command-line
8802 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 you'll never actually type 'wildcharm', just use it in mappings that
8804 automatically invoke completion mode, e.g.: >
8805 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008806 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807< Then after typing :ss you can use CTRL-P & CTRL-N.
8808
8809 *'wildignore'* *'wig'*
8810'wildignore' 'wig' string (default "")
8811 global
8812 {not in Vi}
8813 {not available when compiled without the |+wildignore|
8814 feature}
8815 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008816 patterns is ignored when expanding |wildcards|, completing file or
8817 directory names, and influences the result of |expand()|, |glob()| and
8818 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8820 Also see 'suffixes'.
8821 Example: >
8822 :set wildignore=*.o,*.obj
8823< The use of |:set+=| and |:set-=| is preferred when adding or removing
8824 a pattern from the list. This avoids problems when a future version
8825 uses another default.
8826
Bram Moolenaar94950a92010-12-02 16:01:29 +01008827
Bram Moolenaar81af9252010-12-10 20:35:50 +01008828 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008829'wildignorecase' 'wic' boolean (default off)
8830 global
8831 {not in Vi}
8832 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008833 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008834 Does not apply when the shell is used to expand wildcards, which
8835 happens when there are special characters.
8836
8837
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008839'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 global
8841 {not in Vi}
8842 {not available if compiled without the |+wildmenu|
8843 feature}
8844 When 'wildmenu' is on, command-line completion operates in an enhanced
8845 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8846 the possible matches are shown just above the command line, with the
8847 first match highlighted (overwriting the status line, if there is
8848 one). Keys that show the previous/next match, such as <Tab> or
8849 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8850 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8851 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008852 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008853 If there are more matches than can fit in the line, a ">" is shown on
8854 the right and/or a "<" is shown on the left. The status line scrolls
8855 as needed.
8856 The "wildmenu" mode is abandoned when a key is hit that is not used
8857 for selecting a completion.
8858 While the "wildmenu" is active the following keys have special
8859 meanings:
8860
8861 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8862 <Down> - in filename/menu name completion: move into a
8863 subdirectory or submenu.
8864 <CR> - in menu completion, when the cursor is just after a
8865 dot: move into a submenu.
8866 <Up> - in filename/menu name completion: move up into
8867 parent directory or parent menu.
8868
8869 This makes the menus accessible from the console |console-menus|.
8870
8871 If you prefer the <Left> and <Right> keys to move the cursor instead
8872 of selecting a different match, use this: >
8873 :cnoremap <Left> <Space><BS><Left>
8874 :cnoremap <Right> <Space><BS><Right>
8875<
8876 The "WildMenu" highlighting is used for displaying the current match
8877 |hl-WildMenu|.
8878
8879 *'wildmode'* *'wim'*
8880'wildmode' 'wim' string (Vim default: "full")
8881 global
8882 {not in Vi}
8883 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008884 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008885 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008886 first part specifies the behavior for the first use of 'wildchar',
8887 The second part for the second use, etc.
8888 These are the possible values for each part:
8889 "" Complete only the first match.
8890 "full" Complete the next full match. After the last match,
8891 the original string is used and then the first match
8892 again.
8893 "longest" Complete till longest common string. If this doesn't
8894 result in a longer string, use the next part.
8895 "longest:full" Like "longest", but also start 'wildmenu' if it is
8896 enabled.
8897 "list" When more than one match, list all matches.
8898 "list:full" When more than one match, list all matches and
8899 complete first match.
8900 "list:longest" When more than one match, list all matches and
8901 complete till longest common string.
8902 When there is only a single match, it is fully completed in all cases.
8903
8904 Examples: >
8905 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008906< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008907 :set wildmode=longest,full
8908< Complete longest common string, then each full match >
8909 :set wildmode=list:full
8910< List all matches and complete each full match >
8911 :set wildmode=list,full
8912< List all matches without completing, then each full match >
8913 :set wildmode=longest,list
8914< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008915 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008917 *'wildoptions'* *'wop'*
8918'wildoptions' 'wop' string (default "")
8919 global
8920 {not in Vi}
8921 {not available when compiled without the |+wildignore|
8922 feature}
8923 A list of words that change how command line completion is done.
8924 Currently only one word is allowed:
8925 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008926 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008927 is displayed per line. Often used tag kinds are:
8928 d #define
8929 f function
8930 Also see |cmdline-completion|.
8931
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 *'winaltkeys'* *'wak'*
8933'winaltkeys' 'wak' string (default "menu")
8934 global
8935 {not in Vi}
8936 {only used in Win32, Motif, GTK and Photon GUI}
8937 Some GUI versions allow the access to menu entries by using the ALT
8938 key in combination with a character that appears underlined in the
8939 menu. This conflicts with the use of the ALT key for mappings and
8940 entering special characters. This option tells what to do:
8941 no Don't use ALT keys for menus. ALT key combinations can be
8942 mapped, but there is no automatic handling. This can then be
8943 done with the |:simalt| command.
8944 yes ALT key handling is done by the windowing system. ALT key
8945 combinations cannot be mapped.
8946 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008947 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008948 keys can be mapped.
8949 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8950 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008951 This option is not used for <F10>; on Win32 and with GTK <F10> will
8952 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008954 *'window'* *'wi'*
8955'window' 'wi' number (default screen height - 1)
8956 global
8957 Window height. Do not confuse this with the height of the Vim window,
8958 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008959 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8960 value is smaller than 'lines' minus one. The screen will scroll
8961 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008962 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8963 in a much smarter way, taking care of wrapping lines.
8964 When resizing the Vim window, the value is smaller than 1 or more than
8965 or equal to 'lines' it will be set to 'lines' minus 1.
8966 {Vi also uses the option to specify the number of displayed lines}
8967
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 *'winheight'* *'wh'* *E591*
8969'winheight' 'wh' number (default 1)
8970 global
8971 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008972 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008973 feature}
8974 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008975 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008976 focus goes to a window that is smaller, its size is increased, at the
8977 cost of the height of other windows.
8978 Set 'winheight' to a small number for normal editing.
8979 Set it to 999 to make the current window fill most of the screen.
8980 Other windows will be only 'winminheight' high. This has the drawback
8981 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8982 to create only two windows, set the option after startup is done,
8983 using the |VimEnter| event: >
8984 au VimEnter * set winheight=999
8985< Minimum value is 1.
8986 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 height of the current window.
8988 'winheight' applies to the current window. Use 'winminheight' to set
8989 the minimal height for other windows.
8990
8991 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8992'winfixheight' 'wfh' boolean (default off)
8993 local to window
8994 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008995 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 feature}
8997 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008998 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8999 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009000 The height may be changed anyway when running out of room.
9001
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009002 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9003'winfixwidth' 'wfw' boolean (default off)
9004 local to window
9005 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009006 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009007 feature}
9008 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009009 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009010 The width may be changed anyway when running out of room.
9011
Bram Moolenaar071d4272004-06-13 20:20:40 +00009012 *'winminheight'* *'wmh'*
9013'winminheight' 'wmh' number (default 1)
9014 global
9015 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009016 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009017 feature}
9018 The minimal height of a window, when it's not the current window.
9019 This is a hard minimum, windows will never become smaller.
9020 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9021 status bar) if necessary. They will return to at least one line when
9022 they become active (since the cursor has to have somewhere to go.)
9023 Use 'winheight' to set the minimal height of the current window.
9024 This option is only checked when making a window smaller. Don't use a
9025 large number, it will cause errors when opening more than a few
9026 windows. A value of 0 to 3 is reasonable.
9027
9028 *'winminwidth'* *'wmw'*
9029'winminwidth' 'wmw' number (default 1)
9030 global
9031 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009032 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009033 feature}
9034 The minimal width of a window, when it's not the current window.
9035 This is a hard minimum, windows will never become smaller.
9036 When set to zero, windows may be "squashed" to zero columns (i.e. just
9037 a vertical separator) if necessary. They will return to at least one
9038 line when they become active (since the cursor has to have somewhere
9039 to go.)
9040 Use 'winwidth' to set the minimal width of the current window.
9041 This option is only checked when making a window smaller. Don't use a
9042 large number, it will cause errors when opening more than a few
9043 windows. A value of 0 to 12 is reasonable.
9044
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009045 *'winptydll'*
9046'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9047 global
9048 {not in Vi}
9049 {only available when compiled with the |terminal|
9050 feature on MS-Windows}
9051 Specifies the name of the winpty shared library, used for the
9052 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009053 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009054 a fallback.
9055 Environment variables are expanded |:set_env|.
9056 This option cannot be set from a |modeline| or in the |sandbox|, for
9057 security reasons.
9058
Bram Moolenaar071d4272004-06-13 20:20:40 +00009059 *'winwidth'* *'wiw'* *E592*
9060'winwidth' 'wiw' number (default 20)
9061 global
9062 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009063 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009064 feature}
9065 Minimal number of columns for the current window. This is not a hard
9066 minimum, Vim will use fewer columns if there is not enough room. If
9067 the current window is smaller, its size is increased, at the cost of
9068 the width of other windows. Set it to 999 to make the current window
9069 always fill the screen. Set it to a small number for normal editing.
9070 The width is not adjusted after one of the commands to change the
9071 width of the current window.
9072 'winwidth' applies to the current window. Use 'winminwidth' to set
9073 the minimal width for other windows.
9074
9075 *'wrap'* *'nowrap'*
9076'wrap' boolean (default on)
9077 local to window
9078 {not in Vi}
9079 This option changes how text is displayed. It doesn't change the text
9080 in the buffer, see 'textwidth' for that.
9081 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009082 displaying continues on the next line. When off lines will not wrap
9083 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009084 moved to a part that is not shown, the screen will scroll
9085 horizontally.
9086 The line will be broken in the middle of a word if necessary. See
9087 'linebreak' to get the break at a word boundary.
9088 To make scrolling horizontally a bit more useful, try this: >
9089 :set sidescroll=5
9090 :set listchars+=precedes:<,extends:>
9091< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009092 This option can't be set from a |modeline| when the 'diff' option is
9093 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009094
9095 *'wrapmargin'* *'wm'*
9096'wrapmargin' 'wm' number (default 0)
9097 local to buffer
9098 Number of characters from the right window border where wrapping
9099 starts. When typing text beyond this limit, an <EOL> will be inserted
9100 and inserting continues on the next line.
9101 Options that add a margin, such as 'number' and 'foldcolumn', cause
9102 the text width to be further reduced. This is Vi compatible.
9103 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009104 This option is set to 0 when 'paste' is set and restored when 'paste'
9105 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009106 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9107 and less usefully}
9108
9109 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9110'wrapscan' 'ws' boolean (default on) *E384* *E385*
9111 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009112 Searches wrap around the end of the file. Also applies to |]s| and
9113 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009114
9115 *'write'* *'nowrite'*
9116'write' boolean (default on)
9117 global
9118 {not in Vi}
9119 Allows writing files. When not set, writing a file is not allowed.
9120 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009121 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009122 argument. Filtering text is still possible, even though this requires
9123 writing a temporary file.
9124
9125 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9126'writeany' 'wa' boolean (default off)
9127 global
9128 Allows writing to any file with no need for "!" override.
9129
9130 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9131'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9132 otherwise)
9133 global
9134 {not in Vi}
9135 Make a backup before overwriting a file. The backup is removed after
9136 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009137 also on.
9138 WARNING: Switching this option off means that when Vim fails to write
9139 your buffer correctly and then, for whatever reason, Vim exits, you
9140 lose both the original file and what you were writing. Only reset
9141 this option if your file system is almost full and it makes the write
9142 fail (and make sure not to exit Vim until the write was successful).
9143 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009144 When the 'backupskip' pattern matches, a backup is not made anyway.
9145 NOTE: This option is set to the default value when 'compatible' is
9146 set.
9147
9148 *'writedelay'* *'wd'*
9149'writedelay' 'wd' number (default 0)
9150 global
9151 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009152 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009153 screen. When non-zero, characters are sent to the terminal one by
9154 one. For MS-DOS pcterm this does not work. For debugging purposes.
9155
9156 vim:tw=78:ts=8:ft=help:norl: