blob: b5e9626bb8f884c39626b822a8f5cdfca906b9d2 [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*options.txt* For Vim version 8.1. Last change: 2018 May 15
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100405 {not available when compiled without the |+eval|
406 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
420NOTE: expanding environment variables and "~/" is only done with the ":set"
421command, not when assigning a value to an option with ":let".
422
Bram Moolenaarc572da52017-08-27 16:52:01 +0200423 *$HOME-windows*
424On MS-Windows, if $HOME is not defined as an environment variable, then
425at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200426If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428This expanded value is not exported to the environment, this matters when
429running an external command: >
430 :echo system('set | findstr ^HOME=')
431and >
432 :echo luaeval('os.getenv("HOME")')
433should echo nothing (an empty string) despite exists('$HOME') being true.
434When setting $HOME to a non-empty string it will be exported to the
435subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200436
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Note the maximum length of an expanded option is limited. How much depends on
439the system, mostly it is something like 256 or 1024 characters.
440
441 *:fix* *:fixdel*
442:fix[del] Set the value of 't_kD':
443 't_kb' is 't_kD' becomes ~
444 CTRL-? CTRL-H
445 not CTRL-? CTRL-?
446
447 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
448
449 If your delete key terminal code is wrong, but the
450 code for backspace is alright, you can put this in
451 your .vimrc: >
452 :fixdel
453< This works no matter what the actual code for
454 backspace is.
455
456 If the backspace key terminal code is wrong you can
457 use this: >
458 :if &term == "termname"
459 : set t_kb=^V<BS>
460 : fixdel
461 :endif
462< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000463 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464 with your terminal name.
465
466 If your <Delete> key sends a strange key sequence (not
467 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
468 :if &term == "termname"
469 : set t_kD=^V<Delete>
470 :endif
471< Where "^V" is CTRL-V and "<Delete>" is the delete key
472 (don't type eight characters!). Replace "termname"
473 with your terminal name.
474
475 *Linux-backspace*
476 Note about Linux: By default the backspace key
477 produces CTRL-?, which is wrong. You can fix it by
478 putting this line in your rc.local: >
479 echo "keycode 14 = BackSpace" | loadkeys
480<
481 *NetBSD-backspace*
482 Note about NetBSD: If your backspace doesn't produce
483 the right code, try this: >
484 xmodmap -e "keycode 22 = BackSpace"
485< If this works, add this in your .Xmodmap file: >
486 keysym 22 = BackSpace
487< You need to restart for this to take effect.
488
489==============================================================================
4902. Automatically setting options *auto-setting*
491
492Besides changing options with the ":set" command, there are three alternatives
493to set options automatically for one or more files:
494
4951. When starting Vim initializations are read from various places. See
496 |initialization|. Most of them are performed for all editing sessions,
497 and some of them depend on the directory where Vim is started.
498 You can create an initialization file with |:mkvimrc|, |:mkview| and
499 |:mksession|.
5002. If you start editing a new file, the automatic commands are executed.
501 This can be used to set options for files matching a particular pattern and
502 many other things. See |autocommand|.
5033. If you start editing a new file, and the 'modeline' option is on, a
504 number of lines at the beginning and end of the file are checked for
505 modelines. This is explained here.
506
507 *modeline* *vim:* *vi:* *ex:* *E520*
508There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200511[text] any text or empty
512{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514[white] optional white space
515{options} a list of option settings, separated with white space
516 or ':', where each part between ':' is the argument
517 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaar14b69452013-06-29 23:05:20 +0200519Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000520 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523The second form (this is compatible with some versions of Vi):
524
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[text] any text or empty
528{white} at least one blank character (<Space> or <Tab>)
529{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
530[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531se[t] the string "set " or "se " (note the space); When
532 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533{options} a list of options, separated with white space, which
534 is the argument for a ":set" command
535: a colon
536[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar14b69452013-06-29 23:05:20 +0200538Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
543chance that a normal word like "lex:" is caught. There is one exception:
544"vi:" and "vim:" can also be at the start of the line (for compatibility with
545version 3.0). Using "ex:" at the start of the line will be ignored (this
546could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 *modeline-local*
549The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000550buffer and window that contain the file. Although it's possible to set global
551options from a modeline, this is unusual. If you have two windows open and
552the files in it set the same global option to a different value, the result
553depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000555When editing a file that was already loaded, only the window-local options
556from the modeline are used. Thus if you manually changed a buffer-local
557option after opening the file, it won't be changed if you edit the same buffer
558in another window. But window-local options will be set.
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-version*
561If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 vim{vers}: version {vers} or later
564 vim<{vers}: version before {vers}
565 vim={vers}: version {vers}
566 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100567{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
568For example, to use a modeline only for Vim 7.0:
569 /* vim700: set foldmethod=marker */ ~
570To use a modeline for Vim after version 7.2:
571 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572There can be no blanks between "vim" and the ":".
573
574
575The number of lines that are checked can be set with the 'modelines' option.
576If 'modeline' is off or 'modelines' is 0 no lines are checked.
577
578Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000579like:
580 /* vi:ts=4: */ ~
581will give an error message for the trailing "*/". This line is OK:
582 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584If an error is detected the rest of the line is skipped.
585
586If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000587backslash in front of the ':' will be removed. Example:
588 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589This sets the 'dir' option to "c:\tmp". Only a single backslash before the
590':' is removed. Thus to include "\:" you have to specify "\\:".
591
592No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000593might create a Trojan horse text file with modelines). And not all options
594can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000595|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000596causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
597are wrapped unexpectedly. So disable modelines before editing untrusted text.
598The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
600Hint: If you would like to do something else than setting an option, you could
601define an autocommand that checks the file for a specific string. For
602example: >
603 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
604And define a function SetVar() that does something with the line containing
605"VAR".
606
607==============================================================================
6083. Options summary *option-summary*
609
610In the list below all the options are mentioned with their full name and with
611an abbreviation if there is one. Both forms may be used.
612
613In this document when a boolean option is "set" that means that ":set option"
614is entered. When an option is "reset", ":set nooption" is used.
615
616For some options there are two default values: The "Vim default", which is
617used when 'compatible' is not set, and the "Vi default", which is used when
618'compatible' is set.
619
620Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000621are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622different value in each window. For example the 'list' option can be set in
623one window and reset in another for the same text, giving both types of view
624at the same time. There are a few options that are specific to a certain
625file. These can have a different value for each file or buffer. For example
626the 'textwidth' option can be 78 for a normal text file and 0 for a C
627program.
628
629 global one option for all buffers and windows
630 local to window each window has its own copy of this option
631 local to buffer each buffer has its own copy of this option
632
633When creating a new window the option values from the currently active window
634are used as a default value for the window-specific options. For the
635buffer-specific options this depends on the 's' and 'S' flags in the
636'cpoptions' option. If 's' is included (which is the default) the values for
637buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000638first entered. If 'S' is present the options are copied each time the buffer
639is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640present, the options are copied from the currently active buffer when the
641buffer is created.
642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000645Not all options are supported in all versions. This depends on the supported
646features and sometimes on the system. A remark about this is in curly braces
647below. When an option is not supported it may still be set without getting an
648error, this is called a hidden option. You can't get the value of a hidden
649option though, it is not stored.
650
651To test if option "foo" can be used with ":set" use something like this: >
652 if exists('&foo')
653This also returns true for a hidden option. To test if option "foo" is really
654supported use something like this: >
655 if exists('+foo')
656<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *E355*
658A jump table for the options with a short description can be found at |Q_op|.
659
660 *'aleph'* *'al'* *aleph* *Aleph*
661'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
662 global
663 {not in Vi}
664 {only available when compiled with the |+rightleft|
665 feature}
666 The ASCII code for the first letter of the Hebrew alphabet. The
667 routine that maps the keyboard in Hebrew mode, both in Insert mode
668 (when hkmap is set) and on the command-line (when hitting CTRL-_)
669 outputs the Hebrew characters in the range [aleph..aleph+26].
670 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
671 See |rileft.txt|.
672
673 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
674'allowrevins' 'ari' boolean (default off)
675 global
676 {not in Vi}
677 {only available when compiled with the |+rightleft|
678 feature}
679 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
680 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
681 into reverse Insert mode, and don't know how to get out. See
682 'revins'.
683 NOTE: This option is reset when 'compatible' is set.
684
685 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
686'altkeymap' 'akm' boolean (default off)
687 global
688 {not in Vi}
689 {only available when compiled with the |+farsi|
690 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 the keyboard map between Farsi and English, when 'allowrevins' set.
693
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 is useful to start the Vim in native mode i.e. English (left-to-right
696 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000697 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
702 {not in Vi}
703 {only available when compiled with the |+multi_byte|
704 feature}
705 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
706 Tells Vim what to do with characters with East Asian Width Class
707 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
708 letters, Cyrillic letters).
709
710 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 expected by most users.
713 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200714 *E834* *E835*
715 The value "double" cannot be used if 'listchars' or 'fillchars'
716 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
729 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
730 when the system locale is set to one of CJK locales. See Unicode
731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
741 {not in Vi}
742 {only available when compiled with GUI enabled
743 on Mac OS X}
744 This option only has an effect in the GUI version of Vim on Mac OS X
745 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
746 which can be easier to read at certain sizes on certain displays.
747 Setting this option can sometimes cause problems if 'guifont' is set
748 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
752'autochdir' 'acd' boolean (default off)
753 global
754 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200755 {only available when compiled with it, use
756 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000757 When on, Vim will change the current working directory whenever you
758 open a file, switch buffers, delete a buffer or open/close a window.
759 It will change to the directory containing the file which was opened
760 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000761 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
764'arabic' 'arab' boolean (default off)
765 local to window
766 {not in Vi}
767 {only available when compiled with the |+arabic|
768 feature}
769 This option can be set to start editing Arabic text.
770 Setting this option will:
771 - Set the 'rightleft' option, unless 'termbidi' is set.
772 - Set the 'arabicshape' option, unless 'termbidi' is set.
773 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
774 between typing English and Arabic key mapping.
775 - Set the 'delcombine' option
776 Note that 'encoding' must be "utf-8" for working with Arabic text.
777
778 Resetting this option will:
779 - Reset the 'rightleft' option.
780 - Disable the use of 'keymap' (without changing its value).
781 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200782 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Also see |arabic.txt|.
785
786 *'arabicshape'* *'arshape'*
787 *'noarabicshape'* *'noarshape'*
788'arabicshape' 'arshape' boolean (default on)
789 global
790 {not in Vi}
791 {only available when compiled with the |+arabic|
792 feature}
793 When on and 'termbidi' is off, the required visual character
794 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200795 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 one which encompasses:
797 a) the changing/morphing of characters based on their location
798 within a word (initial, medial, final and stand-alone).
799 b) the enabling of the ability to compose characters
800 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100801 When disabled the display shows each character's true stand-alone
802 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Arabic is a complex language which requires other settings, for
804 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100805 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
808'autoindent' 'ai' boolean (default off)
809 local to buffer
810 Copy indent from current line when starting a new line (typing <CR>
811 in Insert mode or when using the "o" or "O" command). If you do not
812 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000813 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
814 to another line has the same effect, unless the 'I' flag is included
815 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000816 When autoindent is on, formatting (with the "gq" command or when you
817 reach 'textwidth' in Insert mode) uses the indentation of the first
818 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 When 'smartindent' or 'cindent' is on the indent is changed in
820 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200821 The 'autoindent' option is reset when the 'paste' option is set and
822 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {small difference from Vi: After the indent is deleted when typing
824 <Esc> or <CR>, the cursor position when moving up or down is after the
825 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
826
827 *'autoread'* *'ar'* *'noautoread'* *'noar'*
828'autoread' 'ar' boolean (default off)
829 global or local to buffer |global-local|
830 {not in Vi}
831 When a file has been detected to have been changed outside of Vim and
832 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200833 When the file has been deleted this is not done, so you have the text
834 from before it was deleted. When it appears again then it is read.
835 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 If this option has a local value, use this command to switch back to
837 using the global value: >
838 :set autoread<
839<
840 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
841'autowrite' 'aw' boolean (default off)
842 global
843 Write the contents of the file, if it has been modified, on each
844 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000845 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
847 Note that for some commands the 'autowrite' option is not used, see
848 'autowriteall' for that.
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200849 Some buffers will not be written, specifically when 'buttype' is
850 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851
852 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
853'autowriteall' 'awa' boolean (default off)
854 global
855 {not in Vi}
856 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
857 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
858 Setting this option also implies that Vim behaves like 'autowrite' has
859 been set.
860
861 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200862'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000863 global
864 {not in Vi}
865 When set to "dark", Vim will try to use colors that look good on a
866 dark background. When set to "light", Vim will try to use colors that
867 look good on a light background. Any other value is illegal.
868 Vim tries to set the default value according to the terminal used.
869 This will not always be correct.
870 Setting this option does not change the background color, it tells Vim
871 what the background color looks like. For changing the background
872 color, see |:hi-normal|.
873
874 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000875 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000876 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 setting 'background' will cause the color scheme to be reloaded. If
879 the color scheme adjusts to the value of 'background' this will work.
880 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100881 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882
883 When setting 'background' to the default value with: >
884 :set background&
885< Vim will guess the value. In the GUI this should work correctly,
886 in other cases Vim might not be able to guess the right value.
887
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200888 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200889 color from the terminal. If the returned RGB value is dark/light and
890 'background' is not dark/light, 'background' will be set and the
891 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200892 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100893 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200894
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 When starting the GUI, the default value for 'background' will be
896 "light". When the value is not set in the .gvimrc, and Vim detects
897 that the background is actually quite dark, 'background' is set to
898 "dark". But this happens only AFTER the .gvimrc file has been read
899 (because the window needs to be opened to find the actual background
900 color). To get around this, force the GUI window to be opened by
901 putting a ":gui" command in the .gvimrc file, before where the value
902 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200903
904 For MS-DOS, Windows and OS/2 the default is "dark".
905 For other systems "dark" is used when 'term' is "linux",
906 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
907 background. Otherwise the default is "light".
908
Bram Moolenaarc572da52017-08-27 16:52:01 +0200909 The |:terminal| command and the |term_start()| function use the
910 'background' value to decide whether the terminal window will start
911 with a white or black background.
912
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 Normally this option would be set in the .vimrc file. Possibly
914 depending on the terminal name. Example: >
915 :if &term == "pcterm"
916 : set background=dark
917 :endif
918< When this option is set, the default settings for the highlight groups
919 will change. To use other settings, place ":highlight" commands AFTER
920 the setting of the 'background' option.
921 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
922 to select the colors for syntax highlighting. After changing this
923 option, you must load syntax.vim again to see the result. This can be
924 done with ":syntax on".
925
926 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200927'backspace' 'bs' string (default "", set to "indent,eol,start"
928 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929 global
930 {not in Vi}
931 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
932 mode. This is a list of items, separated by commas. Each item allows
933 a way to backspace over something:
934 value effect ~
935 indent allow backspacing over autoindent
936 eol allow backspacing over line breaks (join lines)
937 start allow backspacing over the start of insert; CTRL-W and CTRL-U
938 stop once at the start of insert.
939
940 When the value is empty, Vi compatible backspacing is used.
941
942 For backwards compatibility with version 5.4 and earlier:
943 value effect ~
944 0 same as ":set backspace=" (Vi compatible)
945 1 same as ":set backspace=indent,eol"
946 2 same as ":set backspace=indent,eol,start"
947
948 See |:fixdel| if your <BS> or <Del> key does not do what you want.
949 NOTE: This option is set to "" when 'compatible' is set.
950
951 *'backup'* *'bk'* *'nobackup'* *'nobk'*
952'backup' 'bk' boolean (default off)
953 global
954 {not in Vi}
955 Make a backup before overwriting a file. Leave it around after the
956 file has been successfully written. If you do not want to keep the
957 backup file, but you do want a backup while the file is being
958 written, reset this option and set the 'writebackup' option (this is
959 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000960 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961 |backup-table| for more explanations.
962 When the 'backupskip' pattern matches, a backup is not made anyway.
963 When 'patchmode' is set, the backup may be renamed to become the
964 oldest version of a file.
965 NOTE: This option is reset when 'compatible' is set.
966
967 *'backupcopy'* *'bkc'*
968'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200969 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 {not in Vi}
971 When writing a file and a backup is made, this option tells how it's
972 done. This is a comma separated list of words.
973
974 The main values are:
975 "yes" make a copy of the file and overwrite the original one
976 "no" rename the file and write a new one
977 "auto" one of the previous, what works best
978
979 Extra values that can be combined with the ones above are:
980 "breaksymlink" always break symlinks when writing
981 "breakhardlink" always break hardlinks when writing
982
983 Making a copy and overwriting the original file:
984 - Takes extra time to copy the file.
985 + When the file has special attributes, is a (hard/symbolic) link or
986 has a resource fork, all this is preserved.
987 - When the file is a link the backup will have the name of the link,
988 not of the real file.
989
990 Renaming the file and writing a new one:
991 + It's fast.
992 - Sometimes not all attributes of the file can be copied to the new
993 file.
994 - When the file is a link the new file will not be a link.
995
996 The "auto" value is the middle way: When Vim sees that renaming file
997 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000998 the file is not a link) that is used. When problems are expected, a
999 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000
1001 The "breaksymlink" and "breakhardlink" values can be used in
1002 combination with any of "yes", "no" and "auto". When included, they
1003 force Vim to always break either symbolic or hard links by doing
1004 exactly what the "no" option does, renaming the original file to
1005 become the backup and writing a new file in its place. This can be
1006 useful for example in source trees where all the files are symbolic or
1007 hard links and any changes should stay in the local source tree, not
1008 be propagated back to the original source.
1009 *crontab*
1010 One situation where "no" and "auto" will cause problems: A program
1011 that opens a file, invokes Vim to edit that file, and then tests if
1012 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001013 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001014 example.
1015
1016 When a copy is made, the original file is truncated and then filled
1017 with the new text. This means that protection bits, owner and
1018 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001019 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001020 group of the backup is set to the group of the original file. If this
1021 fails, the protection bits for the group are made the same as for
1022 others.
1023
1024 When the file is renamed this is the other way around: The backup has
1025 the same attributes of the original file, and the newly written file
1026 is owned by the current user. When the file was a (hard/symbolic)
1027 link, the new file will not! That's why the "auto" value doesn't
1028 rename when the file is a link. The owner and group of the newly
1029 written file will be set to the same ones as the original file, but
1030 the system may refuse to do this. In that case the "auto" value will
1031 again not rename the file.
1032
Bram Moolenaar036986f2017-03-16 17:41:02 +01001033 NOTE: This option is set to the Vi default value when 'compatible' is
1034 set and to the Vim default value when 'compatible' is reset.
1035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 *'backupdir'* *'bdir'*
1037'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001038 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039 for Unix: ".,~/tmp,~/")
1040 global
1041 {not in Vi}
1042 List of directories for the backup file, separated with commas.
1043 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001044 where this is possible. The directory must exist, Vim will not
1045 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001046 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 impossible!). Writing may fail because of this.
1048 - A directory "." means to put the backup file in the same directory
1049 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001050 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 put the backup file relative to where the edited file is. The
1052 leading "." is replaced with the path name of the edited file.
1053 ("." inside a directory name has no special meaning).
1054 - Spaces after the comma are ignored, other spaces are considered part
1055 of the directory name. To have a space at the start of a directory
1056 name, precede it with a backslash.
1057 - To include a comma in a directory name precede it with a backslash.
1058 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001059 - For Unix and Win32, if a directory ends in two path separators "//",
1060 the swap file name will be built from the complete path to the file
1061 with all path separators changed to percent '%' signs. This will
1062 ensure file name uniqueness in the backup directory.
1063 On Win32, it is also possible to end with "\\". However, When a
1064 separating comma is following, you must use "//", since "\\" will
1065 include the comma in the file name. Therefore it is recommended to
1066 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 - Environment variables are expanded |:set_env|.
1068 - Careful with '\' characters, type one before a space, type two to
1069 get one in the option (see |option-backslash|), for example: >
1070 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1071< - For backwards compatibility with Vim version 3.0 a '>' at the start
1072 of the option is removed.
1073 See also 'backup' and 'writebackup' options.
1074 If you want to hide your backup files on Unix, consider this value: >
1075 :set backupdir=./.backup,~/.backup,.,/tmp
1076< You must create a ".backup" directory in each directory and in your
1077 home directory for this to work properly.
1078 The use of |:set+=| and |:set-=| is preferred when adding or removing
1079 directories from the list. This avoids problems when a future version
1080 uses another default.
1081 This option cannot be set from a |modeline| or in the |sandbox|, for
1082 security reasons.
1083
1084 *'backupext'* *'bex'* *E589*
1085'backupext' 'bex' string (default "~", for VMS: "_")
1086 global
1087 {not in Vi}
1088 String which is appended to a file name to make the name of the
1089 backup file. The default is quite unusual, because this avoids
1090 accidentally overwriting existing files with a backup file. You might
1091 prefer using ".bak", but make sure that you don't have files with
1092 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001093 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001095 If you like to keep a lot of backups, you could use a BufWritePre
1096 autocommand to change 'backupext' just before writing the file to
1097 include a timestamp. >
1098 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1099< Use 'backupdir' to put the backup in a different directory.
1100
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001102'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1103 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1104 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 global
1106 {not in Vi}
1107 {not available when compiled without the |+wildignore|
1108 feature}
1109 A list of file patterns. When one of the patterns matches with the
1110 name of the file which is written, no backup file is created. Both
1111 the specified file name and the full path name of the file are used.
1112 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1113 Watch out for special characters, see |option-backslash|.
1114 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001115 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001116
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001117 WARNING: Not having a backup file means that when Vim fails to write
1118 your buffer correctly and then, for whatever reason, Vim exits, you
1119 lose both the original file and what you were writing. Only disable
1120 backups if you don't care about losing the file.
1121
Bram Moolenaar02467872007-05-06 13:22:01 +00001122 Note that environment variables are not expanded. If you want to use
1123 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001124 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001125
1126< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001127 backup would be made by renaming the original file crontab won't see
1128 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129
1130 *'balloondelay'* *'bdlay'*
1131'balloondelay' 'bdlay' number (default: 600)
1132 global
1133 {not in Vi}
1134 {only available when compiled with the |+balloon_eval|
1135 feature}
1136 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1137
1138 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1139'ballooneval' 'beval' boolean (default off)
1140 global
1141 {not in Vi}
1142 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001143 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001144 Switch on the |balloon-eval| functionality for the GUI.
1145
1146 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1147 *'nobevalterm'*
1148'balloonevalterm' 'bevalterm' boolean (default off)
1149 global
1150 {not in Vi}
1151 {only available when compiled with the
1152 |+balloon_eval_term| feature}
1153 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001155 *'balloonexpr'* *'bexpr'*
1156'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001157 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158 {not in Vi}
1159 {only available when compiled with the |+balloon_eval|
1160 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001161 Expression for text to show in evaluation balloon. It is only used
1162 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001163
1164 v:beval_bufnr number of the buffer in which balloon is going to show
1165 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001166 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001167 v:beval_lnum line number
1168 v:beval_col column number (byte index)
1169 v:beval_text word under or after the mouse pointer
1170
1171 The evaluation of the expression must not have side effects!
1172 Example: >
1173 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001174 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001175 \', column ' . v:beval_col .
1176 \ ' of file ' . bufname(v:beval_bufnr) .
1177 \ ' on word "' . v:beval_text . '"'
1178 endfunction
1179 set bexpr=MyBalloonExpr()
1180 set ballooneval
1181<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001182 Also see |balloon_show()|, can be used if the content of the balloon
1183 is to be fetched asynchronously.
1184
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001185 NOTE: The balloon is displayed only if the cursor is on a text
1186 character. If the result of evaluating 'balloonexpr' is not empty,
1187 Vim does not try to send a message to an external debugger (Netbeans
1188 or Sun Workshop).
1189
Bram Moolenaar30b65812012-07-12 22:01:11 +02001190 The expression will be evaluated in the |sandbox| when set from a
1191 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001192
1193 It is not allowed to change text or jump to another window while
1194 evaluating 'balloonexpr' |textlock|.
1195
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001196 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001197 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001198< When they are supported "\n" characters will start a new line. If the
1199 expression evaluates to a |List| this is equal to using each List item
1200 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001201 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001202
Bram Moolenaar165bc692015-07-21 17:53:25 +02001203 *'belloff'* *'bo'*
1204'belloff' 'bo' string (default "")
1205 global
1206 {not in Vi}
1207 Specifies for which events the bell will not be rung. It is a comma
1208 separated list of items. For each item that is present, the bell
1209 will be silenced. This is most useful to specify specific events in
1210 insert mode to be silenced.
1211
1212 item meaning when present ~
1213 all All events.
1214 backspace When hitting <BS> or <Del> and deleting results in an
1215 error.
1216 cursor Fail to move around using the cursor keys or
1217 <PageUp>/<PageDown> in |Insert-mode|.
1218 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1219 |i_CTRL-X_CTRL-T|.
1220 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1221 |i_CTRL-E|.
1222 ctrlg Unknown Char after <C-G> in Insert mode.
1223 error Other Error occurred (e.g. try to join last line)
1224 (mostly used in |Normal-mode| or |Cmdline-mode|).
1225 esc hitting <Esc> in |Normal-mode|.
1226 ex In |Visual-mode|, hitting |Q| results in an error.
1227 hangul Error occurred when using hangul input.
1228 insertmode Pressing <Esc> in 'insertmode'.
1229 lang Calling the beep module for Lua/Mzscheme/TCL.
1230 mess No output available for |g<|.
1231 showmatch Error occurred for 'showmatch' function.
1232 operator Empty region error |cpo-E|.
1233 register Unknown register after <C-R> in |Insert-mode|.
1234 shell Bell from shell output |:!|.
1235 spell Error happened on spell suggest.
1236 wildmode More matches in |cmdline-completion| available
1237 (depends on the 'wildmode' setting).
1238
Bram Moolenaar036986f2017-03-16 17:41:02 +01001239 This is most useful to fine tune when in Insert mode the bell should
1240 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001241 indicate that an error occurred. It can be silenced by adding the
1242 "error" keyword.
1243
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1245'binary' 'bin' boolean (default off)
1246 local to buffer
1247 {not in Vi}
1248 This option should be set before editing a binary file. You can also
1249 use the |-b| Vim argument. When this option is switched on a few
1250 options will be changed (also when it already was on):
1251 'textwidth' will be set to 0
1252 'wrapmargin' will be set to 0
1253 'modeline' will be off
1254 'expandtab' will be off
1255 Also, 'fileformat' and 'fileformats' options will not be used, the
1256 file is read and written like 'fileformat' was "unix" (a single <NL>
1257 separates lines).
1258 The 'fileencoding' and 'fileencodings' options will not be used, the
1259 file is read without conversion.
1260 NOTE: When you start editing a(nother) file while the 'bin' option is
1261 on, settings from autocommands may change the settings again (e.g.,
1262 'textwidth'), causing trouble when editing. You might want to set
1263 'bin' again when the file has been loaded.
1264 The previous values of these options are remembered and restored when
1265 'bin' is switched from on to off. Each buffer has its own set of
1266 saved option values.
1267 To edit a file with 'binary' set you can use the |++bin| argument.
1268 This avoids you have to do ":set bin", which would have effect for all
1269 files you edit.
1270 When writing a file the <EOL> for the last line is only written if
1271 there was one in the original file (normally Vim appends an <EOL> to
1272 the last line if there is none; this would make the file longer). See
1273 the 'endofline' option.
1274
1275 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1276'bioskey' 'biosk' boolean (default on)
1277 global
1278 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001279 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
1281 *'bomb'* *'nobomb'*
1282'bomb' boolean (default off)
1283 local to buffer
1284 {not in Vi}
1285 {only available when compiled with the |+multi_byte|
1286 feature}
1287 When writing a file and the following conditions are met, a BOM (Byte
1288 Order Mark) is prepended to the file:
1289 - this option is on
1290 - the 'binary' option is off
1291 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1292 endian variants.
1293 Some applications use the BOM to recognize the encoding of the file.
1294 Often used for UCS-2 files on MS-Windows. For other applications it
1295 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001296 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1298 check for the presence of the BOM is done and 'bomb' set accordingly.
1299 Unless 'binary' is set, it is removed from the first line, so that you
1300 don't see it when editing. When you don't change the options, the BOM
1301 will be restored when writing the file.
1302
1303 *'breakat'* *'brk'*
1304'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1305 global
1306 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001307 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 feature}
1309 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001310 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1311 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001313 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001314'breakindent' 'bri' boolean (default off)
1315 local to window
1316 {not in Vi}
1317 {not available when compiled without the |+linebreak|
1318 feature}
1319 Every wrapped line will continue visually indented (same amount of
1320 space as the beginning of that line), thus preserving horizontal blocks
1321 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001322 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001323
1324 *'breakindentopt'* *'briopt'*
1325'breakindentopt' 'briopt' string (default empty)
1326 local to window
1327 {not in Vi}
1328 {not available when compiled without the |+linebreak|
1329 feature}
1330 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001331 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001332 min:{n} Minimum text width that will be kept after
1333 applying 'breakindent', even if the resulting
1334 text should normally be narrower. This prevents
1335 text indented almost to the right window border
1336 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001337 shift:{n} After applying 'breakindent', the wrapped line's
1338 beginning will be shifted by the given number of
1339 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001340 indentation (negative) or emphasizing the line
1341 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001342 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001343 additional indent.
1344 The default value for min is 20 and shift is 0.
1345
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001347'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001349 {not in Vi} {only for Motif, Athena, GTK, Mac and
1350 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001352 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001353 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 buffer Use the directory of the related buffer.
1355 current Use the current directory.
1356 {path} Use the specified directory
1357
1358 *'bufhidden'* *'bh'*
1359'bufhidden' 'bh' string (default: "")
1360 local to buffer
1361 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 This option specifies what happens when a buffer is no longer
1363 displayed in a window:
1364 <empty> follow the global 'hidden' option
1365 hide hide the buffer (don't unload it), also when 'hidden'
1366 is not set
1367 unload unload the buffer, also when 'hidden' is set or using
1368 |:hide|
1369 delete delete the buffer from the buffer list, also when
1370 'hidden' is set or using |:hide|, like using
1371 |:bdelete|
1372 wipe wipe out the buffer from the buffer list, also when
1373 'hidden' is set or using |:hide|, like using
1374 |:bwipeout|
1375
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001376 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001377 are lost without a warning. Also, these values may break autocommands
1378 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 This option is used together with 'buftype' and 'swapfile' to specify
1380 special kinds of buffers. See |special-buffers|.
1381
1382 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1383'buflisted' 'bl' boolean (default: on)
1384 local to buffer
1385 {not in Vi}
1386 When this option is set, the buffer shows up in the buffer list. If
1387 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1388 This option is reset by Vim for buffers that are only used to remember
1389 a file name or marks. Vim sets it when starting to edit a buffer.
1390 But not when moving to a buffer with ":buffer".
1391
1392 *'buftype'* *'bt'* *E382*
1393'buftype' 'bt' string (default: "")
1394 local to buffer
1395 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 The value of this option specifies the type of a buffer:
1397 <empty> normal buffer
1398 nofile buffer which is not related to a file and will not be
1399 written
1400 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001401 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001402 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001404 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 help help buffer (you are not supposed to set this
1406 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001407 terminal buffer for a |terminal| (you are not supposed to set
1408 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001409 prompt buffer where only the last line can be edited, meant
1410 to be used by a plugin, see |prompt-buffer|
1411 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413 This option is used together with 'bufhidden' and 'swapfile' to
1414 specify special kinds of buffers. See |special-buffers|.
1415
1416 Be careful with changing this option, it can have many side effects!
1417
Bram Moolenaar280f1262006-01-30 00:14:18 +00001418 A "quickfix" buffer is only used for the error list and the location
1419 list. This value is set by the |:cwindow| and |:lwindow| commands and
1420 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421
1422 "nofile" and "nowrite" buffers are similar:
1423 both: The buffer is not to be written to disk, ":w" doesn't
1424 work (":w filename" does work though).
1425 both: The buffer is never considered to be |'modified'|.
1426 There is no warning when the changes will be lost, for
1427 example when you quit Vim.
1428 both: A swap file is only created when using too much memory
1429 (when 'swapfile' has been reset there is never a swap
1430 file).
1431 nofile only: The buffer name is fixed, it is not handled like a
1432 file name. It is not modified in response to a |:cd|
1433 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001434 both: When using ":e bufname" and already editing "bufname"
1435 the buffer is made empty and autocommands are
1436 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001437 *E676*
1438 "acwrite" implies that the buffer name is not related to a file, like
1439 "nofile", but it will be written. Thus, in contrast to "nofile" and
1440 "nowrite", ":w" does work and a modified buffer can't be abandoned
1441 without saving. For writing there must be matching |BufWriteCmd|,
1442 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443
1444 *'casemap'* *'cmp'*
1445'casemap' 'cmp' string (default: "internal,keepascii")
1446 global
1447 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001448 {only available when compiled with the |+multi_byte|
1449 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 Specifies details about changing the case of letters. It may contain
1451 these words, separated by a comma:
1452 internal Use internal case mapping functions, the current
1453 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001454 matters when 'encoding' is a Unicode encoding,
1455 "latin1" or "iso-8859-15". When "internal" is
1456 omitted, the towupper() and towlower() system library
1457 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1459 case mapping, the current locale is not effective.
1460 This probably only matters for Turkish.
1461
1462 *'cdpath'* *'cd'* *E344* *E346*
1463'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1464 global
1465 {not in Vi}
1466 {not available when compiled without the
1467 |+file_in_path| feature}
1468 This is a list of directories which will be searched when using the
1469 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001470 for has a relative path, not an absolute part starting with "/", "./"
1471 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 The 'cdpath' option's value has the same form and semantics as
1473 |'path'|. Also see |file-searching|.
1474 The default value is taken from $CDPATH, with a "," prepended to look
1475 in the current directory first.
1476 If the default value taken from $CDPATH is not what you want, include
1477 a modified version of the following command in your vimrc file to
1478 override it: >
1479 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1480< This option cannot be set from a |modeline| or in the |sandbox|, for
1481 security reasons.
1482 (parts of 'cdpath' can be passed to the shell to expand file names).
1483
1484 *'cedit'*
1485'cedit' string (Vi default: "", Vim default: CTRL-F)
1486 global
1487 {not in Vi}
1488 {not available when compiled without the |+vertsplit|
1489 feature}
1490 The key used in Command-line Mode to open the command-line window.
1491 The default is CTRL-F when 'compatible' is off.
1492 Only non-printable keys are allowed.
1493 The key can be specified as a single character, but it is difficult to
1494 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001495 :exe "set cedit=\<C-Y>"
1496 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497< |Nvi| also has this option, but it only uses the first character.
1498 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001499 NOTE: This option is set to the Vim default value when 'compatible'
1500 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501
1502 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1503'charconvert' 'ccv' string (default "")
1504 global
1505 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001506 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 {not in Vi}
1508 An expression that is used for character encoding conversion. It is
1509 evaluated when a file that is to be read or has been written has a
1510 different encoding from what is desired.
1511 'charconvert' is not used when the internal iconv() function is
1512 supported and is able to do the conversion. Using iconv() is
1513 preferred, because it is much faster.
1514 'charconvert' is not used when reading stdin |--|, because there is no
1515 file to convert from. You will have to save the text in a file first.
1516 The expression must return zero or an empty string for success,
1517 non-zero for failure.
1518 The possible encoding names encountered are in 'encoding'.
1519 Additionally, names given in 'fileencodings' and 'fileencoding' are
1520 used.
1521 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1522 is done internally by Vim, 'charconvert' is not used for this.
1523 'charconvert' is also used to convert the viminfo file, if the 'c'
1524 flag is present in 'viminfo'. Also used for Unicode conversion.
1525 Example: >
1526 set charconvert=CharConvert()
1527 fun CharConvert()
1528 system("recode "
1529 \ . v:charconvert_from . ".." . v:charconvert_to
1530 \ . " <" . v:fname_in . " >" v:fname_out)
1531 return v:shell_error
1532 endfun
1533< The related Vim variables are:
1534 v:charconvert_from name of the current encoding
1535 v:charconvert_to name of the desired encoding
1536 v:fname_in name of the input file
1537 v:fname_out name of the output file
1538 Note that v:fname_in and v:fname_out will never be the same.
1539 Note that v:charconvert_from and v:charconvert_to may be different
1540 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1541 Encryption is not done by Vim when using 'charconvert'. If you want
1542 to encrypt the file after conversion, 'charconvert' should take care
1543 of this.
1544 This option cannot be set from a |modeline| or in the |sandbox|, for
1545 security reasons.
1546
1547 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1548'cindent' 'cin' boolean (default off)
1549 local to buffer
1550 {not in Vi}
1551 {not available when compiled without the |+cindent|
1552 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001553 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 that trigger reindenting in insert mode and 'cinoptions' to set your
1555 preferred indent style.
1556 If 'indentexpr' is not empty, it overrules 'cindent'.
1557 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1558 the "=" operator indents using this algorithm rather than calling an
1559 external program.
1560 See |C-indenting|.
1561 When you don't like the way 'cindent' works, try the 'smartindent'
1562 option or 'indentexpr'.
1563 This option is not used when 'paste' is set.
1564 NOTE: This option is reset when 'compatible' is set.
1565
1566 *'cinkeys'* *'cink'*
1567'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1568 local to buffer
1569 {not in Vi}
1570 {not available when compiled without the |+cindent|
1571 feature}
1572 A list of keys that, when typed in Insert mode, cause reindenting of
1573 the current line. Only used if 'cindent' is on and 'indentexpr' is
1574 empty.
1575 For the format of this option see |cinkeys-format|.
1576 See |C-indenting|.
1577
1578 *'cinoptions'* *'cino'*
1579'cinoptions' 'cino' string (default "")
1580 local to buffer
1581 {not in Vi}
1582 {not available when compiled without the |+cindent|
1583 feature}
1584 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1585 program. See |cinoptions-values| for the values of this option, and
1586 |C-indenting| for info on C indenting in general.
1587
1588
1589 *'cinwords'* *'cinw'*
1590'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1591 local to buffer
1592 {not in Vi}
1593 {not available when compiled without both the
1594 |+cindent| and the |+smartindent| features}
1595 These keywords start an extra indent in the next line when
1596 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1597 an appropriate place (inside {}).
1598 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1599 matter, include the keyword both the uppercase and lowercase:
1600 "if,If,IF".
1601
1602 *'clipboard'* *'cb'*
1603'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1604 for X-windows, "" otherwise)
1605 global
1606 {not in Vi}
1607 {only in GUI versions or when the |+xterm_clipboard|
1608 feature is included}
1609 This option is a list of comma separated names.
1610 These names are recognized:
1611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 unnamed When included, Vim will use the clipboard register '*'
1614 for all yank, delete, change and put operations which
1615 would normally go to the unnamed register. When a
1616 register is explicitly specified, it will always be
1617 used regardless of whether "unnamed" is in 'clipboard'
1618 or not. The clipboard register can always be
1619 explicitly accessed using the "* notation. Also see
1620 |gui-clipboard|.
1621
Bram Moolenaar30b65812012-07-12 22:01:11 +02001622 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001623 unnamedplus A variant of the "unnamed" flag which uses the
1624 clipboard register '+' (|quoteplus|) instead of
1625 register '*' for all yank, delete, change and put
1626 operations which would normally go to the unnamed
1627 register. When "unnamed" is also included to the
1628 option, yank operations (but not delete, change or
1629 put) will additionally copy the text into register
1630 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001631 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001632 Availability can be checked with: >
1633 if has('unnamedplus')
1634<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001635 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 autoselect Works like the 'a' flag in 'guioptions': If present,
1637 then whenever Visual mode is started, or the Visual
1638 area extended, Vim tries to become the owner of the
1639 windowing system's global selection or put the
1640 selected text on the clipboard used by the selection
1641 register "*. See |guioptions_a| and |quotestar| for
1642 details. When the GUI is active, the 'a' flag in
1643 'guioptions' is used, when the GUI is not active, this
1644 "autoselect" flag is used.
1645 Also applies to the modeless selection.
1646
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001647 *clipboard-autoselectplus*
1648 autoselectplus Like "autoselect" but using the + register instead of
1649 the * register. Compare to the 'P' flag in
1650 'guioptions'.
1651
1652 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 autoselectml Like "autoselect", but for the modeless selection
1654 only. Compare to the 'A' flag in 'guioptions'.
1655
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001656 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001657 html When the clipboard contains HTML, use this when
1658 pasting. When putting text on the clipboard, mark it
1659 as HTML. This works to copy rendered HTML from
1660 Firefox, paste it as raw HTML in Vim, select the HTML
1661 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001662 You probably want to add this only temporarily,
1663 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001664 Only supported for GTK version 2 and later.
1665 Only available with the |+multi_byte| feature.
1666
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001667 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 exclude:{pattern}
1669 Defines a pattern that is matched against the name of
1670 the terminal 'term'. If there is a match, no
1671 connection will be made to the X server. This is
1672 useful in this situation:
1673 - Running Vim in a console.
1674 - $DISPLAY is set to start applications on another
1675 display.
1676 - You do not want to connect to the X server in the
1677 console, but do want this in a terminal emulator.
1678 To never connect to the X server use: >
1679 exclude:.*
1680< This has the same effect as using the |-X| argument.
1681 Note that when there is no connection to the X server
1682 the window title won't be restored and the clipboard
1683 cannot be accessed.
1684 The value of 'magic' is ignored, {pattern} is
1685 interpreted as if 'magic' was on.
1686 The rest of the option value will be used for
1687 {pattern}, this must be the last entry.
1688
1689 *'cmdheight'* *'ch'*
1690'cmdheight' 'ch' number (default 1)
1691 global
1692 {not in Vi}
1693 Number of screen lines to use for the command-line. Helps avoiding
1694 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001695 The value of this option is stored with the tab page, so that each tab
1696 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697
1698 *'cmdwinheight'* *'cwh'*
1699'cmdwinheight' 'cwh' number (default 7)
1700 global
1701 {not in Vi}
1702 {not available when compiled without the |+vertsplit|
1703 feature}
1704 Number of screen lines to use for the command-line window. |cmdwin|
1705
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001706 *'colorcolumn'* *'cc'*
1707'colorcolumn' 'cc' string (default "")
1708 local to window
1709 {not in Vi}
1710 {not available when compiled without the |+syntax|
1711 feature}
1712 'colorcolumn' is a comma separated list of screen columns that are
1713 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1714 text. Will make screen redrawing slower.
1715 The screen column can be an absolute number, or a number preceded with
1716 '+' or '-', which is added to or subtracted from 'textwidth'. >
1717
1718 :set cc=+1 " highlight column after 'textwidth'
1719 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1720 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1721<
1722 When 'textwidth' is zero then the items with '-' and '+' are not used.
1723 A maximum of 256 columns are highlighted.
1724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 *'columns'* *'co'* *E594*
1726'columns' 'co' number (default 80 or terminal width)
1727 global
1728 {not in Vi}
1729 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001730 initialization and does not have to be set by hand. Also see
1731 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 When Vim is running in the GUI or in a resizable window, setting this
1733 option will cause the window size to be changed. When you only want
1734 to use the size for the GUI, put the command in your |gvimrc| file.
1735 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001736 number of columns of the display, the display may be messed up. For
1737 the GUI it is always possible and Vim limits the number of columns to
1738 what fits on the screen. You can use this command to get the widest
1739 window possible: >
1740 :set columns=9999
1741< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742
1743 *'comments'* *'com'* *E524* *E525*
1744'comments' 'com' string (default
1745 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1746 local to buffer
1747 {not in Vi}
1748 {not available when compiled without the |+comments|
1749 feature}
1750 A comma separated list of strings that can start a comment line. See
1751 |format-comments|. See |option-backslash| about using backslashes to
1752 insert a space.
1753
1754 *'commentstring'* *'cms'* *E537*
1755'commentstring' 'cms' string (default "/*%s*/")
1756 local to buffer
1757 {not in Vi}
1758 {not available when compiled without the |+folding|
1759 feature}
1760 A template for a comment. The "%s" in the value is replaced with the
1761 comment text. Currently only used to add markers for folding, see
1762 |fold-marker|.
1763
1764 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001765'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001766 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 global
1768 {not in Vi}
1769 This option has the effect of making Vim either more Vi-compatible, or
1770 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001771
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 other options are also changed as a side effect.
1774 NOTE: Setting or resetting this option can have a lot of unexpected
1775 effects: Mappings are interpreted in another way, undo behaves
1776 differently, etc. If you set this option in your vimrc file, you
1777 should probably put it at the very start.
1778
Bram Moolenaar071d4272004-06-13 20:20:40 +00001779 By default this option is on and the Vi defaults are used for the
1780 options. This default was chosen for those people who want to use Vim
1781 just like Vi, and don't even (want to) know about the 'compatible'
1782 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001783 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001784 this option is switched off, and all options that have not been
1785 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001786 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001787 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001788 happen for the system-wide vimrc or gvimrc file, nor for a file given
1789 with the |-u| argument). Also see |compatible-default| and
1790 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 You can also set this option with the "-C" argument, and reset it with
1792 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001793 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 When this option is set, numerous other options are set to make Vim as
1796 Vi-compatible as possible. When this option is unset, various options
1797 are set to make Vim more useful. The table below lists all the
1798 options affected.
1799 The {?} column indicates when the options are affected:
1800 + Means that the option is set to the value given in {set value} when
1801 'compatible' is set.
1802 & Means that the option is set to the value given in {set value} when
1803 'compatible' is set AND is set to its Vim default value when
1804 'compatible' is unset.
1805 - Means the option is NOT changed when setting 'compatible' but IS
1806 set to its Vim default when 'compatible' is unset.
1807 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808
Bram Moolenaar036986f2017-03-16 17:41:02 +01001809 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001810
1811 'allowrevins' + off no CTRL-_ command
1812 'antialias' + off don't use antialiased fonts
1813 'arabic' + off reset arabic-related options
1814 'arabicshape' + on correct character shapes
1815 'backspace' + "" normal backspace
1816 'backup' + off no backup file
1817 'backupcopy' & Unix: "yes" backup file is a copy
1818 else: "auto" copy or rename backup file
1819 'balloonexpr' + "" text to show in evaluation balloon
1820 'breakindent' + off don't indent when wrapping lines
1821 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1822 'cindent' + off no C code indentation
1823 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1824 'copyindent' + off don't copy indent structure
1825 'cpoptions' & (all flags) Vi-compatible flags
1826 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001827 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001828 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001829 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001830 'cscopeverbose' + off see |cscopeverbose|
1831 'delcombine' + off unicode: delete whole char combination
1832 'digraph' + off no digraphs
1833 'esckeys' & off no <Esc>-keys in Insert mode
1834 'expandtab' + off tabs not expanded to spaces
1835 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 'formatexpr' + "" use 'formatprg' for auto-formatting
1838 'formatoptions' & "vt" Vi compatible formatting
1839 'gdefault' + off no default 'g' flag for ":s"
1840 'history' & 0 no commandline history
1841 'hkmap' + off no Hebrew keyboard mapping
1842 'hkmapp' + off no phonetic Hebrew keyboard mapping
1843 'hlsearch' + off no highlighting of search matches
1844 'incsearch' + off no incremental searching
1845 'indentexpr' + "" no indenting by expression
1846 'insertmode' + off do not start in Insert mode
1847 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001849 'joinspaces' + on insert 2 spaces after period
1850 'modeline' & off no modelines
1851 'more' & off no pauses in listings
1852 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1853 'numberwidth' & 8 min number of columns for line number
1854 'preserveindent'+ off don't preserve current indent structure
1855 when changing it
1856 'revins' + off no reverse insert
1857 'ruler' + off no ruler
1858 'scrolljump' + 1 no jump scroll
1859 'scrolloff' + 0 no scroll offset
1860 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1861 'shiftround' + off indent not rounded to shiftwidth
1862 'shortmess' & "" no shortening of messages
1863 'showcmd' & off command characters not shown
1864 'showmode' & off current mode not shown
1865 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1866 'smartcase' + off no automatic ignore case switch
1867 'smartindent' + off no smart indentation
1868 'smarttab' + off no smart tab size
1869 'softtabstop' + 0 tabs are always 'tabstop' positions
1870 'startofline' + on goto startofline with some commands
1871 'tagcase' & "followic" 'ignorecase' when searching tags file
1872 'tagrelative' & off tag file names are not relative
1873 'termguicolors' + off don't use highlight-(guifg|guibg)
1874 'textauto' & off no automatic textmode detection
1875 'textwidth' + 0 no automatic line wrap
1876 'tildeop' + off tilde is not an operator
1877 'ttimeout' + off no terminal timeout
1878 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001879 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001880 'virtualedit' + "" cursor can only be placed on characters
1881 'whichwrap' & "" left-right movements don't wrap
1882 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001884 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
1886 *'complete'* *'cpt'* *E535*
1887'complete' 'cpt' string (default: ".,w,b,u,t,i")
1888 local to buffer
1889 {not in Vi}
1890 This option specifies how keyword completion |ins-completion| works
1891 when CTRL-P or CTRL-N are used. It is also used for whole-line
1892 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1893 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001894 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 w scan buffers from other windows
1896 b scan other loaded buffers that are in the buffer list
1897 u scan the unloaded buffers that are in the buffer list
1898 U scan the buffers that are not in the buffer list
1899 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001900 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 k{dict} scan the file {dict}. Several "k" flags can be given,
1902 patterns are valid too. For example: >
1903 :set cpt=k/usr/dict/*,k~/spanish
1904< s scan the files given with the 'thesaurus' option
1905 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1906 are valid too.
1907 i scan current and included files
1908 d scan current and included files for defined name or macro
1909 |i_CTRL-X_CTRL-D|
1910 ] tag completion
1911 t same as "]"
1912
1913 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1914 not executed, this may lead to unexpected completions from some files
1915 (gzipped files for example). Unloaded buffers are not scanned for
1916 whole-line completion.
1917
1918 The default is ".,w,b,u,t,i", which means to scan:
1919 1. the current buffer
1920 2. buffers in other windows
1921 3. other loaded buffers
1922 4. unloaded buffers
1923 5. tags
1924 6. included files
1925
1926 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001927 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1928 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001930 *'completefunc'* *'cfu'*
1931'completefunc' 'cfu' string (default: empty)
1932 local to buffer
1933 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001934 {not available when compiled without the |+eval|
1935 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001936 This option specifies a function to be used for Insert mode completion
1937 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001938 See |complete-functions| for an explanation of how the function is
1939 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001940 This option cannot be set from a |modeline| or in the |sandbox|, for
1941 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001942
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001943 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001944'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001945 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001946 {not available when compiled without the
1947 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001948 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001949 A comma separated list of options for Insert mode completion
1950 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001951
1952 menu Use a popup menu to show the possible completions. The
1953 menu is only shown when there is more than one match and
1954 sufficient colors are available. |ins-completion-menu|
1955
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001956 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001957 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001958 match, e.g., what file it comes from.
1959
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001960 longest Only insert the longest common text of the matches. If
1961 the menu is displayed you can use CTRL-L to add more
1962 characters. Whether case is ignored depends on the kind
1963 of completion. For buffer text the 'ignorecase' option is
1964 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001965
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001966 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001967 completion in the preview window. Only works in
1968 combination with "menu" or "menuone".
1969
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001970 noinsert Do not insert any text for a match until the user selects
1971 a match from the menu. Only works in combination with
1972 "menu" or "menuone". No effect if "longest" is present.
1973
1974 noselect Do not select a match in the menu, force the user to
1975 select one from the menu. Only works in combination with
1976 "menu" or "menuone".
1977
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001978
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979 *'concealcursor'* *'cocu'*
1980'concealcursor' 'cocu' string (default: "")
1981 local to window
1982 {not in Vi}
1983 {not available when compiled without the |+conceal|
1984 feature}
1985 Sets the modes in which text in the cursor line can also be concealed.
1986 When the current mode is listed then concealing happens just like in
1987 other lines.
1988 n Normal mode
1989 v Visual mode
1990 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001991 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001992
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001993 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001994 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001995 are moving around text is concealed, but when starting to insert text
1996 or selecting a Visual area the concealed text is displayed, so that
1997 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001998 Keep in mind that the cursor position is not always where it's
1999 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002000
2001
2002'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02002003 number (default 0)
2004 local to window
2005 {not in Vi}
2006 {not available when compiled without the |+conceal|
2007 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002008 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2009 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002011 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002012 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002013 1 Each block of concealed text is replaced with one
2014 character. If the syntax item does not have a custom
2015 replacement character defined (see |:syn-cchar|) the
2016 character defined in 'listchars' is used (default is a
2017 space).
2018 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002019 2 Concealed text is completely hidden unless it has a
2020 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002021 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002022 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002023
Bram Moolenaara7781e02010-07-19 20:13:22 +02002024 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002025 edit and copy the text. This can be changed with the 'concealcursor'
2026 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002027
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2029'confirm' 'cf' boolean (default off)
2030 global
2031 {not in Vi}
2032 When 'confirm' is on, certain operations that would normally
2033 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2034 instead raise a |dialog| asking if you wish to save the current
2035 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2036 If 'confirm' is off you can still activate confirmation for one
2037 command only (this is most useful in mappings) with the |:confirm|
2038 command.
2039 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2040
2041 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2042'conskey' 'consk' boolean (default off)
2043 global
2044 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002045 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046
2047 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2048'copyindent' 'ci' boolean (default off)
2049 local to buffer
2050 {not in Vi}
2051 Copy the structure of the existing lines indent when autoindenting a
2052 new line. Normally the new indent is reconstructed by a series of
2053 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2054 in which case only spaces are used). Enabling this option makes the
2055 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002056 existing line. 'expandtab' has no effect on these characters, a Tab
2057 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002059 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 Also see 'preserveindent'.
2061
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002062 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063'cpoptions' 'cpo' string (Vim default: "aABceFs",
2064 Vi default: all flags)
2065 global
2066 {not in Vi}
2067 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002068 this indicates Vi-compatible behavior. This is used for things where
2069 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 'cpoptions' stands for "compatible-options".
2071 Commas can be added for readability.
2072 To avoid problems with flags that are added in the future, use the
2073 "+=" and "-=" feature of ":set" |add-option-flags|.
2074 NOTE: This option is set to the Vi default value when 'compatible' is
2075 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002076 NOTE: This option is set to the POSIX default value at startup when
2077 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002078 variable exists |posix|. This means Vim tries to behave like the
2079 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080
2081 contains behavior ~
2082 *cpo-a*
2083 a When included, a ":read" command with a file name
2084 argument will set the alternate file name for the
2085 current window.
2086 *cpo-A*
2087 A When included, a ":write" command with a file name
2088 argument will set the alternate file name for the
2089 current window.
2090 *cpo-b*
2091 b "\|" in a ":map" command is recognized as the end of
2092 the map command. The '\' is included in the mapping,
2093 the text after the '|' is interpreted as the next
2094 command. Use a CTRL-V instead of a backslash to
2095 include the '|' in the mapping. Applies to all
2096 mapping, abbreviation, menu and autocmd commands.
2097 See also |map_bar|.
2098 *cpo-B*
2099 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002100 abbreviations, user commands and the "to" part of the
2101 menu commands. Remove this flag to be able to use a
2102 backslash like a CTRL-V. For example, the command
2103 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 'B' included: "\^[" (^[ is a real <Esc>)
2105 'B' excluded: "<Esc>" (5 characters)
2106 ('<' excluded in both cases)
2107 *cpo-c*
2108 c Searching continues at the end of any match at the
2109 cursor position, but not further than the start of the
2110 next line. When not present searching continues
2111 one character from the cursor position. With 'c'
2112 "abababababab" only gets three matches when repeating
2113 "/abab", without 'c' there are five matches.
2114 *cpo-C*
2115 C Do not concatenate sourced lines that start with a
2116 backslash. See |line-continuation|.
2117 *cpo-d*
2118 d Using "./" in the 'tags' option doesn't mean to use
2119 the tags file relative to the current file, but the
2120 tags file in the current directory.
2121 *cpo-D*
2122 D Can't use CTRL-K to enter a digraph after Normal mode
2123 commands with a character argument, like |r|, |f| and
2124 |t|.
2125 *cpo-e*
2126 e When executing a register with ":@r", always add a
2127 <CR> to the last line, also when the register is not
2128 linewise. If this flag is not present, the register
2129 is not linewise and the last line does not end in a
2130 <CR>, then the last line is put on the command-line
2131 and can be edited before hitting <CR>.
2132 *cpo-E*
2133 E It is an error when using "y", "d", "c", "g~", "gu" or
2134 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002135 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 This makes "y0" fail in the first column.
2137 *cpo-f*
2138 f When included, a ":read" command with a file name
2139 argument will set the file name for the current buffer,
2140 if the current buffer doesn't have a file name yet.
2141 *cpo-F*
2142 F When included, a ":write" command with a file name
2143 argument will set the file name for the current
2144 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002145 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-g*
2147 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002148 *cpo-H*
2149 H When using "I" on a line with only blanks, insert
2150 before the last blank. Without this flag insert after
2151 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 *cpo-i*
2153 i When included, interrupting the reading of a file will
2154 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 *cpo-I*
2156 I When moving the cursor up or down just after inserting
2157 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 *cpo-j*
2159 j When joining lines, only add two spaces after a '.',
2160 not after '!' or '?'. Also see 'joinspaces'.
2161 *cpo-J*
2162 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002163 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 white space.
2165 *cpo-k*
2166 k Disable the recognition of raw key codes in
2167 mappings, abbreviations, and the "to" part of menu
2168 commands. For example, if <Key> sends ^[OA (where ^[
2169 is <Esc>), the command ":map X ^[OA" results in X
2170 being mapped to:
2171 'k' included: "^[OA" (3 characters)
2172 'k' excluded: "<Key>" (one key code)
2173 Also see the '<' flag below.
2174 *cpo-K*
2175 K Don't wait for a key code to complete when it is
2176 halfway a mapping. This breaks mapping <F1><F1> when
2177 only part of the second <F1> has been read. It
2178 enables cancelling the mapping by typing <F1><Esc>.
2179 *cpo-l*
2180 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002181 literally, only "\]", "\^", "\-" and "\\" are special.
2182 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2184 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002185 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 *cpo-L*
2187 L When the 'list' option is set, 'wrapmargin',
2188 'textwidth', 'softtabstop' and Virtual Replace mode
2189 (see |gR|) count a <Tab> as two characters, instead of
2190 the normal behavior of a <Tab>.
2191 *cpo-m*
2192 m When included, a showmatch will always wait half a
2193 second. When not included, a showmatch will wait half
2194 a second or until a character is typed. |'showmatch'|
2195 *cpo-M*
2196 M When excluded, "%" matching will take backslashes into
2197 account. Thus in "( \( )" and "\( ( \)" the outer
2198 parenthesis match. When included "%" ignores
2199 backslashes, which is Vi compatible.
2200 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002201 n When included, the column used for 'number' and
2202 'relativenumber' will also be used for text of wrapped
2203 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 *cpo-o*
2205 o Line offset to search command is not remembered for
2206 next search.
2207 *cpo-O*
2208 O Don't complain if a file is being overwritten, even
2209 when it didn't exist when editing it. This is a
2210 protection against a file unexpectedly created by
2211 someone else. Vi didn't complain about this.
2212 *cpo-p*
2213 p Vi compatible Lisp indenting. When not present, a
2214 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002215 *cpo-P*
2216 P When included, a ":write" command that appends to a
2217 file will set the file name for the current buffer, if
2218 the current buffer doesn't have a file name yet and
2219 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002220 *cpo-q*
2221 q When joining multiple lines leave the cursor at the
2222 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 *cpo-r*
2224 r Redo ("." command) uses "/" to repeat a search
2225 command, instead of the actually used search string.
2226 *cpo-R*
2227 R Remove marks from filtered lines. Without this flag
2228 marks are kept like |:keepmarks| was used.
2229 *cpo-s*
2230 s Set buffer options when entering the buffer for the
2231 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002232 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 set when the buffer is created.
2234 *cpo-S*
2235 S Set buffer options always when entering a buffer
2236 (except 'readonly', 'fileformat', 'filetype' and
2237 'syntax'). This is the (most) Vi compatible setting.
2238 The options are set to the values in the current
2239 buffer. When you change an option and go to another
2240 buffer, the value is copied. Effectively makes the
2241 buffer options global to all buffers.
2242
2243 's' 'S' copy buffer options
2244 no no when buffer created
2245 yes no when buffer first entered (default)
2246 X yes each time when buffer entered (vi comp.)
2247 *cpo-t*
2248 t Search pattern for the tag command is remembered for
2249 "n" command. Otherwise Vim only puts the pattern in
2250 the history for search pattern, but doesn't change the
2251 last used search pattern.
2252 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002253 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *cpo-v*
2255 v Backspaced characters remain visible on the screen in
2256 Insert mode. Without this flag the characters are
2257 erased from the screen right away. With this flag the
2258 screen newly typed text overwrites backspaced
2259 characters.
2260 *cpo-w*
2261 w When using "cw" on a blank character, only change one
2262 character and not all blanks until the start of the
2263 next word.
2264 *cpo-W*
2265 W Don't overwrite a readonly file. When omitted, ":w!"
2266 overwrites a readonly file, if possible.
2267 *cpo-x*
2268 x <Esc> on the command-line executes the command-line.
2269 The default in Vim is to abandon the command-line,
2270 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002271 *cpo-X*
2272 X When using a count with "R" the replaced text is
2273 deleted only once. Also when repeating "R" with "."
2274 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 *cpo-y*
2276 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002277 *cpo-Z*
2278 Z When using "w!" while the 'readonly' option is set,
2279 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 *cpo-!*
2281 ! When redoing a filter command, use the last used
2282 external command, whatever it was. Otherwise the last
2283 used -filter- command is used.
2284 *cpo-$*
2285 $ When making a change to one line, don't redisplay the
2286 line, but put a '$' at the end of the changed text.
2287 The changed text will be overwritten when you type the
2288 new text. The line is redisplayed if you type any
2289 command that moves the cursor from the insertion
2290 point.
2291 *cpo-%*
2292 % Vi-compatible matching is done for the "%" command.
2293 Does not recognize "#if", "#endif", etc.
2294 Does not recognize "/*" and "*/".
2295 Parens inside single and double quotes are also
2296 counted, causing a string that contains a paren to
2297 disturb the matching. For example, in a line like
2298 "if (strcmp("foo(", s))" the first paren does not
2299 match the last one. When this flag is not included,
2300 parens inside single and double quotes are treated
2301 specially. When matching a paren outside of quotes,
2302 everything inside quotes is ignored. When matching a
2303 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002304 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002305 This flag is also used for other features, such as
2306 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002307 *cpo--*
2308 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002309 it would go above the first line or below the last
2310 line. Without it the cursor moves to the first or
2311 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002312 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002313 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002314 *cpo-+*
2315 + When included, a ":write file" command will reset the
2316 'modified' flag of the buffer, even though the buffer
2317 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002318 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 * Use ":*" in the same way as ":@". When not included,
2320 ":*" is an alias for ":'<,'>", select the Visual area.
2321 *cpo-<*
2322 < Disable the recognition of special key codes in |<>|
2323 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 ":map X <Tab>" results in X being mapped to:
2326 '<' included: "<Tab>" (5 characters)
2327 '<' excluded: "^I" (^I is a real <Tab>)
2328 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002329 *cpo->*
2330 > When appending to a register, put a line break before
2331 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002332 *cpo-;*
2333 ; When using |,| or |;| to repeat the last |t| search
2334 and the cursor is right in front of the searched
2335 character, the cursor won't move. When not included,
2336 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002337 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002338
2339 POSIX flags. These are not included in the Vi default value, except
2340 when $VIM_POSIX was set on startup. |posix|
2341
2342 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002343 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002344 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345 *cpo-&*
2346 & When ":preserve" was used keep the swap file when
2347 exiting normally while this buffer is still loaded.
2348 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002349 *cpo-\*
2350 \ Backslash in a [] range in a search pattern is taken
2351 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002352 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2353 '\' excluded: "/[ \-]" finds <Space> and '-'
2354 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002355 *cpo-/*
2356 / When "%" is used as the replacement string in a |:s|
2357 command, use the previous replacement string. |:s%|
2358 *cpo-{*
2359 { The |{| and |}| commands also stop at a "{" character
2360 at the start of a line.
2361 *cpo-.*
2362 . The ":chdir" and ":cd" commands fail if the current
2363 buffer is modified, unless ! is used. Vim doesn't
2364 need this, since it remembers the full path of an
2365 opened file.
2366 *cpo-bar*
2367 | The value of the $LINES and $COLUMNS environment
2368 variables overrule the terminal size values obtained
2369 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002372 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002373'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002374 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002375 {not in Vi}
2376 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002377 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002378 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002379 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002380 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002381 blowfish Blowfish method. Medium strong encryption but it has
2382 an implementation flaw. Requires Vim 7.3 or later,
2383 files can NOT be read by Vim 7.2 and older. This adds
2384 a "seed" to the file, every time you write the file
2385 the encrypted bytes will be different.
2386 *blowfish2*
2387 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002388 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002389 and older. This adds a "seed" to the file, every time
2390 you write the file the encrypted bytes will be
2391 different. The whole undo file is encrypted, not just
2392 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002393
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002394 You should use "blowfish2", also to re-encrypt older files.
2395
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002396 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002397 to the detected method of the file being read. Thus if you write it
2398 without changing 'cryptmethod' the same method will be used.
2399 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002400 explicitly write it, you don't get a warning unless there are other
2401 modifications. Also see |:X|.
2402
2403 When setting the global value to an empty string, it will end up with
2404 the value "zip". When setting the local value to an empty string the
2405 buffer will use the global value.
2406
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002407 When a new encryption method is added in a later version of Vim, and
2408 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002409 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002410
2411
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 *'cscopepathcomp'* *'cspc'*
2413'cscopepathcomp' 'cspc' number (default 0)
2414 global
2415 {not available when compiled without the |+cscope|
2416 feature}
2417 {not in Vi}
2418 Determines how many components of the path to show in a list of tags.
2419 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002420 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421
2422 *'cscopeprg'* *'csprg'*
2423'cscopeprg' 'csprg' string (default "cscope")
2424 global
2425 {not available when compiled without the |+cscope|
2426 feature}
2427 {not in Vi}
2428 Specifies the command to execute cscope. See |cscopeprg|.
2429 This option cannot be set from a |modeline| or in the |sandbox|, for
2430 security reasons.
2431
2432 *'cscopequickfix'* *'csqf'*
2433'cscopequickfix' 'csqf' string (default "")
2434 global
2435 {not available when compiled without the |+cscope|
2436 or |+quickfix| features}
2437 {not in Vi}
2438 Specifies whether to use quickfix window to show cscope results.
2439 See |cscopequickfix|.
2440
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002441 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002442'cscoperelative' 'csre' boolean (default off)
2443 global
2444 {not available when compiled without the |+cscope|
2445 feature}
2446 {not in Vi}
2447 In the absence of a prefix (-P) for cscope. setting this option enables
2448 to use the basename of cscope.out path as the prefix.
2449 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002450 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002451
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2453'cscopetag' 'cst' boolean (default off)
2454 global
2455 {not available when compiled without the |+cscope|
2456 feature}
2457 {not in Vi}
2458 Use cscope for tag commands. See |cscope-options|.
2459 NOTE: This option is reset when 'compatible' is set.
2460
2461 *'cscopetagorder'* *'csto'*
2462'cscopetagorder' 'csto' number (default 0)
2463 global
2464 {not available when compiled without the |+cscope|
2465 feature}
2466 {not in Vi}
2467 Determines the order in which ":cstag" performs a search. See
2468 |cscopetagorder|.
2469 NOTE: This option is set to 0 when 'compatible' is set.
2470
2471 *'cscopeverbose'* *'csverb'*
2472 *'nocscopeverbose'* *'nocsverb'*
2473'cscopeverbose' 'csverb' boolean (default off)
2474 global
2475 {not available when compiled without the |+cscope|
2476 feature}
2477 {not in Vi}
2478 Give messages when adding a cscope database. See |cscopeverbose|.
2479 NOTE: This option is reset when 'compatible' is set.
2480
Bram Moolenaar860cae12010-06-05 23:22:07 +02002481 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2482'cursorbind' 'crb' boolean (default off)
2483 local to window
2484 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002485 When this option is set, as the cursor in the current
2486 window moves other cursorbound windows (windows that also have
2487 this option set) move their cursors to the corresponding line and
2488 column. This option is useful for viewing the
2489 differences between two versions of a file (see 'diff'); in diff mode,
2490 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002491 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002492
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002493
2494 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2495'cursorcolumn' 'cuc' boolean (default off)
2496 local to window
2497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002498 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002499 feature}
2500 Highlight the screen column of the cursor with CursorColumn
2501 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2502 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002503 If you only want the highlighting in the current window you can use
2504 these autocommands: >
2505 au WinLeave * set nocursorline nocursorcolumn
2506 au WinEnter * set cursorline cursorcolumn
2507<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002508
2509 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2510'cursorline' 'cul' boolean (default off)
2511 local to window
2512 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002513 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002514 feature}
2515 Highlight the screen line of the cursor with CursorLine
2516 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2517 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002518 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002519 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002520
2521
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 *'debug'*
2523'debug' string (default "")
2524 global
2525 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002526 These values can be used:
2527 msg Error messages that would otherwise be omitted will be given
2528 anyway.
2529 throw Error messages that would otherwise be omitted will be given
2530 anyway and also throw an exception and set |v:errmsg|.
2531 beep A message will be given when otherwise only a beep would be
2532 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002533 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002534 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2535 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536
2537 *'define'* *'def'*
2538'define' 'def' string (default "^\s*#\s*define")
2539 global or local to buffer |global-local|
2540 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002541 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 pattern, just like for the "/" command. This option is used for the
2543 commands like "[i" and "[d" |include-search|. The 'isident' option is
2544 used to recognize the defined name after the match:
2545 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2546 See |option-backslash| about inserting backslashes to include a space
2547 or backslash.
2548 The default value is for C programs. For C++ this value would be
2549 useful, to include const type declarations: >
2550 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2551< When using the ":set" command, you need to double the backslashes!
2552
2553 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2554'delcombine' 'deco' boolean (default off)
2555 global
2556 {not in Vi}
2557 {only available when compiled with the |+multi_byte|
2558 feature}
2559 If editing Unicode and this option is set, backspace and Normal mode
2560 "x" delete each combining character on its own. When it is off (the
2561 default) the character along with its combining characters are
2562 deleted.
2563 Note: When 'delcombine' is set "xx" may work different from "2x"!
2564
2565 This is useful for Arabic, Hebrew and many other languages where one
2566 may have combining characters overtop of base characters, and want
2567 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002568 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'dictionary'* *'dict'*
2571'dictionary' 'dict' string (default "")
2572 global or local to buffer |global-local|
2573 {not in Vi}
2574 List of file names, separated by commas, that are used to lookup words
2575 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2576 contain a list of words. This can be one word per line, or several
2577 words per line, separated by non-keyword characters (white space is
2578 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002579
2580 When this option is empty or an entry "spell" is present, and spell
2581 checking is enabled, words in the word lists for the currently active
2582 'spelllang' are used. See |spell|.
2583
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002584 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 after a comma are ignored, otherwise spaces are included in the file
2586 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002587 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 Where to find a list of words?
2589 - On FreeBSD, there is the file "/usr/share/dict/words".
2590 - In the Simtel archive, look in the "msdos/linguist" directory.
2591 - In "miscfiles" of the GNU collection.
2592 The use of |:set+=| and |:set-=| is preferred when adding or removing
2593 directories from the list. This avoids problems when a future version
2594 uses another default.
2595 Backticks cannot be used in this option for security reasons.
2596
2597 *'diff'* *'nodiff'*
2598'diff' boolean (default off)
2599 local to window
2600 {not in Vi}
2601 {not available when compiled without the |+diff|
2602 feature}
2603 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605
2606 *'dex'* *'diffexpr'*
2607'diffexpr' 'dex' string (default "")
2608 global
2609 {not in Vi}
2610 {not available when compiled without the |+diff|
2611 feature}
2612 Expression which is evaluated to obtain an ed-style diff file from two
2613 versions of a file. See |diff-diffexpr|.
2614 This option cannot be set from a |modeline| or in the |sandbox|, for
2615 security reasons.
2616
2617 *'dip'* *'diffopt'*
2618'diffopt' 'dip' string (default "filler")
2619 global
2620 {not in Vi}
2621 {not available when compiled without the |+diff|
2622 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002623 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 All are optional. Items must be separated by a comma.
2625
2626 filler Show filler lines, to keep the text
2627 synchronized with a window that has inserted
2628 lines at the same position. Mostly useful
2629 when windows are side-by-side and 'scrollbind'
2630 is set.
2631
2632 context:{n} Use a context of {n} lines between a change
2633 and a fold that contains unchanged lines.
2634 When omitted a context of six lines is used.
2635 See |fold-diff|.
2636
2637 icase Ignore changes in case of text. "a" and "A"
2638 are considered the same. Adds the "-i" flag
2639 to the "diff" command if 'diffexpr' is empty.
2640
2641 iwhite Ignore changes in amount of white space. Adds
2642 the "-b" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly. It should ignore adding trailing
2646 white space, but not leading white space.
2647
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002648 horizontal Start diff mode with horizontal splits (unless
2649 explicitly specified otherwise).
2650
2651 vertical Start diff mode with vertical splits (unless
2652 explicitly specified otherwise).
2653
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002654 hiddenoff Do not use diff mode for a buffer when it
2655 becomes hidden.
2656
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002657 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2658 starting diff mode. Without this 2 is used.
2659
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 Examples: >
2661
2662 :set diffopt=filler,context:4
2663 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002664 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665<
2666 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2667'digraph' 'dg' boolean (default off)
2668 global
2669 {not in Vi}
2670 {not available when compiled without the |+digraphs|
2671 feature}
2672 Enable the entering of digraphs in Insert mode with {char1} <BS>
2673 {char2}. See |digraphs|.
2674 NOTE: This option is reset when 'compatible' is set.
2675
2676 *'directory'* *'dir'*
2677'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002678 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 for Unix: ".,~/tmp,/var/tmp,/tmp")
2680 global
2681 List of directory names for the swap file, separated with commas.
2682 - The swap file will be created in the first directory where this is
2683 possible.
2684 - Empty means that no swap file will be used (recovery is
2685 impossible!).
2686 - A directory "." means to put the swap file in the same directory as
2687 the edited file. On Unix, a dot is prepended to the file name, so
2688 it doesn't show in a directory listing. On MS-Windows the "hidden"
2689 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002690 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 put the swap file relative to where the edited file is. The leading
2692 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002693 - For Unix and Win32, if a directory ends in two path separators "//",
2694 the swap file name will be built from the complete path to the file
2695 with all path separators substituted to percent '%' signs. This will
2696 ensure file name uniqueness in the preserve directory.
2697 On Win32, it is also possible to end with "\\". However, When a
2698 separating comma is following, you must use "//", since "\\" will
2699 include the comma in the file name. Therefore it is recommended to
2700 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 - Spaces after the comma are ignored, other spaces are considered part
2702 of the directory name. To have a space at the start of a directory
2703 name, precede it with a backslash.
2704 - To include a comma in a directory name precede it with a backslash.
2705 - A directory name may end in an ':' or '/'.
2706 - Environment variables are expanded |:set_env|.
2707 - Careful with '\' characters, type one before a space, type two to
2708 get one in the option (see |option-backslash|), for example: >
2709 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2710< - For backwards compatibility with Vim version 3.0 a '>' at the start
2711 of the option is removed.
2712 Using "." first in the list is recommended. This means that editing
2713 the same file twice will result in a warning. Using "/tmp" on Unix is
2714 discouraged: When the system crashes you lose the swap file.
2715 "/var/tmp" is often not cleared when rebooting, thus is a better
2716 choice than "/tmp". But it can contain a lot of files, your swap
2717 files get lost in the crowd. That is why a "tmp" directory in your
2718 home directory is tried first.
2719 The use of |:set+=| and |:set-=| is preferred when adding or removing
2720 directories from the list. This avoids problems when a future version
2721 uses another default.
2722 This option cannot be set from a |modeline| or in the |sandbox|, for
2723 security reasons.
2724 {Vi: directory to put temp file in, defaults to "/tmp"}
2725
2726 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002727'display' 'dy' string (default "", set to "truncate" in
2728 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729 global
2730 {not in Vi}
2731 Change the way text is displayed. This is comma separated list of
2732 flags:
2733 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002734 in a window will be displayed. "@@@" is put in the
2735 last columns of the last screen line to indicate the
2736 rest of the line is not displayed.
2737 truncate Like "lastline", but "@@@" is displayed in the first
2738 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 uhex Show unprintable characters hexadecimal as <xx>
2740 instead of using ^C and ~C.
2741
Bram Moolenaard0796902016-09-16 20:02:31 +02002742 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002743 doesn't fit is replaced with "@" lines.
2744
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 *'eadirection'* *'ead'*
2746'eadirection' 'ead' string (default "both")
2747 global
2748 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002749 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 feature}
2751 Tells when the 'equalalways' option applies:
2752 ver vertically, width of windows is not affected
2753 hor horizontally, height of windows is not affected
2754 both width and height of windows is affected
2755
2756 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2757'edcompatible' 'ed' boolean (default off)
2758 global
2759 Makes the 'g' and 'c' flags of the ":substitute" command to be
2760 toggled each time the flag is given. See |complex-change|. See
2761 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002762 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763
Bram Moolenaar03413f42016-04-12 21:07:15 +02002764 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002765'emoji' 'emo' boolean (default: on)
2766 global
2767 {not in Vi}
2768 {only available when compiled with the |+multi_byte|
2769 feature}
2770 When on all Unicode emoji characters are considered to be full width.
2771
2772
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 *'encoding'* *'enc'* *E543*
2774'encoding' 'enc' string (default: "latin1" or value from $LANG)
2775 global
2776 {only available when compiled with the |+multi_byte|
2777 feature}
2778 {not in Vi}
2779 Sets the character encoding used inside Vim. It applies to text in
2780 the buffers, registers, Strings in expressions, text stored in the
2781 viminfo file, etc. It sets the kind of characters which Vim can work
2782 with. See |encoding-names| for the possible values.
2783
2784 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002785 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002787 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
Bram Moolenaar865242e2010-07-14 21:12:05 +02002789 This option cannot be set from a |modeline|. It would most likely
2790 corrupt the text.
2791
Bram Moolenaar3df01732017-02-17 22:47:16 +01002792 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2793 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 'encoding', "utf-8" is the natural choice for the environment and
2795 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002796 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 versions, and to avoid changing the encoding of newly created files
2798 without your knowledge (in case 'fileencodings' is empty).
2799
2800 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 iconv() or as specified with 'charconvert'.
2803
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002804 If you need to know whether 'encoding' is a multi-byte encoding, you
2805 can use: >
2806 if has("multi_byte_encoding")
2807<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 Normally 'encoding' will be equal to your current locale. This will
2809 be the default if Vim recognizes your environment settings. If
2810 'encoding' is not set to the current locale, 'termencoding' must be
2811 set to convert typed and displayed text. See |encoding-table|.
2812
2813 When you set this option, it fires the |EncodingChanged| autocommand
2814 event so that you can set up fonts if necessary.
2815
2816 When the option is set, the value is converted to lowercase. Thus
2817 you can set it with uppercase values too. Underscores are translated
2818 to '-' signs.
2819 When the encoding is recognized, it is changed to the standard name.
2820 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2821 "iso-8859-2" and "utf8" becomes "utf-8".
2822
2823 Note: "latin1" is also used when the encoding could not be detected.
2824 This only works when editing files in the same encoding! When the
2825 actual character set is not latin1, make sure 'fileencoding' and
2826 'fileencodings' are empty. When conversion is needed, switch to using
2827 utf-8.
2828
2829 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2830 You don't notice this while editing, but it does matter for the
2831 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2832 setting 'encoding' to one of these values instead of utf-8 only has
2833 effect for encoding used for files when 'fileencoding' is empty.
2834
Bram Moolenaar661b1822005-07-28 22:36:45 +00002835 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2836 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837
2838 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2839'endofline' 'eol' boolean (default on)
2840 local to buffer
2841 {not in Vi}
2842 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002843 is on, or 'fixeol' option is off, no <EOL> will be written for the
2844 last line in the file. This option is automatically set or reset when
2845 starting to edit a new file, depending on whether file has an <EOL>
2846 for the last line in the file. Normally you don't have to set or
2847 reset this option.
2848 When 'binary' is off and 'fixeol' is on the value is not used when
2849 writing the file. When 'binary' is on or 'fixeol' is off it is used
2850 to remember the presence of a <EOL> for the last line in the file, so
2851 that when you write the file the situation from the original file can
2852 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2855'equalalways' 'ea' boolean (default on)
2856 global
2857 {not in Vi}
2858 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002859 splitting or closing a window. This also happens the moment the
2860 option is switched on. When off, splitting a window will reduce the
2861 size of the current window and leave the other windows the same. When
2862 closing a window the extra lines are given to the window next to it
2863 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 When mixing vertically and horizontally split windows, a minimal size
2865 is computed and some windows may be larger if there is room. The
2866 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002867 Changing the height and width of a window can be avoided by setting
2868 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002869 If a window size is specified when creating a new window sizes are
2870 currently not equalized (it's complicated, but may be implemented in
2871 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872
2873 *'equalprg'* *'ep'*
2874'equalprg' 'ep' string (default "")
2875 global or local to buffer |global-local|
2876 {not in Vi}
2877 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002878 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002879 or 'indentexpr'. When Vim was compiled without internal formatting,
2880 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 about including spaces and backslashes.
2883 This option cannot be set from a |modeline| or in the |sandbox|, for
2884 security reasons.
2885
2886 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2887'errorbells' 'eb' boolean (default off)
2888 global
2889 Ring the bell (beep or screen flash) for error messages. This only
2890 makes a difference for error messages, the bell will be used always
2891 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002893 screen flash or do nothing. See 'belloff' to finetune when to ring the
2894 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
2896 *'errorfile'* *'ef'*
2897'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2898 others: "errors.err")
2899 global
2900 {not in Vi}
2901 {not available when compiled without the |+quickfix|
2902 feature}
2903 Name of the errorfile for the QuickFix mode (see |:cf|).
2904 When the "-q" command-line argument is used, 'errorfile' is set to the
2905 following argument. See |-q|.
2906 NOT used for the ":make" command. See 'makeef' for that.
2907 Environment variables are expanded |:set_env|.
2908 See |option-backslash| about including spaces and backslashes.
2909 This option cannot be set from a |modeline| or in the |sandbox|, for
2910 security reasons.
2911
2912 *'errorformat'* *'efm'*
2913'errorformat' 'efm' string (default is very long)
2914 global or local to buffer |global-local|
2915 {not in Vi}
2916 {not available when compiled without the |+quickfix|
2917 feature}
2918 Scanf-like description of the format for the lines in the error file
2919 (see |errorformat|).
2920
2921 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2922'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2923 global
2924 {not in Vi}
2925 Function keys that start with an <Esc> are recognized in Insert
2926 mode. When this option is off, the cursor and function keys cannot be
2927 used in Insert mode if they start with an <Esc>. The advantage of
2928 this is that the single <Esc> is recognized immediately, instead of
2929 after one second. Instead of resetting this option, you might want to
2930 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2931 when 'esckeys' is off, you can still map anything, but the cursor keys
2932 won't work by default.
2933 NOTE: This option is set to the Vi default value when 'compatible' is
2934 set and to the Vim default value when 'compatible' is reset.
2935
2936 *'eventignore'* *'ei'*
2937'eventignore' 'ei' string (default "")
2938 global
2939 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002941 When set to "all" or when "all" is one of the items, all autocommand
2942 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 Otherwise this is a comma separated list of event names. Example: >
2944 :set ei=WinEnter,WinLeave
2945<
2946 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2947'expandtab' 'et' boolean (default off)
2948 local to buffer
2949 {not in Vi}
2950 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002951 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2953 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002954 This option is reset when the 'paste' option is set and restored when
2955 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 NOTE: This option is reset when 'compatible' is set.
2957
2958 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2959'exrc' 'ex' boolean (default off)
2960 global
2961 {not in Vi}
2962 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002963 directory.
2964
2965 Setting this option is a potential security leak. E.g., consider
2966 unpacking a package or fetching files from github, a .vimrc in there
2967 might be a trojan horse. BETTER NOT SET THIS OPTION!
2968 Instead, define an autocommand in your .vimrc to set options for a
2969 matching directory.
2970
2971 If you do switch this option on you should also consider setting the
2972 'secure' option (see |initialization|).
2973 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 This option cannot be set from a |modeline| or in the |sandbox|, for
2975 security reasons.
2976
2977 *'fileencoding'* *'fenc'* *E213*
2978'fileencoding' 'fenc' string (default: "")
2979 local to buffer
2980 {only available when compiled with the |+multi_byte|
2981 feature}
2982 {not in Vi}
2983 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002984
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002986 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 When 'fileencoding' is empty, the same value as 'encoding' will be
2988 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002989 No error will be given when the value is set, only when it is used,
2990 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002991 Conversion will also be done when 'encoding' and 'fileencoding' are
2992 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2993 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002995 'encoding' is "utf-8" or another Unicode encoding, conversion
2996 is most likely done in a way that the reverse conversion
2997 results in the same text. When 'encoding' is not "utf-8" some
2998 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002999
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 See 'encoding' for the possible values. Additionally, values may be
3001 specified that can be handled by the converter, see
3002 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003003
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 When reading a file 'fileencoding' will be set from 'fileencodings'.
3005 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003006 'fileencoding', use the |++enc| argument. One exception: when
3007 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003008 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003009
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3011 When the option is set, the value is converted to lowercase. Thus
3012 you can set it with uppercase values too. '_' characters are
3013 replaced with '-'. If a name is recognized from the list for
3014 'encoding', it is replaced by the standard name. For example
3015 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003016
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 When this option is set, after starting to edit a file, the 'modified'
3018 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003019
3020 Keep in mind that changing 'fenc' from a modeline happens
3021 AFTER the text has been read, thus it applies to when the file will be
3022 written. If you do set 'fenc' in a modeline, you might want to set
3023 'nomodified' to avoid not being able to ":q".
3024
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 This option can not be changed when 'modifiable' is off.
3026
3027 *'fe'*
3028 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003029 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 old short name was 'fe', which is no longer used.
3031
3032 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003033'fileencodings' 'fencs' string (default: "ucs-bom",
3034 "ucs-bom,utf-8,default,latin1" when
3035 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 global
3037 {only available when compiled with the |+multi_byte|
3038 feature}
3039 {not in Vi}
3040 This is a list of character encodings considered when starting to edit
3041 an existing file. When a file is read, Vim tries to use the first
3042 mentioned character encoding. If an error is detected, the next one
3043 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003044 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 an empty string, which means the value of 'encoding' is used.
3046 WARNING: Conversion can cause loss of information! When
3047 'encoding' is "utf-8" (or one of the other Unicode variants)
3048 conversion is most likely done in a way that the reverse
3049 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003050 "utf-8" some non-ASCII characters may be lost! You can use
3051 the |++bad| argument to specify what is done with characters
3052 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 For an empty file or a file with only ASCII characters most encodings
3054 will work and the first entry of 'fileencodings' will be used (except
3055 "ucs-bom", which requires the BOM to be present). If you prefer
3056 another encoding use an BufReadPost autocommand event to test if your
3057 preferred encoding is to be used. Example: >
3058 au BufReadPost * if search('\S', 'w') == 0 |
3059 \ set fenc=iso-2022-jp | endif
3060< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3061 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003062 When the |++enc| argument is used then the value of 'fileencodings' is
3063 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003064 Note that 'fileencodings' is not used for a new file, the global value
3065 of 'fileencoding' is used instead. You can set it with: >
3066 :setglobal fenc=iso-8859-2
3067< This means that a non-existing file may get a different encoding than
3068 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 The special value "ucs-bom" can be used to check for a Unicode BOM
3070 (Byte Order Mark) at the start of the file. It must not be preceded
3071 by "utf-8" or another Unicode encoding for this to work properly.
3072 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3073 because Vim cannot detect an error, thus the encoding is always
3074 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003075 The special value "default" can be used for the encoding from the
3076 environment. This is the default value for 'encoding'. It is useful
3077 when 'encoding' is set to "utf-8" and your environment uses a
3078 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003079 When 'encoding' is "utf-8" and a file contains an illegal byte
3080 sequence it won't be recognized as UTF-8. You can use the |8g8|
3081 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 WRONG VALUES: WHAT'S WRONG:
3083 latin1,utf-8 "latin1" will always be used
3084 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3085 file
3086 cp1250,latin1 "cp1250" will always be used
3087 If 'fileencodings' is empty, 'fileencoding' is not modified.
3088 See 'fileencoding' for the possible values.
3089 Setting this option does not have an effect until the next time a file
3090 is read.
3091
3092 *'fileformat'* *'ff'*
3093'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3094 Unix default: "unix",
3095 Macintosh default: "mac")
3096 local to buffer
3097 {not in Vi}
3098 This gives the <EOL> of the current buffer, which is used for
3099 reading/writing the buffer from/to a file:
3100 dos <CR> <NL>
3101 unix <NL>
3102 mac <CR>
3103 When "dos" is used, CTRL-Z at the end of a file is ignored.
3104 See |file-formats| and |file-read|.
3105 For the character encoding of the file see 'fileencoding'.
3106 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003107 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 This option is set automatically when starting to edit a file and
3109 'fileformats' is not empty and 'binary' is off.
3110 When this option is set, after starting to edit a file, the 'modified'
3111 option is set, because the file would be different when written.
3112 This option can not be changed when 'modifiable' is off.
3113 For backwards compatibility: When this option is set to "dos",
3114 'textmode' is set, otherwise 'textmode' is reset.
3115
3116 *'fileformats'* *'ffs'*
3117'fileformats' 'ffs' string (default:
3118 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3119 Vim Unix: "unix,dos",
3120 Vim Mac: "mac,unix,dos",
3121 Vi Cygwin: "unix,dos",
3122 Vi others: "")
3123 global
3124 {not in Vi}
3125 This gives the end-of-line (<EOL>) formats that will be tried when
3126 starting to edit a new buffer and when reading a file into an existing
3127 buffer:
3128 - When empty, the format defined with 'fileformat' will be used
3129 always. It is not set automatically.
3130 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003131 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 'fileformats' name will be used when a file is read into an existing
3133 buffer, no matter what 'fileformat' for that buffer is set to.
3134 - When more than one name is present, separated by commas, automatic
3135 <EOL> detection will be done when reading a file. When starting to
3136 edit a file, a check is done for the <EOL>:
3137 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3138 'fileformat' is set to "dos".
3139 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003140 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003142 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3143 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003144 This means that "mac" is only chosen when:
3145 "unix" is not present or no <NL> is found in the file, and
3146 "dos" is not present or no <CR><NL> is found in the file.
3147 Except: if "unix" was chosen, but there is a <CR> before
3148 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003149 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 4. If 'fileformat' is still not set, the first name from
3151 'fileformats' is used.
3152 When reading a file into an existing buffer, the same is done, but
3153 this happens like 'fileformat' has been set appropriately for that
3154 file only, the option is not changed.
3155 When 'binary' is set, the value of 'fileformats' is not used.
3156
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003157 When Vim starts up with an empty buffer the first item is used. You
3158 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003159
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3161 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3162 done:
3163 - When 'fileformats' is empty, there is no automatic detection. Dos
3164 format will be used.
3165 - When 'fileformats' is set to one or more names, automatic detection
3166 is done. This is based on the first <NL> in the file: If there is a
3167 <CR> in front of it, Dos format is used, otherwise Unix format is
3168 used.
3169 Also see |file-formats|.
3170 For backwards compatibility: When this option is set to an empty
3171 string or one format (no comma is included), 'textauto' is reset,
3172 otherwise 'textauto' is set.
3173 NOTE: This option is set to the Vi default value when 'compatible' is
3174 set and to the Vim default value when 'compatible' is reset.
3175
Bram Moolenaarbf884932013-04-05 22:26:15 +02003176 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3177'fileignorecase' 'fic' boolean (default on for systems where case in file
3178 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003179 global
3180 {not in Vi}
3181 When set case is ignored when using file names and directories.
3182 See 'wildignorecase' for only ignoring case when doing completion.
3183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 *'filetype'* *'ft'*
3185'filetype' 'ft' string (default: "")
3186 local to buffer
3187 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 When this option is set, the FileType autocommand event is triggered.
3189 All autocommands that match with the value of this option will be
3190 executed. Thus the value of 'filetype' is used in place of the file
3191 name.
3192 Otherwise this option does not always reflect the current file type.
3193 This option is normally set when the file type is detected. To enable
3194 this use the ":filetype on" command. |:filetype|
3195 Setting this option to a different value is most useful in a modeline,
3196 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003197 Example, for in an IDL file:
3198 /* vim: set filetype=idl : */ ~
3199 |FileType| |filetypes|
3200 When a dot appears in the value then this separates two filetype
3201 names. Example:
3202 /* vim: set filetype=c.doxygen : */ ~
3203 This will use the "c" filetype first, then the "doxygen" filetype.
3204 This works both for filetype plugins and for syntax files. More than
3205 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 This option is not copied to another buffer, independent of the 's' or
3207 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003208 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209
3210 *'fillchars'* *'fcs'*
3211'fillchars' 'fcs' string (default "vert:|,fold:-")
3212 global
3213 {not in Vi}
3214 {not available when compiled without the |+windows|
3215 and |+folding| features}
3216 Characters to fill the statuslines and vertical separators.
3217 It is a comma separated list of items:
3218
3219 item default Used for ~
3220 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003221 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 vert:c '|' vertical separators |:vsplit|
3223 fold:c '-' filling 'foldtext'
3224 diff:c '-' deleted lines of the 'diff' option
3225
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003227 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 otherwise.
3229
3230 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003231 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232< This is similar to the default, except that these characters will also
3233 be used when there is highlighting.
3234
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003235 for "stl" and "stlnc" only single-byte values are supported.
3236
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 The highlighting used for these items:
3238 item highlight group ~
3239 stl:c StatusLine |hl-StatusLine|
3240 stlnc:c StatusLineNC |hl-StatusLineNC|
3241 vert:c VertSplit |hl-VertSplit|
3242 fold:c Folded |hl-Folded|
3243 diff:c DiffDelete |hl-DiffDelete|
3244
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003245 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3246'fixendofline' 'fixeol' boolean (default on)
3247 local to buffer
3248 {not in Vi}
3249 When writing a file and this option is on, <EOL> at the end of file
3250 will be restored if missing. Turn this option off if you want to
3251 preserve the situation from the original file.
3252 When the 'binary' option is set the value of this option doesn't
3253 matter.
3254 See the 'endofline' option.
3255
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3257'fkmap' 'fk' boolean (default off) *E198*
3258 global
3259 {not in Vi}
3260 {only available when compiled with the |+rightleft|
3261 feature}
3262 When on, the keyboard is mapped for the Farsi character set.
3263 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003264 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265
3266 *'foldclose'* *'fcl'*
3267'foldclose' 'fcl' string (default "")
3268 global
3269 {not in Vi}
3270 {not available when compiled without the |+folding|
3271 feature}
3272 When set to "all", a fold is closed when the cursor isn't in it and
3273 its level is higher than 'foldlevel'. Useful if you want folds to
3274 automatically close when moving out of them.
3275
3276 *'foldcolumn'* *'fdc'*
3277'foldcolumn' 'fdc' number (default 0)
3278 local to window
3279 {not in Vi}
3280 {not available when compiled without the |+folding|
3281 feature}
3282 When non-zero, a column with the specified width is shown at the side
3283 of the window which indicates open and closed folds. The maximum
3284 value is 12.
3285 See |folding|.
3286
3287 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3288'foldenable' 'fen' boolean (default on)
3289 local to window
3290 {not in Vi}
3291 {not available when compiled without the |+folding|
3292 feature}
3293 When off, all folds are open. This option can be used to quickly
3294 switch between showing all text unfolded and viewing the text with
3295 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003296 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 'foldenable' is off.
3298 This option is set by commands that create a new fold or close a fold.
3299 See |folding|.
3300
3301 *'foldexpr'* *'fde'*
3302'foldexpr' 'fde' string (default: "0")
3303 local to window
3304 {not in Vi}
3305 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003306 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003308 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003309
Bram Moolenaar30b65812012-07-12 22:01:11 +02003310 The expression will be evaluated in the |sandbox| if set from a
3311 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003312 This option can't be set from a |modeline| when the 'diff' option is
3313 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003314
3315 It is not allowed to change text or jump to another window while
3316 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317
3318 *'foldignore'* *'fdi'*
3319'foldignore' 'fdi' string (default: "#")
3320 local to window
3321 {not in Vi}
3322 {not available when compiled without the |+folding|
3323 feature}
3324 Used only when 'foldmethod' is "indent". Lines starting with
3325 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003326 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 The default "#" works well for C programs. See |fold-indent|.
3328
3329 *'foldlevel'* *'fdl'*
3330'foldlevel' 'fdl' number (default: 0)
3331 local to window
3332 {not in Vi}
3333 {not available when compiled without the |+folding|
3334 feature}
3335 Sets the fold level: Folds with a higher level will be closed.
3336 Setting this option to zero will close all folds. Higher numbers will
3337 close fewer folds.
3338 This option is set by commands like |zm|, |zM| and |zR|.
3339 See |fold-foldlevel|.
3340
3341 *'foldlevelstart'* *'fdls'*
3342'foldlevelstart' 'fdls' number (default: -1)
3343 global
3344 {not in Vi}
3345 {not available when compiled without the |+folding|
3346 feature}
3347 Sets 'foldlevel' when starting to edit another buffer in a window.
3348 Useful to always start editing with all folds closed (value zero),
3349 some folds closed (one) or no folds closed (99).
3350 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003351 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 ignores this option and closes all folds.
3353 It is also done before BufReadPre autocommands, to allow an autocmd to
3354 overrule the 'foldlevel' value for specific files.
3355 When the value is negative, it is not used.
3356
3357 *'foldmarker'* *'fmr'* *E536*
3358'foldmarker' 'fmr' string (default: "{{{,}}}")
3359 local to window
3360 {not in Vi}
3361 {not available when compiled without the |+folding|
3362 feature}
3363 The start and end marker used when 'foldmethod' is "marker". There
3364 must be one comma, which separates the start and end marker. The
3365 marker is a literal string (a regular expression would be too slow).
3366 See |fold-marker|.
3367
3368 *'foldmethod'* *'fdm'*
3369'foldmethod' 'fdm' string (default: "manual")
3370 local to window
3371 {not in Vi}
3372 {not available when compiled without the |+folding|
3373 feature}
3374 The kind of folding used for the current window. Possible values:
3375 |fold-manual| manual Folds are created manually.
3376 |fold-indent| indent Lines with equal indent form a fold.
3377 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3378 |fold-marker| marker Markers are used to specify folds.
3379 |fold-syntax| syntax Syntax highlighting items specify folds.
3380 |fold-diff| diff Fold text that is not changed.
3381
3382 *'foldminlines'* *'fml'*
3383'foldminlines' 'fml' number (default: 1)
3384 local to window
3385 {not in Vi}
3386 {not available when compiled without the |+folding|
3387 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003388 Sets the number of screen lines above which a fold can be displayed
3389 closed. Also for manually closed folds. With the default value of
3390 one a fold can only be closed if it takes up two or more screen lines.
3391 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003392 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 "zc" to close a fold, which is displayed open because it's smaller
3394 than 'foldminlines', a following "zc" may close a containing fold.
3395
3396 *'foldnestmax'* *'fdn'*
3397'foldnestmax' 'fdn' number (default: 20)
3398 local to window
3399 {not in Vi}
3400 {not available when compiled without the |+folding|
3401 feature}
3402 Sets the maximum nesting of folds for the "indent" and "syntax"
3403 methods. This avoids that too many folds will be created. Using more
3404 than 20 doesn't work, because the internal limit is 20.
3405
3406 *'foldopen'* *'fdo'*
3407'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3408 search,tag,undo")
3409 global
3410 {not in Vi}
3411 {not available when compiled without the |+folding|
3412 feature}
3413 Specifies for which type of commands folds will be opened, if the
3414 command moves the cursor into a closed fold. It is a comma separated
3415 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003416 NOTE: When the command is part of a mapping this option is not used.
3417 Add the |zv| command to the mapping to get the same effect.
3418 (rationale: the mapping may want to control opening folds itself)
3419
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 item commands ~
3421 all any
3422 block "(", "{", "[[", "[{", etc.
3423 hor horizontal movements: "l", "w", "fx", etc.
3424 insert any command in Insert mode
3425 jump far jumps: "G", "gg", etc.
3426 mark jumping to a mark: "'m", CTRL-O, etc.
3427 percent "%"
3428 quickfix ":cn", ":crew", ":make", etc.
3429 search search for a pattern: "/", "n", "*", "gd", etc.
3430 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003431 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 tag jumping to a tag: ":ta", CTRL-T, etc.
3433 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 When a movement command is used for an operator (e.g., "dl" or "y%")
3435 this option is not used. This means the operator will include the
3436 whole closed fold.
3437 Note that vertical movements are not here, because it would make it
3438 very difficult to move onto a closed fold.
3439 In insert mode the folds containing the cursor will always be open
3440 when text is inserted.
3441 To close folds you can re-apply 'foldlevel' with the |zx| command or
3442 set the 'foldclose' option to "all".
3443
3444 *'foldtext'* *'fdt'*
3445'foldtext' 'fdt' string (default: "foldtext()")
3446 local to window
3447 {not in Vi}
3448 {not available when compiled without the |+folding|
3449 feature}
3450 An expression which is used to specify the text displayed for a closed
3451 fold. See |fold-foldtext|.
3452
Bram Moolenaar30b65812012-07-12 22:01:11 +02003453 The expression will be evaluated in the |sandbox| if set from a
3454 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003455
3456 It is not allowed to change text or jump to another window while
3457 evaluating 'foldtext' |textlock|.
3458
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003459 *'formatexpr'* *'fex'*
3460'formatexpr' 'fex' string (default "")
3461 local to buffer
3462 {not in Vi}
3463 {not available when compiled without the |+eval|
3464 feature}
3465 Expression which is evaluated to format a range of lines for the |gq|
3466 operator or automatic formatting (see 'formatoptions'). When this
3467 option is empty 'formatprg' is used.
3468
3469 The |v:lnum| variable holds the first line to be formatted.
3470 The |v:count| variable holds the number of lines to be formatted.
3471 The |v:char| variable holds the character that is going to be
3472 inserted if the expression is being evaluated due to
3473 automatic formatting. This can be empty. Don't insert
3474 it yet!
3475
3476 Example: >
3477 :set formatexpr=mylang#Format()
3478< This will invoke the mylang#Format() function in the
3479 autoload/mylang.vim file in 'runtimepath'. |autoload|
3480
3481 The expression is also evaluated when 'textwidth' is set and adding
3482 text beyond that limit. This happens under the same conditions as
3483 when internal formatting is used. Make sure the cursor is kept in the
3484 same spot relative to the text then! The |mode()| function will
3485 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003486
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003487 When the expression evaluates to non-zero Vim will fall back to using
3488 the internal format mechanism.
3489
3490 The expression will be evaluated in the |sandbox| when set from a
3491 modeline, see |sandbox-option|. That stops the option from working,
3492 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003493 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003494
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 *'formatoptions'* *'fo'*
3496'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3497 local to buffer
3498 {not in Vi}
3499 This is a sequence of letters which describes how automatic
3500 formatting is to be done. See |fo-table|. When the 'paste' option is
3501 on, no formatting is done (like 'formatoptions' is empty). Commas can
3502 be inserted for readability.
3503 To avoid problems with flags that are added in the future, use the
3504 "+=" and "-=" feature of ":set" |add-option-flags|.
3505 NOTE: This option is set to the Vi default value when 'compatible' is
3506 set and to the Vim default value when 'compatible' is reset.
3507
Bram Moolenaar86b68352004-12-27 21:59:20 +00003508 *'formatlistpat'* *'flp'*
3509'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3510 local to buffer
3511 {not in Vi}
3512 A pattern that is used to recognize a list header. This is used for
3513 the "n" flag in 'formatoptions'.
3514 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003515 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003516 while still checking more characters. There must be a character
3517 following the pattern, when it matches the whole line it is handled
3518 like there is no match.
3519 The default recognizes a number, followed by an optional punctuation
3520 character and white space.
3521
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 *'formatprg'* *'fp'*
3523'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003524 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 {not in Vi}
3526 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003527 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003529 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003530 If the 'formatexpr' option is not empty it will be used instead.
3531 Otherwise, if 'formatprg' option is an empty string, the internal
3532 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003533 Environment variables are expanded |:set_env|. See |option-backslash|
3534 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003535 This option cannot be set from a |modeline| or in the |sandbox|, for
3536 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
Bram Moolenaard94464e2015-11-02 15:28:18 +01003538 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003539'fsync' 'fs' boolean (default on)
3540 global
3541 {not in Vi}
3542 When on, the library function fsync() will be called after writing a
3543 file. This will flush a file to disk, ensuring that it is safely
3544 written even on filesystems which do metadata-only journaling. This
3545 will force the harddrive to spin up on Linux systems running in laptop
3546 mode, so it may be undesirable in some situations. Be warned that
3547 turning this off increases the chances of data loss after a crash. On
3548 systems without an fsync() implementation, this variable is always
3549 off.
3550 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003551 'fsync' also applies to |writefile()|, unless a flag is used to
3552 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003553
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3555'gdefault' 'gd' boolean (default off)
3556 global
3557 {not in Vi}
3558 When on, the ":substitute" flag 'g' is default on. This means that
3559 all matches in a line are substituted instead of one. When a 'g' flag
3560 is given to a ":substitute" command, this will toggle the substitution
3561 of all or one match. See |complex-change|.
3562
3563 command 'gdefault' on 'gdefault' off ~
3564 :s/// subst. all subst. one
3565 :s///g subst. one subst. all
3566 :s///gg subst. all subst. one
3567
3568 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003569 DEPRECATED: Setting this option may break plugins that are not aware
3570 of this option. Also, many users get confused that adding the /g flag
3571 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572
3573 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003574'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 global
3576 {not in Vi}
3577 Format to recognize for the ":grep" command output.
3578 This is a scanf-like string that uses the same format as the
3579 'errorformat' option: see |errorformat|.
3580
3581 *'grepprg'* *'gp'*
3582'grepprg' 'gp' string (default "grep -n ",
3583 Unix: "grep -n $* /dev/null",
3584 Win32: "findstr /n" or "grep -n",
3585 VMS: "SEARCH/NUMBERS ")
3586 global or local to buffer |global-local|
3587 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003588 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 and '#' characters, which are expanded like when used in a command-
3590 line. The placeholder "$*" is allowed to specify where the arguments
3591 will be included. Environment variables are expanded |:set_env|. See
3592 |option-backslash| about including spaces and backslashes.
3593 When your "grep" accepts the "-H" argument, use this to make ":grep"
3594 also work well with a single file: >
3595 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003596< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003597 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3598 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003599 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 apply equally to 'grepprg'.
3601 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3602 otherwise it's "grep -n".
3603 This option cannot be set from a |modeline| or in the |sandbox|, for
3604 security reasons.
3605
3606 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3607'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3608 ve:ver35-Cursor,
3609 o:hor50-Cursor,
3610 i-ci:ver25-Cursor/lCursor,
3611 r-cr:hor20-Cursor/lCursor,
3612 sm:block-Cursor
3613 -blinkwait175-blinkoff150-blinkon175",
3614 for MS-DOS and Win32 console:
3615 "n-v-c:block,o:hor50,i-ci:hor15,
3616 r-cr:hor30,sm:block")
3617 global
3618 {not in Vi}
3619 {only available when compiled with GUI enabled, and
3620 for MS-DOS and Win32 console}
3621 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003622 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 the height of the cursor can be changed. This can be done by
3624 specifying a block cursor, or a percentage for a vertical or
3625 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003626 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3627 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003629 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 mode-list and an argument-list:
3631 mode-list:argument-list,mode-list:argument-list,..
3632 The mode-list is a dash separated list of these modes:
3633 n Normal mode
3634 v Visual mode
3635 ve Visual mode with 'selection' "exclusive" (same as 'v',
3636 if not specified)
3637 o Operator-pending mode
3638 i Insert mode
3639 r Replace mode
3640 c Command-line Normal (append) mode
3641 ci Command-line Insert mode
3642 cr Command-line Replace mode
3643 sm showmatch in Insert mode
3644 a all modes
3645 The argument-list is a dash separated list of these arguments:
3646 hor{N} horizontal bar, {N} percent of the character height
3647 ver{N} vertical bar, {N} percent of the character width
3648 block block cursor, fills the whole character
3649 [only one of the above three should be present]
3650 blinkwait{N} *cursor-blinking*
3651 blinkon{N}
3652 blinkoff{N}
3653 blink times for cursor: blinkwait is the delay before
3654 the cursor starts blinking, blinkon is the time that
3655 the cursor is shown and blinkoff is the time that the
3656 cursor is not shown. The times are in msec. When one
3657 of the numbers is zero, there is no blinking. The
3658 default is: "blinkwait700-blinkon400-blinkoff250".
3659 These numbers are used for a missing entry. This
3660 means that blinking is enabled by default. To switch
3661 blinking off you can use "blinkon0". The cursor only
3662 blinks when Vim is waiting for input, not while
3663 executing a command.
3664 To make the cursor blink in an xterm, see
3665 |xterm-blink|.
3666 {group-name}
3667 a highlight group name, that sets the color and font
3668 for the cursor
3669 {group-name}/{group-name}
3670 Two highlight group names, the first is used when
3671 no language mappings are used, the other when they
3672 are. |language-mapping|
3673
3674 Examples of parts:
3675 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3676 block cursor with colors from the "nCursor"
3677 highlight group
3678 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3679 In Insert and Command-line Insert mode, use a
3680 30% vertical bar cursor with colors from the
3681 "iCursor" highlight group. Blink a bit
3682 faster.
3683
3684 The 'a' mode is different. It will set the given argument-list for
3685 all modes. It does not reset anything to defaults. This can be used
3686 to do a common setting for all modes. For example, to switch off
3687 blinking: "a:blinkon0"
3688
3689 Examples of cursor highlighting: >
3690 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3691 :highlight Cursor gui=NONE guifg=bg guibg=fg
3692<
3693 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003694 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695'guifont' 'gfn' string (default "")
3696 global
3697 {not in Vi}
3698 {only available when compiled with GUI enabled}
3699 This is a list of fonts which will be used for the GUI version of Vim.
3700 In its simplest form the value is just one font name. When
3701 the font cannot be found you will get an error message. To try other
3702 font names a list can be specified, font names separated with commas.
3703 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003704
Bram Moolenaar05159a02005-02-26 23:04:13 +00003705 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3706 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003707
Bram Moolenaar3df01732017-02-17 22:47:16 +01003708 Note: As to the GTK GUIs, no error is given against any invalid names,
3709 and the first element of the list is always picked up and made use of.
3710 This is because, instead of identifying a given name with a font, the
3711 GTK GUIs use it to construct a pattern and try to look up a font which
3712 best matches the pattern among available fonts, and this way, the
3713 matching never fails. An invalid name doesn't matter because a number
3714 of font properties other than name will do to get the matching done.
3715
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 Spaces after a comma are ignored. To include a comma in a font name
3717 precede it with a backslash. Setting an option requires an extra
3718 backslash before a space and a backslash. See also
3719 |option-backslash|. For example: >
3720 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003721< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003723
3724 If none of the fonts can be loaded, Vim will keep the current setting.
3725 If an empty font list is given, Vim will try using other resource
3726 settings (for X, it will use the Vim.font resource), and finally it
3727 will try some builtin default which should always be there ("7x13" in
3728 the case of X). The font names given should be "normal" fonts. Vim
3729 will try to find the related bold and italic fonts.
3730
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003731 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003732 :set guifont=*
3733< will bring up a font requester, where you can pick the font you want.
3734
3735 The font name depends on the GUI used. See |setting-guifont| for a
3736 way to set 'guifont' for various systems.
3737
Bram Moolenaar3df01732017-02-17 22:47:16 +01003738 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003740< That's all. XLFDs are not used. For Chinese this is reported to work
3741 well: >
3742 if has("gui_gtk2")
3743 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3744 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3745 endif
3746<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003747 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3748
Bram Moolenaar05159a02005-02-26 23:04:13 +00003749 For Mac OSX you can use something like this: >
3750 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003751< Also see 'macatsui', it can help fix display problems.
3752 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003754 width). An exception is GTK: all fonts are accepted, but mono-spaced
3755 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003756
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 To preview a font on X11, you might be able to use the "xfontsel"
3758 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003759
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 For the Win32 GUI *E244* *E245*
3761 - takes these options in the font name:
3762 hXX - height is XX (points, can be floating-point)
3763 wXX - width is XX (points, can be floating-point)
3764 b - bold
3765 i - italic
3766 u - underline
3767 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003768 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3770 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3771 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003772 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003773 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003774 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003775 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003776 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
3778 Use a ':' to separate the options.
3779 - A '_' can be used in the place of a space, so you don't need to use
3780 backslashes to escape the spaces.
3781 - Examples: >
3782 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3783 :set guifont=Andale_Mono:h7.5:w4.5
3784< See also |font-sizes|.
3785
3786 *'guifontset'* *'gfs'*
3787 *E250* *E252* *E234* *E597* *E598*
3788'guifontset' 'gfs' string (default "")
3789 global
3790 {not in Vi}
3791 {only available when compiled with GUI enabled and
3792 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003793 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 When not empty, specifies two (or more) fonts to be used. The first
3795 one for normal English, the second one for your special language. See
3796 |xfontset|.
3797 Setting this option also means that all font names will be handled as
3798 a fontset name. Also the ones used for the "font" argument of the
3799 |:highlight| command.
3800 The fonts must match with the current locale. If fonts for the
3801 character sets that the current locale uses are not included, setting
3802 'guifontset' will fail.
3803 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3804 the comma-separated names are alternative names, one of which will be
3805 used. In 'guifontset' the whole string is one fontset name,
3806 including the commas. It is not possible to specify alternative
3807 fontset names.
3808 This example works on many X11 systems: >
3809 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3810<
3811 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3812'guifontwide' 'gfw' string (default "")
3813 global
3814 {not in Vi}
3815 {only available when compiled with GUI enabled}
3816 When not empty, specifies a comma-separated list of fonts to be used
3817 for double-width characters. The first font that can be loaded is
3818 used.
3819 Note: The size of these fonts must be exactly twice as wide as the one
3820 specified with 'guifont' and the same height.
3821
Bram Moolenaar3df01732017-02-17 22:47:16 +01003822 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823
3824 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3825 'guifontset' is empty or invalid.
3826 When 'guifont' is set and a valid font is found in it and
3827 'guifontwide' is empty Vim will attempt to find a matching
3828 double-width font and set 'guifontwide' to it.
3829
Bram Moolenaar3df01732017-02-17 22:47:16 +01003830 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831
3832 If set and valid, 'guifontwide' is always used for double width
3833 characters, even if 'encoding' is not set to "utf-8".
3834 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003835 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 font for characters not available in 'guifont'. Thus you do not need
3837 to set 'guifontwide' at all unless you want to override the choice
3838 made by Pango/Xft.
3839
Bram Moolenaar0f272122013-01-23 18:37:40 +01003840 Windows +multibyte only: *guifontwide_win_mbyte*
3841
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003842 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003843
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 *'guiheadroom'* *'ghr'*
3845'guiheadroom' 'ghr' number (default 50)
3846 global
3847 {not in Vi} {only for GTK and X11 GUI}
3848 The number of pixels subtracted from the screen height when fitting
3849 the GUI window on the screen. Set this before the GUI is started,
3850 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003851 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 lines will be left for window decorations and other items on the
3853 screen. Set it to a negative value to allow windows taller than the
3854 screen.
3855
3856 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003857'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3858 removed in |defaults.vim|),
3859 "aegimrLtT" (GTK, Motif and Athena),
3860 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 global
3862 {not in Vi}
3863 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003864 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 sequence of letters which describes what components and options of the
3866 GUI should be used.
3867 To avoid problems with flags that are added in the future, use the
3868 "+=" and "-=" feature of ":set" |add-option-flags|.
3869
Bram Moolenaar13568252018-03-16 20:46:58 +01003870 Valid characters are as follows:
3871 *'go-!'*
3872 '!' External commands are executed in a terminal window. Without
3873 this flag the MS-Windows GUI will open a console window to
3874 execute the command. The Unix GUI will simulate a dumb
3875 terminal to list the command output.
3876 The terminal window will be positioned at the bottom, and grow
3877 upwards as needed.
Bram Moolenaar02467872007-05-06 13:22:01 +00003878 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'a' Autoselect: If present, then whenever VISUAL mode is started,
3880 or the Visual area extended, Vim tries to become the owner of
3881 the windowing system's global selection. This means that the
3882 Visually highlighted text is available for pasting into other
3883 applications as well as into Vim itself. When the Visual mode
3884 ends, possibly due to an operation on the text, or when an
3885 application wants to paste the selection, the highlighted text
3886 is automatically yanked into the "* selection register.
3887 Thus the selection is still available for pasting into other
3888 applications after the VISUAL mode has ended.
3889 If not present, then Vim won't become the owner of the
3890 windowing system's global selection unless explicitly told to
3891 by a yank or delete operation for the "* register.
3892 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003893 *'go-P'*
3894 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003895 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003896 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003897 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 applies to the modeless selection.
3899
3900 'guioptions' autoselect Visual autoselect modeless ~
3901 "" - -
3902 "a" yes yes
3903 "A" - yes
3904 "aA" yes yes
3905
Bram Moolenaar02467872007-05-06 13:22:01 +00003906 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 'c' Use console dialogs instead of popup dialogs for simple
3908 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003909 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003910 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003911 'guitablabel' can be used to change the text in the labels.
3912 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003913 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003914 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003915 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 'f' Foreground: Don't use fork() to detach the GUI from the shell
3917 where it was started. Use this for programs that wait for the
3918 editor to finish (e.g., an e-mail program). Alternatively you
3919 can use "gvim -f" or ":gui -f" to start the GUI in the
3920 foreground. |gui-fork|
3921 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003922 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003923 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3925 corner of the window. It's black&white on non-GTK, because of
3926 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003929 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003930 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003932 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003934 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003935 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 'g' Grey menu items: Make menu items that are not active grey. If
3937 'g' is not included inactive menu items are not shown at all.
3938 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003939 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 't' Include tearoff menu items. Currently only works for Win32,
3941 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003942 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003943 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003944 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003945 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003947 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'R' Right-hand scrollbar is present when there is a vertically
3949 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003950 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003952 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 'L' Left-hand scrollbar is present when there is a vertically
3954 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003955 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3957 the longest visible line, or on the cursor line if the 'h'
3958 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003959 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 'h' Limit horizontal scrollbar size to the length of the cursor
3961 line. Reduces computations. |gui-horiz-scroll|
3962
3963 And yes, you may even have scrollbars on the left AND the right if
3964 you really want to :-). See |gui-scrollbars| for more information.
3965
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003966 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'v' Use a vertical button layout for dialogs. When not included,
3968 a horizontal layout is preferred, but when it doesn't fit a
3969 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003970 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 'p' Use Pointer callbacks for X11 GUI. This is required for some
3972 window managers. If the cursor is not blinking or hollow at
3973 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003974 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003976 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003977 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003978 *'go-k'*
3979 'k' Keep the GUI window size when adding/removing a scrollbar, or
3980 toolbar, tabline, etc. Instead, the behavior is similar to
3981 when the window is maximized and will adjust 'lines' and
3982 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003983 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003984 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003985
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 *'guipty'* *'noguipty'*
3987'guipty' boolean (default on)
3988 global
3989 {not in Vi}
3990 {only available when compiled with GUI enabled}
3991 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3992 I/O to/from shell commands. See |gui-pty|.
3993
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003994 *'guitablabel'* *'gtl'*
3995'guitablabel' 'gtl' string (default empty)
3996 global
3997 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003998 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003999 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004000 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004001 pages line. When empty and when the result is empty Vim will use a
4002 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004003
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004004 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004005 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004006 The expression will be evaluated in the |sandbox| when set from a
4007 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004008
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004009 Only used when the GUI tab pages line is displayed. 'e' must be
4010 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4011 used.
4012
Bram Moolenaar57657d82006-04-21 22:12:41 +00004013 *'guitabtooltip'* *'gtt'*
4014'guitabtooltip' 'gtt' string (default empty)
4015 global
4016 {not in Vi}
4017 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004018 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004019 When nonempty describes the text to use in a tooltip for the GUI tab
4020 pages line. When empty Vim will use a default tooltip.
4021 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004022 You can include a line break. Simplest method is to use |:let|: >
4023 :let &guitabtooltip = "line one\nline two"
4024<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004025
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 *'helpfile'* *'hf'*
4027'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4028 (others) "$VIMRUNTIME/doc/help.txt")
4029 global
4030 {not in Vi}
4031 Name of the main help file. All distributed help files should be
4032 placed together in one directory. Additionally, all "doc" directories
4033 in 'runtimepath' will be used.
4034 Environment variables are expanded |:set_env|. For example:
4035 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004036 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 spaces and backslashes.
4038 This option cannot be set from a |modeline| or in the |sandbox|, for
4039 security reasons.
4040
4041 *'helpheight'* *'hh'*
4042'helpheight' 'hh' number (default 20)
4043 global
4044 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004045 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 feature}
4047 Minimal initial height of the help window when it is opened with the
4048 ":help" command. The initial height of the help window is half of the
4049 current window, or (when the 'ea' option is on) the same as other
4050 windows. When the height is less than 'helpheight', the height is
4051 set to 'helpheight'. Set to zero to disable.
4052
4053 *'helplang'* *'hlg'*
4054'helplang' 'hlg' string (default: messages language or empty)
4055 global
4056 {only available when compiled with the |+multi_lang|
4057 feature}
4058 {not in Vi}
4059 Comma separated list of languages. Vim will use the first language
4060 for which the desired help can be found. The English help will always
4061 be used as a last resort. You can add "en" to prefer English over
4062 another language, but that will only find tags that exist in that
4063 language and not in the English help.
4064 Example: >
4065 :set helplang=de,it
4066< This will first search German, then Italian and finally English help
4067 files.
4068 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4069 try to find the tag in the current language before using this option.
4070 See |help-translated|.
4071
4072 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4073'hidden' 'hid' boolean (default off)
4074 global
4075 {not in Vi}
4076 When off a buffer is unloaded when it is |abandon|ed. When on a
4077 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4078 displayed in another window, it does not become hidden, of course.
4079 The commands that move through the buffer list sometimes make a buffer
4080 hidden although the 'hidden' option is off: When the buffer is
4081 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004082 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004083 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 This option is set for one command with ":hide {command}" |:hide|.
4085 WARNING: It's easy to forget that you have changes in hidden buffers.
4086 Think twice when using ":q!" or ":qa!".
4087
4088 *'highlight'* *'hl'*
4089'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004090 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4091 d:Directory,e:ErrorMsg,i:IncSearch,
4092 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4093 N:CursorLineNr,r:Question,s:StatusLine,
4094 S:StatusLineNC,c:VertSplit,t:Title,
4095 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4096 F:FoldColumn,A:DiffAdd,C:DiffChange,
4097 D:DiffDelete,T:DiffText,>:SignColumn,
4098 B:SpellBad,P:SpellCap,R:SpellRare,
4099 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004100 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4101 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004102 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004103 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 global
4105 {not in Vi}
4106 This option can be used to set highlighting mode for various
4107 occasions. It is a comma separated list of character pairs. The
4108 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004109 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004111 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4112 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 characters from 'showbreak'
4114 |hl-Directory| d directories in CTRL-D listing and other special
4115 things in listings
4116 |hl-ErrorMsg| e error messages
4117 h (obsolete, ignored)
4118 |hl-IncSearch| i 'incsearch' highlighting
4119 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4120 |hl-MoreMsg| m |more-prompt|
4121 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004122 |hl-LineNr| n line number for ":number" and ":#" commands, and
4123 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004124 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4125 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 |hl-Question| r |hit-enter| prompt and yes/no questions
4127 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004128 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4130 |hl-VertSplit| c column used to separate vertically split windows
4131 |hl-Visual| v Visual mode
4132 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4133 Selection" Only X11 Gui's |gui-x11| and
4134 |xterm-clipboard|.
4135 |hl-WarningMsg| w warning messages
4136 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4137 |hl-Folded| f line used for closed folds
4138 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004139 |hl-DiffAdd| A added line in diff mode
4140 |hl-DiffChange| C changed line in diff mode
4141 |hl-DiffDelete| D deleted line in diff mode
4142 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004144 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004145 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004146 |hl-SpellRare| R rare word |spell|
4147 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004148 |hl-Conceal| - the placeholders used for concealed characters
4149 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004150 |hl-Pmenu| + popup menu normal line
4151 |hl-PmenuSel| = popup menu normal line
4152 |hl-PmenuSbar| x popup menu scrollbar
4153 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154
4155 The display modes are:
4156 r reverse (termcap entry "mr" and "me")
4157 i italic (termcap entry "ZH" and "ZR")
4158 b bold (termcap entry "md" and "me")
4159 s standout (termcap entry "so" and "se")
4160 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004161 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004162 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 n no highlighting
4164 - no highlighting
4165 : use a highlight group
4166 The default is used for occasions that are not included.
4167 If you want to change what the display modes do, see |dos-colors|
4168 for an example.
4169 When using the ':' display mode, this must be followed by the name of
4170 a highlight group. A highlight group can be used to define any type
4171 of highlighting, including using color. See |:highlight| on how to
4172 define one. The default uses a different group for each occasion.
4173 See |highlight-default| for the default highlight groups.
4174
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004176'history' 'hi' number (Vim default: 50, Vi default: 0,
4177 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 global
4179 {not in Vi}
4180 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004181 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004183 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 NOTE: This option is set to the Vi default value when 'compatible' is
4185 set and to the Vim default value when 'compatible' is reset.
4186
4187 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4188'hkmap' 'hk' boolean (default off)
4189 global
4190 {not in Vi}
4191 {only available when compiled with the |+rightleft|
4192 feature}
4193 When on, the keyboard is mapped for the Hebrew character set.
4194 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4195 toggle this option. See |rileft.txt|.
4196 NOTE: This option is reset when 'compatible' is set.
4197
4198 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4199'hkmapp' 'hkp' boolean (default off)
4200 global
4201 {not in Vi}
4202 {only available when compiled with the |+rightleft|
4203 feature}
4204 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4205 This is useful if you have a non-Hebrew keyboard.
4206 See |rileft.txt|.
4207 NOTE: This option is reset when 'compatible' is set.
4208
Bram Moolenaar036986f2017-03-16 17:41:02 +01004209 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4210'hlsearch' 'hls' boolean (default off)
4211 global
4212 {not in Vi}
4213 {not available when compiled without the
4214 |+extra_search| feature}
4215 When there is a previous search pattern, highlight all its matches.
4216 The type of highlighting used can be set with the 'l' occasion in the
4217 'highlight' option. This uses the "Search" highlight group by
4218 default. Note that only the matching text is highlighted, any offsets
4219 are not applied.
4220 See also: 'incsearch' and |:match|.
4221 When you get bored looking at the highlighted matches, you can turn it
4222 off with |:nohlsearch|. This does not change the option value, as
4223 soon as you use a search command, the highlighting comes back.
4224 'redrawtime' specifies the maximum time spent on finding matches.
4225 When the search pattern can match an end-of-line, Vim will try to
4226 highlight all of the matched text. However, this depends on where the
4227 search starts. This will be the first line in the window or the first
4228 line below a closed fold. A match in a previous line which is not
4229 drawn may not continue in a newly drawn line.
4230 You can specify whether the highlight status is restored on startup
4231 with the 'h' flag in 'viminfo' |viminfo-h|.
4232 NOTE: This option is reset when 'compatible' is set.
4233
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 *'icon'* *'noicon'*
4235'icon' boolean (default off, on when title can be restored)
4236 global
4237 {not in Vi}
4238 {not available when compiled without the |+title|
4239 feature}
4240 When on, the icon text of the window will be set to the value of
4241 'iconstring' (if it is not empty), or to the name of the file
4242 currently being edited. Only the last part of the name is used.
4243 Overridden by the 'iconstring' option.
4244 Only works if the terminal supports setting window icons (currently
4245 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4246 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4247 builtin termcap).
4248 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004249 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004251 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252
4253 *'iconstring'*
4254'iconstring' string (default "")
4255 global
4256 {not in Vi}
4257 {not available when compiled without the |+title|
4258 feature}
4259 When this option is not empty, it will be used for the icon text of
4260 the window. This happens only when the 'icon' option is on.
4261 Only works if the terminal supports setting window icon text
4262 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4263 Does not work for MS Windows.
4264 When Vim was compiled with HAVE_X11 defined, the original icon will be
4265 restored if possible |X11|.
4266 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004267 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 'titlestring' for example settings.
4269 {not available when compiled without the |+statusline| feature}
4270
4271 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4272'ignorecase' 'ic' boolean (default off)
4273 global
4274 Ignore case in search patterns. Also used when searching in the tags
4275 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004276 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 Can be overruled by using "\c" or "\C" in the pattern, see
4278 |/ignorecase|.
4279
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004280 *'imactivatefunc'* *'imaf'*
4281'imactivatefunc' 'imaf' string (default "")
4282 global
4283 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004284 {only available when compiled with the |+multi_byte|
4285 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004286 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004287 activate or deactivate the Input Method.
4288 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004289
4290 Example: >
4291 function ImActivateFunc(active)
4292 if a:active
4293 ... do something
4294 else
4295 ... do something
4296 endif
4297 " return value is not used
4298 endfunction
4299 set imactivatefunc=ImActivateFunc
4300<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 *'imactivatekey'* *'imak'*
4302'imactivatekey' 'imak' string (default "")
4303 global
4304 {not in Vi}
4305 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004306 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 Specifies the key that your Input Method in X-Windows uses for
4308 activation. When this is specified correctly, vim can fully control
4309 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4310 You can't use this option to change the activation key, the option
4311 tells Vim what the key is.
4312 Format:
4313 [MODIFIER_FLAG-]KEY_STRING
4314
4315 These characters can be used for MODIFIER_FLAG (case is ignored):
4316 S Shift key
4317 L Lock key
4318 C Control key
4319 1 Mod1 key
4320 2 Mod2 key
4321 3 Mod3 key
4322 4 Mod4 key
4323 5 Mod5 key
4324 Combinations are allowed, for example "S-C-space" or "SC-space" are
4325 both shift+ctrl+space.
4326 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4327
4328 Example: >
4329 :set imactivatekey=S-space
4330< "S-space" means shift+space. This is the activation key for kinput2 +
4331 canna (Japanese), and ami (Korean).
4332
4333 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4334'imcmdline' 'imc' boolean (default off)
4335 global
4336 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004337 {only available when compiled with the |+multi_byte|
4338 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 When set the Input Method is always on when starting to edit a command
4340 line, unless entering a search pattern (see 'imsearch' for that).
4341 Setting this option is useful when your input method allows entering
4342 English characters directly, e.g., when it's used to type accented
4343 characters with dead keys.
4344
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004345 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4347 global
4348 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004349 {only available when compiled with the |+multi_byte|
4350 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 When set the Input Method is never used. This is useful to disable
4352 the IM when it doesn't work properly.
4353 Currently this option is on by default for SGI/IRIX machines. This
4354 may change in later releases.
4355
4356 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004357'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 local to buffer
4359 {not in Vi}
4360 Specifies whether :lmap or an Input Method (IM) is to be used in
4361 Insert mode. Valid values:
4362 0 :lmap is off and IM is off
4363 1 :lmap is ON and IM is off
4364 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 To always reset the option to zero when leaving Insert mode with <Esc>
4366 this can be used: >
4367 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4368< This makes :lmap and IM turn off automatically when leaving Insert
4369 mode.
4370 Note that this option changes when using CTRL-^ in Insert mode
4371 |i_CTRL-^|.
4372 The value is set to 1 when setting 'keymap' to a valid keymap name.
4373 It is also used for the argument of commands like "r" and "f".
4374 The value 0 may not work correctly with Athena and Motif with some XIM
4375 methods. Use 'imdisable' to disable XIM then.
4376
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004377 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004378 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004379 |+multi_byte_ime| or |global-ime|.
4380
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004382'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 local to buffer
4384 {not in Vi}
4385 Specifies whether :lmap or an Input Method (IM) is to be used when
4386 entering a search pattern. Valid values:
4387 -1 the value of 'iminsert' is used, makes it look like
4388 'iminsert' is also used when typing a search pattern
4389 0 :lmap is off and IM is off
4390 1 :lmap is ON and IM is off
4391 2 :lmap is off and IM is ON
4392 Note that this option changes when using CTRL-^ in Command-line mode
4393 |c_CTRL-^|.
4394 The value is set to 1 when it is not -1 and setting the 'keymap'
4395 option to a valid keymap name.
4396 The value 0 may not work correctly with Athena and Motif with some XIM
4397 methods. Use 'imdisable' to disable XIM then.
4398
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004399 *'imstatusfunc'* *'imsf'*
4400'imstatusfunc' 'imsf' string (default "")
4401 global
4402 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004403 {only available when compiled with the |+multi_byte|
4404 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004405 This option specifies a function that is called to obtain the status
4406 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004407 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004408
4409 Example: >
4410 function ImStatusFunc()
4411 let is_active = ...do something
4412 return is_active ? 1 : 0
4413 endfunction
4414 set imstatusfunc=ImStatusFunc
4415<
4416 NOTE: This function is invoked very often. Keep it fast.
4417
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004418 *'imstyle'* *'imst'*
4419'imstyle' 'imst' number (default 1)
4420 global
4421 {not in Vi}
4422 {only available when compiled with |+xim| and
4423 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004424 This option specifies the input style of Input Method:
4425 0 use on-the-spot style
4426 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004427 See: |xim-input-style|
4428
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004429 For a long time on-the-spot style had been used in the GTK version of
4430 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004431 |single-repeat|, etc. Therefore over-the-spot style becomes the
4432 default now. This should work fine for most people, however if you
4433 have any problem with it, try using on-the-spot style.
4434
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 *'include'* *'inc'*
4436'include' 'inc' string (default "^\s*#\s*include")
4437 global or local to buffer |global-local|
4438 {not in Vi}
4439 {not available when compiled without the
4440 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004441 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004442 pattern, just like for the "/" command (See |pattern|). The default
4443 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004444 "]I", "[d", etc.
4445 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004446 comes after the matched pattern. But if "\zs" appears in the pattern
4447 then the text matched from "\zs" to the end, or until "\ze" if it
4448 appears, is used as the file name. Use this to include characters
4449 that are not in 'isfname', such as a space. You can then use
4450 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004451 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452
4453 *'includeexpr'* *'inex'*
4454'includeexpr' 'inex' string (default "")
4455 local to buffer
4456 {not in Vi}
4457 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004458 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004460 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461 :set includeexpr=substitute(v:fname,'\\.','/','g')
4462< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004463
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004465 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 Also used for |<cfile>|.
4467
Bram Moolenaar30b65812012-07-12 22:01:11 +02004468 The expression will be evaluated in the |sandbox| when set from a
4469 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004470
4471 It is not allowed to change text or jump to another window while
4472 evaluating 'includeexpr' |textlock|.
4473
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004475'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4476 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 global
4478 {not in Vi}
4479 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004480 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004481 While typing a search command, show where the pattern, as it was typed
4482 so far, matches. The matched string is highlighted. If the pattern
4483 is invalid or not found, nothing is shown. The screen will be updated
4484 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004485 Also applies to the pattern in commands: >
4486 :global
4487 :lvimgrep
4488 :lvimgrepadd
4489 :smagic
4490 :snomagic
4491 :sort
4492 :substitute
4493 :vglobal
4494 :vimgrep
4495 :vimgrepadd
4496< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004497 original position when no match is found and when pressing <Esc>. You
4498 still need to finish the search command with <Enter> to move the
4499 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004500 You can use the CTRL-G and CTRL-T keys to move to the next and
4501 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004502 When compiled with the |+reltime| feature Vim only searches for about
4503 half a second. With a complicated pattern and/or a lot of text the
4504 match may not be found. This is to avoid that Vim hangs while you
4505 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004506 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004507 When 'hlsearch' is on, all matched strings are highlighted too while
4508 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004509 If you don't want to turn 'hlsearch' on, but want to highlight all
4510 matches while searching, you can turn on and off 'hlsearch' with
4511 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004512 augroup vimrc-incsearch-highlight
4513 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004514 autocmd CmdlineEnter /,\? :set hlsearch
4515 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004516 augroup END
4517<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004518 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004519 to the command line. If 'ignorecase' and 'smartcase' are set and the
4520 command line has no uppercase characters, the added character is
4521 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004522 CTRL-R CTRL-W can be used to add the word at the end of the current
4523 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 NOTE: This option is reset when 'compatible' is set.
4525
4526 *'indentexpr'* *'inde'*
4527'indentexpr' 'inde' string (default "")
4528 local to buffer
4529 {not in Vi}
4530 {not available when compiled without the |+cindent|
4531 or |+eval| features}
4532 Expression which is evaluated to obtain the proper indent for a line.
4533 It is used when a new line is created, for the |=| operator and
4534 in Insert mode as specified with the 'indentkeys' option.
4535 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004536 'smartindent' indenting. When 'lisp' is set, this option is
4537 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 When 'paste' is set this option is not used for indenting.
4539 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004540 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 when the expression is evaluated (but it may be moved around).
4542 The expression must return the number of spaces worth of indent. It
4543 can return "-1" to keep the current indent (this means 'autoindent' is
4544 used for the indent).
4545 Functions useful for computing the indent are |indent()|, |cindent()|
4546 and |lispindent()|.
4547 The evaluation of the expression must not have side effects! It must
4548 not change the text, jump to another window, etc. Afterwards the
4549 cursor position is always restored, thus the cursor may be moved.
4550 Normally this option would be set to call a function: >
4551 :set indentexpr=GetMyIndent()
4552< Error messages will be suppressed, unless the 'debug' option contains
4553 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004554 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004555 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556
Bram Moolenaar30b65812012-07-12 22:01:11 +02004557 The expression will be evaluated in the |sandbox| when set from a
4558 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004559
4560 It is not allowed to change text or jump to another window while
4561 evaluating 'indentexpr' |textlock|.
4562
4563
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564 *'indentkeys'* *'indk'*
4565'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4566 local to buffer
4567 {not in Vi}
4568 {not available when compiled without the |+cindent|
4569 feature}
4570 A list of keys that, when typed in Insert mode, cause reindenting of
4571 the current line. Only happens if 'indentexpr' isn't empty.
4572 The format is identical to 'cinkeys', see |indentkeys-format|.
4573 See |C-indenting| and |indent-expression|.
4574
4575 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4576'infercase' 'inf' boolean (default off)
4577 local to buffer
4578 {not in Vi}
4579 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004580 'ignorecase' is also on, the case of the match is adjusted depending
4581 on the typed text. If the typed text contains a lowercase letter
4582 where the match has an upper case letter, the completed part is made
4583 lowercase. If the typed text has no lowercase letters and the match
4584 has a lowercase letter where the typed text has an uppercase letter,
4585 and there is a letter before it, the completed part is made uppercase.
4586 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587
4588 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4589'insertmode' 'im' boolean (default off)
4590 global
4591 {not in Vi}
4592 Makes Vim work in a way that Insert mode is the default mode. Useful
4593 if you want to use Vim as a modeless editor. Used for |evim|.
4594 These Insert mode commands will be useful:
4595 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004596 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 this is a mapping, it is executed as if 'insertmode' was off.
4598 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004600 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4601 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
4603 These items change when 'insertmode' is set:
4604 - when starting to edit of a file, Vim goes to Insert mode.
4605 - <Esc> in Insert mode is a no-op and beeps.
4606 - <Esc> in Normal mode makes Vim go to Insert mode.
4607 - CTRL-L in Insert mode is a command, it is not inserted.
4608 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4609 However, when <Esc> is used inside a mapping, it behaves like
4610 'insertmode' was not set. This was done to be able to use the same
4611 mappings with 'insertmode' set or not set.
4612 When executing commands with |:normal| 'insertmode' is not used.
4613
4614 NOTE: This option is reset when 'compatible' is set.
4615
4616 *'isfname'* *'isf'*
4617'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4618 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4619 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4620 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4621 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4622 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4623 global
4624 {not in Vi}
4625 The characters specified by this option are included in file names and
4626 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 Multi-byte characters 256 and above are always included, only the
4629 characters up to 255 are specified with this option.
4630 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004631 Think twice before adding white space to this option. Although a
4632 space may appear inside a file name, the effect will be that Vim
4633 doesn't know where a file name starts or ends when doing completion.
4634 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636 Note that on systems using a backslash as path separator, Vim tries to
4637 do its best to make it work as you would expect. That is a bit
4638 tricky, since Vi originally used the backslash to escape special
4639 characters. Vim will not remove a backslash in front of a normal file
4640 name character on these systems, but it will on Unix and alikes. The
4641 '&' and '^' are not included by default, because these are special for
4642 cmd.exe.
4643
4644 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004645 Each part can be a single character number or a range. A range is two
4646 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 decimal number between 0 and 255 or the ASCII character itself (does
4648 not work for digits). Example:
4649 "_,-,128-140,#-43" (include '_' and '-' and the range
4650 128 to 140 and '#' to 43)
4651 If a part starts with '^', the following character number or range
4652 will be excluded from the option. The option is interpreted from left
4653 to right. Put the excluded character after the range where it is
4654 included. To include '^' itself use it as the last character of the
4655 option or the end of a range. Example:
4656 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4657 If the character is '@', all characters where isalpha() returns TRUE
4658 are included. Normally these are the characters a to z and A to Z,
4659 plus accented characters. To include '@' itself use "@-@". Examples:
4660 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004661 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 "a-z,A-Z,@-@" All letters plus the '@' character.
4663 A comma can be included by using it where a character number is
4664 expected. Example:
4665 "48-57,,,_" Digits, comma and underscore.
4666 A comma can be excluded by prepending a '^'. Example:
4667 " -~,^,,9" All characters from space to '~', excluding
4668 comma, plus <Tab>.
4669 See |option-backslash| about including spaces and backslashes.
4670
4671 *'isident'* *'isi'*
4672'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4673 "@,48-57,_,128-167,224-235"
4674 otherwise: "@,48-57,_,192-255")
4675 global
4676 {not in Vi}
4677 The characters given by this option are included in identifiers.
4678 Identifiers are used in recognizing environment variables and after a
4679 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004680 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 option.
4682 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004683 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4685
4686 *'iskeyword'* *'isk'*
4687'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4688 "@,48-57,_,128-167,224-235"
4689 otherwise: "@,48-57,_,192-255"
4690 Vi default: "@,48-57,_")
4691 local to buffer
4692 {not in Vi}
4693 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004694 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 'isfname' for a description of the format of this option. For C
4696 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4697 For a help file it is set to all non-blank printable characters except
4698 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4699 command).
4700 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004701 This option also influences syntax highlighting, unless the syntax
4702 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 NOTE: This option is set to the Vi default value when 'compatible' is
4704 set and to the Vim default value when 'compatible' is reset.
4705
4706 *'isprint'* *'isp'*
4707'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4708 "@,~-255"; otherwise: "@,161-255")
4709 global
4710 {not in Vi}
4711 The characters given by this option are displayed directly on the
4712 screen. It is also used for "\p" in a |pattern|. The characters from
4713 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4714 even when they are not included in 'isprint' or excluded. See
4715 'isfname' for a description of the format of this option.
4716
4717 Non-printable characters are displayed with two characters:
4718 0 - 31 "^@" - "^_"
4719 32 - 126 always single characters
4720 127 "^?"
4721 128 - 159 "~@" - "~_"
4722 160 - 254 "| " - "|~"
4723 255 "~?"
4724 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4725 displayed as <xx>, with the hexadecimal value of the byte.
4726 When 'display' contains "uhex" all unprintable characters are
4727 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004728 The SpecialKey highlighting will be used for unprintable characters.
4729 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730
4731 Multi-byte characters 256 and above are always included, only the
4732 characters up to 255 are specified with this option. When a character
4733 is printable but it is not available in the current font, a
4734 replacement character will be shown.
4735 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4736 There is no option to specify these characters.
4737
4738 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4739'joinspaces' 'js' boolean (default on)
4740 global
4741 {not in Vi}
4742 Insert two spaces after a '.', '?' and '!' with a join command.
4743 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4744 Otherwise only one space is inserted.
4745 NOTE: This option is set when 'compatible' is set.
4746
4747 *'key'*
4748'key' string (default "")
4749 local to buffer
4750 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004751 {only available when compiled with the |+cryptv|
4752 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004754 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 Careful: Do not set the key value by hand, someone might see the typed
4756 key. Use the |:X| command. But you can make 'key' empty: >
4757 :set key=
4758< It is not possible to get the value of this option with ":set key" or
4759 "echo &key". This is to avoid showing it to someone who shouldn't
4760 know. It also means you cannot see it yourself once you have set it,
4761 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004762 You can use "&key" in an expression to detect whether encryption is
4763 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
4765 *'keymap'* *'kmp'* *E544*
4766'keymap' 'kmp' string (default "")
4767 local to buffer
4768 {not in Vi}
4769 {only available when compiled with the |+keymap|
4770 feature}
4771 Name of a keyboard mapping. See |mbyte-keymap|.
4772 Setting this option to a valid keymap name has the side effect of
4773 setting 'iminsert' to one, so that the keymap becomes effective.
4774 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004775 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776
4777 *'keymodel'* *'km'*
4778'keymodel' 'km' string (default "")
4779 global
4780 {not in Vi}
4781 List of comma separated words, which enable special things that keys
4782 can do. These values can be used:
4783 startsel Using a shifted special key starts selection (either
4784 Select mode or Visual mode, depending on "key" being
4785 present in 'selectmode').
4786 stopsel Using a not-shifted special key stops selection.
4787 Special keys in this context are the cursor keys, <End>, <Home>,
4788 <PageUp> and <PageDown>.
4789 The 'keymodel' option is set by the |:behave| command.
4790
4791 *'keywordprg'* *'kp'*
4792'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004793 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 global or local to buffer |global-local|
4795 {not in Vi}
4796 Program to use for the |K| command. Environment variables are
4797 expanded |:set_env|. ":help" may be used to access the Vim internal
4798 help. (Note that previously setting the global option to the empty
4799 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004800 When the first character is ":", the command is invoked as a Vim
4801 Ex command prefixed with [count].
4802 When "man", "man -s" or an Ex command is used, Vim will automatically
4803 translate a count for the "K" command and pass it as the first
4804 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 See |option-backslash| about including spaces and backslashes.
4806 Example: >
4807 :set keywordprg=man\ -s
4808< This option cannot be set from a |modeline| or in the |sandbox|, for
4809 security reasons.
4810
4811 *'langmap'* *'lmap'* *E357* *E358*
4812'langmap' 'lmap' string (default "")
4813 global
4814 {not in Vi}
4815 {only available when compiled with the |+langmap|
4816 feature}
4817 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004818 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004819 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 care of translating these special characters to the original meaning
4821 of the key. This means you don't have to change the keyboard mode to
4822 be able to execute Normal mode commands.
4823 This is the opposite of the 'keymap' option, where characters are
4824 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004825 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004826 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004827 This option cannot be set from a |modeline| or in the |sandbox|, for
4828 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004830 Example (for Greek, in UTF-8): *greek* >
4831 :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 +00004832< Example (exchanges meaning of z and y for commands): >
4833 :set langmap=zy,yz,ZY,YZ
4834<
4835 The 'langmap' option is a list of parts, separated with commas. Each
4836 part can be in one of two forms:
4837 1. A list of pairs. Each pair is a "from" character immediately
4838 followed by the "to" character. Examples: "aA", "aAbBcC".
4839 2. A list of "from" characters, a semi-colon and a list of "to"
4840 characters. Example: "abc;ABC"
4841 Example: "aA,fgh;FGH,cCdDeE"
4842 Special characters need to be preceded with a backslash. These are
4843 ";", ',' and backslash itself.
4844
4845 This will allow you to activate vim actions without having to switch
4846 back and forth between the languages. Your language characters will
4847 be understood as normal vim English characters (according to the
4848 langmap mappings) in the following cases:
4849 o Normal/Visual mode (commands, buffer/register names, user mappings)
4850 o Insert/Replace Mode: Register names after CTRL-R
4851 o Insert/Replace Mode: Mappings
4852 Characters entered in Command-line mode will NOT be affected by
4853 this option. Note that this option can be changed at any time
4854 allowing to switch between mappings for different languages/encodings.
4855 Use a mapping to avoid having to type it each time!
4856
4857 *'langmenu'* *'lm'*
4858'langmenu' 'lm' string (default "")
4859 global
4860 {not in Vi}
4861 {only available when compiled with the |+menu| and
4862 |+multi_lang| features}
4863 Language to use for menu translation. Tells which file is loaded
4864 from the "lang" directory in 'runtimepath': >
4865 "lang/menu_" . &langmenu . ".vim"
4866< (without the spaces). For example, to always use the Dutch menus, no
4867 matter what $LANG is set to: >
4868 :set langmenu=nl_NL.ISO_8859-1
4869< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004870 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 If your $LANG is set to a non-English language but you do want to use
4872 the English menus: >
4873 :set langmenu=none
4874< This option must be set before loading menus, switching on filetype
4875 detection or syntax highlighting. Once the menus are defined setting
4876 this option has no effect. But you could do this: >
4877 :source $VIMRUNTIME/delmenu.vim
4878 :set langmenu=de_DE.ISO_8859-1
4879 :source $VIMRUNTIME/menu.vim
4880< Warning: This deletes all menus that you defined yourself!
4881
Bram Moolenaard94464e2015-11-02 15:28:18 +01004882 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004883'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004884 global
4885 {not in Vi}
4886 {only available when compiled with the |+langmap|
4887 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004888 This is just like 'langremap' but with the value inverted. It only
4889 exists for backwards compatibility. When setting 'langremap' then
4890 'langnoremap' is set to the inverted value, and the other way around.
4891
4892 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4893'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4894 global
4895 {not in Vi}
4896 {only available when compiled with the |+langmap|
4897 feature}
4898 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004899 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004900 'langmap' disables some of your mappings, try resetting this option.
4901 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004902 that works for you to avoid mappings to break.
4903
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 *'laststatus'* *'ls'*
4905'laststatus' 'ls' number (default 1)
4906 global
4907 {not in Vi}
4908 The value of this option influences when the last window will have a
4909 status line:
4910 0: never
4911 1: only if there are at least two windows
4912 2: always
4913 The screen looks nicer with a status line if you have several
4914 windows, but it takes another screen line. |status-line|
4915
4916 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4917'lazyredraw' 'lz' boolean (default off)
4918 global
4919 {not in Vi}
4920 When this option is set, the screen will not be redrawn while
4921 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004922 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 update use |:redraw|.
4924
4925 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4926'linebreak' 'lbr' boolean (default off)
4927 local to window
4928 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004929 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004931 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 than at the last character that fits on the screen. Unlike
4933 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004934 it only affects the way the file is displayed, not its contents.
4935 If 'breakindent' is set, line is visually indented. Then, the value
4936 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004937 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 Note that <Tab> characters after an <EOL> are mostly not displayed
4939 with the right amount of white space.
4940
4941 *'lines'* *E593*
4942'lines' number (default 24 or terminal height)
4943 global
4944 Number of lines of the Vim window.
4945 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004946 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 When Vim is running in the GUI or in a resizable window, setting this
4948 option will cause the window size to be changed. When you only want
4949 to use the size for the GUI, put the command in your |gvimrc| file.
4950 Vim limits the number of lines to what fits on the screen. You can
4951 use this command to get the tallest window possible: >
4952 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004953< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004954 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955 When you set this option and Vim is unable to change the physical
4956 number of lines of the display, the display may be messed up.
4957
4958 *'linespace'* *'lsp'*
4959'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4960 global
4961 {not in Vi}
4962 {only in the GUI}
4963 Number of pixel lines inserted between characters. Useful if the font
4964 uses the full character cell height, making lines touch each other.
4965 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004966 With some fonts there can be too much room between lines (to have
4967 space for ascents and descents). Then it makes sense to set
4968 'linespace' to a negative value. This may cause display problems
4969 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970
4971 *'lisp'* *'nolisp'*
4972'lisp' boolean (default off)
4973 local to buffer
4974 {not available when compiled without the |+lispindent|
4975 feature}
4976 Lisp mode: When <Enter> is typed in insert mode set the indent for
4977 the next line to Lisp standards (well, sort of). Also happens with
4978 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4979 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4980 better. Also see 'lispwords'.
4981 The '-' character is included in keyword characters. Redefines the
4982 "=" operator to use this same indentation algorithm rather than
4983 calling an external program if 'equalprg' is empty.
4984 This option is not used when 'paste' is set.
4985 {Vi: Does it a little bit differently}
4986
4987 *'lispwords'* *'lw'*
4988'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004989 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 {not in Vi}
4991 {not available when compiled without the |+lispindent|
4992 feature}
4993 Comma separated list of words that influence the Lisp indenting.
4994 |'lisp'|
4995
4996 *'list'* *'nolist'*
4997'list' boolean (default off)
4998 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004999 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5000 line. Useful to see the difference between tabs and spaces and for
5001 trailing blanks. Further changed by the 'listchars' option.
5002
5003 The cursor is displayed at the start of the space a Tab character
5004 occupies, not at the end as usual in Normal mode. To get this cursor
5005 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005006 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005007<
5008 Note that list mode will also affect formatting (set with 'textwidth'
5009 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 changing the way tabs are displayed.
5011
5012 *'listchars'* *'lcs'*
5013'listchars' 'lcs' string (default "eol:$")
5014 global
5015 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005016 Strings to use in 'list' mode and for the |:list| command. It is a
5017 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005018 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 eol:c Character to show at the end of each line. When
5020 omitted, there is no extra character at the end of the
5021 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005022 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005023 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00005025 fill the space that the tab normally occupies.
5026 "tab:>-" will show a tab that takes four spaces as
5027 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005028 *lcs-space*
5029 space:c Character to show for a space. When omitted, spaces
5030 are left blank.
5031 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005032 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005033 trailing spaces are blank. Overrides the "space"
5034 setting for trailing spaces.
5035 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 extends:c Character to show in the last column, when 'wrap' is
5037 off and the line continues beyond the right of the
5038 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005039 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040 precedes:c Character to show in the first column, when 'wrap'
5041 is off and there is text preceding the character
5042 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005043 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005044 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005045 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005046 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005047 nbsp:c Character to show for a non-breakable space character
5048 (0xA0 (160 decimal) and U+202F). Left blank when
5049 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005051 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005053 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054
5055 Examples: >
5056 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005057 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 :set lcs=extends:>,precedes:<
5059< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005060 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005061 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062
5063 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5064'loadplugins' 'lpl' boolean (default on)
5065 global
5066 {not in Vi}
5067 When on the plugin scripts are loaded when starting up |load-plugins|.
5068 This option can be reset in your |vimrc| file to disable the loading
5069 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005070 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5071 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072
Bram Moolenaard94464e2015-11-02 15:28:18 +01005073 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005074'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005075 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005076 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005077 {only available when compiled with the |+lua/dyn|
5078 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005079 Specifies the name of the Lua shared library. The default is
5080 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005081 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005082 This option cannot be set from a |modeline| or in the |sandbox|, for
5083 security reasons.
5084
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005085 *'macatsui'* *'nomacatsui'*
5086'macatsui' boolean (default on)
5087 global
5088 {only available in Mac GUI version}
5089 This is a workaround for when drawing doesn't work properly. When set
5090 and compiled with multi-byte support ATSUI text drawing is used. When
5091 not set ATSUI text drawing is not used. Switch this option off when
5092 you experience drawing problems. In a future version the problems may
5093 be solved and this option becomes obsolete. Therefore use this method
5094 to unset it: >
5095 if exists('&macatsui')
5096 set nomacatsui
5097 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005098< Another option to check if you have drawing problems is
5099 'termencoding'.
5100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 *'magic'* *'nomagic'*
5102'magic' boolean (default on)
5103 global
5104 Changes the special characters that can be used in search patterns.
5105 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005106 WARNING: Switching this option off most likely breaks plugins! That
5107 is because many patterns assume it's on and will fail when it's off.
5108 Only switch it off when working with old Vi scripts. In any other
5109 situation write patterns that work when 'magic' is on. Include "\M"
5110 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111
5112 *'makeef'* *'mef'*
5113'makeef' 'mef' string (default: "")
5114 global
5115 {not in Vi}
5116 {not available when compiled without the |+quickfix|
5117 feature}
5118 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5119 and the |:grep| command.
5120 When it is empty, an internally generated temp file will be used.
5121 When "##" is included, it is replaced by a number to make the name
5122 unique. This makes sure that the ":make" command doesn't overwrite an
5123 existing file.
5124 NOT used for the ":cf" command. See 'errorfile' for that.
5125 Environment variables are expanded |:set_env|.
5126 See |option-backslash| about including spaces and backslashes.
5127 This option cannot be set from a |modeline| or in the |sandbox|, for
5128 security reasons.
5129
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005130 *'makeencoding'* *'menc'*
5131'makeencoding' 'menc' string (default "")
5132 global or local to buffer |global-local|
5133 {only available when compiled with the |+multi_byte|
5134 feature}
5135 {not in Vi}
5136 Encoding used for reading the output of external commands. When empty,
5137 encoding is not converted.
5138 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5139 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5140 and `:laddfile`.
5141
5142 This would be mostly useful when you use MS-Windows and set 'encoding'
5143 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5144 'makeencoding' to "char" has the same effect as setting to the system
5145 locale encoding. Example: >
5146 :set encoding=utf-8
5147 :set makeencoding=char " system locale is used
5148<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 *'makeprg'* *'mp'*
5150'makeprg' 'mp' string (default "make", VMS: "MMS")
5151 global or local to buffer |global-local|
5152 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005153 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005154 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5155 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005156 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005157 Environment variables are expanded |:set_env|. See |option-backslash|
5158 about including spaces and backslashes.
5159 Note that a '|' must be escaped twice: once for ":set" and once for
5160 the interpretation of a command. When you use a filter called
5161 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 :set makeprg=gmake\ \\\|\ myfilter
5163< The placeholder "$*" can be given (even multiple times) to specify
5164 where the arguments will be included, for example: >
5165 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5166< This option cannot be set from a |modeline| or in the |sandbox|, for
5167 security reasons.
5168
5169 *'matchpairs'* *'mps'*
5170'matchpairs' 'mps' string (default "(:),{:},[:]")
5171 local to buffer
5172 {not in Vi}
5173 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005174 other.
5175 Only character pairs are allowed that are different, thus you cannot
5176 jump between two double quotes.
5177 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005178 The pairs must be separated by a comma. Example for including '<' and
5179 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 :set mps+=<:>
5181
5182< A more exotic example, to jump between the '=' and ';' in an
5183 assignment, useful for languages like C and Java: >
5184 :au FileType c,cpp,java set mps+==:;
5185
5186< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005187 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
5189 *'matchtime'* *'mat'*
5190'matchtime' 'mat' number (default 5)
5191 global
5192 {not in Vi}{in Nvi}
5193 Tenths of a second to show the matching paren, when 'showmatch' is
5194 set. Note that this is not in milliseconds, like other options that
5195 set a time. This is to be compatible with Nvi.
5196
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005197 *'maxcombine'* *'mco'*
5198'maxcombine' 'mco' number (default 2)
5199 global
5200 {not in Vi}
5201 {only available when compiled with the |+multi_byte|
5202 feature}
5203 The maximum number of combining characters supported for displaying.
5204 Only used when 'encoding' is "utf-8".
5205 The default is OK for most languages. Hebrew may require 4.
5206 Maximum value is 6.
5207 Even when this option is set to 2 you can still edit text with more
5208 combining characters, you just can't see them. Use |g8| or |ga|.
5209 See |mbyte-combining|.
5210
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 *'maxfuncdepth'* *'mfd'*
5212'maxfuncdepth' 'mfd' number (default 100)
5213 global
5214 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005215 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005216 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 Maximum depth of function calls for user functions. This normally
5218 catches endless recursion. When using a recursive function with
5219 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5220 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005221 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005222 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 See also |:function|.
5224
5225 *'maxmapdepth'* *'mmd'* *E223*
5226'maxmapdepth' 'mmd' number (default 1000)
5227 global
5228 {not in Vi}
5229 Maximum number of times a mapping is done without resulting in a
5230 character to be used. This normally catches endless mappings, like
5231 ":map x y" with ":map y x". It still does not catch ":map g wg",
5232 because the 'w' is used before the next mapping is done. See also
5233 |key-mapping|.
5234
5235 *'maxmem'* *'mm'*
5236'maxmem' 'mm' number (default between 256 to 5120 (system
5237 dependent) or half the amount of memory
5238 available)
5239 global
5240 {not in Vi}
5241 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5242 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005243 other memory to be freed.
5244 The maximum usable value is about 2000000. Use this to work without a
5245 limit.
5246 The value is ignored when 'swapfile' is off.
5247 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005249 *'maxmempattern'* *'mmp'*
5250'maxmempattern' 'mmp' number (default 1000)
5251 global
5252 {not in Vi}
5253 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005254 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005255 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005256 When Vim runs into the limit it gives an error message and mostly
5257 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005258 Running into the limit often means that the pattern is very
5259 inefficient or too complex. This may already happen with the pattern
5260 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005261 Might also happen on redraw, when syntax rules try to match a complex
5262 text structure.
5263 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5264 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005265
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 *'maxmemtot'* *'mmt'*
5267'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5268 dependent) or half the amount of memory
5269 available)
5270 global
5271 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005272 Maximum amount of memory in Kbyte to use for all buffers together.
5273 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005274 without a limit.
5275 On 64 bit machines higher values might work. But hey, do you really
5276 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005277 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005278 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005279 Buffers with 'swapfile' off still count to the total amount of memory
5280 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005281 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282
5283 *'menuitems'* *'mis'*
5284'menuitems' 'mis' number (default 25)
5285 global
5286 {not in Vi}
5287 {not available when compiled without the |+menu|
5288 feature}
5289 Maximum number of items to use in a menu. Used for menus that are
5290 generated from a list of items, e.g., the Buffers menu. Changing this
5291 option has no direct effect, the menu must be refreshed first.
5292
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005293 *'mkspellmem'* *'msm'*
5294'mkspellmem' 'msm' string (default "460000,2000,500")
5295 global
5296 {not in Vi}
5297 {not available when compiled without the |+syntax|
5298 feature}
5299 Parameters for |:mkspell|. This tunes when to start compressing the
5300 word tree. Compression can be slow when there are many words, but
5301 it's needed to avoid running out of memory. The amount of memory used
5302 per word depends very much on how similar the words are, that's why
5303 this tuning is complicated.
5304
5305 There are three numbers, separated by commas:
5306 {start},{inc},{added}
5307
5308 For most languages the uncompressed word tree fits in memory. {start}
5309 gives the amount of memory in Kbyte that can be used before any
5310 compression is done. It should be a bit smaller than the amount of
5311 memory that is available to Vim.
5312
5313 When going over the {start} limit the {inc} number specifies the
5314 amount of memory in Kbyte that can be allocated before another
5315 compression is done. A low number means compression is done after
5316 less words are added, which is slow. A high number means more memory
5317 will be allocated.
5318
5319 After doing compression, {added} times 1024 words can be added before
5320 the {inc} limit is ignored and compression is done when any extra
5321 amount of memory is needed. A low number means there is a smaller
5322 chance of hitting the {inc} limit, less memory is used but it's
5323 slower.
5324
5325 The languages for which these numbers are important are Italian and
5326 Hungarian. The default works for when you have about 512 Mbyte. If
5327 you have 1 Gbyte you could use: >
5328 :set mkspellmem=900000,3000,800
5329< If you have less than 512 Mbyte |:mkspell| may fail for some
5330 languages, no matter what you set 'mkspellmem' to.
5331
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005333'modeline' 'ml' boolean (Vim default: on (off for root),
5334 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 local to buffer
5336 *'modelines'* *'mls'*
5337'modelines' 'mls' number (default 5)
5338 global
5339 {not in Vi}
5340 If 'modeline' is on 'modelines' gives the number of lines that is
5341 checked for set commands. If 'modeline' is off or 'modelines' is zero
5342 no lines are checked. See |modeline|.
5343 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5344 set and to the Vim default value when 'compatible' is reset.
5345
5346 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5347'modifiable' 'ma' boolean (default on)
5348 local to buffer
5349 {not in Vi} *E21*
5350 When off the buffer contents cannot be changed. The 'fileformat' and
5351 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005352 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353
5354 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5355'modified' 'mod' boolean (default off)
5356 local to buffer
5357 {not in Vi}
5358 When on, the buffer is considered to be modified. This option is set
5359 when:
5360 1. A change was made to the text since it was last written. Using the
5361 |undo| command to go back to the original text will reset the
5362 option. But undoing changes that were made before writing the
5363 buffer will set the option again, since the text is different from
5364 when it was written.
5365 2. 'fileformat' or 'fileencoding' is different from its original
5366 value. The original value is set when the buffer is read or
5367 written. A ":set nomodified" command also resets the original
5368 values to the current values and the 'modified' option will be
5369 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005370 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005371 This option is not set when a change is made to the buffer as the
5372 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5373 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5374 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5376 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005377 Note that the text may actually be the same, e.g. 'modified' is set
5378 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380 *'more'* *'nomore'*
5381'more' boolean (Vim default: on, Vi default: off)
5382 global
5383 {not in Vi}
5384 When on, listings pause when the whole screen is filled. You will get
5385 the |more-prompt|. When this option is off there are no pauses, the
5386 listing continues until finished.
5387 NOTE: This option is set to the Vi default value when 'compatible' is
5388 set and to the Vim default value when 'compatible' is reset.
5389
5390 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005391'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5392 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 global
5394 {not in Vi}
5395 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005396 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5397 sysmouse and Linux console with gpm). For using the mouse in the
5398 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005400 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 v Visual mode
5402 i Insert mode
5403 c Command-line mode
5404 h all previous modes when editing a help file
5405 a all previous modes
5406 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 Normally you would enable the mouse in all four modes with: >
5408 :set mouse=a
5409< When the mouse is not enabled, the GUI will still use the mouse for
5410 modeless selection. This doesn't move the text cursor.
5411
5412 See |mouse-using|. Also see |'clipboard'|.
5413
5414 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005415 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 the mouse buttons can still be used by keeping the shift key pressed.
5417 Also see the 'clipboard' option.
5418
5419 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5420'mousefocus' 'mousef' boolean (default off)
5421 global
5422 {not in Vi}
5423 {only works in the GUI}
5424 The window that the mouse pointer is on is automatically activated.
5425 When changing the window layout or window focus in another way, the
5426 mouse pointer is moved to the window with keyboard focus. Off is the
5427 default because it makes using the pull down menus a little goofy, as
5428 a pointer transit may activate a window unintentionally.
5429
5430 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5431'mousehide' 'mh' boolean (default on)
5432 global
5433 {not in Vi}
5434 {only works in the GUI}
5435 When on, the mouse pointer is hidden when characters are typed.
5436 The mouse pointer is restored when the mouse is moved.
5437
5438 *'mousemodel'* *'mousem'*
5439'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5440 global
5441 {not in Vi}
5442 Sets the model to use for the mouse. The name mostly specifies what
5443 the right mouse button is used for:
5444 extend Right mouse button extends a selection. This works
5445 like in an xterm.
5446 popup Right mouse button pops up a menu. The shifted left
5447 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005448 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 popup_setpos Like "popup", but the cursor will be moved to the
5450 position where the mouse was clicked, and thus the
5451 selected operation will act upon the clicked object.
5452 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005453 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 course, that right clicking outside a selection will
5455 end Visual mode.
5456 Overview of what button does what for each model:
5457 mouse extend popup(_setpos) ~
5458 left click place cursor place cursor
5459 left drag start selection start selection
5460 shift-left search word extend selection
5461 right click extend selection popup menu (place cursor)
5462 right drag extend selection -
5463 middle click paste paste
5464
5465 In the "popup" model the right mouse button produces a pop-up menu.
5466 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005467 In a terminal the popup menu works if Vim is compiled with the
5468 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
5470 Note that you can further refine the meaning of buttons with mappings.
5471 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5472 selection (because that's handled in the GUI code directly).
5473
5474 The 'mousemodel' option is set by the |:behave| command.
5475
5476 *'mouseshape'* *'mouses'* *E547*
5477'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005478 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 global
5480 {not in Vi}
5481 {only available when compiled with the |+mouseshape|
5482 feature}
5483 This option tells Vim what the mouse pointer should look like in
5484 different modes. The option is a comma separated list of parts, much
5485 like used for 'guicursor'. Each part consist of a mode/location-list
5486 and an argument-list:
5487 mode-list:shape,mode-list:shape,..
5488 The mode-list is a dash separated list of these modes/locations:
5489 In a normal window: ~
5490 n Normal mode
5491 v Visual mode
5492 ve Visual mode with 'selection' "exclusive" (same as 'v',
5493 if not specified)
5494 o Operator-pending mode
5495 i Insert mode
5496 r Replace mode
5497
5498 Others: ~
5499 c appending to the command-line
5500 ci inserting in the command-line
5501 cr replacing in the command-line
5502 m at the 'Hit ENTER' or 'More' prompts
5503 ml idem, but cursor in the last line
5504 e any mode, pointer below last window
5505 s any mode, pointer on a status line
5506 sd any mode, while dragging a status line
5507 vs any mode, pointer on a vertical separator line
5508 vd any mode, while dragging a vertical separator line
5509 a everywhere
5510
5511 The shape is one of the following:
5512 avail name looks like ~
5513 w x arrow Normal mouse pointer
5514 w x blank no pointer at all (use with care!)
5515 w x beam I-beam
5516 w x updown up-down sizing arrows
5517 w x leftright left-right sizing arrows
5518 w x busy The system's usual busy pointer
5519 w x no The system's usual 'no input' pointer
5520 x udsizing indicates up-down resizing
5521 x lrsizing indicates left-right resizing
5522 x crosshair like a big thin +
5523 x hand1 black hand
5524 x hand2 white hand
5525 x pencil what you write with
5526 x question big ?
5527 x rightup-arrow arrow pointing right-up
5528 w x up-arrow arrow pointing up
5529 x <number> any X11 pointer number (see X11/cursorfont.h)
5530
5531 The "avail" column contains a 'w' if the shape is available for Win32,
5532 x for X11.
5533 Any modes not specified or shapes not available use the normal mouse
5534 pointer.
5535
5536 Example: >
5537 :set mouseshape=s:udsizing,m:no
5538< will make the mouse turn to a sizing arrow over the status lines and
5539 indicate no input when the hit-enter prompt is displayed (since
5540 clicking the mouse has no effect in this state.)
5541
5542 *'mousetime'* *'mouset'*
5543'mousetime' 'mouset' number (default 500)
5544 global
5545 {not in Vi}
5546 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5547 time in msec between two mouse clicks for the second click to be
5548 recognized as a multi click.
5549
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005550 *'mzschemedll'*
5551'mzschemedll' string (default depends on the build)
5552 global
5553 {not in Vi}
5554 {only available when compiled with the |+mzscheme/dyn|
5555 feature}
5556 Specifies the name of the MzScheme shared library. The default is
5557 DYNAMIC_MZSCH_DLL which was specified at compile time.
5558 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005559 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005560 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005561 This option cannot be set from a |modeline| or in the |sandbox|, for
5562 security reasons.
5563
5564 *'mzschemegcdll'*
5565'mzschemegcdll' string (default depends on the build)
5566 global
5567 {not in Vi}
5568 {only available when compiled with the |+mzscheme/dyn|
5569 feature}
5570 Specifies the name of the MzScheme GC shared library. The default is
5571 DYNAMIC_MZGC_DLL which was specified at compile time.
5572 The value can be equal to 'mzschemedll' if it includes the GC code.
5573 Environment variables are expanded |:set_env|.
5574 This option cannot be set from a |modeline| or in the |sandbox|, for
5575 security reasons.
5576
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005577 *'mzquantum'* *'mzq'*
5578'mzquantum' 'mzq' number (default 100)
5579 global
5580 {not in Vi}
5581 {not available when compiled without the |+mzscheme|
5582 feature}
5583 The number of milliseconds between polls for MzScheme threads.
5584 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005585 NOTE: This option is set to the Vim default value when 'compatible'
5586 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005587
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005589'nrformats' 'nf' string (default "bin,octal,hex",
5590 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 local to buffer
5592 {not in Vi}
5593 This defines what bases Vim will consider for numbers when using the
5594 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5595 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005596 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005598 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005599 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005601 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 considered to be hexadecimal. Example: Using CTRL-X on
5603 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005604 bin If included, numbers starting with "0b" or "0B" will be
5605 considered to be binary. Example: Using CTRL-X on
5606 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 Numbers which simply begin with a digit in the range 1-9 are always
5608 considered decimal. This also happens for numbers that are not
5609 recognized as octal or hex.
5610
5611 *'number'* *'nu'* *'nonumber'* *'nonu'*
5612'number' 'nu' boolean (default off)
5613 local to window
5614 Print the line number in front of each line. When the 'n' option is
5615 excluded from 'cpoptions' a wrapped line will not use the column of
5616 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005617 The 'numberwidth' option can be used to set the room used for the line
5618 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 When a long, wrapped line doesn't start with the first character, '-'
5620 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005621 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5622 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005623 *number_relativenumber*
5624 The 'relativenumber' option changes the displayed number to be
5625 relative to the cursor. Together with 'number' there are these
5626 four combinations (cursor in line 3):
5627
Bram Moolenaar3848e002016-03-19 18:42:29 +01005628 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005629 'nornu' 'nornu' 'rnu' 'rnu'
5630
5631 |apple | 1 apple | 2 apple | 2 apple
5632 |pear | 2 pear | 1 pear | 1 pear
5633 |nobody | 3 nobody | 0 nobody |3 nobody
5634 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005636 *'numberwidth'* *'nuw'*
5637'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5638 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005639 {not in Vi}
5640 {only available when compiled with the |+linebreak|
5641 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005642 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005643 when the 'number' or 'relativenumber' option is set or printing lines
5644 with a line number. Since one space is always between the number and
5645 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005646 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005647 fit the highest line number in the buffer respectively the number of
5648 rows in the window, depending on whether 'number' or 'relativenumber'
5649 is set. Thus with the Vim default of 4 there is room for a line number
5650 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005651 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005652 NOTE: This option is set to the Vi default value when 'compatible' is
5653 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005654
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005655 *'omnifunc'* *'ofu'*
5656'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005657 local to buffer
5658 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005659 {not available when compiled without the |+eval|
5660 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005661 This option specifies a function to be used for Insert mode omni
5662 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005663 See |complete-functions| for an explanation of how the function is
5664 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005665 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005666 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005667 This option cannot be set from a |modeline| or in the |sandbox|, for
5668 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005669
5670
Bram Moolenaar02467872007-05-06 13:22:01 +00005671 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005672'opendevice' 'odev' boolean (default off)
5673 global
5674 {not in Vi}
5675 {only for MS-DOS, MS-Windows and OS/2}
5676 Enable reading and writing from devices. This may get Vim stuck on a
5677 device that can be opened but doesn't actually do the I/O. Therefore
5678 it is off by default.
5679 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5680 result in editing a device.
5681
5682
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005683 *'operatorfunc'* *'opfunc'*
5684'operatorfunc' 'opfunc' string (default: empty)
5685 global
5686 {not in Vi}
5687 This option specifies a function to be called by the |g@| operator.
5688 See |:map-operator| for more info and an example.
5689
5690 This option cannot be set from a |modeline| or in the |sandbox|, for
5691 security reasons.
5692
5693
Bram Moolenaar251e1912011-06-19 05:09:16 +02005694 *'osfiletype'* *'oft'*
5695'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 local to buffer
5697 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005698 This option was supported on RISC OS, which has been removed.
5699
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005701 *'packpath'* *'pp'*
5702'packpath' 'pp' string (default: see 'runtimepath')
5703 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005704 Directories used to find packages. See |packages|.
5705
5706
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005708'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 global
5710 Specifies the nroff macros that separate paragraphs. These are pairs
5711 of two letters (see |object-motions|).
5712
5713 *'paste'* *'nopaste'*
5714'paste' boolean (default off)
5715 global
5716 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005717 Put Vim in Paste mode. This is useful if you want to cut or copy
5718 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 unexpected effects.
5720 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 knows about pasting and will mostly do the right thing without 'paste'
5723 being set. The same is true for a terminal where Vim handles the
5724 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005725 This option is reset when starting the GUI. Thus if you set it in
5726 your .vimrc it will work in a terminal, but not in the GUI. Setting
5727 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5728 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 When the 'paste' option is switched on (also when it was already on):
5730 - mapping in Insert mode and Command-line mode is disabled
5731 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005733 - 'expandtab' is reset
5734 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 - 'revins' is reset
5736 - 'ruler' is reset
5737 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005738 - 'smartindent' is reset
5739 - 'smarttab' is reset
5740 - 'softtabstop' is set to 0
5741 - 'textwidth' is set to 0
5742 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005745 - 'indentexpr'
5746 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 NOTE: When you start editing another file while the 'paste' option is
5748 on, settings from the modelines or autocommands may change the
5749 settings again, causing trouble when pasting text. You might want to
5750 set the 'paste' option again.
5751 When the 'paste' option is reset the mentioned options are restored to
5752 the value before the moment 'paste' was switched from off to on.
5753 Resetting 'paste' before ever setting it does not have any effect.
5754 Since mapping doesn't work while 'paste' is active, you need to use
5755 the 'pastetoggle' option to toggle the 'paste' option with some key.
5756
5757 *'pastetoggle'* *'pt'*
5758'pastetoggle' 'pt' string (default "")
5759 global
5760 {not in Vi}
5761 When non-empty, specifies the key sequence that toggles the 'paste'
5762 option. This is like specifying a mapping: >
5763 :map {keys} :set invpaste<CR>
5764< Where {keys} is the value of 'pastetoggle'.
5765 The difference is that it will work even when 'paste' is set.
5766 'pastetoggle' works in Insert mode and Normal mode, but not in
5767 Command-line mode.
5768 Mappings are checked first, thus overrule 'pastetoggle'. However,
5769 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5770 this: >
5771 :map <F10> :set paste<CR>
5772 :map <F11> :set nopaste<CR>
5773 :imap <F10> <C-O>:set paste<CR>
5774 :imap <F11> <nop>
5775 :set pastetoggle=<F11>
5776< This will make <F10> start paste mode and <F11> stop paste mode.
5777 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5778 mode everything is inserted literally, except the 'pastetoggle' key
5779 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005780 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781
5782 *'pex'* *'patchexpr'*
5783'patchexpr' 'pex' string (default "")
5784 global
5785 {not in Vi}
5786 {not available when compiled without the |+diff|
5787 feature}
5788 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005789 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790
Bram Moolenaardbc28022014-07-26 13:40:44 +02005791 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005792'patchmode' 'pm' string (default "")
5793 global
5794 {not in Vi}
5795 When non-empty the oldest version of a file is kept. This can be used
5796 to keep the original version of a file if you are changing files in a
5797 source distribution. Only the first time that a file is written a
5798 copy of the original file will be kept. The name of the copy is the
5799 name of the original file with the string in the 'patchmode' option
5800 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005801 ".orig" or ".org". 'backupdir' must not be empty for this to work
5802 (Detail: The backup file is renamed to the patchmode file after the
5803 new file has been successfully written, that's why it must be possible
5804 to write a backup file). If there was no file to be backed up, an
5805 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 When the 'backupskip' pattern matches, a patchmode file is not made.
5807 Using 'patchmode' for compressed files appends the extension at the
5808 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5809 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005810 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005812 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813'path' 'pa' string (default on Unix: ".,/usr/include,,"
5814 on OS/2: ".,/emx/include,,"
5815 other systems: ".,,")
5816 global or local to buffer |global-local|
5817 {not in Vi}
5818 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005819 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5820 provided that the file being searched for has a relative path (not
5821 starting with "/", "./" or "../"). The directories in the 'path'
5822 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 - Use commas to separate directory names: >
5824 :set path=.,/usr/local/include,/usr/include
5825< - Spaces can also be used to separate directory names (for backwards
5826 compatibility with version 3.0). To have a space in a directory
5827 name, precede it with an extra backslash, and escape the space: >
5828 :set path=.,/dir/with\\\ space
5829< - To include a comma in a directory name precede it with an extra
5830 backslash: >
5831 :set path=.,/dir/with\\,comma
5832< - To search relative to the directory of the current file, use: >
5833 :set path=.
5834< - To search in the current directory use an empty string between two
5835 commas: >
5836 :set path=,,
5837< - A directory name may end in a ':' or '/'.
5838 - Environment variables are expanded |:set_env|.
5839 - When using |netrw.vim| URLs can be used. For example, adding
5840 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005841 - Search upwards and downwards in a directory tree using "*", "**" and
5842 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 {not available when compiled without the |+path_extra| feature}
5844 - Careful with '\' characters, type two to get one in the option: >
5845 :set path=.,c:\\include
5846< Or just use '/' instead: >
5847 :set path=.,c:/include
5848< Don't forget "." or files won't even be found in the same directory as
5849 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005850 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 it is something like 256 or 1024 characters.
5852 You can check if all the include files are found, using the value of
5853 'path', see |:checkpath|.
5854 The use of |:set+=| and |:set-=| is preferred when adding or removing
5855 directories from the list. This avoids problems when a future version
5856 uses another default. To remove the current directory use: >
5857 :set path-=
5858< To add the current directory use: >
5859 :set path+=
5860< To use an environment variable, you probably need to replace the
5861 separator. Here is an example to append $INCL, in which directory
5862 names are separated with a semi-colon: >
5863 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5864< Replace the ';' with a ':' or whatever separator is used. Note that
5865 this doesn't work when $INCL contains a comma or white space.
5866
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005867 *'perldll'*
5868'perldll' string (default depends on the build)
5869 global
5870 {not in Vi}
5871 {only available when compiled with the |+perl/dyn|
5872 feature}
5873 Specifies the name of the Perl shared library. The default is
5874 DYNAMIC_PERL_DLL, which was specified at compile time.
5875 Environment variables are expanded |:set_env|.
5876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5880'preserveindent' 'pi' boolean (default off)
5881 local to buffer
5882 {not in Vi}
5883 When changing the indent of the current line, preserve as much of the
5884 indent structure as possible. Normally the indent is replaced by a
5885 series of tabs followed by spaces as required (unless |'expandtab'| is
5886 enabled, in which case only spaces are used). Enabling this option
5887 means the indent will preserve as many existing characters as possible
5888 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005889 'expandtab' does not apply to the preserved white space, a Tab remains
5890 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005891 NOTE: When using ">>" multiple times the resulting indent is a mix of
5892 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005893 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 Also see 'copyindent'.
5895 Use |:retab| to clean up white space.
5896
5897 *'previewheight'* *'pvh'*
5898'previewheight' 'pvh' number (default 12)
5899 global
5900 {not in Vi}
5901 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005902 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 Default height for a preview window. Used for |:ptag| and associated
5904 commands. Used for |CTRL-W_}| when no count is given.
5905
5906 *'previewwindow'* *'nopreviewwindow'*
5907 *'pvw'* *'nopvw'* *E590*
5908'previewwindow' 'pvw' boolean (default off)
5909 local to window
5910 {not in Vi}
5911 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005912 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005913 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 set. It's normally not set directly, but by using one of the commands
5915 |:ptag|, |:pedit|, etc.
5916
5917 *'printdevice'* *'pdev'*
5918'printdevice' 'pdev' string (default empty)
5919 global
5920 {not in Vi}
5921 {only available when compiled with the |+printer|
5922 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005923 The name of the printer to be used for |:hardcopy|.
5924 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005925 This option cannot be set from a |modeline| or in the |sandbox|, for
5926 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927
Bram Moolenaar8299df92004-07-10 09:47:34 +00005928 *'printencoding'* *'penc'*
5929'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 global
5931 {not in Vi}
5932 {only available when compiled with the |+printer|
5933 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005934 Sets the character encoding used when printing.
5935 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936
5937 *'printexpr'* *'pexpr'*
5938'printexpr' 'pexpr' String (default: see below)
5939 global
5940 {not in Vi}
5941 {only available when compiled with the |+printer|
5942 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005943 Expression used to print the PostScript produced with |:hardcopy|.
5944 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005945 This option cannot be set from a |modeline| or in the |sandbox|, for
5946 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947
Bram Moolenaar8299df92004-07-10 09:47:34 +00005948 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949'printfont' 'pfn' string (default "courier")
5950 global
5951 {not in Vi}
5952 {only available when compiled with the |+printer|
5953 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005954 The name of the font that will be used for |:hardcopy|.
5955 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956
5957 *'printheader'* *'pheader'*
5958'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5959 global
5960 {not in Vi}
5961 {only available when compiled with the |+printer|
5962 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005963 The format of the header produced in |:hardcopy| output.
5964 See |pheader-option|.
5965
5966 *'printmbcharset'* *'pmbcs'*
5967'printmbcharset' 'pmbcs' string (default "")
5968 global
5969 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005970 {only available when compiled with the |+printer|,
5971 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005972 The CJK character set to be used for CJK output from |:hardcopy|.
5973 See |pmbcs-option|.
5974
5975 *'printmbfont'* *'pmbfn'*
5976'printmbfont' 'pmbfn' string (default "")
5977 global
5978 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005979 {only available when compiled with the |+printer|,
5980 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005981 List of font names to be used for CJK output from |:hardcopy|.
5982 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983
5984 *'printoptions'* *'popt'*
5985'printoptions' 'popt' string (default "")
5986 global
5987 {not in Vi}
5988 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005989 List of items that control the format of the output of |:hardcopy|.
5990 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005992 *'prompt'* *'noprompt'*
5993'prompt' boolean (default on)
5994 global
5995 When on a ":" prompt is used in Ex mode.
5996
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005997 *'pumheight'* *'ph'*
5998'pumheight' 'ph' number (default 0)
5999 global
6000 {not available when compiled without the
6001 |+insert_expand| feature}
6002 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006003 Determines the maximum number of items to show in the popup menu for
6004 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006005 |ins-completion-menu|.
6006
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006007 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006008'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006009 global
6010 {not available when compiled without the
6011 |+insert_expand| feature}
6012 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006013 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006014 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006015
Bram Moolenaard94464e2015-11-02 15:28:18 +01006016 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006017'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006018 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006019 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006020 {only available when compiled with the |+python/dyn|
6021 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006022 Specifies the name of the Python 2.x shared library. The default is
6023 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006024 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006025 This option cannot be set from a |modeline| or in the |sandbox|, for
6026 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006027
Bram Moolenaar94073162018-01-31 21:49:05 +01006028 *'pythonhome'*
6029'pythonhome' string (default "")
6030 global
6031 {not in Vi}
6032 {only available when compiled with the |+python/dyn|
6033 feature}
6034 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6035 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6036 which was specified at compile time, will be used for the Python 2.x
6037 home directory.
6038 Environment variables are expanded |:set_env|.
6039 This option cannot be set from a |modeline| or in the |sandbox|, for
6040 security reasons.
6041
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006042 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006043'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006044 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006045 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006046 {only available when compiled with the |+python3/dyn|
6047 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006048 Specifies the name of the Python 3 shared library. The default is
6049 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006050 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006051 This option cannot be set from a |modeline| or in the |sandbox|, for
6052 security reasons.
6053
Bram Moolenaar94073162018-01-31 21:49:05 +01006054 *'pythonthreehome'*
6055'pythonthreehome' string (default "")
6056 global
6057 {not in Vi}
6058 {only available when compiled with the |+python3/dyn|
6059 feature}
6060 Specifies the name of the Python 3 home directory. When
6061 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6062 PYTHON3_HOME, which was specified at compile time, will be used for
6063 the Python 3 home directory.
6064 Environment variables are expanded |:set_env|.
6065 This option cannot be set from a |modeline| or in the |sandbox|, for
6066 security reasons.
6067
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006068 *'pyxversion'* *'pyx'*
6069'pyxversion' 'pyx' number (default depends on the build)
6070 global
6071 {not in Vi}
6072 {only available when compiled with the |+python| or
6073 the |+python3| feature}
6074 Specifies the python version used for pyx* functions and commands
6075 |python_x|. The default value is as follows:
6076
6077 Compiled with Default ~
6078 |+python| and |+python3| 0
6079 only |+python| 2
6080 only |+python3| 3
6081
6082 Available values are 0, 2 and 3.
6083 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6084 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6085 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6086 to 2 if Python 2 is available.
6087 See also: |has-pythonx|
6088
6089 If Vim is compiled with only |+python| or |+python3| setting
6090 'pyxversion' has no effect. The pyx* functions and commands are
6091 always the same as the compiled version.
6092
6093 This option cannot be set from a |modeline| or in the |sandbox|, for
6094 security reasons.
6095
Bram Moolenaar677ee682005-01-27 14:41:15 +00006096 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006097'quoteescape' 'qe' string (default "\")
6098 local to buffer
6099 {not in Vi}
6100 The characters that are used to escape quotes in a string. Used for
6101 objects like a', a" and a` |a'|.
6102 When one of the characters in this option is found inside a string,
6103 the following character will be skipped. The default value makes the
6104 text "foo\"bar\\" considered to be one string.
6105
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6107'readonly' 'ro' boolean (default off)
6108 local to buffer
6109 If on, writes fail unless you use a '!'. Protects you from
6110 accidentally overwriting a file. Default on when Vim is started
6111 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006112 When using ":w!" the 'readonly' option is reset for the current
6113 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006115 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006116 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006118 *'redrawtime'* *'rdt'*
6119'redrawtime' 'rdt' number (default 2000)
6120 global
6121 {not in Vi}
6122 {only available when compiled with the |+reltime|
6123 feature}
6124 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006125 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006126 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006127 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006128 matches will be highlighted.
6129 For syntax highlighting the time applies per window. When over the
6130 limit syntax highlighting is disabled until |CTRL-L| is used.
6131 This is used to avoid that Vim hangs when using a very complicated
6132 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006133
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006134 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006135'regexpengine' 're' number (default 0)
6136 global
6137 {not in Vi}
6138 This selects the default regexp engine. |two-engines|
6139 The possible values are:
6140 0 automatic selection
6141 1 old engine
6142 2 NFA engine
6143 Note that when using the NFA engine and the pattern contains something
6144 that is not supported the pattern will not match. This is only useful
6145 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006146 Using automatic selection enables Vim to switch the engine, if the
6147 default engine becomes too costly. E.g., when the NFA engine uses too
6148 many states. This should prevent Vim from hanging on a combination of
6149 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006150
Bram Moolenaar64486672010-05-16 15:46:46 +02006151 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6152'relativenumber' 'rnu' boolean (default off)
6153 local to window
6154 {not in Vi}
6155 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006156 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006157 precede some vertical motion commands (e.g. j k + -) with, without
6158 having to calculate it yourself. Especially useful in combination with
6159 other commands (e.g. y d c < > gq gw =).
6160 When the 'n' option is excluded from 'cpoptions' a wrapped
6161 line will not use the column of line numbers (this is the default when
6162 'compatible' isn't set).
6163 The 'numberwidth' option can be used to set the room used for the line
6164 number.
6165 When a long, wrapped line doesn't start with the first character, '-'
6166 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006167 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6168 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006169
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006170 The number in front of the cursor line also depends on the value of
6171 'number', see |number_relativenumber| for all combinations of the two
6172 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006173
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 *'remap'* *'noremap'*
6175'remap' boolean (default on)
6176 global
6177 Allows for mappings to work recursively. If you do not want this for
6178 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006179 NOTE: To avoid portability problems with Vim scripts, always keep
6180 this option at the default "on". Only switch it off when working with
6181 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006183 *'renderoptions'* *'rop'*
6184'renderoptions' 'rop' string (default: empty)
6185 global
6186 {not in Vi}
6187 {only available when compiled with GUI and DIRECTX on
6188 MS-Windows}
6189 Select a text renderer and set its options. The options depend on the
6190 renderer.
6191
6192 Syntax: >
6193 set rop=type:{renderer}(,{name}:{value})*
6194<
6195 Currently, only one optional renderer is available.
6196
6197 render behavior ~
6198 directx Vim will draw text using DirectX (DirectWrite). It makes
6199 drawn glyphs more beautiful than default GDI.
6200 It requires 'encoding' is "utf-8", and only works on
6201 MS-Windows Vista or newer version.
6202
6203 Options:
6204 name meaning type value ~
6205 gamma gamma float 1.0 - 2.2 (maybe)
6206 contrast enhancedContrast float (unknown)
6207 level clearTypeLevel float (unknown)
6208 geom pixelGeometry int 0 - 2 (see below)
6209 renmode renderingMode int 0 - 6 (see below)
6210 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006211 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006212
Bram Moolenaar92467d32017-12-05 13:22:16 +01006213 See this URL for detail (except for scrlines):
6214 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006215
6216 For geom: structure of a device pixel.
6217 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6218 1 - DWRITE_PIXEL_GEOMETRY_RGB
6219 2 - DWRITE_PIXEL_GEOMETRY_BGR
6220
6221 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006222 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006223
6224 For renmode: method of rendering glyphs.
6225 0 - DWRITE_RENDERING_MODE_DEFAULT
6226 1 - DWRITE_RENDERING_MODE_ALIASED
6227 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6228 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6229 4 - DWRITE_RENDERING_MODE_NATURAL
6230 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6231 6 - DWRITE_RENDERING_MODE_OUTLINE
6232
6233 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006234 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006235
6236 For taamode: antialiasing mode used for drawing text.
6237 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6238 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6239 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6240 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6241
6242 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006243 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6244
Bram Moolenaara338adc2018-01-31 20:51:47 +01006245 For scrlines:
6246 This was used for optimizing scrolling behavior, however this
6247 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006248
6249 Example: >
6250 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006251 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006252 set rop=type:directx
6253<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006254 If select a raster font (Courier, Terminal or FixedSys which
6255 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006256 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006257
6258 NOTE: It is known that some fonts and options combination
6259 causes trouble on drawing glyphs.
6260
Bram Moolenaar92467d32017-12-05 13:22:16 +01006261 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006262 special made fonts (True-Type fonts which includes only
6263 bitmap glyphs).
6264 - 'taamode:3' will not work with some vector fonts.
6265
6266 NOTE: With this option, you can display colored emoji
6267 (emoticon) in Windows 8.1 or later. To display colored emoji,
6268 there are some conditions which you should notice.
6269
6270 - If your font includes non-colored emoji already, it will
6271 be used.
6272 - If your font doesn't have emoji, the system chooses an
6273 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6274 will be used.
6275 - When this alternative font didn't have fixed width glyph,
6276 emoji might be rendered beyond the bounding box of drawing
6277 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006278
6279 Other render types are currently not supported.
6280
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 *'report'*
6282'report' number (default 2)
6283 global
6284 Threshold for reporting number of lines changed. When the number of
6285 changed lines is more than 'report' a message will be given for most
6286 ":" commands. If you want it always, set 'report' to 0.
6287 For the ":substitute" command the number of substitutions is used
6288 instead of the number of lines.
6289
6290 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6291'restorescreen' 'rs' boolean (default on)
6292 global
6293 {not in Vi} {only in Windows 95/NT console version}
6294 When set, the screen contents is restored when exiting Vim. This also
6295 happens when executing external commands.
6296
6297 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6298 options in your .vimrc. To disable restoring:
6299 set t_ti= t_te=
6300 To enable restoring (for an xterm):
6301 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6302 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6303
6304 *'revins'* *'ri'* *'norevins'* *'nori'*
6305'revins' 'ri' boolean (default off)
6306 global
6307 {not in Vi}
6308 {only available when compiled with the |+rightleft|
6309 feature}
6310 Inserting characters in Insert mode will work backwards. See "typing
6311 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6312 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006313 NOTE: This option is reset when 'compatible' is set.
6314 This option is reset when 'paste' is set and restored when 'paste' is
6315 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316
6317 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6318'rightleft' 'rl' boolean (default off)
6319 local to window
6320 {not in Vi}
6321 {only available when compiled with the |+rightleft|
6322 feature}
6323 When on, display orientation becomes right-to-left, i.e., characters
6324 that are stored in the file appear from the right to the left.
6325 Using this option, it is possible to edit files for languages that
6326 are written from the right to the left such as Hebrew and Arabic.
6327 This option is per window, so it is possible to edit mixed files
6328 simultaneously, or to view the same file in both ways (this is
6329 useful whenever you have a mixed text file with both right-to-left
6330 and left-to-right strings so that both sets are displayed properly
6331 in different windows). Also see |rileft.txt|.
6332
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006333 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334'rightleftcmd' 'rlc' string (default "search")
6335 local to window
6336 {not in Vi}
6337 {only available when compiled with the |+rightleft|
6338 feature}
6339 Each word in this option enables the command line editing to work in
6340 right-to-left mode for a group of commands:
6341
6342 search "/" and "?" commands
6343
6344 This is useful for languages such as Hebrew, Arabic and Farsi.
6345 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6346
Bram Moolenaard94464e2015-11-02 15:28:18 +01006347 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006348'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006349 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006350 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006351 {only available when compiled with the |+ruby/dyn|
6352 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006353 Specifies the name of the Ruby shared library. The default is
6354 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006355 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006356 This option cannot be set from a |modeline| or in the |sandbox|, for
6357 security reasons.
6358
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006360'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 global
6362 {not in Vi}
6363 {not available when compiled without the
6364 |+cmdline_info| feature}
6365 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006366 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 text in the file is shown on the far right:
6368 Top first line is visible
6369 Bot last line is visible
6370 All first and last line are visible
6371 45% relative position in the file
6372 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006373 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006375 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 this option takes precedence over 'ruler' and 'rulerformat'
6377 If the number of characters displayed is different from the number of
6378 bytes in the text (e.g., for a TAB or a multi-byte character), both
6379 the text column (byte number) and the screen column are shown,
6380 separated with a dash.
6381 For an empty line "0-1" is shown.
6382 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006383 This option is reset when 'paste' is set and restored when 'paste' is
6384 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 If you don't want to see the ruler all the time but want to know where
6386 you are, use "g CTRL-G" |g_CTRL-G|.
6387 NOTE: This option is reset when 'compatible' is set.
6388
6389 *'rulerformat'* *'ruf'*
6390'rulerformat' 'ruf' string (default empty)
6391 global
6392 {not in Vi}
6393 {not available when compiled without the |+statusline|
6394 feature}
6395 When this option is not empty, it determines the content of the ruler
6396 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006397 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 The default ruler width is 17 characters. To make the ruler 15
6399 characters wide, put "%15(" at the start and "%)" at the end.
6400 Example: >
6401 :set rulerformat=%15(%c%V\ %p%%%)
6402<
6403 *'runtimepath'* *'rtp'* *vimfiles*
6404'runtimepath' 'rtp' string (default:
6405 Unix: "$HOME/.vim,
6406 $VIM/vimfiles,
6407 $VIMRUNTIME,
6408 $VIM/vimfiles/after,
6409 $HOME/.vim/after"
6410 Amiga: "home:vimfiles,
6411 $VIM/vimfiles,
6412 $VIMRUNTIME,
6413 $VIM/vimfiles/after,
6414 home:vimfiles/after"
6415 PC, OS/2: "$HOME/vimfiles,
6416 $VIM/vimfiles,
6417 $VIMRUNTIME,
6418 $VIM/vimfiles/after,
6419 $HOME/vimfiles/after"
6420 Macintosh: "$VIM:vimfiles,
6421 $VIMRUNTIME,
6422 $VIM:vimfiles:after"
6423 RISC-OS: "Choices:vimfiles,
6424 $VIMRUNTIME,
6425 Choices:vimfiles/after"
6426 VMS: "sys$login:vimfiles,
6427 $VIM/vimfiles,
6428 $VIMRUNTIME,
6429 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006430 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 global
6432 {not in Vi}
6433 This is a list of directories which will be searched for runtime
6434 files:
6435 filetype.vim filetypes by file name |new-filetype|
6436 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006437 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 colors/ color scheme files |:colorscheme|
6439 compiler/ compiler files |:compiler|
6440 doc/ documentation |write-local-help|
6441 ftplugin/ filetype plugins |write-filetype-plugin|
6442 indent/ indent scripts |indent-expression|
6443 keymap/ key mapping files |mbyte-keymap|
6444 lang/ menu translations |:menutrans|
6445 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006446 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 plugin/ plugin scripts |write-plugin|
6448 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006449 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 syntax/ syntax files |mysyntaxfile|
6451 tutor/ files for vimtutor |tutor|
6452
6453 And any other file searched for with the |:runtime| command.
6454
6455 The defaults for most systems are setup to search five locations:
6456 1. In your home directory, for your personal preferences.
6457 2. In a system-wide Vim directory, for preferences from the system
6458 administrator.
6459 3. In $VIMRUNTIME, for files distributed with Vim.
6460 *after-directory*
6461 4. In the "after" directory in the system-wide Vim directory. This is
6462 for the system administrator to overrule or add to the distributed
6463 defaults (rarely needed)
6464 5. In the "after" directory in your home directory. This is for
6465 personal preferences to overrule or add to the distributed defaults
6466 or system-wide settings (rarely needed).
6467
Bram Moolenaard0796902016-09-16 20:02:31 +02006468 More entries are added when using |packages|. If it gets very long
6469 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6470 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006471
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6473 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 wildcards.
6476 See |:runtime|.
6477 Example: >
6478 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6479< This will use the directory "~/vimruntime" first (containing your
6480 personal Vim runtime files), then "/mygroup/vim" (shared between a
6481 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6482 files).
6483 You probably should always include $VIMRUNTIME somewhere, to use the
6484 distributed runtime files. You can put a directory before $VIMRUNTIME
6485 to find files which replace a distributed runtime files. You can put
6486 a directory after $VIMRUNTIME to find files which add to distributed
6487 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006488 When Vim is started with |--clean| the home directory entries are not
6489 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 This option cannot be set from a |modeline| or in the |sandbox|, for
6491 security reasons.
6492
6493 *'scroll'* *'scr'*
6494'scroll' 'scr' number (default: half the window height)
6495 local to window
6496 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6497 set to half the number of lines in the window when the window size
6498 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006499 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6501 the number of screen lines instead of file lines, makes a difference
6502 when lines wrap}
6503
6504 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6505'scrollbind' 'scb' boolean (default off)
6506 local to window
6507 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 See also |scroll-binding|. When this option is set, the current
6509 window scrolls as other scrollbind windows (windows that also have
6510 this option set) scroll. This option is useful for viewing the
6511 differences between two versions of a file, see 'diff'.
6512 See |'scrollopt'| for options that determine how this option should be
6513 interpreted.
6514 This option is mostly reset when splitting a window to edit another
6515 file. This means that ":split | edit file" results in two windows
6516 with scroll-binding, but ":split file" does not.
6517
6518 *'scrolljump'* *'sj'*
6519'scrolljump' 'sj' number (default 1)
6520 global
6521 {not in Vi}
6522 Minimal number of lines to scroll when the cursor gets off the
6523 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6524 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006525 When set to a negative number from -1 to -100 this is used as the
6526 percentage of the window height. Thus -50 scrolls half the window
6527 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 NOTE: This option is set to 1 when 'compatible' is set.
6529
6530 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006531'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 global
6533 {not in Vi}
6534 Minimal number of screen lines to keep above and below the cursor.
6535 This will make some context visible around where you are working. If
6536 you set it to a very large value (999) the cursor line will always be
6537 in the middle of the window (except at the start or end of the file or
6538 when long lines wrap).
6539 For scrolling horizontally see 'sidescrolloff'.
6540 NOTE: This option is set to 0 when 'compatible' is set.
6541
6542 *'scrollopt'* *'sbo'*
6543'scrollopt' 'sbo' string (default "ver,jump")
6544 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 {not in Vi}
6546 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006547 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6548 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 The following words are available:
6550 ver Bind vertical scrolling for 'scrollbind' windows
6551 hor Bind horizontal scrolling for 'scrollbind' windows
6552 jump Applies to the offset between two windows for vertical
6553 scrolling. This offset is the difference in the first
6554 displayed line of the bound windows. When moving
6555 around in a window, another 'scrollbind' window may
6556 reach a position before the start or after the end of
6557 the buffer. The offset is not changed though, when
6558 moving back the 'scrollbind' window will try to scroll
6559 to the desired position when possible.
6560 When now making that window the current one, two
6561 things can be done with the relative offset:
6562 1. When "jump" is not included, the relative offset is
6563 adjusted for the scroll position in the new current
6564 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006565 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 2. When "jump" is included, the other windows are
6567 scrolled to keep the same relative offset. When
6568 going back to the other window, it still uses the
6569 same relative offset.
6570 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006571 When 'diff' mode is active there always is vertical scroll binding,
6572 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573
6574 *'sections'* *'sect'*
6575'sections' 'sect' string (default "SHNHH HUnhsh")
6576 global
6577 Specifies the nroff macros that separate sections. These are pairs of
6578 two letters (See |object-motions|). The default makes a section start
6579 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6580
6581 *'secure'* *'nosecure'* *E523*
6582'secure' boolean (default off)
6583 global
6584 {not in Vi}
6585 When on, ":autocmd", shell and write commands are not allowed in
6586 ".vimrc" and ".exrc" in the current directory and map commands are
6587 displayed. Switch it off only if you know that you will not run into
6588 problems, or when the 'exrc' option is off. On Unix this option is
6589 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006590 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 'secure' at the end of your ~/.vimrc then.
6592 This option cannot be set from a |modeline| or in the |sandbox|, for
6593 security reasons.
6594
6595 *'selection'* *'sel'*
6596'selection' 'sel' string (default "inclusive")
6597 global
6598 {not in Vi}
6599 This option defines the behavior of the selection. It is only used
6600 in Visual and Select mode.
6601 Possible values:
6602 value past line inclusive ~
6603 old no yes
6604 inclusive yes yes
6605 exclusive yes no
6606 "past line" means that the cursor is allowed to be positioned one
6607 character past the line.
6608 "inclusive" means that the last character of the selection is included
6609 in an operation. For example, when "x" is used to delete the
6610 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006611 When "old" is used and 'virtualedit' allows the cursor to move past
6612 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 Note that when "exclusive" is used and selecting from the end
6614 backwards, you cannot include the last character of a line, when
6615 starting in Normal mode and 'virtualedit' empty.
6616
6617 The 'selection' option is set by the |:behave| command.
6618
6619 *'selectmode'* *'slm'*
6620'selectmode' 'slm' string (default "")
6621 global
6622 {not in Vi}
6623 This is a comma separated list of words, which specifies when to start
6624 Select mode instead of Visual mode, when a selection is started.
6625 Possible values:
6626 mouse when using the mouse
6627 key when using shifted special keys
6628 cmd when using "v", "V" or CTRL-V
6629 See |Select-mode|.
6630 The 'selectmode' option is set by the |:behave| command.
6631
6632 *'sessionoptions'* *'ssop'*
6633'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006634 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 global
6636 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006637 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 feature}
6639 Changes the effect of the |:mksession| command. It is a comma
6640 separated list of words. Each word enables saving and restoring
6641 something:
6642 word save and restore ~
6643 blank empty windows
6644 buffers hidden and unloaded buffers, not just those in windows
6645 curdir the current directory
6646 folds manually created folds, opened/closed folds and local
6647 fold options
6648 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006649 and contain at least one lowercase letter. Only
6650 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 help the help window
6652 localoptions options and mappings local to a window or buffer (not
6653 global values for local options)
6654 options all options and mappings (also global values for local
6655 options)
6656 resize size of the Vim window: 'lines' and 'columns'
6657 sesdir the directory in which the session file is located
6658 will become the current directory (useful with
6659 projects accessed over a network from different
6660 systems)
6661 slash backslashes in file names replaced with forward
6662 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006663 tabpages all tab pages; without this only the current tab page
6664 is restored, so that you can make a session for each
6665 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006666 terminal include terminal windows where the command can be
6667 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 unix with Unix end-of-line format (single <NL>), even when
6669 on Windows or DOS
6670 winpos position of the whole Vim window
6671 winsize window sizes
6672
6673 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006674 When neither "curdir" nor "sesdir" is included, file names are stored
6675 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 "slash" and "unix" are useful on Windows when sharing session files
6677 with Unix. The Unix version of Vim cannot source dos format scripts,
6678 but the Windows version of Vim can source unix format scripts.
6679
6680 *'shell'* *'sh'* *E91*
6681'shell' 'sh' string (default $SHELL or "sh",
6682 MS-DOS and Win32: "command.com" or
6683 "cmd.exe", OS/2: "cmd")
6684 global
6685 Name of the shell to use for ! and :! commands. When changing the
6686 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6687 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006688 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 See |option-backslash| about including spaces and backslashes.
6690 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006691
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006693 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6695< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006696 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006697 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006698 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006700 Example with escaped space (Vim will do this when initializing the
6701 option from $SHELL): >
6702 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006703< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006704 backslashes are consumed by `:set`.
6705
Bram Moolenaar071d4272004-06-13 20:20:40 +00006706 Under MS-Windows, when the executable ends in ".com" it must be
6707 included. Thus setting the shell to "command.com" or "4dos.com"
6708 works, but "command" and "4dos" do not work for all commands (e.g.,
6709 filtering).
6710 For unknown reasons, when using "4dos.com" the current directory is
6711 changed to "C:\". To avoid this set 'shell' like this: >
6712 :set shell=command.com\ /c\ 4dos
6713< This option cannot be set from a |modeline| or in the |sandbox|, for
6714 security reasons.
6715
6716 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006717'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006718 MS-DOS and Win32, when 'shell' does not
6719 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 global
6721 {not in Vi}
6722 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6723 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6724 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006725 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006726 On Unix it can have more than one flag. Each white space separated
6727 part is passed as an argument to the shell command.
6728 See |option-backslash| about including spaces and backslashes.
6729 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 This option cannot be set from a |modeline| or in the |sandbox|, for
6731 security reasons.
6732
6733 *'shellpipe'* *'sp'*
6734'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6735 global
6736 {not in Vi}
6737 {not available when compiled without the |+quickfix|
6738 feature}
6739 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006740 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 including spaces and backslashes.
6742 The name of the temporary file can be represented by "%s" if necessary
6743 (the file name is appended automatically if no %s appears in the value
6744 of this option).
6745 For the Amiga and MS-DOS the default is ">". The output is directly
6746 saved in a file and not echoed to the screen.
6747 For Unix the default it "| tee". The stdout of the compiler is saved
6748 in a file and echoed to the screen. If the 'shell' option is "csh" or
6749 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006750 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6751 default becomes "2>&1| tee". This means that stderr is also included.
6752 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6753 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 The initialization of this option is done after reading the ".vimrc"
6755 and the other initializations, so that when the 'shell' option is set
6756 there, the 'shellpipe' option changes automatically, unless it was
6757 explicitly set before.
6758 When 'shellpipe' is set to an empty string, no redirection of the
6759 ":make" output will be done. This is useful if you use a 'makeprg'
6760 that writes to 'makeef' by itself. If you want no piping, but do
6761 want to include the 'makeef', set 'shellpipe' to a single space.
6762 Don't forget to precede the space with a backslash: ":set sp=\ ".
6763 In the future pipes may be used for filtering and this option will
6764 become obsolete (at least for Unix).
6765 This option cannot be set from a |modeline| or in the |sandbox|, for
6766 security reasons.
6767
6768 *'shellquote'* *'shq'*
6769'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6770 contains "sh" somewhere: "\"")
6771 global
6772 {not in Vi}
6773 Quoting character(s), put around the command passed to the shell, for
6774 the "!" and ":!" commands. The redirection is kept outside of the
6775 quoting. See 'shellxquote' to include the redirection. It's
6776 probably not useful to set both options.
6777 This is an empty string by default. Only known to be useful for
6778 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6779 or bash, where it should be "\"". The default is adjusted according
6780 the value of 'shell', to reduce the need to set this option by the
6781 user. See |dos-shell|.
6782 This option cannot be set from a |modeline| or in the |sandbox|, for
6783 security reasons.
6784
6785 *'shellredir'* *'srr'*
6786'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6787 global
6788 {not in Vi}
6789 String to be used to put the output of a filter command in a temporary
6790 file. See also |:!|. See |option-backslash| about including spaces
6791 and backslashes.
6792 The name of the temporary file can be represented by "%s" if necessary
6793 (the file name is appended automatically if no %s appears in the value
6794 of this option).
6795 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6796 or "zsh" during initializations, the default becomes ">&". If the
6797 'shell' option is "sh", "ksh" or "bash" the default becomes
6798 ">%s 2>&1". This means that stderr is also included.
6799 For Win32, the Unix checks are done and additionally "cmd" is checked
6800 for, which makes the default ">%s 2>&1". Also, the same names with
6801 ".exe" appended are checked for.
6802 The initialization of this option is done after reading the ".vimrc"
6803 and the other initializations, so that when the 'shell' option is set
6804 there, the 'shellredir' option changes automatically unless it was
6805 explicitly set before.
6806 In the future pipes may be used for filtering and this option will
6807 become obsolete (at least for Unix).
6808 This option cannot be set from a |modeline| or in the |sandbox|, for
6809 security reasons.
6810
6811 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6812'shellslash' 'ssl' boolean (default off)
6813 global
6814 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6815 When set, a forward slash is used when expanding file names. This is
6816 useful when a Unix-like shell is used instead of command.com or
6817 cmd.exe. Backward slashes can still be typed, but they are changed to
6818 forward slashes by Vim.
6819 Note that setting or resetting this option has no effect for some
6820 existing file names, thus this option needs to be set before opening
6821 any file for best results. This might change in the future.
6822 'shellslash' only works when a backslash can be used as a path
6823 separator. To test if this is so use: >
6824 if exists('+shellslash')
6825<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006826 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6827'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6828 global
6829 {not in Vi}
6830 When on, use temp files for shell commands. When off use a pipe.
6831 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006832 Currently a pipe is only supported on Unix and MS-Windows 2K and
6833 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006834 :if has("filterpipe")
6835< The advantage of using a pipe is that nobody can read the temp file
6836 and the 'shell' command does not need to support redirection.
6837 The advantage of using a temp file is that the file type and encoding
6838 can be detected.
6839 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6840 |FilterWritePost| autocommands event are not triggered when
6841 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006842 The `system()` function does not respect this option and always uses
6843 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006844 NOTE: This option is set to the Vim default value when 'compatible'
6845 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006846
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 *'shelltype'* *'st'*
6848'shelltype' 'st' number (default 0)
6849 global
6850 {not in Vi} {only for the Amiga}
6851 On the Amiga this option influences the way how the commands work
6852 which use a shell.
6853 0 and 1: always use the shell
6854 2 and 3: use the shell only to filter lines
6855 4 and 5: use shell only for ':sh' command
6856 When not using the shell, the command is executed directly.
6857
6858 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6859 1 and 3: use "shell cmd" to start external commands
6860
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006861 *'shellxescape'* *'sxe'*
6862'shellxescape' 'sxe' string (default: "";
6863 for MS-DOS and MS-Windows: "\"&|<>()@^")
6864 global
6865 {not in Vi}
6866 When 'shellxquote' is set to "(" then the characters listed in this
6867 option will be escaped with a '^' character. This makes it possible
6868 to execute most external commands with cmd.exe.
6869
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 *'shellxquote'* *'sxq'*
6871'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006872 for Win32, when 'shell' is cmd.exe: "("
6873 for Win32, when 'shell' contains "sh"
6874 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 for Unix, when using system(): "\"")
6876 global
6877 {not in Vi}
6878 Quoting character(s), put around the command passed to the shell, for
6879 the "!" and ":!" commands. Includes the redirection. See
6880 'shellquote' to exclude the redirection. It's probably not useful
6881 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006882 When the value is '(' then ')' is appended. When the value is '"('
6883 then ')"' is appended.
6884 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006885 This is an empty string by default on most systems, but is known to be
6886 useful for on Win32 version, either for cmd.exe which automatically
6887 strips off the first and last quote on a command, or 3rd-party shells
6888 such as the MKS Korn Shell or bash, where it should be "\"". The
6889 default is adjusted according the value of 'shell', to reduce the need
6890 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 This option cannot be set from a |modeline| or in the |sandbox|, for
6892 security reasons.
6893
6894 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6895'shiftround' 'sr' boolean (default off)
6896 global
6897 {not in Vi}
6898 Round indent to multiple of 'shiftwidth'. Applies to > and <
6899 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6900 a multiple of 'shiftwidth' (this is Vi compatible).
6901 NOTE: This option is reset when 'compatible' is set.
6902
6903 *'shiftwidth'* *'sw'*
6904'shiftwidth' 'sw' number (default 8)
6905 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006906 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006908 When zero the 'ts' value will be used. Use the |shiftwidth()|
6909 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910
6911 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006912'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6913 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 global
6915 {not in Vi}
6916 This option helps to avoid all the |hit-enter| prompts caused by file
6917 messages, for example with CTRL-G, and to avoid some other messages.
6918 It is a list of flags:
6919 flag meaning when present ~
6920 f use "(3 of 5)" instead of "(file 3 of 5)"
6921 i use "[noeol]" instead of "[Incomplete last line]"
6922 l use "999L, 888C" instead of "999 lines, 888 characters"
6923 m use "[+]" instead of "[Modified]"
6924 n use "[New]" instead of "[New File]"
6925 r use "[RO]" instead of "[readonly]"
6926 w use "[w]" instead of "written" for file write message
6927 and "[a]" instead of "appended" for ':w >> file' command
6928 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6929 "[unix format]" and "[mac]" instead of "[mac format]".
6930 a all of the above abbreviations
6931
6932 o overwrite message for writing a file with subsequent message
6933 for reading a file (useful for ":wn" or when 'autowrite' on)
6934 O message for reading a file overwrites any previous message.
6935 Also for quickfix message (e.g., ":cn").
6936 s don't give "search hit BOTTOM, continuing at TOP" or "search
6937 hit TOP, continuing at BOTTOM" messages
6938 t truncate file message at the start if it is too long to fit
6939 on the command-line, "<" will appear in the left most column.
6940 Ignored in Ex mode.
6941 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006942 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 Ignored in Ex mode.
6944 W don't give "written" or "[w]" when writing a file
6945 A don't give the "ATTENTION" message when an existing swap file
6946 is found.
6947 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006948 c don't give |ins-completion-menu| messages. For example,
6949 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6950 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006951 q use "recording" instead of "recording @a"
6952 F don't give the file info when editing a file, like `:silent`
6953 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954
6955 This gives you the opportunity to avoid that a change between buffers
6956 requires you to hit <Enter>, but still gives as useful a message as
6957 possible for the space available. To get the whole message that you
6958 would have got with 'shm' empty, use ":file!"
6959 Useful values:
6960 shm= No abbreviation of message.
6961 shm=a Abbreviation, but no loss of information.
6962 shm=at Abbreviation, and truncate message when necessary.
6963
6964 NOTE: This option is set to the Vi default value when 'compatible' is
6965 set and to the Vim default value when 'compatible' is reset.
6966
6967 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6968'shortname' 'sn' boolean (default off)
6969 local to buffer
6970 {not in Vi, not in MS-DOS versions}
6971 Filenames are assumed to be 8 characters plus one extension of 3
6972 characters. Multiple dots in file names are not allowed. When this
6973 option is on, dots in file names are replaced with underscores when
6974 adding an extension (".~" or ".swp"). This option is not available
6975 for MS-DOS, because then it would always be on. This option is useful
6976 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6977 or crossdos. When running the Win32 GUI version under Win32s, this
6978 option is always on by default.
6979
6980 *'showbreak'* *'sbr'* *E595*
6981'showbreak' 'sbr' string (default "")
6982 global
6983 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006984 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 feature}
6986 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006987 values are "> " or "+++ ": >
6988 :set showbreak=>\
6989< Note the backslash to escape the trailing space. It's easier like
6990 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006991 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006992< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 comma (in a future version the comma might be used to separate the
6994 part that is shown at the end and at the start of a line).
6995 The characters are highlighted according to the '@' flag in
6996 'highlight'.
6997 Note that tabs after the showbreak will be displayed differently.
6998 If you want the 'showbreak' to appear in between line numbers, add the
6999 "n" flag to 'cpoptions'.
7000
7001 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007002'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7003 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 global
7005 {not in Vi}
7006 {not available when compiled without the
7007 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007008 Show (partial) command in the last line of the screen. Set this
7009 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010 In Visual mode the size of the selected area is shown:
7011 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007012 If the number of bytes is different it is also displayed: "2-6"
7013 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007015 - When selecting a block, the size in screen characters:
7016 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 NOTE: This option is set to the Vi default value when 'compatible' is
7018 set and to the Vim default value when 'compatible' is reset.
7019
7020 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7021'showfulltag' 'sft' boolean (default off)
7022 global
7023 {not in Vi}
7024 When completing a word in insert mode (see |ins-completion|) from the
7025 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007026 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 matched a C function, you can see a template for what arguments are
7028 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007029 Note that this doesn't work well together with having "longest" in
7030 'completeopt', because the completion from the search pattern may not
7031 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032
7033 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7034'showmatch' 'sm' boolean (default off)
7035 global
7036 When a bracket is inserted, briefly jump to the matching one. The
7037 jump is only done if the match can be seen on the screen. The time to
7038 show the match can be set with 'matchtime'.
7039 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007040 seen or not).
7041 This option is reset when 'paste' is set and restored when 'paste' is
7042 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 When the 'm' flag is not included in 'cpoptions', typing a character
7044 will immediately move the cursor back to where it belongs.
7045 See the "sm" field in 'guicursor' for setting the cursor shape and
7046 blinking when showing the match.
7047 The 'matchpairs' option can be used to specify the characters to show
7048 matches for. 'rightleft' and 'revins' are used to look for opposite
7049 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007050 Also see the matchparen plugin for highlighting the match when moving
7051 around |pi_paren.txt|.
7052 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053
7054 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7055'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7056 global
7057 If in Insert, Replace or Visual mode put a message on the last line.
7058 Use the 'M' flag in 'highlight' to set the type of highlighting for
7059 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007060 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 doesn't mean XIM is really active, especially when 'imactivatekey' is
7062 not set.
7063 NOTE: This option is set to the Vi default value when 'compatible' is
7064 set and to the Vim default value when 'compatible' is reset.
7065
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007066 *'showtabline'* *'stal'*
7067'showtabline' 'stal' number (default 1)
7068 global
7069 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007070 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007071 feature}
7072 The value of this option specifies when the line with tab page labels
7073 will be displayed:
7074 0: never
7075 1: only if there are at least two tab pages
7076 2: always
7077 This is both for the GUI and non-GUI implementation of the tab pages
7078 line.
7079 See |tab-page| for more information about tab pages.
7080
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 *'sidescroll'* *'ss'*
7082'sidescroll' 'ss' number (default 0)
7083 global
7084 {not in Vi}
7085 The minimal number of columns to scroll horizontally. Used only when
7086 the 'wrap' option is off and the cursor is moved off of the screen.
7087 When it is zero the cursor will be put in the middle of the screen.
7088 When using a slow terminal set it to a large number or 0. When using
7089 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7090 commands.
7091
7092 *'sidescrolloff'* *'siso'*
7093'sidescrolloff' 'siso' number (default 0)
7094 global
7095 {not in Vi}
7096 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007097 right of the cursor if 'nowrap' is set. Setting this option to a
7098 value greater than 0 while having |'sidescroll'| also at a non-zero
7099 value makes some context visible in the line you are scrolling in
7100 horizontally (except at beginning of the line). Setting this option
7101 to a large value (like 999) has the effect of keeping the cursor
7102 horizontally centered in the window, as long as one does not come too
7103 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 NOTE: This option is set to 0 when 'compatible' is set.
7105
7106 Example: Try this together with 'sidescroll' and 'listchars' as
7107 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007108 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109
7110 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7111 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007112<
7113 *'signcolumn'* *'scl'*
7114'signcolumn' 'scl' string (default "auto")
7115 local to window
7116 {not in Vi}
7117 {not available when compiled without the |+signs|
7118 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007119 Whether or not to draw the signcolumn. Valid values are:
7120 "auto" only when there is a sign to display
7121 "no" never
7122 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123
7124
7125 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7126'smartcase' 'scs' boolean (default off)
7127 global
7128 {not in Vi}
7129 Override the 'ignorecase' option if the search pattern contains upper
7130 case characters. Only used when the search pattern is typed and
7131 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007132 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7134 recalling the search pattern from history and hitting <Enter>.
7135 NOTE: This option is reset when 'compatible' is set.
7136
7137 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7138'smartindent' 'si' boolean (default off)
7139 local to buffer
7140 {not in Vi}
7141 {not available when compiled without the
7142 |+smartindent| feature}
7143 Do smart autoindenting when starting a new line. Works for C-like
7144 programs, but can also be used for other languages. 'cindent' does
7145 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007146 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007147 setting 'si' has no effect. 'indentexpr' is a more advanced
7148 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 Normally 'autoindent' should also be on when using 'smartindent'.
7150 An indent is automatically inserted:
7151 - After a line ending in '{'.
7152 - After a line starting with a keyword from 'cinwords'.
7153 - Before a line starting with '}' (only with the "O" command).
7154 When typing '}' as the first character in a new line, that line is
7155 given the same indent as the matching '{'.
7156 When typing '#' as the first character in a new line, the indent for
7157 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007158 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7160 When using the ">>" command, lines starting with '#' are not shifted
7161 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007162 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007163 This option is reset when 'paste' is set and restored when 'paste' is
7164 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165
7166 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7167'smarttab' 'sta' boolean (default off)
7168 global
7169 {not in Vi}
7170 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007171 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7172 <BS> will delete a 'shiftwidth' worth of space at the start of the
7173 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007174 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007175 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7176 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007177 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007179 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007180 This option is reset when 'paste' is set and restored when 'paste' is
7181 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 NOTE: This option is reset when 'compatible' is set.
7183
7184 *'softtabstop'* *'sts'*
7185'softtabstop' 'sts' number (default 0)
7186 local to buffer
7187 {not in Vi}
7188 Number of spaces that a <Tab> counts for while performing editing
7189 operations, like inserting a <Tab> or using <BS>. It "feels" like
7190 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7191 used. This is useful to keep the 'ts' setting at its standard value
7192 of 8, while being able to edit like it is set to 'sts'. However,
7193 commands like "x" still work on the actual characters.
7194 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007195 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007196 'softtabstop' is set to 0 when the 'paste' option is set and restored
7197 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7199 spaces is minimized by using <Tab>s.
7200 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7201 set.
7202 NOTE: This option is set to 0 when 'compatible' is set.
7203
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007204 If Vim is compiled with the |+vartabs| feature then the value of
7205 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7206 anything other than an empty string.
7207
Bram Moolenaar217ad922005-03-20 22:37:15 +00007208 *'spell'* *'nospell'*
7209'spell' boolean (default off)
7210 local to window
7211 {not in Vi}
7212 {not available when compiled without the |+syntax|
7213 feature}
7214 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007215 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007216
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007217 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007218'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007219 local to buffer
7220 {not in Vi}
7221 {not available when compiled without the |+syntax|
7222 feature}
7223 Pattern to locate the end of a sentence. The following word will be
7224 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007225 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007226 When this check is not wanted make this option empty.
7227 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007228 Be careful with special characters, see |option-backslash| about
7229 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007230 To set this option automatically depending on the language, see
7231 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007232
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007233 *'spellfile'* *'spf'*
7234'spellfile' 'spf' string (default empty)
7235 local to buffer
7236 {not in Vi}
7237 {not available when compiled without the |+syntax|
7238 feature}
7239 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007240 commands. It must end in ".{encoding}.add". You need to include the
7241 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007242 *E765*
7243 It may also be a comma separated list of names. A count before the
7244 |zg| and |zw| commands can be used to access each. This allows using
7245 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007246 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007247 you: Using the first directory in 'runtimepath' that is writable. If
7248 there is no "spell" directory yet it will be created. For the file
7249 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007250 ignoring the region.
7251 The resulting ".spl" file will be used for spell checking, it does not
7252 have to appear in 'spelllang'.
7253 Normally one file is used for all regions, but you can add the region
7254 name if you want to. However, it will then only be used when
7255 'spellfile' is set to it, for entries in 'spelllang' only files
7256 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007257 This option cannot be set from a |modeline| or in the |sandbox|, for
7258 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007259
Bram Moolenaar217ad922005-03-20 22:37:15 +00007260 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007261'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007262 local to buffer
7263 {not in Vi}
7264 {not available when compiled without the |+syntax|
7265 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007266 A comma separated list of word list names. When the 'spell' option is
7267 on spellchecking will be done for these languages. Example: >
7268 set spelllang=en_us,nl,medical
7269< This means US English, Dutch and medical words are recognized. Words
7270 that are not recognized will be highlighted.
7271 The word list name must not include a comma or dot. Using a dash is
7272 recommended to separate the two letter language name from a
7273 specification. Thus "en-rare" is used for rare English words.
7274 A region name must come last and have the form "_xx", where "xx" is
7275 the two-letter, lower case region name. You can use more than one
7276 region by listing them: "en_us,en_ca" supports both US and Canadian
7277 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007278 Britain. (Note: currently en_au and en_nz dictionaries are older than
7279 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007280 If the name "cjk" is included East Asian characters are excluded from
7281 spell checking. This is useful when editing text that also has Asian
7282 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007283 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007284 As a special case the name of a .spl file can be given as-is. The
7285 first "_xx" in the name is removed and used as the region name
7286 (_xx is an underscore, two letters and followed by a non-letter).
7287 This is mainly for testing purposes. You must make sure the correct
7288 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007289 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007290 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7291 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007292 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007293
Bram Moolenaar98692072006-02-04 00:57:42 +00007294 If the |spellfile.vim| plugin is active and you use a language name
7295 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7296 will ask you if you want to download the file.
7297
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007298 After this option has been set successfully, Vim will source the files
7299 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007300 up to the first comma, dot or underscore.
7301 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007302
7303
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007304 *'spellsuggest'* *'sps'*
7305'spellsuggest' 'sps' string (default "best")
7306 global
7307 {not in Vi}
7308 {not available when compiled without the |+syntax|
7309 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007310 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007311 the |spellsuggest()| function. This is a comma-separated list of
7312 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007313
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007314 best Internal method that works best for English. Finds
7315 changes like "fast" and uses a bit of sound-a-like
7316 scoring to improve the ordering.
7317
7318 double Internal method that uses two methods and mixes the
7319 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007320 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007321 word. That only works when the language specifies
7322 sound folding. Can be slow and doesn't always give
7323 better results.
7324
7325 fast Internal method that only checks for simple changes:
7326 character inserts/deletes/swaps. Works well for
7327 simple typing mistakes.
7328
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007329 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007330 Not used for |spellsuggest()|. The number of
7331 suggestions is never more than the value of 'lines'
7332 minus two.
7333
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007334 file:{filename} Read file {filename}, which must have two columns,
7335 separated by a slash. The first column contains the
7336 bad word, the second column the suggested good word.
7337 Example:
7338 theribal/terrible ~
7339 Use this for common mistakes that do not appear at the
7340 top of the suggestion list with the internal methods.
7341 Lines without a slash are ignored, use this for
7342 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007343 The word in the second column must be correct,
7344 otherwise it will not be used. Add the word to an
7345 ".add" file if it is currently flagged as a spelling
7346 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007347 The file is used for all languages.
7348
7349 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7350 trouble with spaces. |v:val| holds the badly spelled
7351 word. The expression must evaluate to a List of
7352 Lists, each with a suggestion and a score.
7353 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007354 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007355 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007356 internal methods use. A lower score is better.
7357 This may invoke |spellsuggest()| if you temporarily
7358 set 'spellsuggest' to exclude the "expr:" part.
7359 Errors are silently ignored, unless you set the
7360 'verbose' option to a non-zero value.
7361
7362 Only one of "best", "double" or "fast" may be used. The others may
7363 appear several times in any order. Example: >
7364 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7365<
7366 This option cannot be set from a |modeline| or in the |sandbox|, for
7367 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007368
7369
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7371'splitbelow' 'sb' boolean (default off)
7372 global
7373 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007374 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 feature}
7376 When on, splitting a window will put the new window below the current
7377 one. |:split|
7378
7379 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7380'splitright' 'spr' boolean (default off)
7381 global
7382 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007383 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 feature}
7385 When on, splitting a window will put the new window right of the
7386 current one. |:vsplit|
7387
7388 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7389'startofline' 'sol' boolean (default on)
7390 global
7391 {not in Vi}
7392 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007393 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007395 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 with a linewise operator, with "%" with a count and to buffer changing
7397 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7398 only has a line number, e.g., ":25" or ":+".
7399 In case of buffer changing commands the cursor is placed at the column
7400 where it was the last time the buffer was edited.
7401 NOTE: This option is set when 'compatible' is set.
7402
Bram Moolenaar00654022011-02-25 14:42:19 +01007403 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007405 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406 {not in Vi}
7407 {not available when compiled without the |+statusline|
7408 feature}
7409 When nonempty, this option determines the content of the status line.
7410 Also see |status-line|.
7411
7412 The option consists of printf style '%' items interspersed with
7413 normal text. Each status line item is of the form:
7414 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007415 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007416 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417
Bram Moolenaar238a5642006-02-21 22:12:05 +00007418 When the option starts with "%!" then it is used as an expression,
7419 evaluated and the result is used as the option value. Example: >
7420 :set statusline=%!MyStatusLine()
7421< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007422 Note that the "%!" expression is evaluated in the context of the
7423 current window and buffer, while %{} items are evaluated in the
7424 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007425
7426 When there is error while evaluating the option then it will be made
7427 empty to avoid further errors. Otherwise screen updating would loop.
7428
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 Note that the only effect of 'ruler' when this option is set (and
7430 'laststatus' is 2) is controlling the output of |CTRL-G|.
7431
7432 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007433 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007435 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 minwid Minimum width of the item, padding as set by '-' & '0'.
7437 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007438 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 on the left for text items. Numeric items will be
7440 shifted down to maxwid-2 digits followed by '>'number
7441 where number is the amount of missing digits, much like
7442 an exponential notation.
7443 item A one letter code as described below.
7444
7445 Following is a description of the possible statusline items. The
7446 second character in "item" is the type:
7447 N for number
7448 S for string
7449 F for flags as described below
7450 - not applicable
7451
7452 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007453 f S Path to the file in the buffer, as typed or relative to current
7454 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 F S Full path to the file in the buffer.
7456 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007457 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007459 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007461 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007463 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007465 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007466 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007467 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7469 being used: "<keymap>"
7470 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007471 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 B N As above, in hexadecimal.
7473 o N Byte number in file of byte under cursor, first byte is 1.
7474 Mnemonic: Offset from start of file (with one added)
7475 {not available when compiled without |+byte_offset| feature}
7476 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007477 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 l N Line number.
7479 L N Number of lines in buffer.
7480 c N Column number.
7481 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007482 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 p N Percentage through file in lines as in |CTRL-G|.
7484 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007485 percentage described for 'ruler'. Always 3 in length, unless
7486 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007487 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007489 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007490 Note that there is no '%' before the closing '}'. The
7491 expression cannot contain a '}' character, call a function to
7492 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 ( - Start of item group. Can be used for setting the width and
7494 alignment of a section. Must be followed by %) somewhere.
7495 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007496 T N For 'tabline': start of tab page N label. Use %T after the last
7497 label. This information is used for mouse clicks.
7498 X N For 'tabline': start of close tab N label. Use %X after the
7499 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7500 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 < - Where to truncate line if too long. Default is at the start.
7502 No width fields allowed.
7503 = - Separation point between left and right aligned items.
7504 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007505 # - Set highlight group. The name must follow and then a # again.
7506 Thus use %#HLname# for highlight group HLname. The same
7507 highlighting is used, also for the statusline of non-current
7508 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007510 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 The difference between User{N} and StatusLine will be applied
7512 to StatusLineNC for the statusline of non-current windows.
7513 The number N must be between 1 and 9. See |hl-User1..9|
7514
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007515 When displaying a flag, Vim removes the leading comma, if any, when
7516 that flag comes right after plaintext. This will make a nice display
7517 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518
Bram Moolenaar582fd852005-03-28 20:58:01 +00007519 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007520 not set) and a minwid is not set for the group, the whole group will
7521 become empty. This will make a group like the following disappear
7522 completely from the statusline when none of the flags are set. >
7523 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007524< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 Beware that an expression is evaluated each and every time the status
7526 line is displayed. The current buffer and current window will be set
7527 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007528 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007529 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007530 real current buffer.
7531
Bram Moolenaar30b65812012-07-12 22:01:11 +02007532 The 'statusline' option will be evaluated in the |sandbox| if set from
7533 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007534
7535 It is not allowed to change text or jump to another window while
7536 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537
7538 If the statusline is not updated when you want it (e.g., after setting
7539 a variable that's used in an expression), you can force an update by
7540 setting an option without changing its value. Example: >
7541 :let &ro = &ro
7542
7543< A result of all digits is regarded a number for display purposes.
7544 Otherwise the result is taken as flag text and applied to the rules
7545 described above.
7546
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007547 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007549 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550
7551 Examples:
7552 Emulate standard status line with 'ruler' set >
7553 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7554< Similar, but add ASCII value of char under the cursor (like "ga") >
7555 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7556< Display byte count and byte value, modified flag in red. >
7557 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7558 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7559< Display a ,GZ flag if a compressed file is loaded >
7560 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7561< In the |:autocmd|'s: >
7562 :let b:gzflag = 1
7563< And: >
7564 :unlet b:gzflag
7565< And define this function: >
7566 :function VarExists(var, val)
7567 : if exists(a:var) | return a:val | else | return '' | endif
7568 :endfunction
7569<
7570 *'suffixes'* *'su'*
7571'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7572 global
7573 {not in Vi}
7574 Files with these suffixes get a lower priority when multiple files
7575 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007576 suffixes. Spaces after the comma are ignored. A dot is also seen as
7577 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 separator, precede it with a backslash (see |option-backslash| about
7579 including spaces and backslashes).
7580 See 'wildignore' for completely ignoring files.
7581 The use of |:set+=| and |:set-=| is preferred when adding or removing
7582 suffixes from the list. This avoids problems when a future version
7583 uses another default.
7584
7585 *'suffixesadd'* *'sua'*
7586'suffixesadd' 'sua' string (default "")
7587 local to buffer
7588 {not in Vi}
7589 {not available when compiled without the
7590 |+file_in_path| feature}
7591 Comma separated list of suffixes, which are used when searching for a
7592 file for the "gf", "[I", etc. commands. Example: >
7593 :set suffixesadd=.java
7594<
7595 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7596'swapfile' 'swf' boolean (default on)
7597 local to buffer
7598 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 swapfile is not wanted for a specific buffer. For example, with
7601 confidential information that even root must not be able to access.
7602 Careful: All text will be in memory:
7603 - Don't use this for big files.
7604 - Recovery will be impossible!
7605 A swapfile will only be present when |'updatecount'| is non-zero and
7606 'swapfile' is set.
7607 When 'swapfile' is reset, the swap file for the current buffer is
7608 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7609 non-zero, a swap file is immediately created.
7610 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007611 If you want to open a new buffer without creating a swap file for it,
7612 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007613 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614
7615 This option is used together with 'bufhidden' and 'buftype' to
7616 specify special kinds of buffers. See |special-buffers|.
7617
7618 *'swapsync'* *'sws'*
7619'swapsync' 'sws' string (default "fsync")
7620 global
7621 {not in Vi}
7622 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007623 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 When this option is empty parts of the swap file may be in memory and
7625 not written to disk. When the system crashes you may lose more work.
7626 On Unix the system does a sync now and then without Vim asking for it,
7627 so the disadvantage of setting this option off is small. On some
7628 systems the swap file will not be written at all. For a unix system
7629 setting it to "sync" will use the sync() call instead of the default
7630 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007631 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632
7633 *'switchbuf'* *'swb'*
7634'switchbuf' 'swb' string (default "")
7635 global
7636 {not in Vi}
7637 This option controls the behavior when switching between buffers.
7638 Possible values (comma separated list):
7639 useopen If included, jump to the first open window that
7640 contains the specified buffer (if there is one).
7641 Otherwise: Do not examine other windows.
7642 This setting is checked with |quickfix| commands, when
7643 jumping to errors (":cc", ":cn", "cp", etc.). It is
7644 also used in all buffer related split commands, for
7645 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007646 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007647 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007649 a buffer for a |quickfix| command that display errors.
7650 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007651 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007652 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007653 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007655 *'synmaxcol'* *'smc'*
7656'synmaxcol' 'smc' number (default 3000)
7657 local to buffer
7658 {not in Vi}
7659 {not available when compiled without the |+syntax|
7660 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007661 Maximum column in which to search for syntax items. In long lines the
7662 text after this column is not highlighted and following lines may not
7663 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007664 This helps to avoid very slow redrawing for an XML file that is one
7665 long line.
7666 Set to zero to remove the limit.
7667
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 *'syntax'* *'syn'*
7669'syntax' 'syn' string (default empty)
7670 local to buffer
7671 {not in Vi}
7672 {not available when compiled without the |+syntax|
7673 feature}
7674 When this option is set, the syntax with this name is loaded, unless
7675 syntax highlighting has been switched off with ":syntax off".
7676 Otherwise this option does not always reflect the current syntax (the
7677 b:current_syntax variable does).
7678 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007679 not automatically recognized. Example, in an IDL file:
7680 /* vim: set syntax=idl : */ ~
7681 When a dot appears in the value then this separates two filetype
7682 names. Example:
7683 /* vim: set syntax=c.doxygen : */ ~
7684 This will use the "c" syntax first, then the "doxygen" syntax.
7685 Note that the second one must be prepared to be loaded as an addition,
7686 otherwise it will be skipped. More than one dot may appear.
7687 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 :set syntax=OFF
7689< To switch syntax highlighting on according to the current value of the
7690 'filetype' option: >
7691 :set syntax=ON
7692< What actually happens when setting the 'syntax' option is that the
7693 Syntax autocommand event is triggered with the value as argument.
7694 This option is not copied to another buffer, independent of the 's' or
7695 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007696 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007698 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007699'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007700 global
7701 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007702 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007703 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007704 When nonempty, this option determines the content of the tab pages
7705 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007706 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007707
7708 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007709 option and only when there is no GUI tab line. When 'e' is in
7710 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007711 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007712
7713 The value is evaluated like with 'statusline'. You can use
7714 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007715 the text to be displayed. Use "%1T" for the first label, "%2T" for
7716 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007717
7718 Keep in mind that only one of the tab pages is the current one, others
7719 are invisible and you can't jump to their windows.
7720
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007721
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007722 *'tabpagemax'* *'tpm'*
7723'tabpagemax' 'tpm' number (default 10)
7724 global
7725 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007726 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007727 feature}
7728 Maximum number of tab pages to be opened by the |-p| command line
7729 argument or the ":tab all" command. |tabpage|
7730
7731
7732 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733'tabstop' 'ts' number (default 8)
7734 local to buffer
7735 Number of spaces that a <Tab> in the file counts for. Also see
7736 |:retab| command, and 'softtabstop' option.
7737
7738 Note: Setting 'tabstop' to any other value than 8 can make your file
7739 appear wrong in many places (e.g., when printing it).
7740
7741 There are four main ways to use tabs in Vim:
7742 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7743 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007744 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 behave like a tab appears every 4 (or 3) characters.
7746 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7747 'expandtab'. This way you will always insert spaces. The
7748 formatting will never be messed up when 'tabstop' is changed.
7749 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007750 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751 works when using Vim to edit the file.
7752 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7753 'noexpandtab'. This should then work (for initial indents only)
7754 for any tabstop setting that people use. It might be nice to have
7755 tabs after the first non-blank inserted as spaces if you do this
7756 though. Otherwise aligned comments will be wrong when 'tabstop' is
7757 changed.
7758
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007759 If Vim is compiled with the |+vartabs| feature then the value of
7760 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7761 than an empty string.
7762
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7764'tagbsearch' 'tbs' boolean (default on)
7765 global
7766 {not in Vi}
7767 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007768 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 searching makes searching for a tag a LOT faster, but a linear search
7770 will find more tags if the tags file wasn't properly sorted.
7771 Vim normally assumes that your tags files are sorted, or indicate that
7772 they are not sorted. Only when this is not the case does the
7773 'tagbsearch' option need to be switched off.
7774
7775 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007776 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 certain files, or retry all files with a linear search. When
7778 'tagbsearch' is off, only a linear search is done.
7779
7780 Linear searching is done anyway, for one file, when Vim finds a line
7781 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007782 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783< [The whitespace before and after the '0' must be a single <Tab>]
7784
7785 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007786 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 instead of a normal tag name, a retry is done with a linear search.
7788 Tags in unsorted tags files, and matches with different case will only
7789 be found in the retry.
7790
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007791 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007792 linear search can be avoided when case is ignored. Use a value of '2'
7793 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7794 sorted with the -f switch to "sort" in most unices, as in the command:
7795 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7796 (at least 5.5) the --sort=foldcase switch can be used for this as
7797 well. Note that case must be folded to uppercase for this to work.
7798
7799 By default, tag searches are case-sensitive. Case is ignored when
7800 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7801 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007802 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7803 'tagcase' is "smart", and the pattern contains only lowercase
7804 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805
7806 When 'tagbsearch' is off, tags searching is slower when a full match
7807 exists, but faster when no full match exists. Tags in unsorted tags
7808 files may only be found with 'tagbsearch' off.
7809 When the tags file is not sorted, or sorted in a wrong way (not on
7810 ASCII byte value), 'tagbsearch' should be off, or the line given above
7811 must be included in the tags file.
7812 This option doesn't affect commands that find all matching tags (e.g.,
7813 command-line completion and ":help").
7814 {Vi: always uses binary search in some versions}
7815
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007816 *'tagcase'* *'tc'*
7817'tagcase' 'tc' string (default "followic")
7818 global or local to buffer |global-local|
7819 {not in Vi}
7820 This option specifies how case is handled when searching the tags
7821 file:
7822 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007823 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007824 ignore Ignore case
7825 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007826 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007827 NOTE: This option is set to the Vi default value when 'compatible' is
7828 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007829
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 *'taglength'* *'tl'*
7831'taglength' 'tl' number (default 0)
7832 global
7833 If non-zero, tags are significant up to this number of characters.
7834
7835 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7836'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7837 global
7838 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007839 If on and using a tags file in another directory, file names in that
7840 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 NOTE: This option is set to the Vi default value when 'compatible' is
7842 set and to the Vim default value when 'compatible' is reset.
7843
7844 *'tags'* *'tag'* *E433*
7845'tags' 'tag' string (default "./tags,tags", when compiled with
7846 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7847 global or local to buffer |global-local|
7848 Filenames for the tag command, separated by spaces or commas. To
7849 include a space or comma in a file name, precede it with a backslash
7850 (see |option-backslash| about including spaces and backslashes).
7851 When a file name starts with "./", the '.' is replaced with the path
7852 of the current file. But only when the 'd' flag is not included in
7853 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7854 |tags-option|.
7855 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007856 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7857 find all files named "tags" below "/lib". The filename itself cannot
7858 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7859 files called "tags?". {not available when compiled without the
7860 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007861 The |tagfiles()| function can be used to get a list of the file names
7862 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7864 files are also supported. They are automatically recognized. The
7865 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7866 differences are ignored (MS-Windows). |emacs-tags|
7867 The use of |:set+=| and |:set-=| is preferred when adding or removing
7868 file names from the list. This avoids problems when a future version
7869 uses another default.
7870 {Vi: default is "tags /usr/lib/tags"}
7871
7872 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7873'tagstack' 'tgst' boolean (default on)
7874 global
7875 {not in all versions of Vi}
7876 When on, the |tagstack| is used normally. When off, a ":tag" or
7877 ":tselect" command with an argument will not push the tag onto the
7878 tagstack. A following ":tag" without an argument, a ":pop" command or
7879 any other command that uses the tagstack will use the unmodified
7880 tagstack, but does change the pointer to the active entry.
7881 Resetting this option is useful when using a ":tag" command in a
7882 mapping which should not change the tagstack.
7883
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007884 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007885'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007886 global
7887 {not in Vi}
7888 {only available when compiled with the |+tcl/dyn|
7889 feature}
7890 Specifies the name of the Tcl shared library. The default is
7891 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007892 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007893 This option cannot be set from a |modeline| or in the |sandbox|, for
7894 security reasons.
7895
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 *'term'* *E529* *E530* *E531*
7897'term' string (default is $TERM, if that fails:
7898 in the GUI: "builtin_gui"
7899 on Amiga: "amiga"
7900 on BeOS: "beos-ansi"
7901 on Mac: "mac-ansi"
7902 on MiNT: "vt52"
7903 on MS-DOS: "pcterm"
7904 on OS/2: "os2ansi"
7905 on Unix: "ansi"
7906 on VMS: "ansi"
7907 on Win 32: "win32")
7908 global
7909 Name of the terminal. Used for choosing the terminal control
7910 characters. Environment variables are expanded |:set_env|.
7911 For example: >
7912 :set term=$TERM
7913< See |termcap|.
7914
7915 *'termbidi'* *'tbidi'*
7916 *'notermbidi'* *'notbidi'*
7917'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7918 global
7919 {not in Vi}
7920 {only available when compiled with the |+arabic|
7921 feature}
7922 The terminal is in charge of Bi-directionality of text (as specified
7923 by Unicode). The terminal is also expected to do the required shaping
7924 that some languages (such as Arabic) require.
7925 Setting this option implies that 'rightleft' will not be set when
7926 'arabic' is set and the value of 'arabicshape' will be ignored.
7927 Note that setting 'termbidi' has the immediate effect that
7928 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7929 This option is reset when the GUI is started.
7930 For further details see |arabic.txt|.
7931
7932 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007933'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 Macintosh GUI: "macroman")
7935 global
7936 {only available when compiled with the |+multi_byte|
7937 feature}
7938 {not in Vi}
7939 Encoding used for the terminal. This specifies what character
7940 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007941 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007942 display). Except for the Mac when 'macatsui' is off, then
7943 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007945 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7947 Any attempts to set a different value will be rejected, and an error
7948 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007949 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 because the Win32 system always passes Unicode characters.
7951 When empty, the same encoding is used as for the 'encoding' option.
7952 This is the normal value.
7953 Not all combinations for 'termencoding' and 'encoding' are valid. See
7954 |encoding-table|.
7955 The value for this option must be supported by internal conversions or
7956 iconv(). When this is not possible no conversion will be done and you
7957 will probably experience problems with non-ASCII characters.
7958 Example: You are working with the locale set to euc-jp (Japanese) and
7959 want to edit a UTF-8 file: >
7960 :let &termencoding = &encoding
7961 :set encoding=utf-8
7962< You need to do this when your system has no locale support for UTF-8.
7963
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007964 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007965'termguicolors' 'tgc' boolean (default off)
7966 global
7967 {not in Vi}
7968 {not available when compiled without the
7969 |+termguicolors| feature}
7970 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007971 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007972
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007973 Requires a ISO-8613-3 compatible terminal. If setting this option
7974 does not work (produces a colorless UI) reading |xterm-true-color|
7975 might help.
7976
7977 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7978 is required. Use this check to find out: >
7979 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007980< This requires Vim to be built with the |+vtp| feature.
7981
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007982 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007983 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007984
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007985 *'termwinscroll'* *'twsl'*
7986'termwinscroll' 'twsl' number (default 10000)
7987 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02007988 {not in Vi}
7989 {not available when compiled without the
7990 |+terminal| feature}
7991 Number of scrollback lines to keep. When going over this limit the
7992 first 10% of the scrollback lines are deleted. This is just to reduce
7993 the memory usage. See |Terminal-Normal|.
7994
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007995 *'termwinkey'* *'twk'*
7996'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007997 local to window
7998 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007999 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008000 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008001 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008002 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008003< The string must be one key stroke but can be multiple bytes.
8004 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008005 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008006 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008007
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008008 *'termwinsize'* *'tws'*
8009'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008010 local to window
8011 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008012 Size of the |terminal| window. Format: {rows}x{columns} or
8013 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008014 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008015 - When set with a "x" (e.g., "24x80") the terminal size is not
8016 adjusted to the window size. If the window is smaller only the
8017 top-left part is displayed.
8018 - When set with a "*" (e.g., "10*50") the terminal size follows the
8019 window size, but will not be smaller than the specified rows and/or
8020 columns.
8021 - When rows is zero then use the height of the window.
8022 - When columns is zero then use the width of the window.
8023 - Using "0x0" or "0*0" is the same as empty.
8024
8025 Examples:
8026 "30x0" uses 30 rows and the current window width.
8027 "20*0" uses at least 20 rows and the current window width.
8028 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008029 Note that the command running in the terminal window may still change
8030 the size of the terminal. In that case the Vim window will be
8031 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008032
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 *'terse'* *'noterse'*
8034'terse' boolean (default off)
8035 global
8036 When set: Add 's' flag to 'shortmess' option (this makes the message
8037 for a search that hits the start or end of the file not being
8038 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8039 shortens a lot of messages}
8040
8041 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8042'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8043 global
8044 {not in Vi}
8045 This option is obsolete. Use 'fileformats'.
8046 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8047 set to the default value for the current system. When 'textauto' is
8048 reset, 'fileformats' is made empty.
8049 NOTE: This option is set to the Vi default value when 'compatible' is
8050 set and to the Vim default value when 'compatible' is reset.
8051
8052 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8053'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8054 others: default off)
8055 local to buffer
8056 {not in Vi}
8057 This option is obsolete. Use 'fileformat'.
8058 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8059 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8060 "unix".
8061
8062 *'textwidth'* *'tw'*
8063'textwidth' 'tw' number (default 0)
8064 local to buffer
8065 {not in Vi}
8066 Maximum width of text that is being inserted. A longer line will be
8067 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008068 this.
8069 'textwidth' is set to 0 when the 'paste' option is set and restored
8070 when 'paste' is reset.
8071 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008073 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 NOTE: This option is set to 0 when 'compatible' is set.
8075
8076 *'thesaurus'* *'tsr'*
8077'thesaurus' 'tsr' string (default "")
8078 global or local to buffer |global-local|
8079 {not in Vi}
8080 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008081 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 the file should contain words with similar meaning, separated by
8083 non-keyword characters (white space is preferred). Maximum line
8084 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008085 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008086 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02008087 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008088 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 after a comma are ignored, otherwise spaces are included in the file
8090 name. See |option-backslash| about using backslashes.
8091 The use of |:set+=| and |:set-=| is preferred when adding or removing
8092 directories from the list. This avoids problems when a future version
8093 uses another default.
8094 Backticks cannot be used in this option for security reasons.
8095
8096 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8097'tildeop' 'top' boolean (default off)
8098 global
8099 {not in Vi}
8100 When on: The tilde command "~" behaves like an operator.
8101 NOTE: This option is reset when 'compatible' is set.
8102
8103 *'timeout'* *'to'* *'notimeout'* *'noto'*
8104'timeout' 'to' boolean (default on)
8105 global
8106 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008107'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 global
8109 {not in Vi}
8110 These two options together determine the behavior when part of a
8111 mapped key sequence or keyboard code has been received:
8112
8113 'timeout' 'ttimeout' action ~
8114 off off do not time out
8115 on on or off time out on :mappings and key codes
8116 off on time out on key codes
8117
8118 If both options are off, Vim will wait until either the complete
8119 mapping or key sequence has been received, or it is clear that there
8120 is no mapping or key sequence for the received characters. For
8121 example: if you have mapped "vl" and Vim has received 'v', the next
8122 character is needed to see if the 'v' is followed by an 'l'.
8123 When one of the options is on, Vim will wait for about 1 second for
8124 the next character to arrive. After that the already received
8125 characters are interpreted as single characters. The waiting time can
8126 be changed with the 'timeoutlen' option.
8127 On slow terminals or very busy systems timing out may cause
8128 malfunctioning cursor keys. If both options are off, Vim waits
8129 forever after an entered <Esc> if there are key codes that start
8130 with <Esc>. You will have to type <Esc> twice. If you do not have
8131 problems with key codes, but would like to have :mapped key
8132 sequences not timing out in 1 second, set the 'ttimeout' option and
8133 reset the 'timeout' option.
8134
8135 NOTE: 'ttimeout' is reset when 'compatible' is set.
8136
8137 *'timeoutlen'* *'tm'*
8138'timeoutlen' 'tm' number (default 1000)
8139 global
8140 {not in all versions of Vi}
8141 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008142'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 global
8144 {not in Vi}
8145 The time in milliseconds that is waited for a key code or mapped key
8146 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8147 when part of a command has been typed.
8148 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8149 different timeout value for key codes is desired set 'ttimeoutlen' to
8150 a non-negative number.
8151
8152 ttimeoutlen mapping delay key code delay ~
8153 < 0 'timeoutlen' 'timeoutlen'
8154 >= 0 'timeoutlen' 'ttimeoutlen'
8155
8156 The timeout only happens when the 'timeout' and 'ttimeout' options
8157 tell so. A useful setting would be >
8158 :set timeout timeoutlen=3000 ttimeoutlen=100
8159< (time out on mapping after three seconds, time out on key codes after
8160 a tenth of a second).
8161
8162 *'title'* *'notitle'*
8163'title' boolean (default off, on when title can be restored)
8164 global
8165 {not in Vi}
8166 {not available when compiled without the |+title|
8167 feature}
8168 When on, the title of the window will be set to the value of
8169 'titlestring' (if it is not empty), or to:
8170 filename [+=-] (path) - VIM
8171 Where:
8172 filename the name of the file being edited
8173 - indicates the file cannot be modified, 'ma' off
8174 + indicates the file was modified
8175 = indicates the file is read-only
8176 =+ indicates the file is read-only and modified
8177 (path) is the path of the file being edited
8178 - VIM the server name |v:servername| or "VIM"
8179 Only works if the terminal supports setting window titles
8180 (currently Amiga console, Win32 console, all GUI versions and
8181 terminals with a non- empty 't_ts' option - these are Unix xterm and
8182 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8183 *X11*
8184 When Vim was compiled with HAVE_X11 defined, the original title will
8185 be restored if possible. The output of ":version" will include "+X11"
8186 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8187 works for the icon name |'icon'|.
8188 But: When Vim was started with the |-X| argument, restoring the title
8189 will not work (except in the GUI).
8190 If the title cannot be restored, it is set to the value of 'titleold'.
8191 You might want to restore the title outside of Vim then.
8192 When using an xterm from a remote machine you can use this command:
8193 rsh machine_name xterm -display $DISPLAY &
8194 then the WINDOWID environment variable should be inherited and the
8195 title of the window should change back to what it should be after
8196 exiting Vim.
8197
8198 *'titlelen'*
8199'titlelen' number (default 85)
8200 global
8201 {not in Vi}
8202 {not available when compiled without the |+title|
8203 feature}
8204 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008205 title. When the title is longer, only the end of the path name is
8206 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 Using a percentage makes this adapt to the width of the window. But
8208 it won't work perfectly, because the actual number of characters
8209 available also depends on the font used and other things in the title
8210 bar. When 'titlelen' is zero the full path is used. Otherwise,
8211 values from 1 to 30000 percent can be used.
8212 'titlelen' is also used for the 'titlestring' option.
8213
8214 *'titleold'*
8215'titleold' string (default "Thanks for flying Vim")
8216 global
8217 {not in Vi}
8218 {only available when compiled with the |+title|
8219 feature}
8220 This option will be used for the window title when exiting Vim if the
8221 original title cannot be restored. Only happens if 'title' is on or
8222 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008223 This option cannot be set from a |modeline| or in the |sandbox|, for
8224 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 *'titlestring'*
8226'titlestring' string (default "")
8227 global
8228 {not in Vi}
8229 {not available when compiled without the |+title|
8230 feature}
8231 When this option is not empty, it will be used for the title of the
8232 window. This happens only when the 'title' option is on.
8233 Only works if the terminal supports setting window titles (currently
8234 Amiga console, Win32 console, all GUI versions and terminals with a
8235 non-empty 't_ts' option).
8236 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008237 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 When this option contains printf-style '%' items, they will be
8239 expanded according to the rules used for 'statusline'.
8240 Example: >
8241 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8242 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8243< The value of 'titlelen' is used to align items in the middle or right
8244 of the available space.
8245 Some people prefer to have the file name first: >
8246 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8247< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008248 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249 separating space only when needed.
8250 NOTE: Use of special characters in 'titlestring' may cause the display
8251 to be garbled (e.g., when it contains a CR or NL character).
8252 {not available when compiled without the |+statusline| feature}
8253
8254 *'toolbar'* *'tb'*
8255'toolbar' 'tb' string (default "icons,tooltips")
8256 global
8257 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8258 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008259 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 possible values are:
8261 icons Toolbar buttons are shown with icons.
8262 text Toolbar buttons shown with text.
8263 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008264 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 tooltips Tooltips are active for toolbar buttons.
8266 Tooltips refer to the popup help text which appears after the mouse
8267 cursor is placed over a toolbar button for a brief moment.
8268
8269 If you want the toolbar to be shown with icons as well as text, do the
8270 following: >
8271 :set tb=icons,text
8272< Motif and Athena cannot display icons and text at the same time. They
8273 will show icons if both are requested.
8274
8275 If none of the strings specified in 'toolbar' are valid or if
8276 'toolbar' is empty, this option is ignored. If you want to disable
8277 the toolbar, you need to set the 'guioptions' option. For example: >
8278 :set guioptions-=T
8279< Also see |gui-toolbar|.
8280
8281 *'toolbariconsize'* *'tbis'*
8282'toolbariconsize' 'tbis' string (default "small")
8283 global
8284 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008285 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008287 tiny Use tiny icons.
8288 small Use small icons (default).
8289 medium Use medium-sized icons.
8290 large Use large icons.
8291 huge Use even larger icons.
8292 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008294 the current theme. Common dimensions are giant=48x48, huge=32x32,
8295 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296
8297 If 'toolbariconsize' is empty, the global default size as determined
8298 by user preferences or the current theme is used.
8299
8300 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8301'ttybuiltin' 'tbi' boolean (default on)
8302 global
8303 {not in Vi}
8304 When on, the builtin termcaps are searched before the external ones.
8305 When off the builtin termcaps are searched after the external ones.
8306 When this option is changed, you should set the 'term' option next for
8307 the change to take effect, for example: >
8308 :set notbi term=$TERM
8309< See also |termcap|.
8310 Rationale: The default for this option is "on", because the builtin
8311 termcap entries are generally better (many systems contain faulty
8312 xterm entries...).
8313
8314 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8315'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8316 sun-cmd, screen, rxvt, dtterm or
8317 iris-ansi; also on when running Vim in
8318 a DOS console)
8319 global
8320 {not in Vi}
8321 Indicates a fast terminal connection. More characters will be sent to
8322 the screen for redrawing, instead of using insert/delete line
8323 commands. Improves smoothness of redrawing when there are multiple
8324 windows and the terminal does not support a scrolling region.
8325 Also enables the extra writing of characters at the end of each screen
8326 line for lines that wrap. This helps when using copy/paste with the
8327 mouse in an xterm and other terminals.
8328
8329 *'ttymouse'* *'ttym'*
8330'ttymouse' 'ttym' string (default depends on 'term')
8331 global
8332 {not in Vi}
8333 {only in Unix and VMS, doesn't work in the GUI; not
8334 available when compiled without |+mouse|}
8335 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008336 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 *xterm-mouse*
8338 xterm xterm-like mouse handling. The mouse generates
8339 "<Esc>[Mscr", where "scr" is three bytes:
8340 "s" = button state
8341 "c" = column plus 33
8342 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008343 This only works up to 223 columns! See "dec",
8344 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 xterm2 Works like "xterm", but with the xterm reporting the
8346 mouse position while the mouse is dragged. This works
8347 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008348 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 work. See below for how Vim detects this
8350 automatically.
8351 *netterm-mouse*
8352 netterm NetTerm mouse handling. The mouse generates
8353 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8354 for the row and column.
8355 *dec-mouse*
8356 dec DEC terminal mouse handling. The mouse generates a
8357 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008358 This is also available for an Xterm, if it was
8359 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 *jsbterm-mouse*
8361 jsbterm JSB term mouse handling.
8362 *pterm-mouse*
8363 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008364 *urxvt-mouse*
8365 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008366 The mouse works only if the terminal supports this
8367 encoding style, but it does not have 223 columns limit
8368 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008369 *sgr-mouse*
8370 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008371 mouse reporting. The mouse works even in columns
8372 beyond 223. This option is backward compatible with
8373 "xterm2" because it can also decode "xterm2" style
8374 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375
8376 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008377 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8378 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8380 recognized, if enabled at compile time. DEC terminal mouse codes
8381 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008382 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8383 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008385 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8386 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8387 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008388 Additionally, if vim is compiled with the |+termresponse| feature and
8389 |t_RV| is set to the escape sequence to request the xterm version
8390 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008392 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar2f058492017-11-30 20:27:52 +01008393 277 or higher and when Vim detects Mac Terminal.app or iTerm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008394 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8395 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 :set t_RV=
8397<
8398 *'ttyscroll'* *'tsl'*
8399'ttyscroll' 'tsl' number (default 999)
8400 global
8401 Maximum number of lines to scroll the screen. If there are more lines
8402 to scroll the window is redrawn. For terminals where scrolling is
8403 very slow and redrawing is not slow this can be set to a small number,
8404 e.g., 3, to speed up displaying.
8405
8406 *'ttytype'* *'tty'*
8407'ttytype' 'tty' string (default from $TERM)
8408 global
8409 Alias for 'term', see above.
8410
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008411 *'undodir'* *'udir'*
8412'undodir' 'udir' string (default ".")
8413 global
8414 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008415 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008416 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008417 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008418 "." means using the directory of the file. The undo file name for
8419 "file.txt" is ".file.txt.un~".
8420 For other directories the file name is the full path of the edited
8421 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008422 When writing: The first directory that exists is used. "." always
8423 works, no directories after "." will be used for writing.
8424 When reading all entries are tried to find an undo file. The first
8425 undo file that exists is used. When it cannot be read an error is
8426 given, no further entry is used.
8427 See |undo-persistence|.
8428
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008429 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008430'undofile' 'udf' boolean (default off)
8431 local to buffer
8432 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008433 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008434 When on, Vim automatically saves undo history to an undo file when
8435 writing a buffer to a file, and restores undo history from the same
8436 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008437 The directory where the undo file is stored is specified by 'undodir'.
8438 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008439 The undo file is not read when 'undoreload' causes the buffer from
8440 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008441 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008442 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008443
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 *'undolevels'* *'ul'*
8445'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8446 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008447 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 {not in Vi}
8449 Maximum number of changes that can be undone. Since undo information
8450 is kept in memory, higher numbers will cause more memory to be used
8451 (nevertheless, a single change can use an unlimited amount of memory).
8452 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8453 itself: >
8454 set ul=0
8455< But you can also get Vi compatibility by including the 'u' flag in
8456 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008457 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008458 Set to -1 for no undo at all. You might want to do this only for the
8459 current buffer: >
8460 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008462
8463 The local value is set to -123456 when the global value is to be used.
8464
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008465 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008466
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008467 *'undoreload'* *'ur'*
8468'undoreload' 'ur' number (default 10000)
8469 global
8470 {not in Vi}
8471 Save the whole buffer for undo when reloading it. This applies to the
8472 ":e!" command and reloading for when the buffer changed outside of
8473 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008474 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008475 of lines is smaller than the value of this option.
8476 Set this option to zero to disable undo for a reload.
8477
8478 When saving undo for a reload, any undo file is not read.
8479
8480 Note that this causes the whole buffer to be stored in memory. Set
8481 this option to a lower value if you run out of memory.
8482
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 *'updatecount'* *'uc'*
8484'updatecount' 'uc' number (default: 200)
8485 global
8486 {not in Vi}
8487 After typing this many characters the swap file will be written to
8488 disk. When zero, no swap file will be created at all (see chapter on
8489 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8490 Vim with the "-n" option, see |startup|. When editing in readonly
8491 mode this option will be initialized to 10000.
8492 The swapfile can be disabled per buffer with |'swapfile'|.
8493 When 'updatecount' is set from zero to non-zero, swap files are
8494 created for all buffers that have 'swapfile' set. When 'updatecount'
8495 is set to zero, existing swap files are not deleted.
8496 Also see |'swapsync'|.
8497 This option has no meaning in buffers where |'buftype'| is "nofile"
8498 or "nowrite".
8499
8500 *'updatetime'* *'ut'*
8501'updatetime' 'ut' number (default 4000)
8502 global
8503 {not in Vi}
8504 If this many milliseconds nothing is typed the swap file will be
8505 written to disk (see |crash-recovery|). Also used for the
8506 |CursorHold| autocommand event.
8507
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008508 *'varsofttabstop'* *'vsts'*
8509'varsofttabstop' 'vsts' string (default "")
8510 local to buffer
8511 {only available when compiled with the |+vartabs|
8512 feature}
8513 {not in Vi}
8514 A list of the number of spaces that a <Tab> counts for while editing,
8515 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8516 width <Tab>s are being inserted, while in fact a mixture of spaces
8517 and <Tab>s is used. Tab widths are separated with commas, with the
8518 final value applying to all subsequent tabs.
8519
8520 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008521 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008522 to use the following: >
8523 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008524< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8525 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008526
8527 Note that the value of |'softtabstop'| will be ignored while
8528 'varsofttabstop' is set.
8529
8530 *'vartabstop'* *'vts'*
8531'vartabstop' 'vts' string (default "")
8532 local to buffer
8533 {only available when compiled with the |+vartabs|
8534 feature}
8535 {not in Vi}
8536 A list of the number of spaces that a <Tab> in the file counts for,
8537 separated by commas. Each value corresponds to one tab, with the
8538 final value applying to all subsequent tabs. For example: >
8539 :set vartabstop=4,20,10,8
8540< This will make the first tab 4 spaces wide, the second 20 spaces,
8541 the third 10 spaces, and all following tabs 8 spaces.
8542
8543 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8544 is set.
8545
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 *'verbose'* *'vbs'*
8547'verbose' 'vbs' number (default 0)
8548 global
8549 {not in Vi, although some versions have a boolean
8550 verbose option}
8551 When bigger than zero, Vim will give messages about what it is doing.
8552 Currently, these messages are given:
8553 >= 1 When the viminfo file is read or written.
8554 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008555 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 >= 8 Files for which a group of autocommands is executed.
8557 >= 9 Every executed autocommand.
8558 >= 12 Every executed function.
8559 >= 13 When an exception is thrown, caught, finished, or discarded.
8560 >= 14 Anything pending in a ":finally" clause.
8561 >= 15 Every executed Ex command (truncated at 200 characters).
8562
8563 This option can also be set with the "-V" argument. See |-V|.
8564 This option is also set by the |:verbose| command.
8565
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008566 When the 'verbosefile' option is set then the verbose messages are not
8567 displayed.
8568
8569 *'verbosefile'* *'vfile'*
8570'verbosefile' 'vfile' string (default empty)
8571 global
8572 {not in Vi}
8573 When not empty all messages are written in a file with this name.
8574 When the file exists messages are appended.
8575 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008576 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008577 Setting 'verbosefile' to a new value is like making it empty first.
8578 The difference with |:redir| is that verbose messages are not
8579 displayed when 'verbosefile' is set.
8580
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581 *'viewdir'* *'vdir'*
8582'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8583 "$VIM/vimfiles/view",
8584 for Unix: "~/.vim/view",
8585 for Macintosh: "$VIM:vimfiles:view"
8586 for VMS: "sys$login:vimfiles/view"
8587 for RiscOS: "Choices:vimfiles/view")
8588 global
8589 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008590 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008591 feature}
8592 Name of the directory where to store files for |:mkview|.
8593 This option cannot be set from a |modeline| or in the |sandbox|, for
8594 security reasons.
8595
8596 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008597'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 global
8599 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008600 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 feature}
8602 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008603 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 word save and restore ~
8605 cursor cursor position in file and in window
8606 folds manually created folds, opened/closed folds and local
8607 fold options
8608 options options and mappings local to a window or buffer (not
8609 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008610 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 slash backslashes in file names replaced with forward
8612 slashes
8613 unix with Unix end-of-line format (single <NL>), even when
8614 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008615 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616
8617 "slash" and "unix" are useful on Windows when sharing view files
8618 with Unix. The Unix version of Vim cannot source dos format scripts,
8619 but the Windows version of Vim can source unix format scripts.
8620
8621 *'viminfo'* *'vi'* *E526* *E527* *E528*
8622'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008623 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8624 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8625 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 global
8627 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008628 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 feature}
8630 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008631 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8632 "NONE".
8633 The string should be a comma separated list of parameters, each
8634 consisting of a single character identifying the particular parameter,
8635 followed by a number or string which specifies the value of that
8636 parameter. If a particular character is left out, then the default
8637 value is used for that parameter. The following is a list of the
8638 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008640 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 ! When included, save and restore global variables that start
8642 with an uppercase letter, and don't contain a lowercase
8643 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008644 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008645 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008646 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 " Maximum number of lines saved for each register. Old name of
8648 the '<' item, with the disadvantage that you need to put a
8649 backslash before the ", otherwise it will be recognized as the
8650 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008651 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 % When included, save and restore the buffer list. If Vim is
8653 started with a file name argument, the buffer list is not
8654 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008655 buffer list is restored from the viminfo file. Quickfix
8656 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8657 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008658 When followed by a number, the number specifies the maximum
8659 number of buffers that are stored. Without a number all
8660 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008661 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 ' Maximum number of previously edited files for which the marks
8663 are remembered. This parameter must always be included when
8664 'viminfo' is non-empty.
8665 Including this item also means that the |jumplist| and the
8666 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008667 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008669 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 patterns are also saved. When not included, the value of
8671 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008672 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008674 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008675 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008676 < Maximum number of lines saved for each register. If zero then
8677 registers are not saved. When not included, all lines are
8678 saved. '"' is the old name for this item.
8679 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008680 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008682 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008683 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684 c When included, convert the text in the viminfo file from the
8685 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008686 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008687 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 f Whether file marks need to be stored. If zero, file marks ('0
8689 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008690 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008692 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008693 h Disable the effect of 'hlsearch' when loading the viminfo
8694 file. When not included, it depends on whether ":nohlsearch"
8695 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008696 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008698 the 'n'. Must be at the end of the option! If the
8699 'viminfofile' option is set, that file name overrides the one
8700 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008701 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008702 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 r Removable media. The argument is a string (up to the next
8704 ','). This parameter can be given several times. Each
8705 specifies the start of a path for which no marks will be
8706 stored. This is to avoid removable media. For MS-DOS you
8707 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8708 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8709 ignored. Maximum length of each 'r' argument is 50
8710 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008711 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 s Maximum size of an item in Kbyte. If zero then registers are
8713 not saved. Currently only applies to registers. The default
8714 "s10" will exclude registers with more than 10 Kbyte of text.
8715 Also see the '<' item above: line count limit.
8716
8717 Example: >
8718 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8719<
8720 '50 Marks will be remembered for the last 50 files you
8721 edited.
8722 <1000 Contents of registers (up to 1000 lines each) will be
8723 remembered.
8724 s100 Registers with more than 100 Kbyte text are skipped.
8725 :0 Command-line history will not be saved.
8726 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8727 no / Since '/' is not specified, the default will be used,
8728 that is, save all of the search history, and also the
8729 previous search and substitute patterns.
8730 no % The buffer list will not be saved nor read back.
8731 no h 'hlsearch' highlighting will be restored.
8732
8733 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8734 load the contents of the file, this is not done automatically.
8735
8736 This option cannot be set from a |modeline| or in the |sandbox|, for
8737 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008738 NOTE: This option is set to the Vim default value when 'compatible'
8739 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008741 *'viminfofile'* *'vif'*
8742'viminfofile' 'vif' string (default: "")
8743 global
8744 {not in Vi}
8745 {not available when compiled without the |+viminfo|
8746 feature}
8747 When non-empty, overrides the file name used for viminfo.
8748 When equal to "NONE" no viminfo file will be read or written.
8749 This option can be set with the |-i| command line flag. The |--clean|
8750 command line flag sets it to "NONE".
8751
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 *'virtualedit'* *'ve'*
8753'virtualedit' 've' string (default "")
8754 global
8755 {not in Vi}
8756 {not available when compiled without the
8757 |+virtualedit| feature}
8758 A comma separated list of these words:
8759 block Allow virtual editing in Visual block mode.
8760 insert Allow virtual editing in Insert mode.
8761 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008762 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008763
Bram Moolenaar071d4272004-06-13 20:20:40 +00008764 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008765 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 of the line. Useful for selecting a rectangle in Visual mode and
8767 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008768 "onemore" is not the same, it will only allow moving the cursor just
8769 after the last character of the line. This makes some commands more
8770 consistent. Previously the cursor was always past the end of the line
8771 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008772 break some plugins or Vim scripts. For example because |l| can move
8773 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008774 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008775 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008776 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008777 It doesn't make sense to combine "all" with "onemore", but you will
8778 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008779 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780
8781 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8782'visualbell' 'vb' boolean (default off)
8783 global
8784 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008785 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008787 use: >
8788 :set vb t_vb=
8789< If you want a short flash, you can use this on many terminals: >
8790 :set vb t_vb=[?5h$<100>[?5l
8791< Here $<100> specifies the time, you can use a smaller or bigger value
8792 to get a shorter or longer flash.
8793
8794 Note: Vim will limit the bell to once per half a second. This avoids
8795 having to wait for the flashing to finish when there are lots of
8796 bells, e.g. on key repeat. This also happens without 'visualbell'
8797 set.
8798
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8800 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8801 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008802
8803 Note: When the GUI starts, 't_vb' is reset to its default value. You
8804 might want to set it again in your |gvimrc|.
8805
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 Does not work on the Amiga, you always get a screen flash.
8807 Also see 'errorbells'.
8808
8809 *'warn'* *'nowarn'*
8810'warn' boolean (default on)
8811 global
8812 Give a warning message when a shell command is used while the buffer
8813 has been changed.
8814
8815 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8816'weirdinvert' 'wiv' boolean (default off)
8817 global
8818 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008819 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 It is provided for backwards compatibility with version 4.x.
8821 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8822 vice versa. Has no effect when the GUI is running.
8823
8824 *'whichwrap'* *'ww'*
8825'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8826 global
8827 {not in Vi}
8828 Allow specified keys that move the cursor left/right to move to the
8829 previous/next line when the cursor is on the first/last character in
8830 the line. Concatenate characters to allow this for these keys:
8831 char key mode ~
8832 b <BS> Normal and Visual
8833 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008834 h "h" Normal and Visual (not recommended)
8835 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 < <Left> Normal and Visual
8837 > <Right> Normal and Visual
8838 ~ "~" Normal
8839 [ <Left> Insert and Replace
8840 ] <Right> Insert and Replace
8841 For example: >
8842 :set ww=<,>,[,]
8843< allows wrap only when cursor keys are used.
8844 When the movement keys are used in combination with a delete or change
8845 operator, the <EOL> also counts for a character. This makes "3h"
8846 different from "3dh" when the cursor crosses the end of a line. This
8847 is also true for "x" and "X", because they do the same as "dl" and
8848 "dh". If you use this, you may also want to use the mapping
8849 ":map <BS> X" to make backspace delete the character in front of the
8850 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008851 When 'l' is included and it is used after an operator at the end of a
8852 line then it will not move to the next line. This makes "dl", "cl",
8853 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 NOTE: This option is set to the Vi default value when 'compatible' is
8855 set and to the Vim default value when 'compatible' is reset.
8856
8857 *'wildchar'* *'wc'*
8858'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8859 global
8860 {not in Vi}
8861 Character you have to type to start wildcard expansion in the
8862 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008863 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 The character is not recognized when used inside a macro. See
8865 'wildcharm' for that.
8866 Although 'wc' is a number option, you can set it to a special key: >
8867 :set wc=<Esc>
8868< NOTE: This option is set to the Vi default value when 'compatible' is
8869 set and to the Vim default value when 'compatible' is reset.
8870
8871 *'wildcharm'* *'wcm'*
8872'wildcharm' 'wcm' number (default: none (0))
8873 global
8874 {not in Vi}
8875 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008876 recognized when used inside a macro. You can find "spare" command-line
8877 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 you'll never actually type 'wildcharm', just use it in mappings that
8879 automatically invoke completion mode, e.g.: >
8880 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008881 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882< Then after typing :ss you can use CTRL-P & CTRL-N.
8883
8884 *'wildignore'* *'wig'*
8885'wildignore' 'wig' string (default "")
8886 global
8887 {not in Vi}
8888 {not available when compiled without the |+wildignore|
8889 feature}
8890 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008891 patterns is ignored when expanding |wildcards|, completing file or
8892 directory names, and influences the result of |expand()|, |glob()| and
8893 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8895 Also see 'suffixes'.
8896 Example: >
8897 :set wildignore=*.o,*.obj
8898< The use of |:set+=| and |:set-=| is preferred when adding or removing
8899 a pattern from the list. This avoids problems when a future version
8900 uses another default.
8901
Bram Moolenaar94950a92010-12-02 16:01:29 +01008902
Bram Moolenaar81af9252010-12-10 20:35:50 +01008903 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008904'wildignorecase' 'wic' boolean (default off)
8905 global
8906 {not in Vi}
8907 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008908 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008909 Does not apply when the shell is used to expand wildcards, which
8910 happens when there are special characters.
8911
8912
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008914'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 global
8916 {not in Vi}
8917 {not available if compiled without the |+wildmenu|
8918 feature}
8919 When 'wildmenu' is on, command-line completion operates in an enhanced
8920 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8921 the possible matches are shown just above the command line, with the
8922 first match highlighted (overwriting the status line, if there is
8923 one). Keys that show the previous/next match, such as <Tab> or
8924 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8925 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8926 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008927 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 If there are more matches than can fit in the line, a ">" is shown on
8929 the right and/or a "<" is shown on the left. The status line scrolls
8930 as needed.
8931 The "wildmenu" mode is abandoned when a key is hit that is not used
8932 for selecting a completion.
8933 While the "wildmenu" is active the following keys have special
8934 meanings:
8935
8936 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8937 <Down> - in filename/menu name completion: move into a
8938 subdirectory or submenu.
8939 <CR> - in menu completion, when the cursor is just after a
8940 dot: move into a submenu.
8941 <Up> - in filename/menu name completion: move up into
8942 parent directory or parent menu.
8943
8944 This makes the menus accessible from the console |console-menus|.
8945
8946 If you prefer the <Left> and <Right> keys to move the cursor instead
8947 of selecting a different match, use this: >
8948 :cnoremap <Left> <Space><BS><Left>
8949 :cnoremap <Right> <Space><BS><Right>
8950<
8951 The "WildMenu" highlighting is used for displaying the current match
8952 |hl-WildMenu|.
8953
8954 *'wildmode'* *'wim'*
8955'wildmode' 'wim' string (Vim default: "full")
8956 global
8957 {not in Vi}
8958 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008959 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008960 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 first part specifies the behavior for the first use of 'wildchar',
8962 The second part for the second use, etc.
8963 These are the possible values for each part:
8964 "" Complete only the first match.
8965 "full" Complete the next full match. After the last match,
8966 the original string is used and then the first match
8967 again.
8968 "longest" Complete till longest common string. If this doesn't
8969 result in a longer string, use the next part.
8970 "longest:full" Like "longest", but also start 'wildmenu' if it is
8971 enabled.
8972 "list" When more than one match, list all matches.
8973 "list:full" When more than one match, list all matches and
8974 complete first match.
8975 "list:longest" When more than one match, list all matches and
8976 complete till longest common string.
8977 When there is only a single match, it is fully completed in all cases.
8978
8979 Examples: >
8980 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008981< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008982 :set wildmode=longest,full
8983< Complete longest common string, then each full match >
8984 :set wildmode=list:full
8985< List all matches and complete each full match >
8986 :set wildmode=list,full
8987< List all matches without completing, then each full match >
8988 :set wildmode=longest,list
8989< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008990 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008992 *'wildoptions'* *'wop'*
8993'wildoptions' 'wop' string (default "")
8994 global
8995 {not in Vi}
8996 {not available when compiled without the |+wildignore|
8997 feature}
8998 A list of words that change how command line completion is done.
8999 Currently only one word is allowed:
9000 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009001 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009002 is displayed per line. Often used tag kinds are:
9003 d #define
9004 f function
9005 Also see |cmdline-completion|.
9006
Bram Moolenaar071d4272004-06-13 20:20:40 +00009007 *'winaltkeys'* *'wak'*
9008'winaltkeys' 'wak' string (default "menu")
9009 global
9010 {not in Vi}
9011 {only used in Win32, Motif, GTK and Photon GUI}
9012 Some GUI versions allow the access to menu entries by using the ALT
9013 key in combination with a character that appears underlined in the
9014 menu. This conflicts with the use of the ALT key for mappings and
9015 entering special characters. This option tells what to do:
9016 no Don't use ALT keys for menus. ALT key combinations can be
9017 mapped, but there is no automatic handling. This can then be
9018 done with the |:simalt| command.
9019 yes ALT key handling is done by the windowing system. ALT key
9020 combinations cannot be mapped.
9021 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009022 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 keys can be mapped.
9024 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9025 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009026 This option is not used for <F10>; on Win32 and with GTK <F10> will
9027 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009028
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009029 *'window'* *'wi'*
9030'window' 'wi' number (default screen height - 1)
9031 global
9032 Window height. Do not confuse this with the height of the Vim window,
9033 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009034 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9035 value is smaller than 'lines' minus one. The screen will scroll
9036 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009037 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9038 in a much smarter way, taking care of wrapping lines.
9039 When resizing the Vim window, the value is smaller than 1 or more than
9040 or equal to 'lines' it will be set to 'lines' minus 1.
9041 {Vi also uses the option to specify the number of displayed lines}
9042
Bram Moolenaar071d4272004-06-13 20:20:40 +00009043 *'winheight'* *'wh'* *E591*
9044'winheight' 'wh' number (default 1)
9045 global
9046 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009047 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009048 feature}
9049 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009050 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009051 focus goes to a window that is smaller, its size is increased, at the
9052 cost of the height of other windows.
9053 Set 'winheight' to a small number for normal editing.
9054 Set it to 999 to make the current window fill most of the screen.
9055 Other windows will be only 'winminheight' high. This has the drawback
9056 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9057 to create only two windows, set the option after startup is done,
9058 using the |VimEnter| event: >
9059 au VimEnter * set winheight=999
9060< Minimum value is 1.
9061 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009062 height of the current window.
9063 'winheight' applies to the current window. Use 'winminheight' to set
9064 the minimal height for other windows.
9065
9066 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9067'winfixheight' 'wfh' boolean (default off)
9068 local to window
9069 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009070 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009071 feature}
9072 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009073 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9074 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009075 The height may be changed anyway when running out of room.
9076
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009077 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9078'winfixwidth' 'wfw' boolean (default off)
9079 local to window
9080 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009081 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009082 feature}
9083 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009084 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009085 The width may be changed anyway when running out of room.
9086
Bram Moolenaar071d4272004-06-13 20:20:40 +00009087 *'winminheight'* *'wmh'*
9088'winminheight' 'wmh' number (default 1)
9089 global
9090 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009091 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009092 feature}
9093 The minimal height of a window, when it's not the current window.
9094 This is a hard minimum, windows will never become smaller.
9095 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9096 status bar) if necessary. They will return to at least one line when
9097 they become active (since the cursor has to have somewhere to go.)
9098 Use 'winheight' to set the minimal height of the current window.
9099 This option is only checked when making a window smaller. Don't use a
9100 large number, it will cause errors when opening more than a few
9101 windows. A value of 0 to 3 is reasonable.
9102
9103 *'winminwidth'* *'wmw'*
9104'winminwidth' 'wmw' number (default 1)
9105 global
9106 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009107 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009108 feature}
9109 The minimal width of a window, when it's not the current window.
9110 This is a hard minimum, windows will never become smaller.
9111 When set to zero, windows may be "squashed" to zero columns (i.e. just
9112 a vertical separator) if necessary. They will return to at least one
9113 line when they become active (since the cursor has to have somewhere
9114 to go.)
9115 Use 'winwidth' to set the minimal width of the current window.
9116 This option is only checked when making a window smaller. Don't use a
9117 large number, it will cause errors when opening more than a few
9118 windows. A value of 0 to 12 is reasonable.
9119
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009120 *'winptydll'*
9121'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9122 global
9123 {not in Vi}
9124 {only available when compiled with the |terminal|
9125 feature on MS-Windows}
9126 Specifies the name of the winpty shared library, used for the
9127 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009128 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009129 a fallback.
9130 Environment variables are expanded |:set_env|.
9131 This option cannot be set from a |modeline| or in the |sandbox|, for
9132 security reasons.
9133
Bram Moolenaar071d4272004-06-13 20:20:40 +00009134 *'winwidth'* *'wiw'* *E592*
9135'winwidth' 'wiw' number (default 20)
9136 global
9137 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009138 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009139 feature}
9140 Minimal number of columns for the current window. This is not a hard
9141 minimum, Vim will use fewer columns if there is not enough room. If
9142 the current window is smaller, its size is increased, at the cost of
9143 the width of other windows. Set it to 999 to make the current window
9144 always fill the screen. Set it to a small number for normal editing.
9145 The width is not adjusted after one of the commands to change the
9146 width of the current window.
9147 'winwidth' applies to the current window. Use 'winminwidth' to set
9148 the minimal width for other windows.
9149
9150 *'wrap'* *'nowrap'*
9151'wrap' boolean (default on)
9152 local to window
9153 {not in Vi}
9154 This option changes how text is displayed. It doesn't change the text
9155 in the buffer, see 'textwidth' for that.
9156 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009157 displaying continues on the next line. When off lines will not wrap
9158 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009159 moved to a part that is not shown, the screen will scroll
9160 horizontally.
9161 The line will be broken in the middle of a word if necessary. See
9162 'linebreak' to get the break at a word boundary.
9163 To make scrolling horizontally a bit more useful, try this: >
9164 :set sidescroll=5
9165 :set listchars+=precedes:<,extends:>
9166< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009167 This option can't be set from a |modeline| when the 'diff' option is
9168 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009169
9170 *'wrapmargin'* *'wm'*
9171'wrapmargin' 'wm' number (default 0)
9172 local to buffer
9173 Number of characters from the right window border where wrapping
9174 starts. When typing text beyond this limit, an <EOL> will be inserted
9175 and inserting continues on the next line.
9176 Options that add a margin, such as 'number' and 'foldcolumn', cause
9177 the text width to be further reduced. This is Vi compatible.
9178 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009179 This option is set to 0 when 'paste' is set and restored when 'paste'
9180 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009181 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9182 and less usefully}
9183
9184 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9185'wrapscan' 'ws' boolean (default on) *E384* *E385*
9186 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009187 Searches wrap around the end of the file. Also applies to |]s| and
9188 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009189
9190 *'write'* *'nowrite'*
9191'write' boolean (default on)
9192 global
9193 {not in Vi}
9194 Allows writing files. When not set, writing a file is not allowed.
9195 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009196 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009197 argument. Filtering text is still possible, even though this requires
9198 writing a temporary file.
9199
9200 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9201'writeany' 'wa' boolean (default off)
9202 global
9203 Allows writing to any file with no need for "!" override.
9204
9205 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9206'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9207 otherwise)
9208 global
9209 {not in Vi}
9210 Make a backup before overwriting a file. The backup is removed after
9211 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009212 also on.
9213 WARNING: Switching this option off means that when Vim fails to write
9214 your buffer correctly and then, for whatever reason, Vim exits, you
9215 lose both the original file and what you were writing. Only reset
9216 this option if your file system is almost full and it makes the write
9217 fail (and make sure not to exit Vim until the write was successful).
9218 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009219 When the 'backupskip' pattern matches, a backup is not made anyway.
9220 NOTE: This option is set to the default value when 'compatible' is
9221 set.
9222
9223 *'writedelay'* *'wd'*
9224'writedelay' 'wd' number (default 0)
9225 global
9226 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009227 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009228 screen. When non-zero, characters are sent to the terminal one by
9229 one. For MS-DOS pcterm this does not work. For debugging purposes.
9230
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009231 vim:tw=78:ts=8:noet:ft=help:norl: