blob: e664c962176ba4a677235990290222b9a7396991 [file] [log] [blame]
Bram Moolenaar314dd792019-02-03 15:27:20 +01001*options.txt* For Vim version 8.1. Last change: 2019 Feb 03
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 Moolenaar95bafa22018-10-02 13:26:25 +0200123< shiftwidth=4 ~
124 Last set from modeline line 1 ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000127This 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:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200135 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000136 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=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100357This only works for a string option. For a number or boolean option you need
358to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100360Note that for non-boolean and non-number options using "<" copies the global
361value to the local value, it doesn't switch back to using the global value
362(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000363 :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 Moolenaar14184a32019-02-16 15:10:30 +0100691 This option was for using Farsi, which has been removed. See
692 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693
694 *'ambiwidth'* *'ambw'*
695'ambiwidth' 'ambw' string (default: "single")
696 global
697 {not in Vi}
698 {only available when compiled with the |+multi_byte|
699 feature}
700 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
701 Tells Vim what to do with characters with East Asian Width Class
702 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
703 letters, Cyrillic letters).
704
705 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 expected by most users.
708 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200709 *E834* *E835*
710 The value "double" cannot be used if 'listchars' or 'fillchars'
711 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713 There are a number of CJK fonts for which the width of glyphs for
714 those characters are solely based on how many octets they take in
715 legacy/traditional CJK encodings. In those encodings, Euro,
716 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000717 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000719 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 Vim is running inside a terminal (emulators) that uses a CJK font
721 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
722 this option should be set to "double" to match the width perceived
723 by Vim with the width of glyphs in the font. Perhaps it also has
724 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
725 when the system locale is set to one of CJK locales. See Unicode
726 Standard Annex #11 (http://www.unicode.org/reports/tr11).
727
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100728 Vim may set this option automatically at startup time when Vim is
729 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200730 escape sequence to request cursor position report. The response can
731 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100732
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
734'antialias' 'anti' boolean (default: off)
735 global
736 {not in Vi}
737 {only available when compiled with GUI enabled
738 on Mac OS X}
739 This option only has an effect in the GUI version of Vim on Mac OS X
740 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
741 which can be easier to read at certain sizes on certain displays.
742 Setting this option can sometimes cause problems if 'guifont' is set
743 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100744 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000745
746 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
747'autochdir' 'acd' boolean (default off)
748 global
749 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200750 {only available when compiled with it, use
751 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000752 When on, Vim will change the current working directory whenever you
753 open a file, switch buffers, delete a buffer or open/close a window.
754 It will change to the directory containing the file which was opened
755 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000756 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757
758 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
759'arabic' 'arab' boolean (default off)
760 local to window
761 {not in Vi}
762 {only available when compiled with the |+arabic|
763 feature}
764 This option can be set to start editing Arabic text.
765 Setting this option will:
766 - Set the 'rightleft' option, unless 'termbidi' is set.
767 - Set the 'arabicshape' option, unless 'termbidi' is set.
768 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
769 between typing English and Arabic key mapping.
770 - Set the 'delcombine' option
771 Note that 'encoding' must be "utf-8" for working with Arabic text.
772
773 Resetting this option will:
774 - Reset the 'rightleft' option.
775 - Disable the use of 'keymap' (without changing its value).
776 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200777 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100778 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 Also see |arabic.txt|.
780
781 *'arabicshape'* *'arshape'*
782 *'noarabicshape'* *'noarshape'*
783'arabicshape' 'arshape' boolean (default on)
784 global
785 {not in Vi}
786 {only available when compiled with the |+arabic|
787 feature}
788 When on and 'termbidi' is off, the required visual character
789 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200790 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 one which encompasses:
792 a) the changing/morphing of characters based on their location
793 within a word (initial, medial, final and stand-alone).
794 b) the enabling of the ability to compose characters
795 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100796 When disabled the display shows each character's true stand-alone
797 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 Arabic is a complex language which requires other settings, for
799 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100800 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
803'autoindent' 'ai' boolean (default off)
804 local to buffer
805 Copy indent from current line when starting a new line (typing <CR>
806 in Insert mode or when using the "o" or "O" command). If you do not
807 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000808 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
809 to another line has the same effect, unless the 'I' flag is included
810 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000811 When autoindent is on, formatting (with the "gq" command or when you
812 reach 'textwidth' in Insert mode) uses the indentation of the first
813 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 When 'smartindent' or 'cindent' is on the indent is changed in
815 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200816 The 'autoindent' option is reset when the 'paste' option is set and
817 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 {small difference from Vi: After the indent is deleted when typing
819 <Esc> or <CR>, the cursor position when moving up or down is after the
820 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
821
822 *'autoread'* *'ar'* *'noautoread'* *'noar'*
823'autoread' 'ar' boolean (default off)
824 global or local to buffer |global-local|
825 {not in Vi}
826 When a file has been detected to have been changed outside of Vim and
827 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200828 When the file has been deleted this is not done, so you have the text
829 from before it was deleted. When it appears again then it is read.
830 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831 If this option has a local value, use this command to switch back to
832 using the global value: >
833 :set autoread<
834<
835 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
836'autowrite' 'aw' boolean (default off)
837 global
838 Write the contents of the file, if it has been modified, on each
839 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000840 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
842 Note that for some commands the 'autowrite' option is not used, see
843 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200844 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200845 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
847 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
848'autowriteall' 'awa' boolean (default off)
849 global
850 {not in Vi}
851 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
852 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
853 Setting this option also implies that Vim behaves like 'autowrite' has
854 been set.
855
856 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200857'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000858 global
859 {not in Vi}
860 When set to "dark", Vim will try to use colors that look good on a
861 dark background. When set to "light", Vim will try to use colors that
862 look good on a light background. Any other value is illegal.
863 Vim tries to set the default value according to the terminal used.
864 This will not always be correct.
865 Setting this option does not change the background color, it tells Vim
866 what the background color looks like. For changing the background
867 color, see |:hi-normal|.
868
869 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000870 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000871 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100872 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000873 setting 'background' will cause the color scheme to be reloaded. If
874 the color scheme adjusts to the value of 'background' this will work.
875 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100876 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000877
878 When setting 'background' to the default value with: >
879 :set background&
880< Vim will guess the value. In the GUI this should work correctly,
881 in other cases Vim might not be able to guess the right value.
882
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200883 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200884 color from the terminal. If the returned RGB value is dark/light and
885 'background' is not dark/light, 'background' will be set and the
886 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200887 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100888 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200889
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890 When starting the GUI, the default value for 'background' will be
891 "light". When the value is not set in the .gvimrc, and Vim detects
892 that the background is actually quite dark, 'background' is set to
893 "dark". But this happens only AFTER the .gvimrc file has been read
894 (because the window needs to be opened to find the actual background
895 color). To get around this, force the GUI window to be opened by
896 putting a ":gui" command in the .gvimrc file, before where the value
897 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200898
899 For MS-DOS, Windows and OS/2 the default is "dark".
900 For other systems "dark" is used when 'term' is "linux",
901 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
902 background. Otherwise the default is "light".
903
Bram Moolenaarc572da52017-08-27 16:52:01 +0200904 The |:terminal| command and the |term_start()| function use the
905 'background' value to decide whether the terminal window will start
906 with a white or black background.
907
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 Normally this option would be set in the .vimrc file. Possibly
909 depending on the terminal name. Example: >
910 :if &term == "pcterm"
911 : set background=dark
912 :endif
913< When this option is set, the default settings for the highlight groups
914 will change. To use other settings, place ":highlight" commands AFTER
915 the setting of the 'background' option.
916 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
917 to select the colors for syntax highlighting. After changing this
918 option, you must load syntax.vim again to see the result. This can be
919 done with ":syntax on".
920
921 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200922'backspace' 'bs' string (default "", set to "indent,eol,start"
923 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 global
925 {not in Vi}
926 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
927 mode. This is a list of items, separated by commas. Each item allows
928 a way to backspace over something:
929 value effect ~
930 indent allow backspacing over autoindent
931 eol allow backspacing over line breaks (join lines)
932 start allow backspacing over the start of insert; CTRL-W and CTRL-U
933 stop once at the start of insert.
934
935 When the value is empty, Vi compatible backspacing is used.
936
937 For backwards compatibility with version 5.4 and earlier:
938 value effect ~
939 0 same as ":set backspace=" (Vi compatible)
940 1 same as ":set backspace=indent,eol"
941 2 same as ":set backspace=indent,eol,start"
942
943 See |:fixdel| if your <BS> or <Del> key does not do what you want.
944 NOTE: This option is set to "" when 'compatible' is set.
945
946 *'backup'* *'bk'* *'nobackup'* *'nobk'*
947'backup' 'bk' boolean (default off)
948 global
949 {not in Vi}
950 Make a backup before overwriting a file. Leave it around after the
951 file has been successfully written. If you do not want to keep the
952 backup file, but you do want a backup while the file is being
953 written, reset this option and set the 'writebackup' option (this is
954 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000955 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000956 |backup-table| for more explanations.
957 When the 'backupskip' pattern matches, a backup is not made anyway.
958 When 'patchmode' is set, the backup may be renamed to become the
959 oldest version of a file.
960 NOTE: This option is reset when 'compatible' is set.
961
962 *'backupcopy'* *'bkc'*
963'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200964 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 {not in Vi}
966 When writing a file and a backup is made, this option tells how it's
967 done. This is a comma separated list of words.
968
969 The main values are:
970 "yes" make a copy of the file and overwrite the original one
971 "no" rename the file and write a new one
972 "auto" one of the previous, what works best
973
974 Extra values that can be combined with the ones above are:
975 "breaksymlink" always break symlinks when writing
976 "breakhardlink" always break hardlinks when writing
977
978 Making a copy and overwriting the original file:
979 - Takes extra time to copy the file.
980 + When the file has special attributes, is a (hard/symbolic) link or
981 has a resource fork, all this is preserved.
982 - When the file is a link the backup will have the name of the link,
983 not of the real file.
984
985 Renaming the file and writing a new one:
986 + It's fast.
987 - Sometimes not all attributes of the file can be copied to the new
988 file.
989 - When the file is a link the new file will not be a link.
990
991 The "auto" value is the middle way: When Vim sees that renaming file
992 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000993 the file is not a link) that is used. When problems are expected, a
994 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995
996 The "breaksymlink" and "breakhardlink" values can be used in
997 combination with any of "yes", "no" and "auto". When included, they
998 force Vim to always break either symbolic or hard links by doing
999 exactly what the "no" option does, renaming the original file to
1000 become the backup and writing a new file in its place. This can be
1001 useful for example in source trees where all the files are symbolic or
1002 hard links and any changes should stay in the local source tree, not
1003 be propagated back to the original source.
1004 *crontab*
1005 One situation where "no" and "auto" will cause problems: A program
1006 that opens a file, invokes Vim to edit that file, and then tests if
1007 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001008 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 example.
1010
1011 When a copy is made, the original file is truncated and then filled
1012 with the new text. This means that protection bits, owner and
1013 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001014 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 group of the backup is set to the group of the original file. If this
1016 fails, the protection bits for the group are made the same as for
1017 others.
1018
1019 When the file is renamed this is the other way around: The backup has
1020 the same attributes of the original file, and the newly written file
1021 is owned by the current user. When the file was a (hard/symbolic)
1022 link, the new file will not! That's why the "auto" value doesn't
1023 rename when the file is a link. The owner and group of the newly
1024 written file will be set to the same ones as the original file, but
1025 the system may refuse to do this. In that case the "auto" value will
1026 again not rename the file.
1027
Bram Moolenaar036986f2017-03-16 17:41:02 +01001028 NOTE: This option is set to the Vi default value when 'compatible' is
1029 set and to the Vim default value when 'compatible' is reset.
1030
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 *'backupdir'* *'bdir'*
1032'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001033 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 for Unix: ".,~/tmp,~/")
1035 global
1036 {not in Vi}
1037 List of directories for the backup file, separated with commas.
1038 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001039 where this is possible. The directory must exist, Vim will not
1040 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001041 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 impossible!). Writing may fail because of this.
1043 - A directory "." means to put the backup file in the same directory
1044 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001045 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 put the backup file relative to where the edited file is. The
1047 leading "." is replaced with the path name of the edited file.
1048 ("." inside a directory name has no special meaning).
1049 - Spaces after the comma are ignored, other spaces are considered part
1050 of the directory name. To have a space at the start of a directory
1051 name, precede it with a backslash.
1052 - To include a comma in a directory name precede it with a backslash.
1053 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001054 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001055 the backup file name will be built from the complete path to the
1056 file with all path separators changed to percent '%' signs. This
1057 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001058 On Win32, it is also possible to end with "\\". However, When a
1059 separating comma is following, you must use "//", since "\\" will
1060 include the comma in the file name. Therefore it is recommended to
1061 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 - Environment variables are expanded |:set_env|.
1063 - Careful with '\' characters, type one before a space, type two to
1064 get one in the option (see |option-backslash|), for example: >
1065 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1066< - For backwards compatibility with Vim version 3.0 a '>' at the start
1067 of the option is removed.
1068 See also 'backup' and 'writebackup' options.
1069 If you want to hide your backup files on Unix, consider this value: >
1070 :set backupdir=./.backup,~/.backup,.,/tmp
1071< You must create a ".backup" directory in each directory and in your
1072 home directory for this to work properly.
1073 The use of |:set+=| and |:set-=| is preferred when adding or removing
1074 directories from the list. This avoids problems when a future version
1075 uses another default.
1076 This option cannot be set from a |modeline| or in the |sandbox|, for
1077 security reasons.
1078
1079 *'backupext'* *'bex'* *E589*
1080'backupext' 'bex' string (default "~", for VMS: "_")
1081 global
1082 {not in Vi}
1083 String which is appended to a file name to make the name of the
1084 backup file. The default is quite unusual, because this avoids
1085 accidentally overwriting existing files with a backup file. You might
1086 prefer using ".bak", but make sure that you don't have files with
1087 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001088 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001090 If you like to keep a lot of backups, you could use a BufWritePre
1091 autocommand to change 'backupext' just before writing the file to
1092 include a timestamp. >
1093 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1094< Use 'backupdir' to put the backup in a different directory.
1095
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001097'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1098 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1099 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001100 global
1101 {not in Vi}
1102 {not available when compiled without the |+wildignore|
1103 feature}
1104 A list of file patterns. When one of the patterns matches with the
1105 name of the file which is written, no backup file is created. Both
1106 the specified file name and the full path name of the file are used.
1107 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1108 Watch out for special characters, see |option-backslash|.
1109 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001110 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001111
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001112 WARNING: Not having a backup file means that when Vim fails to write
1113 your buffer correctly and then, for whatever reason, Vim exits, you
1114 lose both the original file and what you were writing. Only disable
1115 backups if you don't care about losing the file.
1116
Bram Moolenaar02467872007-05-06 13:22:01 +00001117 Note that environment variables are not expanded. If you want to use
1118 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001119 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001120
1121< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001122 backup would be made by renaming the original file crontab won't see
1123 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124
1125 *'balloondelay'* *'bdlay'*
1126'balloondelay' 'bdlay' number (default: 600)
1127 global
1128 {not in Vi}
1129 {only available when compiled with the |+balloon_eval|
1130 feature}
1131 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1132
1133 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1134'ballooneval' 'beval' boolean (default off)
1135 global
1136 {not in Vi}
1137 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001139 Switch on the |balloon-eval| functionality for the GUI.
1140
1141 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1142 *'nobevalterm'*
1143'balloonevalterm' 'bevalterm' boolean (default off)
1144 global
1145 {not in Vi}
1146 {only available when compiled with the
1147 |+balloon_eval_term| feature}
1148 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001150 *'balloonexpr'* *'bexpr'*
1151'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001152 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 {not in Vi}
1154 {only available when compiled with the |+balloon_eval|
1155 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001156 Expression for text to show in evaluation balloon. It is only used
1157 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001158
1159 v:beval_bufnr number of the buffer in which balloon is going to show
1160 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001161 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001162 v:beval_lnum line number
1163 v:beval_col column number (byte index)
1164 v:beval_text word under or after the mouse pointer
1165
1166 The evaluation of the expression must not have side effects!
1167 Example: >
1168 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001169 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001170 \', column ' . v:beval_col .
1171 \ ' of file ' . bufname(v:beval_bufnr) .
1172 \ ' on word "' . v:beval_text . '"'
1173 endfunction
1174 set bexpr=MyBalloonExpr()
1175 set ballooneval
1176<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001177 Also see |balloon_show()|, can be used if the content of the balloon
1178 is to be fetched asynchronously.
1179
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001180 NOTE: The balloon is displayed only if the cursor is on a text
1181 character. If the result of evaluating 'balloonexpr' is not empty,
1182 Vim does not try to send a message to an external debugger (Netbeans
1183 or Sun Workshop).
1184
Bram Moolenaar30b65812012-07-12 22:01:11 +02001185 The expression will be evaluated in the |sandbox| when set from a
1186 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001187
1188 It is not allowed to change text or jump to another window while
1189 evaluating 'balloonexpr' |textlock|.
1190
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001191 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001192 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001193< When they are supported "\n" characters will start a new line. If the
1194 expression evaluates to a |List| this is equal to using each List item
1195 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001196 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001197
Bram Moolenaar165bc692015-07-21 17:53:25 +02001198 *'belloff'* *'bo'*
1199'belloff' 'bo' string (default "")
1200 global
1201 {not in Vi}
1202 Specifies for which events the bell will not be rung. It is a comma
1203 separated list of items. For each item that is present, the bell
1204 will be silenced. This is most useful to specify specific events in
1205 insert mode to be silenced.
1206
1207 item meaning when present ~
1208 all All events.
1209 backspace When hitting <BS> or <Del> and deleting results in an
1210 error.
1211 cursor Fail to move around using the cursor keys or
1212 <PageUp>/<PageDown> in |Insert-mode|.
1213 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1214 |i_CTRL-X_CTRL-T|.
1215 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1216 |i_CTRL-E|.
1217 ctrlg Unknown Char after <C-G> in Insert mode.
1218 error Other Error occurred (e.g. try to join last line)
1219 (mostly used in |Normal-mode| or |Cmdline-mode|).
1220 esc hitting <Esc> in |Normal-mode|.
1221 ex In |Visual-mode|, hitting |Q| results in an error.
1222 hangul Error occurred when using hangul input.
1223 insertmode Pressing <Esc> in 'insertmode'.
1224 lang Calling the beep module for Lua/Mzscheme/TCL.
1225 mess No output available for |g<|.
1226 showmatch Error occurred for 'showmatch' function.
1227 operator Empty region error |cpo-E|.
1228 register Unknown register after <C-R> in |Insert-mode|.
1229 shell Bell from shell output |:!|.
1230 spell Error happened on spell suggest.
1231 wildmode More matches in |cmdline-completion| available
1232 (depends on the 'wildmode' setting).
1233
Bram Moolenaar036986f2017-03-16 17:41:02 +01001234 This is most useful to fine tune when in Insert mode the bell should
1235 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001236 indicate that an error occurred. It can be silenced by adding the
1237 "error" keyword.
1238
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1240'binary' 'bin' boolean (default off)
1241 local to buffer
1242 {not in Vi}
1243 This option should be set before editing a binary file. You can also
1244 use the |-b| Vim argument. When this option is switched on a few
1245 options will be changed (also when it already was on):
1246 'textwidth' will be set to 0
1247 'wrapmargin' will be set to 0
1248 'modeline' will be off
1249 'expandtab' will be off
1250 Also, 'fileformat' and 'fileformats' options will not be used, the
1251 file is read and written like 'fileformat' was "unix" (a single <NL>
1252 separates lines).
1253 The 'fileencoding' and 'fileencodings' options will not be used, the
1254 file is read without conversion.
1255 NOTE: When you start editing a(nother) file while the 'bin' option is
1256 on, settings from autocommands may change the settings again (e.g.,
1257 'textwidth'), causing trouble when editing. You might want to set
1258 'bin' again when the file has been loaded.
1259 The previous values of these options are remembered and restored when
1260 'bin' is switched from on to off. Each buffer has its own set of
1261 saved option values.
1262 To edit a file with 'binary' set you can use the |++bin| argument.
1263 This avoids you have to do ":set bin", which would have effect for all
1264 files you edit.
1265 When writing a file the <EOL> for the last line is only written if
1266 there was one in the original file (normally Vim appends an <EOL> to
1267 the last line if there is none; this would make the file longer). See
1268 the 'endofline' option.
1269
1270 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1271'bioskey' 'biosk' boolean (default on)
1272 global
1273 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001274 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275
1276 *'bomb'* *'nobomb'*
1277'bomb' boolean (default off)
1278 local to buffer
1279 {not in Vi}
1280 {only available when compiled with the |+multi_byte|
1281 feature}
1282 When writing a file and the following conditions are met, a BOM (Byte
1283 Order Mark) is prepended to the file:
1284 - this option is on
1285 - the 'binary' option is off
1286 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1287 endian variants.
1288 Some applications use the BOM to recognize the encoding of the file.
1289 Often used for UCS-2 files on MS-Windows. For other applications it
1290 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001291 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1293 check for the presence of the BOM is done and 'bomb' set accordingly.
1294 Unless 'binary' is set, it is removed from the first line, so that you
1295 don't see it when editing. When you don't change the options, the BOM
1296 will be restored when writing the file.
1297
1298 *'breakat'* *'brk'*
1299'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1300 global
1301 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001302 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 feature}
1304 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001305 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1306 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001308 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309'breakindent' 'bri' boolean (default off)
1310 local to window
1311 {not in Vi}
1312 {not available when compiled without the |+linebreak|
1313 feature}
1314 Every wrapped line will continue visually indented (same amount of
1315 space as the beginning of that line), thus preserving horizontal blocks
1316 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001317 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318
1319 *'breakindentopt'* *'briopt'*
1320'breakindentopt' 'briopt' string (default empty)
1321 local to window
1322 {not in Vi}
1323 {not available when compiled without the |+linebreak|
1324 feature}
1325 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001326 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001327 min:{n} Minimum text width that will be kept after
1328 applying 'breakindent', even if the resulting
1329 text should normally be narrower. This prevents
1330 text indented almost to the right window border
1331 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001332 shift:{n} After applying 'breakindent', the wrapped line's
1333 beginning will be shifted by the given number of
1334 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001335 indentation (negative) or emphasizing the line
1336 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001337 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001338 additional indent.
1339 The default value for min is 20 and shift is 0.
1340
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001342'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001344 {not in Vi} {only for Motif, Athena, GTK, Mac and
1345 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001347 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001348 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 buffer Use the directory of the related buffer.
1350 current Use the current directory.
1351 {path} Use the specified directory
1352
1353 *'bufhidden'* *'bh'*
1354'bufhidden' 'bh' string (default: "")
1355 local to buffer
1356 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 This option specifies what happens when a buffer is no longer
1358 displayed in a window:
1359 <empty> follow the global 'hidden' option
1360 hide hide the buffer (don't unload it), also when 'hidden'
1361 is not set
1362 unload unload the buffer, also when 'hidden' is set or using
1363 |:hide|
1364 delete delete the buffer from the buffer list, also when
1365 'hidden' is set or using |:hide|, like using
1366 |:bdelete|
1367 wipe wipe out the buffer from the buffer list, also when
1368 'hidden' is set or using |:hide|, like using
1369 |:bwipeout|
1370
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001371 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001372 are lost without a warning. Also, these values may break autocommands
1373 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 This option is used together with 'buftype' and 'swapfile' to specify
1375 special kinds of buffers. See |special-buffers|.
1376
1377 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1378'buflisted' 'bl' boolean (default: on)
1379 local to buffer
1380 {not in Vi}
1381 When this option is set, the buffer shows up in the buffer list. If
1382 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1383 This option is reset by Vim for buffers that are only used to remember
1384 a file name or marks. Vim sets it when starting to edit a buffer.
1385 But not when moving to a buffer with ":buffer".
1386
1387 *'buftype'* *'bt'* *E382*
1388'buftype' 'bt' string (default: "")
1389 local to buffer
1390 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 The value of this option specifies the type of a buffer:
1392 <empty> normal buffer
1393 nofile buffer which is not related to a file and will not be
1394 written
1395 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001396 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001397 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001399 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001400 help help buffer (you are not supposed to set this
1401 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001402 terminal buffer for a |terminal| (you are not supposed to set
1403 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001404 prompt buffer where only the last line can be edited, meant
1405 to be used by a plugin, see |prompt-buffer|
1406 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407
1408 This option is used together with 'bufhidden' and 'swapfile' to
1409 specify special kinds of buffers. See |special-buffers|.
1410
1411 Be careful with changing this option, it can have many side effects!
1412
Bram Moolenaar280f1262006-01-30 00:14:18 +00001413 A "quickfix" buffer is only used for the error list and the location
1414 list. This value is set by the |:cwindow| and |:lwindow| commands and
1415 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416
1417 "nofile" and "nowrite" buffers are similar:
1418 both: The buffer is not to be written to disk, ":w" doesn't
1419 work (":w filename" does work though).
1420 both: The buffer is never considered to be |'modified'|.
1421 There is no warning when the changes will be lost, for
1422 example when you quit Vim.
1423 both: A swap file is only created when using too much memory
1424 (when 'swapfile' has been reset there is never a swap
1425 file).
1426 nofile only: The buffer name is fixed, it is not handled like a
1427 file name. It is not modified in response to a |:cd|
1428 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001429 both: When using ":e bufname" and already editing "bufname"
1430 the buffer is made empty and autocommands are
1431 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001432 *E676*
1433 "acwrite" implies that the buffer name is not related to a file, like
1434 "nofile", but it will be written. Thus, in contrast to "nofile" and
1435 "nowrite", ":w" does work and a modified buffer can't be abandoned
1436 without saving. For writing there must be matching |BufWriteCmd|,
1437 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438
1439 *'casemap'* *'cmp'*
1440'casemap' 'cmp' string (default: "internal,keepascii")
1441 global
1442 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001443 {only available when compiled with the |+multi_byte|
1444 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 Specifies details about changing the case of letters. It may contain
1446 these words, separated by a comma:
1447 internal Use internal case mapping functions, the current
1448 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001449 matters when 'encoding' is a Unicode encoding,
1450 "latin1" or "iso-8859-15". When "internal" is
1451 omitted, the towupper() and towlower() system library
1452 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1454 case mapping, the current locale is not effective.
1455 This probably only matters for Turkish.
1456
1457 *'cdpath'* *'cd'* *E344* *E346*
1458'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1459 global
1460 {not in Vi}
1461 {not available when compiled without the
1462 |+file_in_path| feature}
1463 This is a list of directories which will be searched when using the
1464 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001465 for has a relative path, not an absolute part starting with "/", "./"
1466 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 The 'cdpath' option's value has the same form and semantics as
1468 |'path'|. Also see |file-searching|.
1469 The default value is taken from $CDPATH, with a "," prepended to look
1470 in the current directory first.
1471 If the default value taken from $CDPATH is not what you want, include
1472 a modified version of the following command in your vimrc file to
1473 override it: >
1474 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1475< This option cannot be set from a |modeline| or in the |sandbox|, for
1476 security reasons.
1477 (parts of 'cdpath' can be passed to the shell to expand file names).
1478
1479 *'cedit'*
1480'cedit' string (Vi default: "", Vim default: CTRL-F)
1481 global
1482 {not in Vi}
1483 {not available when compiled without the |+vertsplit|
1484 feature}
1485 The key used in Command-line Mode to open the command-line window.
1486 The default is CTRL-F when 'compatible' is off.
1487 Only non-printable keys are allowed.
1488 The key can be specified as a single character, but it is difficult to
1489 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001490 :exe "set cedit=\<C-Y>"
1491 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492< |Nvi| also has this option, but it only uses the first character.
1493 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001494 NOTE: This option is set to the Vim default value when 'compatible'
1495 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496
1497 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1498'charconvert' 'ccv' string (default "")
1499 global
1500 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001501 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 {not in Vi}
1503 An expression that is used for character encoding conversion. It is
1504 evaluated when a file that is to be read or has been written has a
1505 different encoding from what is desired.
1506 'charconvert' is not used when the internal iconv() function is
1507 supported and is able to do the conversion. Using iconv() is
1508 preferred, because it is much faster.
1509 'charconvert' is not used when reading stdin |--|, because there is no
1510 file to convert from. You will have to save the text in a file first.
1511 The expression must return zero or an empty string for success,
1512 non-zero for failure.
1513 The possible encoding names encountered are in 'encoding'.
1514 Additionally, names given in 'fileencodings' and 'fileencoding' are
1515 used.
1516 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1517 is done internally by Vim, 'charconvert' is not used for this.
1518 'charconvert' is also used to convert the viminfo file, if the 'c'
1519 flag is present in 'viminfo'. Also used for Unicode conversion.
1520 Example: >
1521 set charconvert=CharConvert()
1522 fun CharConvert()
1523 system("recode "
1524 \ . v:charconvert_from . ".." . v:charconvert_to
1525 \ . " <" . v:fname_in . " >" v:fname_out)
1526 return v:shell_error
1527 endfun
1528< The related Vim variables are:
1529 v:charconvert_from name of the current encoding
1530 v:charconvert_to name of the desired encoding
1531 v:fname_in name of the input file
1532 v:fname_out name of the output file
1533 Note that v:fname_in and v:fname_out will never be the same.
1534 Note that v:charconvert_from and v:charconvert_to may be different
1535 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1536 Encryption is not done by Vim when using 'charconvert'. If you want
1537 to encrypt the file after conversion, 'charconvert' should take care
1538 of this.
1539 This option cannot be set from a |modeline| or in the |sandbox|, for
1540 security reasons.
1541
1542 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1543'cindent' 'cin' boolean (default off)
1544 local to buffer
1545 {not in Vi}
1546 {not available when compiled without the |+cindent|
1547 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001548 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 that trigger reindenting in insert mode and 'cinoptions' to set your
1550 preferred indent style.
1551 If 'indentexpr' is not empty, it overrules 'cindent'.
1552 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1553 the "=" operator indents using this algorithm rather than calling an
1554 external program.
1555 See |C-indenting|.
1556 When you don't like the way 'cindent' works, try the 'smartindent'
1557 option or 'indentexpr'.
1558 This option is not used when 'paste' is set.
1559 NOTE: This option is reset when 'compatible' is set.
1560
1561 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001562'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 local to buffer
1564 {not in Vi}
1565 {not available when compiled without the |+cindent|
1566 feature}
1567 A list of keys that, when typed in Insert mode, cause reindenting of
1568 the current line. Only used if 'cindent' is on and 'indentexpr' is
1569 empty.
1570 For the format of this option see |cinkeys-format|.
1571 See |C-indenting|.
1572
1573 *'cinoptions'* *'cino'*
1574'cinoptions' 'cino' string (default "")
1575 local to buffer
1576 {not in Vi}
1577 {not available when compiled without the |+cindent|
1578 feature}
1579 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1580 program. See |cinoptions-values| for the values of this option, and
1581 |C-indenting| for info on C indenting in general.
1582
1583
1584 *'cinwords'* *'cinw'*
1585'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1586 local to buffer
1587 {not in Vi}
1588 {not available when compiled without both the
1589 |+cindent| and the |+smartindent| features}
1590 These keywords start an extra indent in the next line when
1591 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1592 an appropriate place (inside {}).
1593 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1594 matter, include the keyword both the uppercase and lowercase:
1595 "if,If,IF".
1596
1597 *'clipboard'* *'cb'*
1598'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1599 for X-windows, "" otherwise)
1600 global
1601 {not in Vi}
1602 {only in GUI versions or when the |+xterm_clipboard|
1603 feature is included}
1604 This option is a list of comma separated names.
1605 These names are recognized:
1606
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001607 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 unnamed When included, Vim will use the clipboard register '*'
1609 for all yank, delete, change and put operations which
1610 would normally go to the unnamed register. When a
1611 register is explicitly specified, it will always be
1612 used regardless of whether "unnamed" is in 'clipboard'
1613 or not. The clipboard register can always be
1614 explicitly accessed using the "* notation. Also see
1615 |gui-clipboard|.
1616
Bram Moolenaar30b65812012-07-12 22:01:11 +02001617 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001618 unnamedplus A variant of the "unnamed" flag which uses the
1619 clipboard register '+' (|quoteplus|) instead of
1620 register '*' for all yank, delete, change and put
1621 operations which would normally go to the unnamed
1622 register. When "unnamed" is also included to the
1623 option, yank operations (but not delete, change or
1624 put) will additionally copy the text into register
1625 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001626 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001627 Availability can be checked with: >
1628 if has('unnamedplus')
1629<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001630 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 autoselect Works like the 'a' flag in 'guioptions': If present,
1632 then whenever Visual mode is started, or the Visual
1633 area extended, Vim tries to become the owner of the
1634 windowing system's global selection or put the
1635 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001636 register "*. See |'go-a'| and |quotestar| for details.
1637 When the GUI is active, the 'a' flag in 'guioptions'
1638 is used, when the GUI is not active, this "autoselect"
1639 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 Also applies to the modeless selection.
1641
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001642 *clipboard-autoselectplus*
1643 autoselectplus Like "autoselect" but using the + register instead of
1644 the * register. Compare to the 'P' flag in
1645 'guioptions'.
1646
1647 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 autoselectml Like "autoselect", but for the modeless selection
1649 only. Compare to the 'A' flag in 'guioptions'.
1650
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001651 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001652 html When the clipboard contains HTML, use this when
1653 pasting. When putting text on the clipboard, mark it
1654 as HTML. This works to copy rendered HTML from
1655 Firefox, paste it as raw HTML in Vim, select the HTML
1656 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001657 You probably want to add this only temporarily,
1658 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001659 Only supported for GTK version 2 and later.
1660 Only available with the |+multi_byte| feature.
1661
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001662 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 exclude:{pattern}
1664 Defines a pattern that is matched against the name of
1665 the terminal 'term'. If there is a match, no
1666 connection will be made to the X server. This is
1667 useful in this situation:
1668 - Running Vim in a console.
1669 - $DISPLAY is set to start applications on another
1670 display.
1671 - You do not want to connect to the X server in the
1672 console, but do want this in a terminal emulator.
1673 To never connect to the X server use: >
1674 exclude:.*
1675< This has the same effect as using the |-X| argument.
1676 Note that when there is no connection to the X server
1677 the window title won't be restored and the clipboard
1678 cannot be accessed.
1679 The value of 'magic' is ignored, {pattern} is
1680 interpreted as if 'magic' was on.
1681 The rest of the option value will be used for
1682 {pattern}, this must be the last entry.
1683
1684 *'cmdheight'* *'ch'*
1685'cmdheight' 'ch' number (default 1)
1686 global
1687 {not in Vi}
1688 Number of screen lines to use for the command-line. Helps avoiding
1689 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001690 The value of this option is stored with the tab page, so that each tab
1691 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692
1693 *'cmdwinheight'* *'cwh'*
1694'cmdwinheight' 'cwh' number (default 7)
1695 global
1696 {not in Vi}
1697 {not available when compiled without the |+vertsplit|
1698 feature}
1699 Number of screen lines to use for the command-line window. |cmdwin|
1700
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001701 *'colorcolumn'* *'cc'*
1702'colorcolumn' 'cc' string (default "")
1703 local to window
1704 {not in Vi}
1705 {not available when compiled without the |+syntax|
1706 feature}
1707 'colorcolumn' is a comma separated list of screen columns that are
1708 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1709 text. Will make screen redrawing slower.
1710 The screen column can be an absolute number, or a number preceded with
1711 '+' or '-', which is added to or subtracted from 'textwidth'. >
1712
1713 :set cc=+1 " highlight column after 'textwidth'
1714 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1715 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1716<
1717 When 'textwidth' is zero then the items with '-' and '+' are not used.
1718 A maximum of 256 columns are highlighted.
1719
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 *'columns'* *'co'* *E594*
1721'columns' 'co' number (default 80 or terminal width)
1722 global
1723 {not in Vi}
1724 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001725 initialization and does not have to be set by hand. Also see
1726 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 When Vim is running in the GUI or in a resizable window, setting this
1728 option will cause the window size to be changed. When you only want
1729 to use the size for the GUI, put the command in your |gvimrc| file.
1730 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001731 number of columns of the display, the display may be messed up. For
1732 the GUI it is always possible and Vim limits the number of columns to
1733 what fits on the screen. You can use this command to get the widest
1734 window possible: >
1735 :set columns=9999
1736< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 *'comments'* *'com'* *E524* *E525*
1739'comments' 'com' string (default
1740 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1741 local to buffer
1742 {not in Vi}
1743 {not available when compiled without the |+comments|
1744 feature}
1745 A comma separated list of strings that can start a comment line. See
1746 |format-comments|. See |option-backslash| about using backslashes to
1747 insert a space.
1748
1749 *'commentstring'* *'cms'* *E537*
1750'commentstring' 'cms' string (default "/*%s*/")
1751 local to buffer
1752 {not in Vi}
1753 {not available when compiled without the |+folding|
1754 feature}
1755 A template for a comment. The "%s" in the value is replaced with the
1756 comment text. Currently only used to add markers for folding, see
1757 |fold-marker|.
1758
1759 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001760'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001761 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001762 global
1763 {not in Vi}
1764 This option has the effect of making Vim either more Vi-compatible, or
1765 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001768 other options are also changed as a side effect.
1769 NOTE: Setting or resetting this option can have a lot of unexpected
1770 effects: Mappings are interpreted in another way, undo behaves
1771 differently, etc. If you set this option in your vimrc file, you
1772 should probably put it at the very start.
1773
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 By default this option is on and the Vi defaults are used for the
1775 options. This default was chosen for those people who want to use Vim
1776 just like Vi, and don't even (want to) know about the 'compatible'
1777 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001778 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001779 this option is switched off, and all options that have not been
1780 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001781 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001782 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001783 happen for the system-wide vimrc or gvimrc file, nor for a file given
1784 with the |-u| argument). Also see |compatible-default| and
1785 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 You can also set this option with the "-C" argument, and reset it with
1787 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001788 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 When this option is set, numerous other options are set to make Vim as
1791 Vi-compatible as possible. When this option is unset, various options
1792 are set to make Vim more useful. The table below lists all the
1793 options affected.
1794 The {?} column indicates when the options are affected:
1795 + Means that the option is set to the value given in {set value} when
1796 'compatible' is set.
1797 & Means that the option is set to the value given in {set value} when
1798 'compatible' is set AND is set to its Vim default value when
1799 'compatible' is unset.
1800 - Means the option is NOT changed when setting 'compatible' but IS
1801 set to its Vim default when 'compatible' is unset.
1802 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803
Bram Moolenaar036986f2017-03-16 17:41:02 +01001804 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001805
1806 'allowrevins' + off no CTRL-_ command
1807 'antialias' + off don't use antialiased fonts
1808 'arabic' + off reset arabic-related options
1809 'arabicshape' + on correct character shapes
1810 'backspace' + "" normal backspace
1811 'backup' + off no backup file
1812 'backupcopy' & Unix: "yes" backup file is a copy
1813 else: "auto" copy or rename backup file
1814 'balloonexpr' + "" text to show in evaluation balloon
1815 'breakindent' + off don't indent when wrapping lines
1816 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1817 'cindent' + off no C code indentation
1818 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1819 'copyindent' + off don't copy indent structure
1820 'cpoptions' & (all flags) Vi-compatible flags
1821 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001822 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001823 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001824 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001825 'cscopeverbose' + off see |cscopeverbose|
1826 'delcombine' + off unicode: delete whole char combination
1827 'digraph' + off no digraphs
1828 'esckeys' & off no <Esc>-keys in Insert mode
1829 'expandtab' + off tabs not expanded to spaces
1830 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001832 'formatexpr' + "" use 'formatprg' for auto-formatting
1833 'formatoptions' & "vt" Vi compatible formatting
1834 'gdefault' + off no default 'g' flag for ":s"
1835 'history' & 0 no commandline history
1836 'hkmap' + off no Hebrew keyboard mapping
1837 'hkmapp' + off no phonetic Hebrew keyboard mapping
1838 'hlsearch' + off no highlighting of search matches
1839 'incsearch' + off no incremental searching
1840 'indentexpr' + "" no indenting by expression
1841 'insertmode' + off do not start in Insert mode
1842 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001844 'joinspaces' + on insert 2 spaces after period
1845 'modeline' & off no modelines
1846 'more' & off no pauses in listings
1847 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1848 'numberwidth' & 8 min number of columns for line number
1849 'preserveindent'+ off don't preserve current indent structure
1850 when changing it
1851 'revins' + off no reverse insert
1852 'ruler' + off no ruler
1853 'scrolljump' + 1 no jump scroll
1854 'scrolloff' + 0 no scroll offset
1855 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1856 'shiftround' + off indent not rounded to shiftwidth
1857 'shortmess' & "" no shortening of messages
1858 'showcmd' & off command characters not shown
1859 'showmode' & off current mode not shown
1860 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1861 'smartcase' + off no automatic ignore case switch
1862 'smartindent' + off no smart indentation
1863 'smarttab' + off no smart tab size
1864 'softtabstop' + 0 tabs are always 'tabstop' positions
1865 'startofline' + on goto startofline with some commands
1866 'tagcase' & "followic" 'ignorecase' when searching tags file
1867 'tagrelative' & off tag file names are not relative
1868 'termguicolors' + off don't use highlight-(guifg|guibg)
1869 'textauto' & off no automatic textmode detection
1870 'textwidth' + 0 no automatic line wrap
1871 'tildeop' + off tilde is not an operator
1872 'ttimeout' + off no terminal timeout
1873 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001874 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001875 'virtualedit' + "" cursor can only be placed on characters
1876 'whichwrap' & "" left-right movements don't wrap
1877 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001878 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001879 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880
1881 *'complete'* *'cpt'* *E535*
1882'complete' 'cpt' string (default: ".,w,b,u,t,i")
1883 local to buffer
1884 {not in Vi}
1885 This option specifies how keyword completion |ins-completion| works
1886 when CTRL-P or CTRL-N are used. It is also used for whole-line
1887 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1888 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001889 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 w scan buffers from other windows
1891 b scan other loaded buffers that are in the buffer list
1892 u scan the unloaded buffers that are in the buffer list
1893 U scan the buffers that are not in the buffer list
1894 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001895 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 k{dict} scan the file {dict}. Several "k" flags can be given,
1897 patterns are valid too. For example: >
1898 :set cpt=k/usr/dict/*,k~/spanish
1899< s scan the files given with the 'thesaurus' option
1900 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1901 are valid too.
1902 i scan current and included files
1903 d scan current and included files for defined name or macro
1904 |i_CTRL-X_CTRL-D|
1905 ] tag completion
1906 t same as "]"
1907
1908 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1909 not executed, this may lead to unexpected completions from some files
1910 (gzipped files for example). Unloaded buffers are not scanned for
1911 whole-line completion.
1912
1913 The default is ".,w,b,u,t,i", which means to scan:
1914 1. the current buffer
1915 2. buffers in other windows
1916 3. other loaded buffers
1917 4. unloaded buffers
1918 5. tags
1919 6. included files
1920
1921 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001922 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1923 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001925 *'completefunc'* *'cfu'*
1926'completefunc' 'cfu' string (default: empty)
1927 local to buffer
1928 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001929 {not available when compiled without the |+eval|
1930 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001931 This option specifies a function to be used for Insert mode completion
1932 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001933 See |complete-functions| for an explanation of how the function is
1934 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001935 This option cannot be set from a |modeline| or in the |sandbox|, for
1936 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001937
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001938 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001939'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001940 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001941 {not available when compiled without the
1942 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001943 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001944 A comma separated list of options for Insert mode completion
1945 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001946
1947 menu Use a popup menu to show the possible completions. The
1948 menu is only shown when there is more than one match and
1949 sufficient colors are available. |ins-completion-menu|
1950
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001951 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001952 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001953 match, e.g., what file it comes from.
1954
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001955 longest Only insert the longest common text of the matches. If
1956 the menu is displayed you can use CTRL-L to add more
1957 characters. Whether case is ignored depends on the kind
1958 of completion. For buffer text the 'ignorecase' option is
1959 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001960
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001961 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001962 completion in the preview window. Only works in
1963 combination with "menu" or "menuone".
1964
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001965 noinsert Do not insert any text for a match until the user selects
1966 a match from the menu. Only works in combination with
1967 "menu" or "menuone". No effect if "longest" is present.
1968
1969 noselect Do not select a match in the menu, force the user to
1970 select one from the menu. Only works in combination with
1971 "menu" or "menuone".
1972
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001973
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001974 *'concealcursor'* *'cocu'*
1975'concealcursor' 'cocu' string (default: "")
1976 local to window
1977 {not in Vi}
1978 {not available when compiled without the |+conceal|
1979 feature}
1980 Sets the modes in which text in the cursor line can also be concealed.
1981 When the current mode is listed then concealing happens just like in
1982 other lines.
1983 n Normal mode
1984 v Visual mode
1985 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001986 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001987
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001988 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001989 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001990 are moving around text is concealed, but when starting to insert text
1991 or selecting a Visual area the concealed text is displayed, so that
1992 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001993 Keep in mind that the cursor position is not always where it's
1994 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001995
1996
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001997 *'conceallevel'* *'cole'*
1998'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001999 local to window
2000 {not in Vi}
2001 {not available when compiled without the |+conceal|
2002 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002003 Determine how text with the "conceal" syntax attribute |:syn-conceal|
2004 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02002005
Bram Moolenaar6df6f472010-07-18 18:04:50 +02002006 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002008 1 Each block of concealed text is replaced with one
2009 character. If the syntax item does not have a custom
2010 replacement character defined (see |:syn-cchar|) the
2011 character defined in 'listchars' is used (default is a
2012 space).
2013 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002014 2 Concealed text is completely hidden unless it has a
2015 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002016 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002017 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002018
Bram Moolenaara7781e02010-07-19 20:13:22 +02002019 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002020 edit and copy the text. This can be changed with the 'concealcursor'
2021 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002022
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2024'confirm' 'cf' boolean (default off)
2025 global
2026 {not in Vi}
2027 When 'confirm' is on, certain operations that would normally
2028 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2029 instead raise a |dialog| asking if you wish to save the current
2030 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2031 If 'confirm' is off you can still activate confirmation for one
2032 command only (this is most useful in mappings) with the |:confirm|
2033 command.
2034 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2035
2036 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2037'conskey' 'consk' boolean (default off)
2038 global
2039 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002040 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
2042 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2043'copyindent' 'ci' boolean (default off)
2044 local to buffer
2045 {not in Vi}
2046 Copy the structure of the existing lines indent when autoindenting a
2047 new line. Normally the new indent is reconstructed by a series of
2048 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2049 in which case only spaces are used). Enabling this option makes the
2050 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002051 existing line. 'expandtab' has no effect on these characters, a Tab
2052 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002054 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 Also see 'preserveindent'.
2056
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002057 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058'cpoptions' 'cpo' string (Vim default: "aABceFs",
2059 Vi default: all flags)
2060 global
2061 {not in Vi}
2062 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002063 this indicates Vi-compatible behavior. This is used for things where
2064 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 'cpoptions' stands for "compatible-options".
2066 Commas can be added for readability.
2067 To avoid problems with flags that are added in the future, use the
2068 "+=" and "-=" feature of ":set" |add-option-flags|.
2069 NOTE: This option is set to the Vi default value when 'compatible' is
2070 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 NOTE: This option is set to the POSIX default value at startup when
2072 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002073 variable exists |posix|. This means Vim tries to behave like the
2074 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075
2076 contains behavior ~
2077 *cpo-a*
2078 a When included, a ":read" command with a file name
2079 argument will set the alternate file name for the
2080 current window.
2081 *cpo-A*
2082 A When included, a ":write" command with a file name
2083 argument will set the alternate file name for the
2084 current window.
2085 *cpo-b*
2086 b "\|" in a ":map" command is recognized as the end of
2087 the map command. The '\' is included in the mapping,
2088 the text after the '|' is interpreted as the next
2089 command. Use a CTRL-V instead of a backslash to
2090 include the '|' in the mapping. Applies to all
2091 mapping, abbreviation, menu and autocmd commands.
2092 See also |map_bar|.
2093 *cpo-B*
2094 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002095 abbreviations, user commands and the "to" part of the
2096 menu commands. Remove this flag to be able to use a
2097 backslash like a CTRL-V. For example, the command
2098 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 'B' included: "\^[" (^[ is a real <Esc>)
2100 'B' excluded: "<Esc>" (5 characters)
2101 ('<' excluded in both cases)
2102 *cpo-c*
2103 c Searching continues at the end of any match at the
2104 cursor position, but not further than the start of the
2105 next line. When not present searching continues
2106 one character from the cursor position. With 'c'
2107 "abababababab" only gets three matches when repeating
2108 "/abab", without 'c' there are five matches.
2109 *cpo-C*
2110 C Do not concatenate sourced lines that start with a
2111 backslash. See |line-continuation|.
2112 *cpo-d*
2113 d Using "./" in the 'tags' option doesn't mean to use
2114 the tags file relative to the current file, but the
2115 tags file in the current directory.
2116 *cpo-D*
2117 D Can't use CTRL-K to enter a digraph after Normal mode
2118 commands with a character argument, like |r|, |f| and
2119 |t|.
2120 *cpo-e*
2121 e When executing a register with ":@r", always add a
2122 <CR> to the last line, also when the register is not
2123 linewise. If this flag is not present, the register
2124 is not linewise and the last line does not end in a
2125 <CR>, then the last line is put on the command-line
2126 and can be edited before hitting <CR>.
2127 *cpo-E*
2128 E It is an error when using "y", "d", "c", "g~", "gu" or
2129 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002130 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 This makes "y0" fail in the first column.
2132 *cpo-f*
2133 f When included, a ":read" command with a file name
2134 argument will set the file name for the current buffer,
2135 if the current buffer doesn't have a file name yet.
2136 *cpo-F*
2137 F When included, a ":write" command with a file name
2138 argument will set the file name for the current
2139 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002140 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-g*
2142 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002143 *cpo-H*
2144 H When using "I" on a line with only blanks, insert
2145 before the last blank. Without this flag insert after
2146 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 *cpo-i*
2148 i When included, interrupting the reading of a file will
2149 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002150 *cpo-I*
2151 I When moving the cursor up or down just after inserting
2152 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 *cpo-j*
2154 j When joining lines, only add two spaces after a '.',
2155 not after '!' or '?'. Also see 'joinspaces'.
2156 *cpo-J*
2157 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002158 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 white space.
2160 *cpo-k*
2161 k Disable the recognition of raw key codes in
2162 mappings, abbreviations, and the "to" part of menu
2163 commands. For example, if <Key> sends ^[OA (where ^[
2164 is <Esc>), the command ":map X ^[OA" results in X
2165 being mapped to:
2166 'k' included: "^[OA" (3 characters)
2167 'k' excluded: "<Key>" (one key code)
2168 Also see the '<' flag below.
2169 *cpo-K*
2170 K Don't wait for a key code to complete when it is
2171 halfway a mapping. This breaks mapping <F1><F1> when
2172 only part of the second <F1> has been read. It
2173 enables cancelling the mapping by typing <F1><Esc>.
2174 *cpo-l*
2175 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002176 literally, only "\]", "\^", "\-" and "\\" are special.
2177 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2179 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002180 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 *cpo-L*
2182 L When the 'list' option is set, 'wrapmargin',
2183 'textwidth', 'softtabstop' and Virtual Replace mode
2184 (see |gR|) count a <Tab> as two characters, instead of
2185 the normal behavior of a <Tab>.
2186 *cpo-m*
2187 m When included, a showmatch will always wait half a
2188 second. When not included, a showmatch will wait half
2189 a second or until a character is typed. |'showmatch'|
2190 *cpo-M*
2191 M When excluded, "%" matching will take backslashes into
2192 account. Thus in "( \( )" and "\( ( \)" the outer
2193 parenthesis match. When included "%" ignores
2194 backslashes, which is Vi compatible.
2195 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002196 n When included, the column used for 'number' and
2197 'relativenumber' will also be used for text of wrapped
2198 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 *cpo-o*
2200 o Line offset to search command is not remembered for
2201 next search.
2202 *cpo-O*
2203 O Don't complain if a file is being overwritten, even
2204 when it didn't exist when editing it. This is a
2205 protection against a file unexpectedly created by
2206 someone else. Vi didn't complain about this.
2207 *cpo-p*
2208 p Vi compatible Lisp indenting. When not present, a
2209 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002210 *cpo-P*
2211 P When included, a ":write" command that appends to a
2212 file will set the file name for the current buffer, if
2213 the current buffer doesn't have a file name yet and
2214 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002215 *cpo-q*
2216 q When joining multiple lines leave the cursor at the
2217 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *cpo-r*
2219 r Redo ("." command) uses "/" to repeat a search
2220 command, instead of the actually used search string.
2221 *cpo-R*
2222 R Remove marks from filtered lines. Without this flag
2223 marks are kept like |:keepmarks| was used.
2224 *cpo-s*
2225 s Set buffer options when entering the buffer for the
2226 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002227 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 set when the buffer is created.
2229 *cpo-S*
2230 S Set buffer options always when entering a buffer
2231 (except 'readonly', 'fileformat', 'filetype' and
2232 'syntax'). This is the (most) Vi compatible setting.
2233 The options are set to the values in the current
2234 buffer. When you change an option and go to another
2235 buffer, the value is copied. Effectively makes the
2236 buffer options global to all buffers.
2237
2238 's' 'S' copy buffer options
2239 no no when buffer created
2240 yes no when buffer first entered (default)
2241 X yes each time when buffer entered (vi comp.)
2242 *cpo-t*
2243 t Search pattern for the tag command is remembered for
2244 "n" command. Otherwise Vim only puts the pattern in
2245 the history for search pattern, but doesn't change the
2246 last used search pattern.
2247 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002248 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 *cpo-v*
2250 v Backspaced characters remain visible on the screen in
2251 Insert mode. Without this flag the characters are
2252 erased from the screen right away. With this flag the
2253 screen newly typed text overwrites backspaced
2254 characters.
2255 *cpo-w*
2256 w When using "cw" on a blank character, only change one
2257 character and not all blanks until the start of the
2258 next word.
2259 *cpo-W*
2260 W Don't overwrite a readonly file. When omitted, ":w!"
2261 overwrites a readonly file, if possible.
2262 *cpo-x*
2263 x <Esc> on the command-line executes the command-line.
2264 The default in Vim is to abandon the command-line,
2265 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002266 *cpo-X*
2267 X When using a count with "R" the replaced text is
2268 deleted only once. Also when repeating "R" with "."
2269 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002271 y A yank command can be redone with ".". Think twice if
2272 you really want to use this, it may break some
2273 plugins, since most people expect "." to only repeat a
2274 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002275 *cpo-Z*
2276 Z When using "w!" while the 'readonly' option is set,
2277 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 *cpo-!*
2279 ! When redoing a filter command, use the last used
2280 external command, whatever it was. Otherwise the last
2281 used -filter- command is used.
2282 *cpo-$*
2283 $ When making a change to one line, don't redisplay the
2284 line, but put a '$' at the end of the changed text.
2285 The changed text will be overwritten when you type the
2286 new text. The line is redisplayed if you type any
2287 command that moves the cursor from the insertion
2288 point.
2289 *cpo-%*
2290 % Vi-compatible matching is done for the "%" command.
2291 Does not recognize "#if", "#endif", etc.
2292 Does not recognize "/*" and "*/".
2293 Parens inside single and double quotes are also
2294 counted, causing a string that contains a paren to
2295 disturb the matching. For example, in a line like
2296 "if (strcmp("foo(", s))" the first paren does not
2297 match the last one. When this flag is not included,
2298 parens inside single and double quotes are treated
2299 specially. When matching a paren outside of quotes,
2300 everything inside quotes is ignored. When matching a
2301 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002302 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002303 This flag is also used for other features, such as
2304 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002305 *cpo--*
2306 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002307 it would go above the first line or below the last
2308 line. Without it the cursor moves to the first or
2309 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002310 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002311 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002312 *cpo-+*
2313 + When included, a ":write file" command will reset the
2314 'modified' flag of the buffer, even though the buffer
2315 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002316 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 * Use ":*" in the same way as ":@". When not included,
2318 ":*" is an alias for ":'<,'>", select the Visual area.
2319 *cpo-<*
2320 < Disable the recognition of special key codes in |<>|
2321 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002322 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 ":map X <Tab>" results in X being mapped to:
2324 '<' included: "<Tab>" (5 characters)
2325 '<' excluded: "^I" (^I is a real <Tab>)
2326 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002327 *cpo->*
2328 > When appending to a register, put a line break before
2329 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002330 *cpo-;*
2331 ; When using |,| or |;| to repeat the last |t| search
2332 and the cursor is right in front of the searched
2333 character, the cursor won't move. When not included,
2334 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002335 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002336
2337 POSIX flags. These are not included in the Vi default value, except
2338 when $VIM_POSIX was set on startup. |posix|
2339
2340 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002341 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002342 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002343 *cpo-&*
2344 & When ":preserve" was used keep the swap file when
2345 exiting normally while this buffer is still loaded.
2346 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002347 *cpo-\*
2348 \ Backslash in a [] range in a search pattern is taken
2349 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002350 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2351 '\' excluded: "/[ \-]" finds <Space> and '-'
2352 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002353 *cpo-/*
2354 / When "%" is used as the replacement string in a |:s|
2355 command, use the previous replacement string. |:s%|
2356 *cpo-{*
2357 { The |{| and |}| commands also stop at a "{" character
2358 at the start of a line.
2359 *cpo-.*
2360 . The ":chdir" and ":cd" commands fail if the current
2361 buffer is modified, unless ! is used. Vim doesn't
2362 need this, since it remembers the full path of an
2363 opened file.
2364 *cpo-bar*
2365 | The value of the $LINES and $COLUMNS environment
2366 variables overrule the terminal size values obtained
2367 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002368
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002371'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002373 {not in Vi}
2374 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002375 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002376 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002377 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002378 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002379 blowfish Blowfish method. Medium strong encryption but it has
2380 an implementation flaw. Requires Vim 7.3 or later,
2381 files can NOT be read by Vim 7.2 and older. This adds
2382 a "seed" to the file, every time you write the file
2383 the encrypted bytes will be different.
2384 *blowfish2*
2385 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002386 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002387 and older. This adds a "seed" to the file, every time
2388 you write the file the encrypted bytes will be
2389 different. The whole undo file is encrypted, not just
2390 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002391
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002392 You should use "blowfish2", also to re-encrypt older files.
2393
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002394 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002395 to the detected method of the file being read. Thus if you write it
2396 without changing 'cryptmethod' the same method will be used.
2397 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002398 explicitly write it, you don't get a warning unless there are other
2399 modifications. Also see |:X|.
2400
2401 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002402 the value "blowfish2". When setting the local value to an empty
2403 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002404
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002405 When a new encryption method is added in a later version of Vim, and
2406 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002407 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002408
2409
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 *'cscopepathcomp'* *'cspc'*
2411'cscopepathcomp' 'cspc' number (default 0)
2412 global
2413 {not available when compiled without the |+cscope|
2414 feature}
2415 {not in Vi}
2416 Determines how many components of the path to show in a list of tags.
2417 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002418 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419
2420 *'cscopeprg'* *'csprg'*
2421'cscopeprg' 'csprg' string (default "cscope")
2422 global
2423 {not available when compiled without the |+cscope|
2424 feature}
2425 {not in Vi}
2426 Specifies the command to execute cscope. See |cscopeprg|.
2427 This option cannot be set from a |modeline| or in the |sandbox|, for
2428 security reasons.
2429
2430 *'cscopequickfix'* *'csqf'*
2431'cscopequickfix' 'csqf' string (default "")
2432 global
2433 {not available when compiled without the |+cscope|
2434 or |+quickfix| features}
2435 {not in Vi}
2436 Specifies whether to use quickfix window to show cscope results.
2437 See |cscopequickfix|.
2438
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002439 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002440'cscoperelative' 'csre' boolean (default off)
2441 global
2442 {not available when compiled without the |+cscope|
2443 feature}
2444 {not in Vi}
2445 In the absence of a prefix (-P) for cscope. setting this option enables
2446 to use the basename of cscope.out path as the prefix.
2447 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002448 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002449
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2451'cscopetag' 'cst' boolean (default off)
2452 global
2453 {not available when compiled without the |+cscope|
2454 feature}
2455 {not in Vi}
2456 Use cscope for tag commands. See |cscope-options|.
2457 NOTE: This option is reset when 'compatible' is set.
2458
2459 *'cscopetagorder'* *'csto'*
2460'cscopetagorder' 'csto' number (default 0)
2461 global
2462 {not available when compiled without the |+cscope|
2463 feature}
2464 {not in Vi}
2465 Determines the order in which ":cstag" performs a search. See
2466 |cscopetagorder|.
2467 NOTE: This option is set to 0 when 'compatible' is set.
2468
2469 *'cscopeverbose'* *'csverb'*
2470 *'nocscopeverbose'* *'nocsverb'*
2471'cscopeverbose' 'csverb' boolean (default off)
2472 global
2473 {not available when compiled without the |+cscope|
2474 feature}
2475 {not in Vi}
2476 Give messages when adding a cscope database. See |cscopeverbose|.
2477 NOTE: This option is reset when 'compatible' is set.
2478
Bram Moolenaar860cae12010-06-05 23:22:07 +02002479 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2480'cursorbind' 'crb' boolean (default off)
2481 local to window
2482 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002483 When this option is set, as the cursor in the current
2484 window moves other cursorbound windows (windows that also have
2485 this option set) move their cursors to the corresponding line and
2486 column. This option is useful for viewing the
2487 differences between two versions of a file (see 'diff'); in diff mode,
2488 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002489 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002490
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002491
2492 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2493'cursorcolumn' 'cuc' boolean (default off)
2494 local to window
2495 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002496 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002497 feature}
2498 Highlight the screen column of the cursor with CursorColumn
2499 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2500 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002501 If you only want the highlighting in the current window you can use
2502 these autocommands: >
2503 au WinLeave * set nocursorline nocursorcolumn
2504 au WinEnter * set cursorline cursorcolumn
2505<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002506
2507 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2508'cursorline' 'cul' boolean (default off)
2509 local to window
2510 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002511 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002512 feature}
2513 Highlight the screen line of the cursor with CursorLine
2514 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2515 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002516 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002517 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002518
2519
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 *'debug'*
2521'debug' string (default "")
2522 global
2523 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002524 These values can be used:
2525 msg Error messages that would otherwise be omitted will be given
2526 anyway.
2527 throw Error messages that would otherwise be omitted will be given
2528 anyway and also throw an exception and set |v:errmsg|.
2529 beep A message will be given when otherwise only a beep would be
2530 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002531 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002532 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2533 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534
2535 *'define'* *'def'*
2536'define' 'def' string (default "^\s*#\s*define")
2537 global or local to buffer |global-local|
2538 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 pattern, just like for the "/" command. This option is used for the
2541 commands like "[i" and "[d" |include-search|. The 'isident' option is
2542 used to recognize the defined name after the match:
2543 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2544 See |option-backslash| about inserting backslashes to include a space
2545 or backslash.
2546 The default value is for C programs. For C++ this value would be
2547 useful, to include const type declarations: >
2548 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2549< When using the ":set" command, you need to double the backslashes!
2550
2551 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2552'delcombine' 'deco' boolean (default off)
2553 global
2554 {not in Vi}
2555 {only available when compiled with the |+multi_byte|
2556 feature}
2557 If editing Unicode and this option is set, backspace and Normal mode
2558 "x" delete each combining character on its own. When it is off (the
2559 default) the character along with its combining characters are
2560 deleted.
2561 Note: When 'delcombine' is set "xx" may work different from "2x"!
2562
2563 This is useful for Arabic, Hebrew and many other languages where one
2564 may have combining characters overtop of base characters, and want
2565 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002566 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567
2568 *'dictionary'* *'dict'*
2569'dictionary' 'dict' string (default "")
2570 global or local to buffer |global-local|
2571 {not in Vi}
2572 List of file names, separated by commas, that are used to lookup words
2573 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2574 contain a list of words. This can be one word per line, or several
2575 words per line, separated by non-keyword characters (white space is
2576 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002577
2578 When this option is empty or an entry "spell" is present, and spell
2579 checking is enabled, words in the word lists for the currently active
2580 'spelllang' are used. See |spell|.
2581
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002582 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 after a comma are ignored, otherwise spaces are included in the file
2584 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002585 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 Where to find a list of words?
2587 - On FreeBSD, there is the file "/usr/share/dict/words".
2588 - In the Simtel archive, look in the "msdos/linguist" directory.
2589 - In "miscfiles" of the GNU collection.
2590 The use of |:set+=| and |:set-=| is preferred when adding or removing
2591 directories from the list. This avoids problems when a future version
2592 uses another default.
2593 Backticks cannot be used in this option for security reasons.
2594
2595 *'diff'* *'nodiff'*
2596'diff' boolean (default off)
2597 local to window
2598 {not in Vi}
2599 {not available when compiled without the |+diff|
2600 feature}
2601 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002602 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603
2604 *'dex'* *'diffexpr'*
2605'diffexpr' 'dex' string (default "")
2606 global
2607 {not in Vi}
2608 {not available when compiled without the |+diff|
2609 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002610 Expression which is evaluated to obtain a diff file (either ed-style
2611 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 This option cannot be set from a |modeline| or in the |sandbox|, for
2613 security reasons.
2614
2615 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002616'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 global
2618 {not in Vi}
2619 {not available when compiled without the |+diff|
2620 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 All are optional. Items must be separated by a comma.
2623
2624 filler Show filler lines, to keep the text
2625 synchronized with a window that has inserted
2626 lines at the same position. Mostly useful
2627 when windows are side-by-side and 'scrollbind'
2628 is set.
2629
2630 context:{n} Use a context of {n} lines between a change
2631 and a fold that contains unchanged lines.
2632 When omitted a context of six lines is used.
2633 See |fold-diff|.
2634
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002635 iblank Ignore changes where lines are all blank. Adds
2636 the "-B" flag to the "diff" command if
2637 'diffexpr' is empty. Check the documentation
2638 of the "diff" command for what this does
2639 exactly.
2640 NOTE: the diff windows will get out of sync,
2641 because no differences between blank lines are
2642 taken into account.
2643
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 icase Ignore changes in case of text. "a" and "A"
2645 are considered the same. Adds the "-i" flag
2646 to the "diff" command if 'diffexpr' is empty.
2647
2648 iwhite Ignore changes in amount of white space. Adds
2649 the "-b" flag to the "diff" command if
2650 'diffexpr' is empty. Check the documentation
2651 of the "diff" command for what this does
2652 exactly. It should ignore adding trailing
2653 white space, but not leading white space.
2654
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002655 iwhiteall Ignore all white space changes. Adds
2656 the "-w" flag to the "diff" command if
2657 'diffexpr' is empty. Check the documentation
2658 of the "diff" command for what this does
2659 exactly.
2660
2661 iwhiteeol Ignore white space changes at end of line.
2662 Adds the "-Z" flag to the "diff" command if
2663 'diffexpr' is empty. Check the documentation
2664 of the "diff" command for what this does
2665 exactly.
2666
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002667 horizontal Start diff mode with horizontal splits (unless
2668 explicitly specified otherwise).
2669
2670 vertical Start diff mode with vertical splits (unless
2671 explicitly specified otherwise).
2672
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002673 hiddenoff Do not use diff mode for a buffer when it
2674 becomes hidden.
2675
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002676 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2677 starting diff mode. Without this 2 is used.
2678
Bram Moolenaare828b762018-09-10 17:51:58 +02002679 internal Use the internal diff library. This is
2680 ignored when 'diffexpr' is set. *E960*
2681 When running out of memory when writing a
2682 buffer this item will be ignored for diffs
2683 involving that buffer. Set the 'verbose'
2684 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685
Bram Moolenaare828b762018-09-10 17:51:58 +02002686 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002687 Use the indent heuristic for the internal
2688 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002689
2690 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002691 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002692 algorithms are:
2693 myers the default algorithm
2694 minimal spend extra time to generate the
2695 smallest possible diff
2696 patience patience diff algorithm
2697 histogram histogram diff algorithm
2698
2699 Examples: >
2700 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002702 :set diffopt=internal,filler,foldcolumn:3
2703 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704<
2705 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2706'digraph' 'dg' boolean (default off)
2707 global
2708 {not in Vi}
2709 {not available when compiled without the |+digraphs|
2710 feature}
2711 Enable the entering of digraphs in Insert mode with {char1} <BS>
2712 {char2}. See |digraphs|.
2713 NOTE: This option is reset when 'compatible' is set.
2714
2715 *'directory'* *'dir'*
2716'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002717 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 for Unix: ".,~/tmp,/var/tmp,/tmp")
2719 global
2720 List of directory names for the swap file, separated with commas.
2721 - The swap file will be created in the first directory where this is
2722 possible.
2723 - Empty means that no swap file will be used (recovery is
2724 impossible!).
2725 - A directory "." means to put the swap file in the same directory as
2726 the edited file. On Unix, a dot is prepended to the file name, so
2727 it doesn't show in a directory listing. On MS-Windows the "hidden"
2728 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002729 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 put the swap file relative to where the edited file is. The leading
2731 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002732 - For Unix and Win32, if a directory ends in two path separators "//",
2733 the swap file name will be built from the complete path to the file
2734 with all path separators substituted to percent '%' signs. This will
2735 ensure file name uniqueness in the preserve directory.
2736 On Win32, it is also possible to end with "\\". However, When a
2737 separating comma is following, you must use "//", since "\\" will
2738 include the comma in the file name. Therefore it is recommended to
2739 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 - Spaces after the comma are ignored, other spaces are considered part
2741 of the directory name. To have a space at the start of a directory
2742 name, precede it with a backslash.
2743 - To include a comma in a directory name precede it with a backslash.
2744 - A directory name may end in an ':' or '/'.
2745 - Environment variables are expanded |:set_env|.
2746 - Careful with '\' characters, type one before a space, type two to
2747 get one in the option (see |option-backslash|), for example: >
2748 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2749< - For backwards compatibility with Vim version 3.0 a '>' at the start
2750 of the option is removed.
2751 Using "." first in the list is recommended. This means that editing
2752 the same file twice will result in a warning. Using "/tmp" on Unix is
2753 discouraged: When the system crashes you lose the swap file.
2754 "/var/tmp" is often not cleared when rebooting, thus is a better
2755 choice than "/tmp". But it can contain a lot of files, your swap
2756 files get lost in the crowd. That is why a "tmp" directory in your
2757 home directory is tried first.
2758 The use of |:set+=| and |:set-=| is preferred when adding or removing
2759 directories from the list. This avoids problems when a future version
2760 uses another default.
2761 This option cannot be set from a |modeline| or in the |sandbox|, for
2762 security reasons.
2763 {Vi: directory to put temp file in, defaults to "/tmp"}
2764
2765 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002766'display' 'dy' string (default "", set to "truncate" in
2767 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 global
2769 {not in Vi}
2770 Change the way text is displayed. This is comma separated list of
2771 flags:
2772 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002773 in a window will be displayed. "@@@" is put in the
2774 last columns of the last screen line to indicate the
2775 rest of the line is not displayed.
2776 truncate Like "lastline", but "@@@" is displayed in the first
2777 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 uhex Show unprintable characters hexadecimal as <xx>
2779 instead of using ^C and ~C.
2780
Bram Moolenaard0796902016-09-16 20:02:31 +02002781 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002782 doesn't fit is replaced with "@" lines.
2783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 *'eadirection'* *'ead'*
2785'eadirection' 'ead' string (default "both")
2786 global
2787 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002788 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 feature}
2790 Tells when the 'equalalways' option applies:
2791 ver vertically, width of windows is not affected
2792 hor horizontally, height of windows is not affected
2793 both width and height of windows is affected
2794
2795 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2796'edcompatible' 'ed' boolean (default off)
2797 global
2798 Makes the 'g' and 'c' flags of the ":substitute" command to be
2799 toggled each time the flag is given. See |complex-change|. See
2800 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002801 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
Bram Moolenaar03413f42016-04-12 21:07:15 +02002803 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002804'emoji' 'emo' boolean (default: on)
2805 global
2806 {not in Vi}
2807 {only available when compiled with the |+multi_byte|
2808 feature}
2809 When on all Unicode emoji characters are considered to be full width.
2810
2811
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 *'encoding'* *'enc'* *E543*
2813'encoding' 'enc' string (default: "latin1" or value from $LANG)
2814 global
2815 {only available when compiled with the |+multi_byte|
2816 feature}
2817 {not in Vi}
2818 Sets the character encoding used inside Vim. It applies to text in
2819 the buffers, registers, Strings in expressions, text stored in the
2820 viminfo file, etc. It sets the kind of characters which Vim can work
2821 with. See |encoding-names| for the possible values.
2822
2823 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002824 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002826 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827
Bram Moolenaar865242e2010-07-14 21:12:05 +02002828 This option cannot be set from a |modeline|. It would most likely
2829 corrupt the text.
2830
Bram Moolenaar3df01732017-02-17 22:47:16 +01002831 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2832 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 'encoding', "utf-8" is the natural choice for the environment and
2834 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002835 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 versions, and to avoid changing the encoding of newly created files
2837 without your knowledge (in case 'fileencodings' is empty).
2838
2839 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002840 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 iconv() or as specified with 'charconvert'.
2842
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002843 If you need to know whether 'encoding' is a multi-byte encoding, you
2844 can use: >
2845 if has("multi_byte_encoding")
2846<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847 Normally 'encoding' will be equal to your current locale. This will
2848 be the default if Vim recognizes your environment settings. If
2849 'encoding' is not set to the current locale, 'termencoding' must be
2850 set to convert typed and displayed text. See |encoding-table|.
2851
2852 When you set this option, it fires the |EncodingChanged| autocommand
2853 event so that you can set up fonts if necessary.
2854
2855 When the option is set, the value is converted to lowercase. Thus
2856 you can set it with uppercase values too. Underscores are translated
2857 to '-' signs.
2858 When the encoding is recognized, it is changed to the standard name.
2859 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2860 "iso-8859-2" and "utf8" becomes "utf-8".
2861
2862 Note: "latin1" is also used when the encoding could not be detected.
2863 This only works when editing files in the same encoding! When the
2864 actual character set is not latin1, make sure 'fileencoding' and
2865 'fileencodings' are empty. When conversion is needed, switch to using
2866 utf-8.
2867
2868 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2869 You don't notice this while editing, but it does matter for the
2870 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2871 setting 'encoding' to one of these values instead of utf-8 only has
2872 effect for encoding used for files when 'fileencoding' is empty.
2873
Bram Moolenaar661b1822005-07-28 22:36:45 +00002874 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2875 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876
2877 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2878'endofline' 'eol' boolean (default on)
2879 local to buffer
2880 {not in Vi}
2881 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002882 is on, or 'fixeol' option is off, no <EOL> will be written for the
2883 last line in the file. This option is automatically set or reset when
2884 starting to edit a new file, depending on whether file has an <EOL>
2885 for the last line in the file. Normally you don't have to set or
2886 reset this option.
2887 When 'binary' is off and 'fixeol' is on the value is not used when
2888 writing the file. When 'binary' is on or 'fixeol' is off it is used
2889 to remember the presence of a <EOL> for the last line in the file, so
2890 that when you write the file the situation from the original file can
2891 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892
2893 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2894'equalalways' 'ea' boolean (default on)
2895 global
2896 {not in Vi}
2897 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002898 splitting or closing a window. This also happens the moment the
2899 option is switched on. When off, splitting a window will reduce the
2900 size of the current window and leave the other windows the same. When
2901 closing a window the extra lines are given to the window next to it
2902 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 When mixing vertically and horizontally split windows, a minimal size
2904 is computed and some windows may be larger if there is room. The
2905 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002906 Changing the height and width of a window can be avoided by setting
2907 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002908 If a window size is specified when creating a new window sizes are
2909 currently not equalized (it's complicated, but may be implemented in
2910 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911
2912 *'equalprg'* *'ep'*
2913'equalprg' 'ep' string (default "")
2914 global or local to buffer |global-local|
2915 {not in Vi}
2916 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002917 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002918 or 'indentexpr'. When Vim was compiled without internal formatting,
2919 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 about including spaces and backslashes.
2922 This option cannot be set from a |modeline| or in the |sandbox|, for
2923 security reasons.
2924
2925 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2926'errorbells' 'eb' boolean (default off)
2927 global
2928 Ring the bell (beep or screen flash) for error messages. This only
2929 makes a difference for error messages, the bell will be used always
2930 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002931 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002932 screen flash or do nothing. See 'belloff' to finetune when to ring the
2933 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934
2935 *'errorfile'* *'ef'*
2936'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2937 others: "errors.err")
2938 global
2939 {not in Vi}
2940 {not available when compiled without the |+quickfix|
2941 feature}
2942 Name of the errorfile for the QuickFix mode (see |:cf|).
2943 When the "-q" command-line argument is used, 'errorfile' is set to the
2944 following argument. See |-q|.
2945 NOT used for the ":make" command. See 'makeef' for that.
2946 Environment variables are expanded |:set_env|.
2947 See |option-backslash| about including spaces and backslashes.
2948 This option cannot be set from a |modeline| or in the |sandbox|, for
2949 security reasons.
2950
2951 *'errorformat'* *'efm'*
2952'errorformat' 'efm' string (default is very long)
2953 global or local to buffer |global-local|
2954 {not in Vi}
2955 {not available when compiled without the |+quickfix|
2956 feature}
2957 Scanf-like description of the format for the lines in the error file
2958 (see |errorformat|).
2959
2960 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2961'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2962 global
2963 {not in Vi}
2964 Function keys that start with an <Esc> are recognized in Insert
2965 mode. When this option is off, the cursor and function keys cannot be
2966 used in Insert mode if they start with an <Esc>. The advantage of
2967 this is that the single <Esc> is recognized immediately, instead of
2968 after one second. Instead of resetting this option, you might want to
2969 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2970 when 'esckeys' is off, you can still map anything, but the cursor keys
2971 won't work by default.
2972 NOTE: This option is set to the Vi default value when 'compatible' is
2973 set and to the Vim default value when 'compatible' is reset.
2974
2975 *'eventignore'* *'ei'*
2976'eventignore' 'ei' string (default "")
2977 global
2978 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002980 When set to "all" or when "all" is one of the items, all autocommand
2981 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 Otherwise this is a comma separated list of event names. Example: >
2983 :set ei=WinEnter,WinLeave
2984<
2985 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2986'expandtab' 'et' boolean (default off)
2987 local to buffer
2988 {not in Vi}
2989 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002990 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2992 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002993 This option is reset when the 'paste' option is set and restored when
2994 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 NOTE: This option is reset when 'compatible' is set.
2996
2997 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2998'exrc' 'ex' boolean (default off)
2999 global
3000 {not in Vi}
3001 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02003002 directory.
3003
3004 Setting this option is a potential security leak. E.g., consider
3005 unpacking a package or fetching files from github, a .vimrc in there
3006 might be a trojan horse. BETTER NOT SET THIS OPTION!
3007 Instead, define an autocommand in your .vimrc to set options for a
3008 matching directory.
3009
3010 If you do switch this option on you should also consider setting the
3011 'secure' option (see |initialization|).
3012 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 This option cannot be set from a |modeline| or in the |sandbox|, for
3014 security reasons.
3015
3016 *'fileencoding'* *'fenc'* *E213*
3017'fileencoding' 'fenc' string (default: "")
3018 local to buffer
3019 {only available when compiled with the |+multi_byte|
3020 feature}
3021 {not in Vi}
3022 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003025 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 When 'fileencoding' is empty, the same value as 'encoding' will be
3027 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003028 No error will be given when the value is set, only when it is used,
3029 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003030 Conversion will also be done when 'encoding' and 'fileencoding' are
3031 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3032 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003034 'encoding' is "utf-8" or another Unicode encoding, conversion
3035 is most likely done in a way that the reverse conversion
3036 results in the same text. When 'encoding' is not "utf-8" some
3037 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 See 'encoding' for the possible values. Additionally, values may be
3040 specified that can be handled by the converter, see
3041 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003042
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 When reading a file 'fileencoding' will be set from 'fileencodings'.
3044 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003045 'fileencoding', use the |++enc| argument. One exception: when
3046 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003047 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003048
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3050 When the option is set, the value is converted to lowercase. Thus
3051 you can set it with uppercase values too. '_' characters are
3052 replaced with '-'. If a name is recognized from the list for
3053 'encoding', it is replaced by the standard name. For example
3054 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003055
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 When this option is set, after starting to edit a file, the 'modified'
3057 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003058
3059 Keep in mind that changing 'fenc' from a modeline happens
3060 AFTER the text has been read, thus it applies to when the file will be
3061 written. If you do set 'fenc' in a modeline, you might want to set
3062 'nomodified' to avoid not being able to ":q".
3063
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 This option can not be changed when 'modifiable' is off.
3065
3066 *'fe'*
3067 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003068 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 old short name was 'fe', which is no longer used.
3070
3071 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003072'fileencodings' 'fencs' string (default: "ucs-bom",
3073 "ucs-bom,utf-8,default,latin1" when
3074 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 global
3076 {only available when compiled with the |+multi_byte|
3077 feature}
3078 {not in Vi}
3079 This is a list of character encodings considered when starting to edit
3080 an existing file. When a file is read, Vim tries to use the first
3081 mentioned character encoding. If an error is detected, the next one
3082 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003083 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 an empty string, which means the value of 'encoding' is used.
3085 WARNING: Conversion can cause loss of information! When
3086 'encoding' is "utf-8" (or one of the other Unicode variants)
3087 conversion is most likely done in a way that the reverse
3088 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003089 "utf-8" some non-ASCII characters may be lost! You can use
3090 the |++bad| argument to specify what is done with characters
3091 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 For an empty file or a file with only ASCII characters most encodings
3093 will work and the first entry of 'fileencodings' will be used (except
3094 "ucs-bom", which requires the BOM to be present). If you prefer
3095 another encoding use an BufReadPost autocommand event to test if your
3096 preferred encoding is to be used. Example: >
3097 au BufReadPost * if search('\S', 'w') == 0 |
3098 \ set fenc=iso-2022-jp | endif
3099< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3100 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003101 When the |++enc| argument is used then the value of 'fileencodings' is
3102 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003103 Note that 'fileencodings' is not used for a new file, the global value
3104 of 'fileencoding' is used instead. You can set it with: >
3105 :setglobal fenc=iso-8859-2
3106< This means that a non-existing file may get a different encoding than
3107 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 The special value "ucs-bom" can be used to check for a Unicode BOM
3109 (Byte Order Mark) at the start of the file. It must not be preceded
3110 by "utf-8" or another Unicode encoding for this to work properly.
3111 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3112 because Vim cannot detect an error, thus the encoding is always
3113 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003114 The special value "default" can be used for the encoding from the
3115 environment. This is the default value for 'encoding'. It is useful
3116 when 'encoding' is set to "utf-8" and your environment uses a
3117 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003118 When 'encoding' is "utf-8" and a file contains an illegal byte
3119 sequence it won't be recognized as UTF-8. You can use the |8g8|
3120 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 WRONG VALUES: WHAT'S WRONG:
3122 latin1,utf-8 "latin1" will always be used
3123 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3124 file
3125 cp1250,latin1 "cp1250" will always be used
3126 If 'fileencodings' is empty, 'fileencoding' is not modified.
3127 See 'fileencoding' for the possible values.
3128 Setting this option does not have an effect until the next time a file
3129 is read.
3130
3131 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003132'fileformat' 'ff' string (MS-Windows default: "dos",
3133 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 local to buffer
3135 {not in Vi}
3136 This gives the <EOL> of the current buffer, which is used for
3137 reading/writing the buffer from/to a file:
3138 dos <CR> <NL>
3139 unix <NL>
3140 mac <CR>
3141 When "dos" is used, CTRL-Z at the end of a file is ignored.
3142 See |file-formats| and |file-read|.
3143 For the character encoding of the file see 'fileencoding'.
3144 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003145 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 This option is set automatically when starting to edit a file and
3147 'fileformats' is not empty and 'binary' is off.
3148 When this option is set, after starting to edit a file, the 'modified'
3149 option is set, because the file would be different when written.
3150 This option can not be changed when 'modifiable' is off.
3151 For backwards compatibility: When this option is set to "dos",
3152 'textmode' is set, otherwise 'textmode' is reset.
3153
3154 *'fileformats'* *'ffs'*
3155'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003156 Vim+Vi MS-Windows: "dos,unix",
3157 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Vi Cygwin: "unix,dos",
3159 Vi others: "")
3160 global
3161 {not in Vi}
3162 This gives the end-of-line (<EOL>) formats that will be tried when
3163 starting to edit a new buffer and when reading a file into an existing
3164 buffer:
3165 - When empty, the format defined with 'fileformat' will be used
3166 always. It is not set automatically.
3167 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003168 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 'fileformats' name will be used when a file is read into an existing
3170 buffer, no matter what 'fileformat' for that buffer is set to.
3171 - When more than one name is present, separated by commas, automatic
3172 <EOL> detection will be done when reading a file. When starting to
3173 edit a file, a check is done for the <EOL>:
3174 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3175 'fileformat' is set to "dos".
3176 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003177 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003179 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3180 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003181 This means that "mac" is only chosen when:
3182 "unix" is not present or no <NL> is found in the file, and
3183 "dos" is not present or no <CR><NL> is found in the file.
3184 Except: if "unix" was chosen, but there is a <CR> before
3185 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003186 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 4. If 'fileformat' is still not set, the first name from
3188 'fileformats' is used.
3189 When reading a file into an existing buffer, the same is done, but
3190 this happens like 'fileformat' has been set appropriately for that
3191 file only, the option is not changed.
3192 When 'binary' is set, the value of 'fileformats' is not used.
3193
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003194 When Vim starts up with an empty buffer the first item is used. You
3195 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003196
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3198 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3199 done:
3200 - When 'fileformats' is empty, there is no automatic detection. Dos
3201 format will be used.
3202 - When 'fileformats' is set to one or more names, automatic detection
3203 is done. This is based on the first <NL> in the file: If there is a
3204 <CR> in front of it, Dos format is used, otherwise Unix format is
3205 used.
3206 Also see |file-formats|.
3207 For backwards compatibility: When this option is set to an empty
3208 string or one format (no comma is included), 'textauto' is reset,
3209 otherwise 'textauto' is set.
3210 NOTE: This option is set to the Vi default value when 'compatible' is
3211 set and to the Vim default value when 'compatible' is reset.
3212
Bram Moolenaarbf884932013-04-05 22:26:15 +02003213 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3214'fileignorecase' 'fic' boolean (default on for systems where case in file
3215 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003216 global
3217 {not in Vi}
3218 When set case is ignored when using file names and directories.
3219 See 'wildignorecase' for only ignoring case when doing completion.
3220
Bram Moolenaar071d4272004-06-13 20:20:40 +00003221 *'filetype'* *'ft'*
3222'filetype' 'ft' string (default: "")
3223 local to buffer
3224 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 When this option is set, the FileType autocommand event is triggered.
3226 All autocommands that match with the value of this option will be
3227 executed. Thus the value of 'filetype' is used in place of the file
3228 name.
3229 Otherwise this option does not always reflect the current file type.
3230 This option is normally set when the file type is detected. To enable
3231 this use the ":filetype on" command. |:filetype|
3232 Setting this option to a different value is most useful in a modeline,
3233 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003234 Example, for in an IDL file:
3235 /* vim: set filetype=idl : */ ~
3236 |FileType| |filetypes|
3237 When a dot appears in the value then this separates two filetype
3238 names. Example:
3239 /* vim: set filetype=c.doxygen : */ ~
3240 This will use the "c" filetype first, then the "doxygen" filetype.
3241 This works both for filetype plugins and for syntax files. More than
3242 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 This option is not copied to another buffer, independent of the 's' or
3244 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003245 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246
3247 *'fillchars'* *'fcs'*
3248'fillchars' 'fcs' string (default "vert:|,fold:-")
3249 global
3250 {not in Vi}
3251 {not available when compiled without the |+windows|
3252 and |+folding| features}
3253 Characters to fill the statuslines and vertical separators.
3254 It is a comma separated list of items:
3255
3256 item default Used for ~
3257 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003258 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 vert:c '|' vertical separators |:vsplit|
3260 fold:c '-' filling 'foldtext'
3261 diff:c '-' deleted lines of the 'diff' option
3262
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003263 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003264 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 otherwise.
3266
3267 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003268 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269< This is similar to the default, except that these characters will also
3270 be used when there is highlighting.
3271
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003272 for "stl" and "stlnc" only single-byte values are supported.
3273
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 The highlighting used for these items:
3275 item highlight group ~
3276 stl:c StatusLine |hl-StatusLine|
3277 stlnc:c StatusLineNC |hl-StatusLineNC|
3278 vert:c VertSplit |hl-VertSplit|
3279 fold:c Folded |hl-Folded|
3280 diff:c DiffDelete |hl-DiffDelete|
3281
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003282 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3283'fixendofline' 'fixeol' boolean (default on)
3284 local to buffer
3285 {not in Vi}
3286 When writing a file and this option is on, <EOL> at the end of file
3287 will be restored if missing. Turn this option off if you want to
3288 preserve the situation from the original file.
3289 When the 'binary' option is set the value of this option doesn't
3290 matter.
3291 See the 'endofline' option.
3292
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3294'fkmap' 'fk' boolean (default off) *E198*
3295 global
3296 {not in Vi}
3297 {only available when compiled with the |+rightleft|
3298 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003299 This option was for using Farsi, which has been removed. See
3300 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301
3302 *'foldclose'* *'fcl'*
3303'foldclose' 'fcl' string (default "")
3304 global
3305 {not in Vi}
3306 {not available when compiled without the |+folding|
3307 feature}
3308 When set to "all", a fold is closed when the cursor isn't in it and
3309 its level is higher than 'foldlevel'. Useful if you want folds to
3310 automatically close when moving out of them.
3311
3312 *'foldcolumn'* *'fdc'*
3313'foldcolumn' 'fdc' number (default 0)
3314 local to window
3315 {not in Vi}
3316 {not available when compiled without the |+folding|
3317 feature}
3318 When non-zero, a column with the specified width is shown at the side
3319 of the window which indicates open and closed folds. The maximum
3320 value is 12.
3321 See |folding|.
3322
3323 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3324'foldenable' 'fen' boolean (default on)
3325 local to window
3326 {not in Vi}
3327 {not available when compiled without the |+folding|
3328 feature}
3329 When off, all folds are open. This option can be used to quickly
3330 switch between showing all text unfolded and viewing the text with
3331 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003332 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 'foldenable' is off.
3334 This option is set by commands that create a new fold or close a fold.
3335 See |folding|.
3336
3337 *'foldexpr'* *'fde'*
3338'foldexpr' 'fde' string (default: "0")
3339 local to window
3340 {not in Vi}
3341 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003342 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003343 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003344 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003345
Bram Moolenaar30b65812012-07-12 22:01:11 +02003346 The expression will be evaluated in the |sandbox| if set from a
3347 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003348 This option can't be set from a |modeline| when the 'diff' option is
3349 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003350
3351 It is not allowed to change text or jump to another window while
3352 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353
3354 *'foldignore'* *'fdi'*
3355'foldignore' 'fdi' string (default: "#")
3356 local to window
3357 {not in Vi}
3358 {not available when compiled without the |+folding|
3359 feature}
3360 Used only when 'foldmethod' is "indent". Lines starting with
3361 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003362 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 The default "#" works well for C programs. See |fold-indent|.
3364
3365 *'foldlevel'* *'fdl'*
3366'foldlevel' 'fdl' number (default: 0)
3367 local to window
3368 {not in Vi}
3369 {not available when compiled without the |+folding|
3370 feature}
3371 Sets the fold level: Folds with a higher level will be closed.
3372 Setting this option to zero will close all folds. Higher numbers will
3373 close fewer folds.
3374 This option is set by commands like |zm|, |zM| and |zR|.
3375 See |fold-foldlevel|.
3376
3377 *'foldlevelstart'* *'fdls'*
3378'foldlevelstart' 'fdls' number (default: -1)
3379 global
3380 {not in Vi}
3381 {not available when compiled without the |+folding|
3382 feature}
3383 Sets 'foldlevel' when starting to edit another buffer in a window.
3384 Useful to always start editing with all folds closed (value zero),
3385 some folds closed (one) or no folds closed (99).
3386 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003387 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 ignores this option and closes all folds.
3389 It is also done before BufReadPre autocommands, to allow an autocmd to
3390 overrule the 'foldlevel' value for specific files.
3391 When the value is negative, it is not used.
3392
3393 *'foldmarker'* *'fmr'* *E536*
3394'foldmarker' 'fmr' string (default: "{{{,}}}")
3395 local to window
3396 {not in Vi}
3397 {not available when compiled without the |+folding|
3398 feature}
3399 The start and end marker used when 'foldmethod' is "marker". There
3400 must be one comma, which separates the start and end marker. The
3401 marker is a literal string (a regular expression would be too slow).
3402 See |fold-marker|.
3403
3404 *'foldmethod'* *'fdm'*
3405'foldmethod' 'fdm' string (default: "manual")
3406 local to window
3407 {not in Vi}
3408 {not available when compiled without the |+folding|
3409 feature}
3410 The kind of folding used for the current window. Possible values:
3411 |fold-manual| manual Folds are created manually.
3412 |fold-indent| indent Lines with equal indent form a fold.
3413 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3414 |fold-marker| marker Markers are used to specify folds.
3415 |fold-syntax| syntax Syntax highlighting items specify folds.
3416 |fold-diff| diff Fold text that is not changed.
3417
3418 *'foldminlines'* *'fml'*
3419'foldminlines' 'fml' number (default: 1)
3420 local to window
3421 {not in Vi}
3422 {not available when compiled without the |+folding|
3423 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003424 Sets the number of screen lines above which a fold can be displayed
3425 closed. Also for manually closed folds. With the default value of
3426 one a fold can only be closed if it takes up two or more screen lines.
3427 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003428 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 "zc" to close a fold, which is displayed open because it's smaller
3430 than 'foldminlines', a following "zc" may close a containing fold.
3431
3432 *'foldnestmax'* *'fdn'*
3433'foldnestmax' 'fdn' number (default: 20)
3434 local to window
3435 {not in Vi}
3436 {not available when compiled without the |+folding|
3437 feature}
3438 Sets the maximum nesting of folds for the "indent" and "syntax"
3439 methods. This avoids that too many folds will be created. Using more
3440 than 20 doesn't work, because the internal limit is 20.
3441
3442 *'foldopen'* *'fdo'*
3443'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3444 search,tag,undo")
3445 global
3446 {not in Vi}
3447 {not available when compiled without the |+folding|
3448 feature}
3449 Specifies for which type of commands folds will be opened, if the
3450 command moves the cursor into a closed fold. It is a comma separated
3451 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003452 NOTE: When the command is part of a mapping this option is not used.
3453 Add the |zv| command to the mapping to get the same effect.
3454 (rationale: the mapping may want to control opening folds itself)
3455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 item commands ~
3457 all any
3458 block "(", "{", "[[", "[{", etc.
3459 hor horizontal movements: "l", "w", "fx", etc.
3460 insert any command in Insert mode
3461 jump far jumps: "G", "gg", etc.
3462 mark jumping to a mark: "'m", CTRL-O, etc.
3463 percent "%"
3464 quickfix ":cn", ":crew", ":make", etc.
3465 search search for a pattern: "/", "n", "*", "gd", etc.
3466 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003467 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 tag jumping to a tag: ":ta", CTRL-T, etc.
3469 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 When a movement command is used for an operator (e.g., "dl" or "y%")
3471 this option is not used. This means the operator will include the
3472 whole closed fold.
3473 Note that vertical movements are not here, because it would make it
3474 very difficult to move onto a closed fold.
3475 In insert mode the folds containing the cursor will always be open
3476 when text is inserted.
3477 To close folds you can re-apply 'foldlevel' with the |zx| command or
3478 set the 'foldclose' option to "all".
3479
3480 *'foldtext'* *'fdt'*
3481'foldtext' 'fdt' string (default: "foldtext()")
3482 local to window
3483 {not in Vi}
3484 {not available when compiled without the |+folding|
3485 feature}
3486 An expression which is used to specify the text displayed for a closed
3487 fold. See |fold-foldtext|.
3488
Bram Moolenaar30b65812012-07-12 22:01:11 +02003489 The expression will be evaluated in the |sandbox| if set from a
3490 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003491
3492 It is not allowed to change text or jump to another window while
3493 evaluating 'foldtext' |textlock|.
3494
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003495 *'formatexpr'* *'fex'*
3496'formatexpr' 'fex' string (default "")
3497 local to buffer
3498 {not in Vi}
3499 {not available when compiled without the |+eval|
3500 feature}
3501 Expression which is evaluated to format a range of lines for the |gq|
3502 operator or automatic formatting (see 'formatoptions'). When this
3503 option is empty 'formatprg' is used.
3504
3505 The |v:lnum| variable holds the first line to be formatted.
3506 The |v:count| variable holds the number of lines to be formatted.
3507 The |v:char| variable holds the character that is going to be
3508 inserted if the expression is being evaluated due to
3509 automatic formatting. This can be empty. Don't insert
3510 it yet!
3511
3512 Example: >
3513 :set formatexpr=mylang#Format()
3514< This will invoke the mylang#Format() function in the
3515 autoload/mylang.vim file in 'runtimepath'. |autoload|
3516
3517 The expression is also evaluated when 'textwidth' is set and adding
3518 text beyond that limit. This happens under the same conditions as
3519 when internal formatting is used. Make sure the cursor is kept in the
3520 same spot relative to the text then! The |mode()| function will
3521 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003522
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003523 When the expression evaluates to non-zero Vim will fall back to using
3524 the internal format mechanism.
3525
3526 The expression will be evaluated in the |sandbox| when set from a
3527 modeline, see |sandbox-option|. That stops the option from working,
3528 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003529 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003530
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 *'formatoptions'* *'fo'*
3532'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3533 local to buffer
3534 {not in Vi}
3535 This is a sequence of letters which describes how automatic
3536 formatting is to be done. See |fo-table|. When the 'paste' option is
3537 on, no formatting is done (like 'formatoptions' is empty). Commas can
3538 be inserted for readability.
3539 To avoid problems with flags that are added in the future, use the
3540 "+=" and "-=" feature of ":set" |add-option-flags|.
3541 NOTE: This option is set to the Vi default value when 'compatible' is
3542 set and to the Vim default value when 'compatible' is reset.
3543
Bram Moolenaar86b68352004-12-27 21:59:20 +00003544 *'formatlistpat'* *'flp'*
3545'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3546 local to buffer
3547 {not in Vi}
3548 A pattern that is used to recognize a list header. This is used for
3549 the "n" flag in 'formatoptions'.
3550 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003551 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003552 while still checking more characters. There must be a character
3553 following the pattern, when it matches the whole line it is handled
3554 like there is no match.
3555 The default recognizes a number, followed by an optional punctuation
3556 character and white space.
3557
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 *'formatprg'* *'fp'*
3559'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003560 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 {not in Vi}
3562 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003563 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003565 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003566 If the 'formatexpr' option is not empty it will be used instead.
3567 Otherwise, if 'formatprg' option is an empty string, the internal
3568 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003569 Environment variables are expanded |:set_env|. See |option-backslash|
3570 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003571 This option cannot be set from a |modeline| or in the |sandbox|, for
3572 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573
Bram Moolenaard94464e2015-11-02 15:28:18 +01003574 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003575'fsync' 'fs' boolean (default on)
3576 global
3577 {not in Vi}
3578 When on, the library function fsync() will be called after writing a
3579 file. This will flush a file to disk, ensuring that it is safely
3580 written even on filesystems which do metadata-only journaling. This
3581 will force the harddrive to spin up on Linux systems running in laptop
3582 mode, so it may be undesirable in some situations. Be warned that
3583 turning this off increases the chances of data loss after a crash. On
3584 systems without an fsync() implementation, this variable is always
3585 off.
3586 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003587 'fsync' also applies to |writefile()|, unless a flag is used to
3588 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003589
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3591'gdefault' 'gd' boolean (default off)
3592 global
3593 {not in Vi}
3594 When on, the ":substitute" flag 'g' is default on. This means that
3595 all matches in a line are substituted instead of one. When a 'g' flag
3596 is given to a ":substitute" command, this will toggle the substitution
3597 of all or one match. See |complex-change|.
3598
3599 command 'gdefault' on 'gdefault' off ~
3600 :s/// subst. all subst. one
3601 :s///g subst. one subst. all
3602 :s///gg subst. all subst. one
3603
3604 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003605 DEPRECATED: Setting this option may break plugins that are not aware
3606 of this option. Also, many users get confused that adding the /g flag
3607 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608
3609 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003610'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 global
3612 {not in Vi}
3613 Format to recognize for the ":grep" command output.
3614 This is a scanf-like string that uses the same format as the
3615 'errorformat' option: see |errorformat|.
3616
3617 *'grepprg'* *'gp'*
3618'grepprg' 'gp' string (default "grep -n ",
3619 Unix: "grep -n $* /dev/null",
3620 Win32: "findstr /n" or "grep -n",
3621 VMS: "SEARCH/NUMBERS ")
3622 global or local to buffer |global-local|
3623 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003624 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 and '#' characters, which are expanded like when used in a command-
3626 line. The placeholder "$*" is allowed to specify where the arguments
3627 will be included. Environment variables are expanded |:set_env|. See
3628 |option-backslash| about including spaces and backslashes.
3629 When your "grep" accepts the "-H" argument, use this to make ":grep"
3630 also work well with a single file: >
3631 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003632< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003633 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3634 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003635 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 apply equally to 'grepprg'.
3637 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3638 otherwise it's "grep -n".
3639 This option cannot be set from a |modeline| or in the |sandbox|, for
3640 security reasons.
3641
3642 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3643'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3644 ve:ver35-Cursor,
3645 o:hor50-Cursor,
3646 i-ci:ver25-Cursor/lCursor,
3647 r-cr:hor20-Cursor/lCursor,
3648 sm:block-Cursor
3649 -blinkwait175-blinkoff150-blinkon175",
3650 for MS-DOS and Win32 console:
3651 "n-v-c:block,o:hor50,i-ci:hor15,
3652 r-cr:hor30,sm:block")
3653 global
3654 {not in Vi}
3655 {only available when compiled with GUI enabled, and
3656 for MS-DOS and Win32 console}
3657 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003658 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 the height of the cursor can be changed. This can be done by
3660 specifying a block cursor, or a percentage for a vertical or
3661 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003662 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3663 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003665 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 mode-list and an argument-list:
3667 mode-list:argument-list,mode-list:argument-list,..
3668 The mode-list is a dash separated list of these modes:
3669 n Normal mode
3670 v Visual mode
3671 ve Visual mode with 'selection' "exclusive" (same as 'v',
3672 if not specified)
3673 o Operator-pending mode
3674 i Insert mode
3675 r Replace mode
3676 c Command-line Normal (append) mode
3677 ci Command-line Insert mode
3678 cr Command-line Replace mode
3679 sm showmatch in Insert mode
3680 a all modes
3681 The argument-list is a dash separated list of these arguments:
3682 hor{N} horizontal bar, {N} percent of the character height
3683 ver{N} vertical bar, {N} percent of the character width
3684 block block cursor, fills the whole character
3685 [only one of the above three should be present]
3686 blinkwait{N} *cursor-blinking*
3687 blinkon{N}
3688 blinkoff{N}
3689 blink times for cursor: blinkwait is the delay before
3690 the cursor starts blinking, blinkon is the time that
3691 the cursor is shown and blinkoff is the time that the
3692 cursor is not shown. The times are in msec. When one
3693 of the numbers is zero, there is no blinking. The
3694 default is: "blinkwait700-blinkon400-blinkoff250".
3695 These numbers are used for a missing entry. This
3696 means that blinking is enabled by default. To switch
3697 blinking off you can use "blinkon0". The cursor only
3698 blinks when Vim is waiting for input, not while
3699 executing a command.
3700 To make the cursor blink in an xterm, see
3701 |xterm-blink|.
3702 {group-name}
3703 a highlight group name, that sets the color and font
3704 for the cursor
3705 {group-name}/{group-name}
3706 Two highlight group names, the first is used when
3707 no language mappings are used, the other when they
3708 are. |language-mapping|
3709
3710 Examples of parts:
3711 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3712 block cursor with colors from the "nCursor"
3713 highlight group
3714 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3715 In Insert and Command-line Insert mode, use a
3716 30% vertical bar cursor with colors from the
3717 "iCursor" highlight group. Blink a bit
3718 faster.
3719
3720 The 'a' mode is different. It will set the given argument-list for
3721 all modes. It does not reset anything to defaults. This can be used
3722 to do a common setting for all modes. For example, to switch off
3723 blinking: "a:blinkon0"
3724
3725 Examples of cursor highlighting: >
3726 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3727 :highlight Cursor gui=NONE guifg=bg guibg=fg
3728<
3729 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003730 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731'guifont' 'gfn' string (default "")
3732 global
3733 {not in Vi}
3734 {only available when compiled with GUI enabled}
3735 This is a list of fonts which will be used for the GUI version of Vim.
3736 In its simplest form the value is just one font name. When
3737 the font cannot be found you will get an error message. To try other
3738 font names a list can be specified, font names separated with commas.
3739 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003740
Bram Moolenaar05159a02005-02-26 23:04:13 +00003741 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3742 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003743
Bram Moolenaar3df01732017-02-17 22:47:16 +01003744 Note: As to the GTK GUIs, no error is given against any invalid names,
3745 and the first element of the list is always picked up and made use of.
3746 This is because, instead of identifying a given name with a font, the
3747 GTK GUIs use it to construct a pattern and try to look up a font which
3748 best matches the pattern among available fonts, and this way, the
3749 matching never fails. An invalid name doesn't matter because a number
3750 of font properties other than name will do to get the matching done.
3751
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 Spaces after a comma are ignored. To include a comma in a font name
3753 precede it with a backslash. Setting an option requires an extra
3754 backslash before a space and a backslash. See also
3755 |option-backslash|. For example: >
3756 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003757< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003759
3760 If none of the fonts can be loaded, Vim will keep the current setting.
3761 If an empty font list is given, Vim will try using other resource
3762 settings (for X, it will use the Vim.font resource), and finally it
3763 will try some builtin default which should always be there ("7x13" in
3764 the case of X). The font names given should be "normal" fonts. Vim
3765 will try to find the related bold and italic fonts.
3766
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003767 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003768 :set guifont=*
3769< will bring up a font requester, where you can pick the font you want.
3770
3771 The font name depends on the GUI used. See |setting-guifont| for a
3772 way to set 'guifont' for various systems.
3773
Bram Moolenaar3df01732017-02-17 22:47:16 +01003774 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003776< That's all. XLFDs are not used. For Chinese this is reported to work
3777 well: >
3778 if has("gui_gtk2")
3779 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3780 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3781 endif
3782<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003783 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3784
Bram Moolenaar05159a02005-02-26 23:04:13 +00003785 For Mac OSX you can use something like this: >
3786 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003787< Also see 'macatsui', it can help fix display problems.
3788 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003790 width). An exception is GTK: all fonts are accepted, but mono-spaced
3791 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003792
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 To preview a font on X11, you might be able to use the "xfontsel"
3794 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003795
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 For the Win32 GUI *E244* *E245*
3797 - takes these options in the font name:
3798 hXX - height is XX (points, can be floating-point)
3799 wXX - width is XX (points, can be floating-point)
3800 b - bold
3801 i - italic
3802 u - underline
3803 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003804 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3806 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3807 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003808 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003809 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003810 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003811 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003812 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813
3814 Use a ':' to separate the options.
3815 - A '_' can be used in the place of a space, so you don't need to use
3816 backslashes to escape the spaces.
3817 - Examples: >
3818 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3819 :set guifont=Andale_Mono:h7.5:w4.5
3820< See also |font-sizes|.
3821
3822 *'guifontset'* *'gfs'*
3823 *E250* *E252* *E234* *E597* *E598*
3824'guifontset' 'gfs' string (default "")
3825 global
3826 {not in Vi}
3827 {only available when compiled with GUI enabled and
3828 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003829 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 When not empty, specifies two (or more) fonts to be used. The first
3831 one for normal English, the second one for your special language. See
3832 |xfontset|.
3833 Setting this option also means that all font names will be handled as
3834 a fontset name. Also the ones used for the "font" argument of the
3835 |:highlight| command.
3836 The fonts must match with the current locale. If fonts for the
3837 character sets that the current locale uses are not included, setting
3838 'guifontset' will fail.
3839 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3840 the comma-separated names are alternative names, one of which will be
3841 used. In 'guifontset' the whole string is one fontset name,
3842 including the commas. It is not possible to specify alternative
3843 fontset names.
3844 This example works on many X11 systems: >
3845 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3846<
3847 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3848'guifontwide' 'gfw' string (default "")
3849 global
3850 {not in Vi}
3851 {only available when compiled with GUI enabled}
3852 When not empty, specifies a comma-separated list of fonts to be used
3853 for double-width characters. The first font that can be loaded is
3854 used.
3855 Note: The size of these fonts must be exactly twice as wide as the one
3856 specified with 'guifont' and the same height.
3857
Bram Moolenaar3df01732017-02-17 22:47:16 +01003858 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859
3860 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3861 'guifontset' is empty or invalid.
3862 When 'guifont' is set and a valid font is found in it and
3863 'guifontwide' is empty Vim will attempt to find a matching
3864 double-width font and set 'guifontwide' to it.
3865
Bram Moolenaar3df01732017-02-17 22:47:16 +01003866 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867
3868 If set and valid, 'guifontwide' is always used for double width
3869 characters, even if 'encoding' is not set to "utf-8".
3870 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003871 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 font for characters not available in 'guifont'. Thus you do not need
3873 to set 'guifontwide' at all unless you want to override the choice
3874 made by Pango/Xft.
3875
Bram Moolenaar0f272122013-01-23 18:37:40 +01003876 Windows +multibyte only: *guifontwide_win_mbyte*
3877
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003878 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003879
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 *'guiheadroom'* *'ghr'*
3881'guiheadroom' 'ghr' number (default 50)
3882 global
3883 {not in Vi} {only for GTK and X11 GUI}
3884 The number of pixels subtracted from the screen height when fitting
3885 the GUI window on the screen. Set this before the GUI is started,
3886 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003887 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 lines will be left for window decorations and other items on the
3889 screen. Set it to a negative value to allow windows taller than the
3890 screen.
3891
3892 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003893'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3894 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003895 "aegimrLtT" (GTK, Motif and Athena),
3896 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 global
3898 {not in Vi}
3899 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003900 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 sequence of letters which describes what components and options of the
3902 GUI should be used.
3903 To avoid problems with flags that are added in the future, use the
3904 "+=" and "-=" feature of ":set" |add-option-flags|.
3905
Bram Moolenaar13568252018-03-16 20:46:58 +01003906 Valid characters are as follows:
3907 *'go-!'*
3908 '!' External commands are executed in a terminal window. Without
3909 this flag the MS-Windows GUI will open a console window to
3910 execute the command. The Unix GUI will simulate a dumb
3911 terminal to list the command output.
3912 The terminal window will be positioned at the bottom, and grow
3913 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003914 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 'a' Autoselect: If present, then whenever VISUAL mode is started,
3916 or the Visual area extended, Vim tries to become the owner of
3917 the windowing system's global selection. This means that the
3918 Visually highlighted text is available for pasting into other
3919 applications as well as into Vim itself. When the Visual mode
3920 ends, possibly due to an operation on the text, or when an
3921 application wants to paste the selection, the highlighted text
3922 is automatically yanked into the "* selection register.
3923 Thus the selection is still available for pasting into other
3924 applications after the VISUAL mode has ended.
3925 If not present, then Vim won't become the owner of the
3926 windowing system's global selection unless explicitly told to
3927 by a yank or delete operation for the "* register.
3928 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003929 *'go-P'*
3930 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003931 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003932 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003933 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 applies to the modeless selection.
3935
3936 'guioptions' autoselect Visual autoselect modeless ~
3937 "" - -
3938 "a" yes yes
3939 "A" - yes
3940 "aA" yes yes
3941
Bram Moolenaar02467872007-05-06 13:22:01 +00003942 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 'c' Use console dialogs instead of popup dialogs for simple
3944 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003945 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003946 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003947 'guitablabel' can be used to change the text in the labels.
3948 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003949 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003950 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003951 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 'f' Foreground: Don't use fork() to detach the GUI from the shell
3953 where it was started. Use this for programs that wait for the
3954 editor to finish (e.g., an e-mail program). Alternatively you
3955 can use "gvim -f" or ":gui -f" to start the GUI in the
3956 foreground. |gui-fork|
3957 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003958 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003959 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3961 corner of the window. It's black&white on non-GTK, because of
3962 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003963 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003965 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003966 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003968 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003970 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'g' Grey menu items: Make menu items that are not active grey. If
3973 'g' is not included inactive menu items are not shown at all.
3974 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003975 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 't' Include tearoff menu items. Currently only works for Win32,
3977 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003978 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003979 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003980 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003981 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003983 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 'R' Right-hand scrollbar is present when there is a vertically
3985 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003986 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003988 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989 'L' Left-hand scrollbar is present when there is a vertically
3990 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003991 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3993 the longest visible line, or on the cursor line if the 'h'
3994 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003995 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 'h' Limit horizontal scrollbar size to the length of the cursor
3997 line. Reduces computations. |gui-horiz-scroll|
3998
3999 And yes, you may even have scrollbars on the left AND the right if
4000 you really want to :-). See |gui-scrollbars| for more information.
4001
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004002 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 'v' Use a vertical button layout for dialogs. When not included,
4004 a horizontal layout is preferred, but when it doesn't fit a
4005 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004006 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 'p' Use Pointer callbacks for X11 GUI. This is required for some
4008 window managers. If the cursor is not blinking or hollow at
4009 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004010 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004012 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004013 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004014 *'go-k'*
4015 'k' Keep the GUI window size when adding/removing a scrollbar, or
4016 toolbar, tabline, etc. Instead, the behavior is similar to
4017 when the window is maximized and will adjust 'lines' and
4018 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004019 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004020 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004021
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 *'guipty'* *'noguipty'*
4023'guipty' boolean (default on)
4024 global
4025 {not in Vi}
4026 {only available when compiled with GUI enabled}
4027 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4028 I/O to/from shell commands. See |gui-pty|.
4029
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004030 *'guitablabel'* *'gtl'*
4031'guitablabel' 'gtl' string (default empty)
4032 global
4033 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004034 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004035 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004036 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004037 pages line. When empty and when the result is empty Vim will use a
4038 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004039
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004040 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004041 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004042 The expression will be evaluated in the |sandbox| when set from a
4043 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004044
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004045 Only used when the GUI tab pages line is displayed. 'e' must be
4046 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4047 used.
4048
Bram Moolenaar57657d82006-04-21 22:12:41 +00004049 *'guitabtooltip'* *'gtt'*
4050'guitabtooltip' 'gtt' string (default empty)
4051 global
4052 {not in Vi}
4053 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004054 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004055 When nonempty describes the text to use in a tooltip for the GUI tab
4056 pages line. When empty Vim will use a default tooltip.
4057 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004058 You can include a line break. Simplest method is to use |:let|: >
4059 :let &guitabtooltip = "line one\nline two"
4060<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004061
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 *'helpfile'* *'hf'*
4063'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4064 (others) "$VIMRUNTIME/doc/help.txt")
4065 global
4066 {not in Vi}
4067 Name of the main help file. All distributed help files should be
4068 placed together in one directory. Additionally, all "doc" directories
4069 in 'runtimepath' will be used.
4070 Environment variables are expanded |:set_env|. For example:
4071 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004072 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 spaces and backslashes.
4074 This option cannot be set from a |modeline| or in the |sandbox|, for
4075 security reasons.
4076
4077 *'helpheight'* *'hh'*
4078'helpheight' 'hh' number (default 20)
4079 global
4080 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004081 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 feature}
4083 Minimal initial height of the help window when it is opened with the
4084 ":help" command. The initial height of the help window is half of the
4085 current window, or (when the 'ea' option is on) the same as other
4086 windows. When the height is less than 'helpheight', the height is
4087 set to 'helpheight'. Set to zero to disable.
4088
4089 *'helplang'* *'hlg'*
4090'helplang' 'hlg' string (default: messages language or empty)
4091 global
4092 {only available when compiled with the |+multi_lang|
4093 feature}
4094 {not in Vi}
4095 Comma separated list of languages. Vim will use the first language
4096 for which the desired help can be found. The English help will always
4097 be used as a last resort. You can add "en" to prefer English over
4098 another language, but that will only find tags that exist in that
4099 language and not in the English help.
4100 Example: >
4101 :set helplang=de,it
4102< This will first search German, then Italian and finally English help
4103 files.
4104 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4105 try to find the tag in the current language before using this option.
4106 See |help-translated|.
4107
4108 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4109'hidden' 'hid' boolean (default off)
4110 global
4111 {not in Vi}
4112 When off a buffer is unloaded when it is |abandon|ed. When on a
4113 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4114 displayed in another window, it does not become hidden, of course.
4115 The commands that move through the buffer list sometimes make a buffer
4116 hidden although the 'hidden' option is off: When the buffer is
4117 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004118 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004119 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 This option is set for one command with ":hide {command}" |:hide|.
4121 WARNING: It's easy to forget that you have changes in hidden buffers.
4122 Think twice when using ":q!" or ":qa!".
4123
4124 *'highlight'* *'hl'*
4125'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004126 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4127 d:Directory,e:ErrorMsg,i:IncSearch,
4128 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4129 N:CursorLineNr,r:Question,s:StatusLine,
4130 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004131 v:Visual,V:VisualNOS,w:WarningMsg,
4132 W:WildMenu,f:Folded,F:FoldColumn,
4133 A:DiffAdd,C:DiffChange,D:DiffDelete,
4134 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004135 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004136 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004137 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4138 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004139 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004140 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 global
4142 {not in Vi}
4143 This option can be used to set highlighting mode for various
4144 occasions. It is a comma separated list of character pairs. The
4145 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004146 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004148 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4149 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 characters from 'showbreak'
4151 |hl-Directory| d directories in CTRL-D listing and other special
4152 things in listings
4153 |hl-ErrorMsg| e error messages
4154 h (obsolete, ignored)
4155 |hl-IncSearch| i 'incsearch' highlighting
4156 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4157 |hl-MoreMsg| m |more-prompt|
4158 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004159 |hl-LineNr| n line number for ":number" and ":#" commands, and
4160 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004161 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4162 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 |hl-Question| r |hit-enter| prompt and yes/no questions
4164 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004165 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4167 |hl-VertSplit| c column used to separate vertically split windows
4168 |hl-Visual| v Visual mode
4169 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4170 Selection" Only X11 Gui's |gui-x11| and
4171 |xterm-clipboard|.
4172 |hl-WarningMsg| w warning messages
4173 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4174 |hl-Folded| f line used for closed folds
4175 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004176 |hl-DiffAdd| A added line in diff mode
4177 |hl-DiffChange| C changed line in diff mode
4178 |hl-DiffDelete| D deleted line in diff mode
4179 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004181 |hl-Conceal| - the placeholders used for concealed characters
4182 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004183 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004184 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004185 |hl-SpellRare| R rare word |spell|
4186 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004187 |hl-Pmenu| + popup menu normal line
4188 |hl-PmenuSel| = popup menu selected line
4189 |hl-PmenuSbar| x popup menu scrollbar
4190 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
4192 The display modes are:
4193 r reverse (termcap entry "mr" and "me")
4194 i italic (termcap entry "ZH" and "ZR")
4195 b bold (termcap entry "md" and "me")
4196 s standout (termcap entry "so" and "se")
4197 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004198 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004199 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 n no highlighting
4201 - no highlighting
4202 : use a highlight group
4203 The default is used for occasions that are not included.
4204 If you want to change what the display modes do, see |dos-colors|
4205 for an example.
4206 When using the ':' display mode, this must be followed by the name of
4207 a highlight group. A highlight group can be used to define any type
4208 of highlighting, including using color. See |:highlight| on how to
4209 define one. The default uses a different group for each occasion.
4210 See |highlight-default| for the default highlight groups.
4211
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004213'history' 'hi' number (Vim default: 50, Vi default: 0,
4214 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 global
4216 {not in Vi}
4217 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004218 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004220 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 NOTE: This option is set to the Vi default value when 'compatible' is
4222 set and to the Vim default value when 'compatible' is reset.
4223
4224 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4225'hkmap' 'hk' boolean (default off)
4226 global
4227 {not in Vi}
4228 {only available when compiled with the |+rightleft|
4229 feature}
4230 When on, the keyboard is mapped for the Hebrew character set.
4231 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4232 toggle this option. See |rileft.txt|.
4233 NOTE: This option is reset when 'compatible' is set.
4234
4235 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4236'hkmapp' 'hkp' boolean (default off)
4237 global
4238 {not in Vi}
4239 {only available when compiled with the |+rightleft|
4240 feature}
4241 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4242 This is useful if you have a non-Hebrew keyboard.
4243 See |rileft.txt|.
4244 NOTE: This option is reset when 'compatible' is set.
4245
Bram Moolenaar036986f2017-03-16 17:41:02 +01004246 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4247'hlsearch' 'hls' boolean (default off)
4248 global
4249 {not in Vi}
4250 {not available when compiled without the
4251 |+extra_search| feature}
4252 When there is a previous search pattern, highlight all its matches.
4253 The type of highlighting used can be set with the 'l' occasion in the
4254 'highlight' option. This uses the "Search" highlight group by
4255 default. Note that only the matching text is highlighted, any offsets
4256 are not applied.
4257 See also: 'incsearch' and |:match|.
4258 When you get bored looking at the highlighted matches, you can turn it
4259 off with |:nohlsearch|. This does not change the option value, as
4260 soon as you use a search command, the highlighting comes back.
4261 'redrawtime' specifies the maximum time spent on finding matches.
4262 When the search pattern can match an end-of-line, Vim will try to
4263 highlight all of the matched text. However, this depends on where the
4264 search starts. This will be the first line in the window or the first
4265 line below a closed fold. A match in a previous line which is not
4266 drawn may not continue in a newly drawn line.
4267 You can specify whether the highlight status is restored on startup
4268 with the 'h' flag in 'viminfo' |viminfo-h|.
4269 NOTE: This option is reset when 'compatible' is set.
4270
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 *'icon'* *'noicon'*
4272'icon' boolean (default off, on when title can be restored)
4273 global
4274 {not in Vi}
4275 {not available when compiled without the |+title|
4276 feature}
4277 When on, the icon text of the window will be set to the value of
4278 'iconstring' (if it is not empty), or to the name of the file
4279 currently being edited. Only the last part of the name is used.
4280 Overridden by the 'iconstring' option.
4281 Only works if the terminal supports setting window icons (currently
4282 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4283 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4284 builtin termcap).
4285 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004286 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004288 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289
4290 *'iconstring'*
4291'iconstring' string (default "")
4292 global
4293 {not in Vi}
4294 {not available when compiled without the |+title|
4295 feature}
4296 When this option is not empty, it will be used for the icon text of
4297 the window. This happens only when the 'icon' option is on.
4298 Only works if the terminal supports setting window icon text
4299 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4300 Does not work for MS Windows.
4301 When Vim was compiled with HAVE_X11 defined, the original icon will be
4302 restored if possible |X11|.
4303 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004304 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 'titlestring' for example settings.
4306 {not available when compiled without the |+statusline| feature}
4307
4308 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4309'ignorecase' 'ic' boolean (default off)
4310 global
4311 Ignore case in search patterns. Also used when searching in the tags
4312 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004313 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 Can be overruled by using "\c" or "\C" in the pattern, see
4315 |/ignorecase|.
4316
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004317 *'imactivatefunc'* *'imaf'*
4318'imactivatefunc' 'imaf' string (default "")
4319 global
4320 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004321 {only available when compiled with the |+multi_byte|
4322 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004323 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004324 activate or deactivate the Input Method.
4325 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004326
4327 Example: >
4328 function ImActivateFunc(active)
4329 if a:active
4330 ... do something
4331 else
4332 ... do something
4333 endif
4334 " return value is not used
4335 endfunction
4336 set imactivatefunc=ImActivateFunc
4337<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 *'imactivatekey'* *'imak'*
4339'imactivatekey' 'imak' string (default "")
4340 global
4341 {not in Vi}
4342 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004343 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 Specifies the key that your Input Method in X-Windows uses for
4345 activation. When this is specified correctly, vim can fully control
4346 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4347 You can't use this option to change the activation key, the option
4348 tells Vim what the key is.
4349 Format:
4350 [MODIFIER_FLAG-]KEY_STRING
4351
4352 These characters can be used for MODIFIER_FLAG (case is ignored):
4353 S Shift key
4354 L Lock key
4355 C Control key
4356 1 Mod1 key
4357 2 Mod2 key
4358 3 Mod3 key
4359 4 Mod4 key
4360 5 Mod5 key
4361 Combinations are allowed, for example "S-C-space" or "SC-space" are
4362 both shift+ctrl+space.
4363 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4364
4365 Example: >
4366 :set imactivatekey=S-space
4367< "S-space" means shift+space. This is the activation key for kinput2 +
4368 canna (Japanese), and ami (Korean).
4369
4370 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4371'imcmdline' 'imc' boolean (default off)
4372 global
4373 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004374 {only available when compiled with the |+multi_byte|
4375 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 When set the Input Method is always on when starting to edit a command
4377 line, unless entering a search pattern (see 'imsearch' for that).
4378 Setting this option is useful when your input method allows entering
4379 English characters directly, e.g., when it's used to type accented
4380 characters with dead keys.
4381
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004382 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4384 global
4385 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004386 {only available when compiled with the |+multi_byte|
4387 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 When set the Input Method is never used. This is useful to disable
4389 the IM when it doesn't work properly.
4390 Currently this option is on by default for SGI/IRIX machines. This
4391 may change in later releases.
4392
4393 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004394'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 local to buffer
4396 {not in Vi}
4397 Specifies whether :lmap or an Input Method (IM) is to be used in
4398 Insert mode. Valid values:
4399 0 :lmap is off and IM is off
4400 1 :lmap is ON and IM is off
4401 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 To always reset the option to zero when leaving Insert mode with <Esc>
4403 this can be used: >
4404 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4405< This makes :lmap and IM turn off automatically when leaving Insert
4406 mode.
4407 Note that this option changes when using CTRL-^ in Insert mode
4408 |i_CTRL-^|.
4409 The value is set to 1 when setting 'keymap' to a valid keymap name.
4410 It is also used for the argument of commands like "r" and "f".
4411 The value 0 may not work correctly with Athena and Motif with some XIM
4412 methods. Use 'imdisable' to disable XIM then.
4413
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004414 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004415 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004416 |+multi_byte_ime| or |global-ime|.
4417
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004419'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 local to buffer
4421 {not in Vi}
4422 Specifies whether :lmap or an Input Method (IM) is to be used when
4423 entering a search pattern. Valid values:
4424 -1 the value of 'iminsert' is used, makes it look like
4425 'iminsert' is also used when typing a search pattern
4426 0 :lmap is off and IM is off
4427 1 :lmap is ON and IM is off
4428 2 :lmap is off and IM is ON
4429 Note that this option changes when using CTRL-^ in Command-line mode
4430 |c_CTRL-^|.
4431 The value is set to 1 when it is not -1 and setting the 'keymap'
4432 option to a valid keymap name.
4433 The value 0 may not work correctly with Athena and Motif with some XIM
4434 methods. Use 'imdisable' to disable XIM then.
4435
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004436 *'imstatusfunc'* *'imsf'*
4437'imstatusfunc' 'imsf' string (default "")
4438 global
4439 {not in Vi}
Bram Moolenaarf2732452018-06-03 14:47:35 +02004440 {only available when compiled with the |+multi_byte|
4441 feature}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004442 This option specifies a function that is called to obtain the status
4443 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004444 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004445
4446 Example: >
4447 function ImStatusFunc()
4448 let is_active = ...do something
4449 return is_active ? 1 : 0
4450 endfunction
4451 set imstatusfunc=ImStatusFunc
4452<
4453 NOTE: This function is invoked very often. Keep it fast.
4454
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004455 *'imstyle'* *'imst'*
4456'imstyle' 'imst' number (default 1)
4457 global
4458 {not in Vi}
4459 {only available when compiled with |+xim| and
4460 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004461 This option specifies the input style of Input Method:
4462 0 use on-the-spot style
4463 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004464 See: |xim-input-style|
4465
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004466 For a long time on-the-spot style had been used in the GTK version of
4467 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004468 |single-repeat|, etc. Therefore over-the-spot style becomes the
4469 default now. This should work fine for most people, however if you
4470 have any problem with it, try using on-the-spot style.
4471
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 *'include'* *'inc'*
4473'include' 'inc' string (default "^\s*#\s*include")
4474 global or local to buffer |global-local|
4475 {not in Vi}
4476 {not available when compiled without the
4477 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004478 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 pattern, just like for the "/" command (See |pattern|). The default
4480 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004481 "]I", "[d", etc.
4482 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004483 comes after the matched pattern. But if "\zs" appears in the pattern
4484 then the text matched from "\zs" to the end, or until "\ze" if it
4485 appears, is used as the file name. Use this to include characters
4486 that are not in 'isfname', such as a space. You can then use
4487 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004488 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 *'includeexpr'* *'inex'*
4491'includeexpr' 'inex' string (default "")
4492 local to buffer
4493 {not in Vi}
4494 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004495 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004497 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 :set includeexpr=substitute(v:fname,'\\.','/','g')
4499< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004500
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004502 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 Also used for |<cfile>|.
4504
Bram Moolenaar30b65812012-07-12 22:01:11 +02004505 The expression will be evaluated in the |sandbox| when set from a
4506 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004507
4508 It is not allowed to change text or jump to another window while
4509 evaluating 'includeexpr' |textlock|.
4510
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004512'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4513 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 global
4515 {not in Vi}
4516 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004517 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004518 While typing a search command, show where the pattern, as it was typed
4519 so far, matches. The matched string is highlighted. If the pattern
4520 is invalid or not found, nothing is shown. The screen will be updated
4521 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004522 Also applies to the pattern in commands: >
4523 :global
4524 :lvimgrep
4525 :lvimgrepadd
4526 :smagic
4527 :snomagic
4528 :sort
4529 :substitute
4530 :vglobal
4531 :vimgrep
4532 :vimgrepadd
4533< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004534 original position when no match is found and when pressing <Esc>. You
4535 still need to finish the search command with <Enter> to move the
4536 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004537 You can use the CTRL-G and CTRL-T keys to move to the next and
4538 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004539 When compiled with the |+reltime| feature Vim only searches for about
4540 half a second. With a complicated pattern and/or a lot of text the
4541 match may not be found. This is to avoid that Vim hangs while you
4542 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004543 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004544 When 'hlsearch' is on, all matched strings are highlighted too while
4545 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004546 If you don't want to turn 'hlsearch' on, but want to highlight all
4547 matches while searching, you can turn on and off 'hlsearch' with
4548 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004549 augroup vimrc-incsearch-highlight
4550 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004551 autocmd CmdlineEnter /,\? :set hlsearch
4552 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004553 augroup END
4554<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004555 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004556 to the command line. If 'ignorecase' and 'smartcase' are set and the
4557 command line has no uppercase characters, the added character is
4558 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004559 CTRL-R CTRL-W can be used to add the word at the end of the current
4560 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 NOTE: This option is reset when 'compatible' is set.
4562
4563 *'indentexpr'* *'inde'*
4564'indentexpr' 'inde' string (default "")
4565 local to buffer
4566 {not in Vi}
4567 {not available when compiled without the |+cindent|
4568 or |+eval| features}
4569 Expression which is evaluated to obtain the proper indent for a line.
4570 It is used when a new line is created, for the |=| operator and
4571 in Insert mode as specified with the 'indentkeys' option.
4572 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004573 'smartindent' indenting. When 'lisp' is set, this option is
4574 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 When 'paste' is set this option is not used for indenting.
4576 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004577 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 when the expression is evaluated (but it may be moved around).
4579 The expression must return the number of spaces worth of indent. It
4580 can return "-1" to keep the current indent (this means 'autoindent' is
4581 used for the indent).
4582 Functions useful for computing the indent are |indent()|, |cindent()|
4583 and |lispindent()|.
4584 The evaluation of the expression must not have side effects! It must
4585 not change the text, jump to another window, etc. Afterwards the
4586 cursor position is always restored, thus the cursor may be moved.
4587 Normally this option would be set to call a function: >
4588 :set indentexpr=GetMyIndent()
4589< Error messages will be suppressed, unless the 'debug' option contains
4590 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004591 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004592 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593
Bram Moolenaar30b65812012-07-12 22:01:11 +02004594 The expression will be evaluated in the |sandbox| when set from a
4595 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004596
4597 It is not allowed to change text or jump to another window while
4598 evaluating 'indentexpr' |textlock|.
4599
4600
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004602'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 local to buffer
4604 {not in Vi}
4605 {not available when compiled without the |+cindent|
4606 feature}
4607 A list of keys that, when typed in Insert mode, cause reindenting of
4608 the current line. Only happens if 'indentexpr' isn't empty.
4609 The format is identical to 'cinkeys', see |indentkeys-format|.
4610 See |C-indenting| and |indent-expression|.
4611
4612 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4613'infercase' 'inf' boolean (default off)
4614 local to buffer
4615 {not in Vi}
4616 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004617 'ignorecase' is also on, the case of the match is adjusted depending
4618 on the typed text. If the typed text contains a lowercase letter
4619 where the match has an upper case letter, the completed part is made
4620 lowercase. If the typed text has no lowercase letters and the match
4621 has a lowercase letter where the typed text has an uppercase letter,
4622 and there is a letter before it, the completed part is made uppercase.
4623 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624
4625 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4626'insertmode' 'im' boolean (default off)
4627 global
4628 {not in Vi}
4629 Makes Vim work in a way that Insert mode is the default mode. Useful
4630 if you want to use Vim as a modeless editor. Used for |evim|.
4631 These Insert mode commands will be useful:
4632 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004633 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 this is a mapping, it is executed as if 'insertmode' was off.
4635 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004637 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4638 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639
4640 These items change when 'insertmode' is set:
4641 - when starting to edit of a file, Vim goes to Insert mode.
4642 - <Esc> in Insert mode is a no-op and beeps.
4643 - <Esc> in Normal mode makes Vim go to Insert mode.
4644 - CTRL-L in Insert mode is a command, it is not inserted.
4645 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4646 However, when <Esc> is used inside a mapping, it behaves like
4647 'insertmode' was not set. This was done to be able to use the same
4648 mappings with 'insertmode' set or not set.
4649 When executing commands with |:normal| 'insertmode' is not used.
4650
4651 NOTE: This option is reset when 'compatible' is set.
4652
4653 *'isfname'* *'isf'*
4654'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4655 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4656 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4657 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4658 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4659 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4660 global
4661 {not in Vi}
4662 The characters specified by this option are included in file names and
4663 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004664 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 Multi-byte characters 256 and above are always included, only the
4666 characters up to 255 are specified with this option.
4667 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004668 Think twice before adding white space to this option. Although a
4669 space may appear inside a file name, the effect will be that Vim
4670 doesn't know where a file name starts or ends when doing completion.
4671 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672
4673 Note that on systems using a backslash as path separator, Vim tries to
4674 do its best to make it work as you would expect. That is a bit
4675 tricky, since Vi originally used the backslash to escape special
4676 characters. Vim will not remove a backslash in front of a normal file
4677 name character on these systems, but it will on Unix and alikes. The
4678 '&' and '^' are not included by default, because these are special for
4679 cmd.exe.
4680
4681 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004682 Each part can be a single character number or a range. A range is two
4683 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 decimal number between 0 and 255 or the ASCII character itself (does
4685 not work for digits). Example:
4686 "_,-,128-140,#-43" (include '_' and '-' and the range
4687 128 to 140 and '#' to 43)
4688 If a part starts with '^', the following character number or range
4689 will be excluded from the option. The option is interpreted from left
4690 to right. Put the excluded character after the range where it is
4691 included. To include '^' itself use it as the last character of the
4692 option or the end of a range. Example:
4693 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4694 If the character is '@', all characters where isalpha() returns TRUE
4695 are included. Normally these are the characters a to z and A to Z,
4696 plus accented characters. To include '@' itself use "@-@". Examples:
4697 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004698 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 "a-z,A-Z,@-@" All letters plus the '@' character.
4700 A comma can be included by using it where a character number is
4701 expected. Example:
4702 "48-57,,,_" Digits, comma and underscore.
4703 A comma can be excluded by prepending a '^'. Example:
4704 " -~,^,,9" All characters from space to '~', excluding
4705 comma, plus <Tab>.
4706 See |option-backslash| about including spaces and backslashes.
4707
4708 *'isident'* *'isi'*
4709'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4710 "@,48-57,_,128-167,224-235"
4711 otherwise: "@,48-57,_,192-255")
4712 global
4713 {not in Vi}
4714 The characters given by this option are included in identifiers.
4715 Identifiers are used in recognizing environment variables and after a
4716 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004717 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004718 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004720 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4722
4723 *'iskeyword'* *'isk'*
4724'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4725 "@,48-57,_,128-167,224-235"
4726 otherwise: "@,48-57,_,192-255"
4727 Vi default: "@,48-57,_")
4728 local to buffer
4729 {not in Vi}
4730 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004731 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004732 'isfname' for a description of the format of this option. For '@'
4733 characters above 255 check the "word" character class.
4734 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 For a help file it is set to all non-blank printable characters except
4736 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4737 command).
4738 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004739 This option also influences syntax highlighting, unless the syntax
4740 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 NOTE: This option is set to the Vi default value when 'compatible' is
4742 set and to the Vim default value when 'compatible' is reset.
4743
4744 *'isprint'* *'isp'*
4745'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4746 "@,~-255"; otherwise: "@,161-255")
4747 global
4748 {not in Vi}
4749 The characters given by this option are displayed directly on the
4750 screen. It is also used for "\p" in a |pattern|. The characters from
4751 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4752 even when they are not included in 'isprint' or excluded. See
4753 'isfname' for a description of the format of this option.
4754
4755 Non-printable characters are displayed with two characters:
4756 0 - 31 "^@" - "^_"
4757 32 - 126 always single characters
4758 127 "^?"
4759 128 - 159 "~@" - "~_"
4760 160 - 254 "| " - "|~"
4761 255 "~?"
4762 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4763 displayed as <xx>, with the hexadecimal value of the byte.
4764 When 'display' contains "uhex" all unprintable characters are
4765 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004766 The SpecialKey highlighting will be used for unprintable characters.
4767 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768
4769 Multi-byte characters 256 and above are always included, only the
4770 characters up to 255 are specified with this option. When a character
4771 is printable but it is not available in the current font, a
4772 replacement character will be shown.
4773 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4774 There is no option to specify these characters.
4775
4776 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4777'joinspaces' 'js' boolean (default on)
4778 global
4779 {not in Vi}
4780 Insert two spaces after a '.', '?' and '!' with a join command.
4781 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4782 Otherwise only one space is inserted.
4783 NOTE: This option is set when 'compatible' is set.
4784
4785 *'key'*
4786'key' string (default "")
4787 local to buffer
4788 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004789 {only available when compiled with the |+cryptv|
4790 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004792 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 Careful: Do not set the key value by hand, someone might see the typed
4794 key. Use the |:X| command. But you can make 'key' empty: >
4795 :set key=
4796< It is not possible to get the value of this option with ":set key" or
4797 "echo &key". This is to avoid showing it to someone who shouldn't
4798 know. It also means you cannot see it yourself once you have set it,
4799 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004800 You can use "&key" in an expression to detect whether encryption is
4801 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802
4803 *'keymap'* *'kmp'* *E544*
4804'keymap' 'kmp' string (default "")
4805 local to buffer
4806 {not in Vi}
4807 {only available when compiled with the |+keymap|
4808 feature}
4809 Name of a keyboard mapping. See |mbyte-keymap|.
4810 Setting this option to a valid keymap name has the side effect of
4811 setting 'iminsert' to one, so that the keymap becomes effective.
4812 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004813 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814
4815 *'keymodel'* *'km'*
4816'keymodel' 'km' string (default "")
4817 global
4818 {not in Vi}
4819 List of comma separated words, which enable special things that keys
4820 can do. These values can be used:
4821 startsel Using a shifted special key starts selection (either
4822 Select mode or Visual mode, depending on "key" being
4823 present in 'selectmode').
4824 stopsel Using a not-shifted special key stops selection.
4825 Special keys in this context are the cursor keys, <End>, <Home>,
4826 <PageUp> and <PageDown>.
4827 The 'keymodel' option is set by the |:behave| command.
4828
4829 *'keywordprg'* *'kp'*
4830'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004831 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 global or local to buffer |global-local|
4833 {not in Vi}
4834 Program to use for the |K| command. Environment variables are
4835 expanded |:set_env|. ":help" may be used to access the Vim internal
4836 help. (Note that previously setting the global option to the empty
4837 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004838 When the first character is ":", the command is invoked as a Vim
4839 Ex command prefixed with [count].
4840 When "man", "man -s" or an Ex command is used, Vim will automatically
4841 translate a count for the "K" command and pass it as the first
4842 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 See |option-backslash| about including spaces and backslashes.
4844 Example: >
4845 :set keywordprg=man\ -s
4846< This option cannot be set from a |modeline| or in the |sandbox|, for
4847 security reasons.
4848
4849 *'langmap'* *'lmap'* *E357* *E358*
4850'langmap' 'lmap' string (default "")
4851 global
4852 {not in Vi}
4853 {only available when compiled with the |+langmap|
4854 feature}
4855 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004856 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004857 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 care of translating these special characters to the original meaning
4859 of the key. This means you don't have to change the keyboard mode to
4860 be able to execute Normal mode commands.
4861 This is the opposite of the 'keymap' option, where characters are
4862 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004863 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004864 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004865 This option cannot be set from a |modeline| or in the |sandbox|, for
4866 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004868 Example (for Greek, in UTF-8): *greek* >
4869 :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 +00004870< Example (exchanges meaning of z and y for commands): >
4871 :set langmap=zy,yz,ZY,YZ
4872<
4873 The 'langmap' option is a list of parts, separated with commas. Each
4874 part can be in one of two forms:
4875 1. A list of pairs. Each pair is a "from" character immediately
4876 followed by the "to" character. Examples: "aA", "aAbBcC".
4877 2. A list of "from" characters, a semi-colon and a list of "to"
4878 characters. Example: "abc;ABC"
4879 Example: "aA,fgh;FGH,cCdDeE"
4880 Special characters need to be preceded with a backslash. These are
4881 ";", ',' and backslash itself.
4882
4883 This will allow you to activate vim actions without having to switch
4884 back and forth between the languages. Your language characters will
4885 be understood as normal vim English characters (according to the
4886 langmap mappings) in the following cases:
4887 o Normal/Visual mode (commands, buffer/register names, user mappings)
4888 o Insert/Replace Mode: Register names after CTRL-R
4889 o Insert/Replace Mode: Mappings
4890 Characters entered in Command-line mode will NOT be affected by
4891 this option. Note that this option can be changed at any time
4892 allowing to switch between mappings for different languages/encodings.
4893 Use a mapping to avoid having to type it each time!
4894
4895 *'langmenu'* *'lm'*
4896'langmenu' 'lm' string (default "")
4897 global
4898 {not in Vi}
4899 {only available when compiled with the |+menu| and
4900 |+multi_lang| features}
4901 Language to use for menu translation. Tells which file is loaded
4902 from the "lang" directory in 'runtimepath': >
4903 "lang/menu_" . &langmenu . ".vim"
4904< (without the spaces). For example, to always use the Dutch menus, no
4905 matter what $LANG is set to: >
4906 :set langmenu=nl_NL.ISO_8859-1
4907< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004908 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 If your $LANG is set to a non-English language but you do want to use
4910 the English menus: >
4911 :set langmenu=none
4912< This option must be set before loading menus, switching on filetype
4913 detection or syntax highlighting. Once the menus are defined setting
4914 this option has no effect. But you could do this: >
4915 :source $VIMRUNTIME/delmenu.vim
4916 :set langmenu=de_DE.ISO_8859-1
4917 :source $VIMRUNTIME/menu.vim
4918< Warning: This deletes all menus that you defined yourself!
4919
Bram Moolenaard94464e2015-11-02 15:28:18 +01004920 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004921'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004922 global
4923 {not in Vi}
4924 {only available when compiled with the |+langmap|
4925 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004926 This is just like 'langremap' but with the value inverted. It only
4927 exists for backwards compatibility. When setting 'langremap' then
4928 'langnoremap' is set to the inverted value, and the other way around.
4929
4930 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4931'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4932 global
4933 {not in Vi}
4934 {only available when compiled with the |+langmap|
4935 feature}
4936 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004937 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004938 'langmap' disables some of your mappings, try resetting this option.
4939 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004940 that works for you to avoid mappings to break.
4941
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 *'laststatus'* *'ls'*
4943'laststatus' 'ls' number (default 1)
4944 global
4945 {not in Vi}
4946 The value of this option influences when the last window will have a
4947 status line:
4948 0: never
4949 1: only if there are at least two windows
4950 2: always
4951 The screen looks nicer with a status line if you have several
4952 windows, but it takes another screen line. |status-line|
4953
4954 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4955'lazyredraw' 'lz' boolean (default off)
4956 global
4957 {not in Vi}
4958 When this option is set, the screen will not be redrawn while
4959 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004960 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 update use |:redraw|.
4962
4963 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4964'linebreak' 'lbr' boolean (default off)
4965 local to window
4966 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004967 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004969 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 than at the last character that fits on the screen. Unlike
4971 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004972 it only affects the way the file is displayed, not its contents.
4973 If 'breakindent' is set, line is visually indented. Then, the value
4974 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004975 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 Note that <Tab> characters after an <EOL> are mostly not displayed
4977 with the right amount of white space.
4978
4979 *'lines'* *E593*
4980'lines' number (default 24 or terminal height)
4981 global
4982 Number of lines of the Vim window.
4983 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004984 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 When Vim is running in the GUI or in a resizable window, setting this
4986 option will cause the window size to be changed. When you only want
4987 to use the size for the GUI, put the command in your |gvimrc| file.
4988 Vim limits the number of lines to what fits on the screen. You can
4989 use this command to get the tallest window possible: >
4990 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004991< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004992 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 When you set this option and Vim is unable to change the physical
4994 number of lines of the display, the display may be messed up.
4995
4996 *'linespace'* *'lsp'*
4997'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4998 global
4999 {not in Vi}
5000 {only in the GUI}
5001 Number of pixel lines inserted between characters. Useful if the font
5002 uses the full character cell height, making lines touch each other.
5003 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005004 With some fonts there can be too much room between lines (to have
5005 space for ascents and descents). Then it makes sense to set
5006 'linespace' to a negative value. This may cause display problems
5007 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
5009 *'lisp'* *'nolisp'*
5010'lisp' boolean (default off)
5011 local to buffer
5012 {not available when compiled without the |+lispindent|
5013 feature}
5014 Lisp mode: When <Enter> is typed in insert mode set the indent for
5015 the next line to Lisp standards (well, sort of). Also happens with
5016 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
5017 flag in 'cpoptions' changes the method of indenting: Vi compatible or
5018 better. Also see 'lispwords'.
5019 The '-' character is included in keyword characters. Redefines the
5020 "=" operator to use this same indentation algorithm rather than
5021 calling an external program if 'equalprg' is empty.
5022 This option is not used when 'paste' is set.
5023 {Vi: Does it a little bit differently}
5024
5025 *'lispwords'* *'lw'*
5026'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005027 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 {not in Vi}
5029 {not available when compiled without the |+lispindent|
5030 feature}
5031 Comma separated list of words that influence the Lisp indenting.
5032 |'lisp'|
5033
5034 *'list'* *'nolist'*
5035'list' boolean (default off)
5036 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005037 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5038 line. Useful to see the difference between tabs and spaces and for
5039 trailing blanks. Further changed by the 'listchars' option.
5040
5041 The cursor is displayed at the start of the space a Tab character
5042 occupies, not at the end as usual in Normal mode. To get this cursor
5043 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005044 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005045<
5046 Note that list mode will also affect formatting (set with 'textwidth'
5047 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 changing the way tabs are displayed.
5049
5050 *'listchars'* *'lcs'*
5051'listchars' 'lcs' string (default "eol:$")
5052 global
5053 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005054 Strings to use in 'list' mode and for the |:list| command. It is a
5055 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005056 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057 eol:c Character to show at the end of each line. When
5058 omitted, there is no extra character at the end of the
5059 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005060 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005061 tab:xy[z] Two or three characters to be used to show a tab.
5062 The third character is optional.
5063
5064 tab:xy The 'x' is always used, then 'y' as many times as will
5065 fit. Thus "tab:>-" displays:
5066 >
5067 >-
5068 >--
5069 etc.
5070
5071 tab:xyz The 'z' is always used, then 'x' is prepended, and
5072 then 'y' is used as many times as will fit. Thus
5073 "tab:<->" displays:
5074 >
5075 <>
5076 <->
5077 <-->
5078 etc.
5079
5080 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005081 *lcs-space*
5082 space:c Character to show for a space. When omitted, spaces
5083 are left blank.
5084 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005085 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005086 trailing spaces are blank. Overrides the "space"
5087 setting for trailing spaces.
5088 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 extends:c Character to show in the last column, when 'wrap' is
5090 off and the line continues beyond the right of the
5091 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005092 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 precedes:c Character to show in the first column, when 'wrap'
5094 is off and there is text preceding the character
5095 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005096 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005097 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005098 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005099 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005100 nbsp:c Character to show for a non-breakable space character
5101 (0xA0 (160 decimal) and U+202F). Left blank when
5102 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005106 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107
5108 Examples: >
5109 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005110 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 :set lcs=extends:>,precedes:<
5112< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005113 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005114 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
5116 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5117'loadplugins' 'lpl' boolean (default on)
5118 global
5119 {not in Vi}
5120 When on the plugin scripts are loaded when starting up |load-plugins|.
5121 This option can be reset in your |vimrc| file to disable the loading
5122 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005123 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5124 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125
Bram Moolenaard94464e2015-11-02 15:28:18 +01005126 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005127'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005128 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005129 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005130 {only available when compiled with the |+lua/dyn|
5131 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005132 Specifies the name of the Lua shared library. The default is
5133 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005134 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005135 This option cannot be set from a |modeline| or in the |sandbox|, for
5136 security reasons.
5137
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005138 *'macatsui'* *'nomacatsui'*
5139'macatsui' boolean (default on)
5140 global
5141 {only available in Mac GUI version}
5142 This is a workaround for when drawing doesn't work properly. When set
5143 and compiled with multi-byte support ATSUI text drawing is used. When
5144 not set ATSUI text drawing is not used. Switch this option off when
5145 you experience drawing problems. In a future version the problems may
5146 be solved and this option becomes obsolete. Therefore use this method
5147 to unset it: >
5148 if exists('&macatsui')
5149 set nomacatsui
5150 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005151< Another option to check if you have drawing problems is
5152 'termencoding'.
5153
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 *'magic'* *'nomagic'*
5155'magic' boolean (default on)
5156 global
5157 Changes the special characters that can be used in search patterns.
5158 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005159 WARNING: Switching this option off most likely breaks plugins! That
5160 is because many patterns assume it's on and will fail when it's off.
5161 Only switch it off when working with old Vi scripts. In any other
5162 situation write patterns that work when 'magic' is on. Include "\M"
5163 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165 *'makeef'* *'mef'*
5166'makeef' 'mef' string (default: "")
5167 global
5168 {not in Vi}
5169 {not available when compiled without the |+quickfix|
5170 feature}
5171 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5172 and the |:grep| command.
5173 When it is empty, an internally generated temp file will be used.
5174 When "##" is included, it is replaced by a number to make the name
5175 unique. This makes sure that the ":make" command doesn't overwrite an
5176 existing file.
5177 NOT used for the ":cf" command. See 'errorfile' for that.
5178 Environment variables are expanded |:set_env|.
5179 See |option-backslash| about including spaces and backslashes.
5180 This option cannot be set from a |modeline| or in the |sandbox|, for
5181 security reasons.
5182
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005183 *'makeencoding'* *'menc'*
5184'makeencoding' 'menc' string (default "")
5185 global or local to buffer |global-local|
5186 {only available when compiled with the |+multi_byte|
5187 feature}
5188 {not in Vi}
5189 Encoding used for reading the output of external commands. When empty,
5190 encoding is not converted.
5191 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5192 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5193 and `:laddfile`.
5194
5195 This would be mostly useful when you use MS-Windows and set 'encoding'
5196 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5197 'makeencoding' to "char" has the same effect as setting to the system
5198 locale encoding. Example: >
5199 :set encoding=utf-8
5200 :set makeencoding=char " system locale is used
5201<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 *'makeprg'* *'mp'*
5203'makeprg' 'mp' string (default "make", VMS: "MMS")
5204 global or local to buffer |global-local|
5205 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005206 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005207 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5208 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005209 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005210 Environment variables are expanded |:set_env|. See |option-backslash|
5211 about including spaces and backslashes.
5212 Note that a '|' must be escaped twice: once for ":set" and once for
5213 the interpretation of a command. When you use a filter called
5214 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 :set makeprg=gmake\ \\\|\ myfilter
5216< The placeholder "$*" can be given (even multiple times) to specify
5217 where the arguments will be included, for example: >
5218 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5219< This option cannot be set from a |modeline| or in the |sandbox|, for
5220 security reasons.
5221
5222 *'matchpairs'* *'mps'*
5223'matchpairs' 'mps' string (default "(:),{:},[:]")
5224 local to buffer
5225 {not in Vi}
5226 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005227 other.
5228 Only character pairs are allowed that are different, thus you cannot
5229 jump between two double quotes.
5230 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005231 The pairs must be separated by a comma. Example for including '<' and
5232 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 :set mps+=<:>
5234
5235< A more exotic example, to jump between the '=' and ';' in an
5236 assignment, useful for languages like C and Java: >
5237 :au FileType c,cpp,java set mps+==:;
5238
5239< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005240 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241
5242 *'matchtime'* *'mat'*
5243'matchtime' 'mat' number (default 5)
5244 global
5245 {not in Vi}{in Nvi}
5246 Tenths of a second to show the matching paren, when 'showmatch' is
5247 set. Note that this is not in milliseconds, like other options that
5248 set a time. This is to be compatible with Nvi.
5249
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005250 *'maxcombine'* *'mco'*
5251'maxcombine' 'mco' number (default 2)
5252 global
5253 {not in Vi}
5254 {only available when compiled with the |+multi_byte|
5255 feature}
5256 The maximum number of combining characters supported for displaying.
5257 Only used when 'encoding' is "utf-8".
5258 The default is OK for most languages. Hebrew may require 4.
5259 Maximum value is 6.
5260 Even when this option is set to 2 you can still edit text with more
5261 combining characters, you just can't see them. Use |g8| or |ga|.
5262 See |mbyte-combining|.
5263
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 *'maxfuncdepth'* *'mfd'*
5265'maxfuncdepth' 'mfd' number (default 100)
5266 global
5267 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005268 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005269 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 Maximum depth of function calls for user functions. This normally
5271 catches endless recursion. When using a recursive function with
5272 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5273 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005274 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005275 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 See also |:function|.
5277
5278 *'maxmapdepth'* *'mmd'* *E223*
5279'maxmapdepth' 'mmd' number (default 1000)
5280 global
5281 {not in Vi}
5282 Maximum number of times a mapping is done without resulting in a
5283 character to be used. This normally catches endless mappings, like
5284 ":map x y" with ":map y x". It still does not catch ":map g wg",
5285 because the 'w' is used before the next mapping is done. See also
5286 |key-mapping|.
5287
5288 *'maxmem'* *'mm'*
5289'maxmem' 'mm' number (default between 256 to 5120 (system
5290 dependent) or half the amount of memory
5291 available)
5292 global
5293 {not in Vi}
5294 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5295 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005296 other memory to be freed.
5297 The maximum usable value is about 2000000. Use this to work without a
5298 limit.
5299 The value is ignored when 'swapfile' is off.
5300 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005302 *'maxmempattern'* *'mmp'*
5303'maxmempattern' 'mmp' number (default 1000)
5304 global
5305 {not in Vi}
5306 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005307 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005308 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005309 When Vim runs into the limit it gives an error message and mostly
5310 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005311 Running into the limit often means that the pattern is very
5312 inefficient or too complex. This may already happen with the pattern
5313 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005314 Might also happen on redraw, when syntax rules try to match a complex
5315 text structure.
5316 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5317 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005318
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 *'maxmemtot'* *'mmt'*
5320'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5321 dependent) or half the amount of memory
5322 available)
5323 global
5324 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005325 Maximum amount of memory in Kbyte to use for all buffers together.
5326 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005327 without a limit.
5328 On 64 bit machines higher values might work. But hey, do you really
5329 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005330 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005331 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005332 Buffers with 'swapfile' off still count to the total amount of memory
5333 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005334 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
5336 *'menuitems'* *'mis'*
5337'menuitems' 'mis' number (default 25)
5338 global
5339 {not in Vi}
5340 {not available when compiled without the |+menu|
5341 feature}
5342 Maximum number of items to use in a menu. Used for menus that are
5343 generated from a list of items, e.g., the Buffers menu. Changing this
5344 option has no direct effect, the menu must be refreshed first.
5345
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005346 *'mkspellmem'* *'msm'*
5347'mkspellmem' 'msm' string (default "460000,2000,500")
5348 global
5349 {not in Vi}
5350 {not available when compiled without the |+syntax|
5351 feature}
5352 Parameters for |:mkspell|. This tunes when to start compressing the
5353 word tree. Compression can be slow when there are many words, but
5354 it's needed to avoid running out of memory. The amount of memory used
5355 per word depends very much on how similar the words are, that's why
5356 this tuning is complicated.
5357
5358 There are three numbers, separated by commas:
5359 {start},{inc},{added}
5360
5361 For most languages the uncompressed word tree fits in memory. {start}
5362 gives the amount of memory in Kbyte that can be used before any
5363 compression is done. It should be a bit smaller than the amount of
5364 memory that is available to Vim.
5365
5366 When going over the {start} limit the {inc} number specifies the
5367 amount of memory in Kbyte that can be allocated before another
5368 compression is done. A low number means compression is done after
5369 less words are added, which is slow. A high number means more memory
5370 will be allocated.
5371
5372 After doing compression, {added} times 1024 words can be added before
5373 the {inc} limit is ignored and compression is done when any extra
5374 amount of memory is needed. A low number means there is a smaller
5375 chance of hitting the {inc} limit, less memory is used but it's
5376 slower.
5377
5378 The languages for which these numbers are important are Italian and
5379 Hungarian. The default works for when you have about 512 Mbyte. If
5380 you have 1 Gbyte you could use: >
5381 :set mkspellmem=900000,3000,800
5382< If you have less than 512 Mbyte |:mkspell| may fail for some
5383 languages, no matter what you set 'mkspellmem' to.
5384
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005386'modeline' 'ml' boolean (Vim default: on (off for root),
5387 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 local to buffer
5389 *'modelines'* *'mls'*
5390'modelines' 'mls' number (default 5)
5391 global
5392 {not in Vi}
5393 If 'modeline' is on 'modelines' gives the number of lines that is
5394 checked for set commands. If 'modeline' is off or 'modelines' is zero
5395 no lines are checked. See |modeline|.
5396 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5397 set and to the Vim default value when 'compatible' is reset.
5398
5399 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5400'modifiable' 'ma' boolean (default on)
5401 local to buffer
5402 {not in Vi} *E21*
5403 When off the buffer contents cannot be changed. The 'fileformat' and
5404 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005405 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
5407 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5408'modified' 'mod' boolean (default off)
5409 local to buffer
5410 {not in Vi}
5411 When on, the buffer is considered to be modified. This option is set
5412 when:
5413 1. A change was made to the text since it was last written. Using the
5414 |undo| command to go back to the original text will reset the
5415 option. But undoing changes that were made before writing the
5416 buffer will set the option again, since the text is different from
5417 when it was written.
5418 2. 'fileformat' or 'fileencoding' is different from its original
5419 value. The original value is set when the buffer is read or
5420 written. A ":set nomodified" command also resets the original
5421 values to the current values and the 'modified' option will be
5422 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005423 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005424 This option is not set when a change is made to the buffer as the
5425 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5426 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5427 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5429 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005430 Note that the text may actually be the same, e.g. 'modified' is set
5431 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432
5433 *'more'* *'nomore'*
5434'more' boolean (Vim default: on, Vi default: off)
5435 global
5436 {not in Vi}
5437 When on, listings pause when the whole screen is filled. You will get
5438 the |more-prompt|. When this option is off there are no pauses, the
5439 listing continues until finished.
5440 NOTE: This option is set to the Vi default value when 'compatible' is
5441 set and to the Vim default value when 'compatible' is reset.
5442
5443 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005444'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5445 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 global
5447 {not in Vi}
5448 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005449 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5450 sysmouse and Linux console with gpm). For using the mouse in the
5451 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005453 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 v Visual mode
5455 i Insert mode
5456 c Command-line mode
5457 h all previous modes when editing a help file
5458 a all previous modes
5459 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005460 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 :set mouse=a
5462< When the mouse is not enabled, the GUI will still use the mouse for
5463 modeless selection. This doesn't move the text cursor.
5464
5465 See |mouse-using|. Also see |'clipboard'|.
5466
5467 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005468 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 the mouse buttons can still be used by keeping the shift key pressed.
5470 Also see the 'clipboard' option.
5471
5472 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5473'mousefocus' 'mousef' boolean (default off)
5474 global
5475 {not in Vi}
5476 {only works in the GUI}
5477 The window that the mouse pointer is on is automatically activated.
5478 When changing the window layout or window focus in another way, the
5479 mouse pointer is moved to the window with keyboard focus. Off is the
5480 default because it makes using the pull down menus a little goofy, as
5481 a pointer transit may activate a window unintentionally.
5482
5483 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5484'mousehide' 'mh' boolean (default on)
5485 global
5486 {not in Vi}
5487 {only works in the GUI}
5488 When on, the mouse pointer is hidden when characters are typed.
5489 The mouse pointer is restored when the mouse is moved.
5490
5491 *'mousemodel'* *'mousem'*
5492'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5493 global
5494 {not in Vi}
5495 Sets the model to use for the mouse. The name mostly specifies what
5496 the right mouse button is used for:
5497 extend Right mouse button extends a selection. This works
5498 like in an xterm.
5499 popup Right mouse button pops up a menu. The shifted left
5500 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005501 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 popup_setpos Like "popup", but the cursor will be moved to the
5503 position where the mouse was clicked, and thus the
5504 selected operation will act upon the clicked object.
5505 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005506 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 course, that right clicking outside a selection will
5508 end Visual mode.
5509 Overview of what button does what for each model:
5510 mouse extend popup(_setpos) ~
5511 left click place cursor place cursor
5512 left drag start selection start selection
5513 shift-left search word extend selection
5514 right click extend selection popup menu (place cursor)
5515 right drag extend selection -
5516 middle click paste paste
5517
5518 In the "popup" model the right mouse button produces a pop-up menu.
5519 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005520 In a terminal the popup menu works if Vim is compiled with the
5521 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522
5523 Note that you can further refine the meaning of buttons with mappings.
5524 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5525 selection (because that's handled in the GUI code directly).
5526
5527 The 'mousemodel' option is set by the |:behave| command.
5528
5529 *'mouseshape'* *'mouses'* *E547*
5530'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005531 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 global
5533 {not in Vi}
5534 {only available when compiled with the |+mouseshape|
5535 feature}
5536 This option tells Vim what the mouse pointer should look like in
5537 different modes. The option is a comma separated list of parts, much
5538 like used for 'guicursor'. Each part consist of a mode/location-list
5539 and an argument-list:
5540 mode-list:shape,mode-list:shape,..
5541 The mode-list is a dash separated list of these modes/locations:
5542 In a normal window: ~
5543 n Normal mode
5544 v Visual mode
5545 ve Visual mode with 'selection' "exclusive" (same as 'v',
5546 if not specified)
5547 o Operator-pending mode
5548 i Insert mode
5549 r Replace mode
5550
5551 Others: ~
5552 c appending to the command-line
5553 ci inserting in the command-line
5554 cr replacing in the command-line
5555 m at the 'Hit ENTER' or 'More' prompts
5556 ml idem, but cursor in the last line
5557 e any mode, pointer below last window
5558 s any mode, pointer on a status line
5559 sd any mode, while dragging a status line
5560 vs any mode, pointer on a vertical separator line
5561 vd any mode, while dragging a vertical separator line
5562 a everywhere
5563
5564 The shape is one of the following:
5565 avail name looks like ~
5566 w x arrow Normal mouse pointer
5567 w x blank no pointer at all (use with care!)
5568 w x beam I-beam
5569 w x updown up-down sizing arrows
5570 w x leftright left-right sizing arrows
5571 w x busy The system's usual busy pointer
5572 w x no The system's usual 'no input' pointer
5573 x udsizing indicates up-down resizing
5574 x lrsizing indicates left-right resizing
5575 x crosshair like a big thin +
5576 x hand1 black hand
5577 x hand2 white hand
5578 x pencil what you write with
5579 x question big ?
5580 x rightup-arrow arrow pointing right-up
5581 w x up-arrow arrow pointing up
5582 x <number> any X11 pointer number (see X11/cursorfont.h)
5583
5584 The "avail" column contains a 'w' if the shape is available for Win32,
5585 x for X11.
5586 Any modes not specified or shapes not available use the normal mouse
5587 pointer.
5588
5589 Example: >
5590 :set mouseshape=s:udsizing,m:no
5591< will make the mouse turn to a sizing arrow over the status lines and
5592 indicate no input when the hit-enter prompt is displayed (since
5593 clicking the mouse has no effect in this state.)
5594
5595 *'mousetime'* *'mouset'*
5596'mousetime' 'mouset' number (default 500)
5597 global
5598 {not in Vi}
5599 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5600 time in msec between two mouse clicks for the second click to be
5601 recognized as a multi click.
5602
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005603 *'mzschemedll'*
5604'mzschemedll' string (default depends on the build)
5605 global
5606 {not in Vi}
5607 {only available when compiled with the |+mzscheme/dyn|
5608 feature}
5609 Specifies the name of the MzScheme shared library. The default is
5610 DYNAMIC_MZSCH_DLL which was specified at compile time.
5611 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005612 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005613 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005614 This option cannot be set from a |modeline| or in the |sandbox|, for
5615 security reasons.
5616
5617 *'mzschemegcdll'*
5618'mzschemegcdll' string (default depends on the build)
5619 global
5620 {not in Vi}
5621 {only available when compiled with the |+mzscheme/dyn|
5622 feature}
5623 Specifies the name of the MzScheme GC shared library. The default is
5624 DYNAMIC_MZGC_DLL which was specified at compile time.
5625 The value can be equal to 'mzschemedll' if it includes the GC code.
5626 Environment variables are expanded |:set_env|.
5627 This option cannot be set from a |modeline| or in the |sandbox|, for
5628 security reasons.
5629
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005630 *'mzquantum'* *'mzq'*
5631'mzquantum' 'mzq' number (default 100)
5632 global
5633 {not in Vi}
5634 {not available when compiled without the |+mzscheme|
5635 feature}
5636 The number of milliseconds between polls for MzScheme threads.
5637 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005638 NOTE: This option is set to the Vim default value when 'compatible'
5639 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005640
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005642'nrformats' 'nf' string (default "bin,octal,hex",
5643 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 local to buffer
5645 {not in Vi}
5646 This defines what bases Vim will consider for numbers when using the
5647 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5648 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005649 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005651 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005652 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005654 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 considered to be hexadecimal. Example: Using CTRL-X on
5656 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005657 bin If included, numbers starting with "0b" or "0B" will be
5658 considered to be binary. Example: Using CTRL-X on
5659 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660 Numbers which simply begin with a digit in the range 1-9 are always
5661 considered decimal. This also happens for numbers that are not
5662 recognized as octal or hex.
5663
5664 *'number'* *'nu'* *'nonumber'* *'nonu'*
5665'number' 'nu' boolean (default off)
5666 local to window
5667 Print the line number in front of each line. When the 'n' option is
5668 excluded from 'cpoptions' a wrapped line will not use the column of
5669 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005670 The 'numberwidth' option can be used to set the room used for the line
5671 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 When a long, wrapped line doesn't start with the first character, '-'
5673 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005674 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5675 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005676 *number_relativenumber*
5677 The 'relativenumber' option changes the displayed number to be
5678 relative to the cursor. Together with 'number' there are these
5679 four combinations (cursor in line 3):
5680
Bram Moolenaar3848e002016-03-19 18:42:29 +01005681 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005682 'nornu' 'nornu' 'rnu' 'rnu'
5683
5684 |apple | 1 apple | 2 apple | 2 apple
5685 |pear | 2 pear | 1 pear | 1 pear
5686 |nobody | 3 nobody | 0 nobody |3 nobody
5687 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005689 *'numberwidth'* *'nuw'*
5690'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5691 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005692 {not in Vi}
5693 {only available when compiled with the |+linebreak|
5694 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005695 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005696 when the 'number' or 'relativenumber' option is set or printing lines
5697 with a line number. Since one space is always between the number and
5698 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005699 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005700 fit the highest line number in the buffer respectively the number of
5701 rows in the window, depending on whether 'number' or 'relativenumber'
5702 is set. Thus with the Vim default of 4 there is room for a line number
5703 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005704 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005705 NOTE: This option is set to the Vi default value when 'compatible' is
5706 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005707
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005708 *'omnifunc'* *'ofu'*
5709'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005710 local to buffer
5711 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005712 {not available when compiled without the |+eval|
5713 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005714 This option specifies a function to be used for Insert mode omni
5715 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005716 See |complete-functions| for an explanation of how the function is
5717 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005718 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005719 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005720 This option cannot be set from a |modeline| or in the |sandbox|, for
5721 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005722
5723
Bram Moolenaar02467872007-05-06 13:22:01 +00005724 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005725'opendevice' 'odev' boolean (default off)
5726 global
5727 {not in Vi}
5728 {only for MS-DOS, MS-Windows and OS/2}
5729 Enable reading and writing from devices. This may get Vim stuck on a
5730 device that can be opened but doesn't actually do the I/O. Therefore
5731 it is off by default.
5732 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5733 result in editing a device.
5734
5735
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005736 *'operatorfunc'* *'opfunc'*
5737'operatorfunc' 'opfunc' string (default: empty)
5738 global
5739 {not in Vi}
5740 This option specifies a function to be called by the |g@| operator.
5741 See |:map-operator| for more info and an example.
5742
5743 This option cannot be set from a |modeline| or in the |sandbox|, for
5744 security reasons.
5745
5746
Bram Moolenaar251e1912011-06-19 05:09:16 +02005747 *'osfiletype'* *'oft'*
5748'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 local to buffer
5750 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005751 This option was supported on RISC OS, which has been removed.
5752
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005754 *'packpath'* *'pp'*
5755'packpath' 'pp' string (default: see 'runtimepath')
5756 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005757 Directories used to find packages. See |packages|.
5758
5759
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005761'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 global
5763 Specifies the nroff macros that separate paragraphs. These are pairs
5764 of two letters (see |object-motions|).
5765
5766 *'paste'* *'nopaste'*
5767'paste' boolean (default off)
5768 global
5769 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005770 Put Vim in Paste mode. This is useful if you want to cut or copy
5771 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 unexpected effects.
5773 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005774 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 knows about pasting and will mostly do the right thing without 'paste'
5776 being set. The same is true for a terminal where Vim handles the
5777 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005778 This option is reset when starting the GUI. Thus if you set it in
5779 your .vimrc it will work in a terminal, but not in the GUI. Setting
5780 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5781 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782 When the 'paste' option is switched on (also when it was already on):
5783 - mapping in Insert mode and Command-line mode is disabled
5784 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005786 - 'expandtab' is reset
5787 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 - 'revins' is reset
5789 - 'ruler' is reset
5790 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005791 - 'smartindent' is reset
5792 - 'smarttab' is reset
5793 - 'softtabstop' is set to 0
5794 - 'textwidth' is set to 0
5795 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005798 - 'indentexpr'
5799 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005800 NOTE: When you start editing another file while the 'paste' option is
5801 on, settings from the modelines or autocommands may change the
5802 settings again, causing trouble when pasting text. You might want to
5803 set the 'paste' option again.
5804 When the 'paste' option is reset the mentioned options are restored to
5805 the value before the moment 'paste' was switched from off to on.
5806 Resetting 'paste' before ever setting it does not have any effect.
5807 Since mapping doesn't work while 'paste' is active, you need to use
5808 the 'pastetoggle' option to toggle the 'paste' option with some key.
5809
5810 *'pastetoggle'* *'pt'*
5811'pastetoggle' 'pt' string (default "")
5812 global
5813 {not in Vi}
5814 When non-empty, specifies the key sequence that toggles the 'paste'
5815 option. This is like specifying a mapping: >
5816 :map {keys} :set invpaste<CR>
5817< Where {keys} is the value of 'pastetoggle'.
5818 The difference is that it will work even when 'paste' is set.
5819 'pastetoggle' works in Insert mode and Normal mode, but not in
5820 Command-line mode.
5821 Mappings are checked first, thus overrule 'pastetoggle'. However,
5822 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5823 this: >
5824 :map <F10> :set paste<CR>
5825 :map <F11> :set nopaste<CR>
5826 :imap <F10> <C-O>:set paste<CR>
5827 :imap <F11> <nop>
5828 :set pastetoggle=<F11>
5829< This will make <F10> start paste mode and <F11> stop paste mode.
5830 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5831 mode everything is inserted literally, except the 'pastetoggle' key
5832 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005833 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005834
5835 *'pex'* *'patchexpr'*
5836'patchexpr' 'pex' string (default "")
5837 global
5838 {not in Vi}
5839 {not available when compiled without the |+diff|
5840 feature}
5841 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005842 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843
Bram Moolenaardbc28022014-07-26 13:40:44 +02005844 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845'patchmode' 'pm' string (default "")
5846 global
5847 {not in Vi}
5848 When non-empty the oldest version of a file is kept. This can be used
5849 to keep the original version of a file if you are changing files in a
5850 source distribution. Only the first time that a file is written a
5851 copy of the original file will be kept. The name of the copy is the
5852 name of the original file with the string in the 'patchmode' option
5853 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005854 ".orig" or ".org". 'backupdir' must not be empty for this to work
5855 (Detail: The backup file is renamed to the patchmode file after the
5856 new file has been successfully written, that's why it must be possible
5857 to write a backup file). If there was no file to be backed up, an
5858 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005859 When the 'backupskip' pattern matches, a patchmode file is not made.
5860 Using 'patchmode' for compressed files appends the extension at the
5861 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5862 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005863 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005865 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866'path' 'pa' string (default on Unix: ".,/usr/include,,"
5867 on OS/2: ".,/emx/include,,"
5868 other systems: ".,,")
5869 global or local to buffer |global-local|
5870 {not in Vi}
5871 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005872 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5873 provided that the file being searched for has a relative path (not
5874 starting with "/", "./" or "../"). The directories in the 'path'
5875 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 - Use commas to separate directory names: >
5877 :set path=.,/usr/local/include,/usr/include
5878< - Spaces can also be used to separate directory names (for backwards
5879 compatibility with version 3.0). To have a space in a directory
5880 name, precede it with an extra backslash, and escape the space: >
5881 :set path=.,/dir/with\\\ space
5882< - To include a comma in a directory name precede it with an extra
5883 backslash: >
5884 :set path=.,/dir/with\\,comma
5885< - To search relative to the directory of the current file, use: >
5886 :set path=.
5887< - To search in the current directory use an empty string between two
5888 commas: >
5889 :set path=,,
5890< - A directory name may end in a ':' or '/'.
5891 - Environment variables are expanded |:set_env|.
5892 - When using |netrw.vim| URLs can be used. For example, adding
5893 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005894 - Search upwards and downwards in a directory tree using "*", "**" and
5895 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 {not available when compiled without the |+path_extra| feature}
5897 - Careful with '\' characters, type two to get one in the option: >
5898 :set path=.,c:\\include
5899< Or just use '/' instead: >
5900 :set path=.,c:/include
5901< Don't forget "." or files won't even be found in the same directory as
5902 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005903 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 it is something like 256 or 1024 characters.
5905 You can check if all the include files are found, using the value of
5906 'path', see |:checkpath|.
5907 The use of |:set+=| and |:set-=| is preferred when adding or removing
5908 directories from the list. This avoids problems when a future version
5909 uses another default. To remove the current directory use: >
5910 :set path-=
5911< To add the current directory use: >
5912 :set path+=
5913< To use an environment variable, you probably need to replace the
5914 separator. Here is an example to append $INCL, in which directory
5915 names are separated with a semi-colon: >
5916 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5917< Replace the ';' with a ':' or whatever separator is used. Note that
5918 this doesn't work when $INCL contains a comma or white space.
5919
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005920 *'perldll'*
5921'perldll' string (default depends on the build)
5922 global
5923 {not in Vi}
5924 {only available when compiled with the |+perl/dyn|
5925 feature}
5926 Specifies the name of the Perl shared library. The default is
5927 DYNAMIC_PERL_DLL, which was specified at compile time.
5928 Environment variables are expanded |:set_env|.
5929 This option cannot be set from a |modeline| or in the |sandbox|, for
5930 security reasons.
5931
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5933'preserveindent' 'pi' boolean (default off)
5934 local to buffer
5935 {not in Vi}
5936 When changing the indent of the current line, preserve as much of the
5937 indent structure as possible. Normally the indent is replaced by a
5938 series of tabs followed by spaces as required (unless |'expandtab'| is
5939 enabled, in which case only spaces are used). Enabling this option
5940 means the indent will preserve as many existing characters as possible
5941 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005942 'expandtab' does not apply to the preserved white space, a Tab remains
5943 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 NOTE: When using ">>" multiple times the resulting indent is a mix of
5945 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005946 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 Also see 'copyindent'.
5948 Use |:retab| to clean up white space.
5949
5950 *'previewheight'* *'pvh'*
5951'previewheight' 'pvh' number (default 12)
5952 global
5953 {not in Vi}
5954 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005955 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956 Default height for a preview window. Used for |:ptag| and associated
5957 commands. Used for |CTRL-W_}| when no count is given.
5958
5959 *'previewwindow'* *'nopreviewwindow'*
5960 *'pvw'* *'nopvw'* *E590*
5961'previewwindow' 'pvw' boolean (default off)
5962 local to window
5963 {not in Vi}
5964 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005965 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005966 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 set. It's normally not set directly, but by using one of the commands
5968 |:ptag|, |:pedit|, etc.
5969
5970 *'printdevice'* *'pdev'*
5971'printdevice' 'pdev' string (default empty)
5972 global
5973 {not in Vi}
5974 {only available when compiled with the |+printer|
5975 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005976 The name of the printer to be used for |:hardcopy|.
5977 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005978 This option cannot be set from a |modeline| or in the |sandbox|, for
5979 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980
Bram Moolenaar8299df92004-07-10 09:47:34 +00005981 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005982'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 global
5984 {not in Vi}
5985 {only available when compiled with the |+printer|
5986 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005987 Sets the character encoding used when printing.
5988 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989
5990 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005991'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 global
5993 {not in Vi}
5994 {only available when compiled with the |+printer|
5995 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005996 Expression used to print the PostScript produced with |:hardcopy|.
5997 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005998 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000
Bram Moolenaar8299df92004-07-10 09:47:34 +00006001 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002'printfont' 'pfn' string (default "courier")
6003 global
6004 {not in Vi}
6005 {only available when compiled with the |+printer|
6006 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006007 The name of the font that will be used for |:hardcopy|.
6008 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009
6010 *'printheader'* *'pheader'*
6011'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
6012 global
6013 {not in Vi}
6014 {only available when compiled with the |+printer|
6015 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006016 The format of the header produced in |:hardcopy| output.
6017 See |pheader-option|.
6018
6019 *'printmbcharset'* *'pmbcs'*
6020'printmbcharset' 'pmbcs' string (default "")
6021 global
6022 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006023 {only available when compiled with the |+printer|,
6024 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006025 The CJK character set to be used for CJK output from |:hardcopy|.
6026 See |pmbcs-option|.
6027
6028 *'printmbfont'* *'pmbfn'*
6029'printmbfont' 'pmbfn' string (default "")
6030 global
6031 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006032 {only available when compiled with the |+printer|,
6033 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006034 List of font names to be used for CJK output from |:hardcopy|.
6035 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036
6037 *'printoptions'* *'popt'*
6038'printoptions' 'popt' string (default "")
6039 global
6040 {not in Vi}
6041 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006042 List of items that control the format of the output of |:hardcopy|.
6043 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006045 *'prompt'* *'noprompt'*
6046'prompt' boolean (default on)
6047 global
6048 When on a ":" prompt is used in Ex mode.
6049
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006050 *'pumheight'* *'ph'*
6051'pumheight' 'ph' number (default 0)
6052 global
6053 {not available when compiled without the
6054 |+insert_expand| feature}
6055 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006056 Determines the maximum number of items to show in the popup menu for
6057 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006058 |ins-completion-menu|.
6059
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006060 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006061'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006062 global
6063 {not available when compiled without the
6064 |+insert_expand| feature}
6065 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006066 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006067 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006068
Bram Moolenaard94464e2015-11-02 15:28:18 +01006069 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006070'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006071 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006072 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006073 {only available when compiled with the |+python/dyn|
6074 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006075 Specifies the name of the Python 2.x shared library. The default is
6076 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006077 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006078 This option cannot be set from a |modeline| or in the |sandbox|, for
6079 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006080
Bram Moolenaar94073162018-01-31 21:49:05 +01006081 *'pythonhome'*
6082'pythonhome' string (default "")
6083 global
6084 {not in Vi}
6085 {only available when compiled with the |+python/dyn|
6086 feature}
6087 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6088 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6089 which was specified at compile time, will be used for the Python 2.x
6090 home directory.
6091 Environment variables are expanded |:set_env|.
6092 This option cannot be set from a |modeline| or in the |sandbox|, for
6093 security reasons.
6094
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006095 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006096'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006097 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006098 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006099 {only available when compiled with the |+python3/dyn|
6100 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006101 Specifies the name of the Python 3 shared library. The default is
6102 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006103 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006104 This option cannot be set from a |modeline| or in the |sandbox|, for
6105 security reasons.
6106
Bram Moolenaar94073162018-01-31 21:49:05 +01006107 *'pythonthreehome'*
6108'pythonthreehome' string (default "")
6109 global
6110 {not in Vi}
6111 {only available when compiled with the |+python3/dyn|
6112 feature}
6113 Specifies the name of the Python 3 home directory. When
6114 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6115 PYTHON3_HOME, which was specified at compile time, will be used for
6116 the Python 3 home directory.
6117 Environment variables are expanded |:set_env|.
6118 This option cannot be set from a |modeline| or in the |sandbox|, for
6119 security reasons.
6120
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01006121 *'pyxversion'* *'pyx'*
6122'pyxversion' 'pyx' number (default depends on the build)
6123 global
6124 {not in Vi}
6125 {only available when compiled with the |+python| or
6126 the |+python3| feature}
6127 Specifies the python version used for pyx* functions and commands
6128 |python_x|. The default value is as follows:
6129
6130 Compiled with Default ~
6131 |+python| and |+python3| 0
6132 only |+python| 2
6133 only |+python3| 3
6134
6135 Available values are 0, 2 and 3.
6136 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6137 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6138 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6139 to 2 if Python 2 is available.
6140 See also: |has-pythonx|
6141
6142 If Vim is compiled with only |+python| or |+python3| setting
6143 'pyxversion' has no effect. The pyx* functions and commands are
6144 always the same as the compiled version.
6145
6146 This option cannot be set from a |modeline| or in the |sandbox|, for
6147 security reasons.
6148
Bram Moolenaar677ee682005-01-27 14:41:15 +00006149 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006150'quoteescape' 'qe' string (default "\")
6151 local to buffer
6152 {not in Vi}
6153 The characters that are used to escape quotes in a string. Used for
6154 objects like a', a" and a` |a'|.
6155 When one of the characters in this option is found inside a string,
6156 the following character will be skipped. The default value makes the
6157 text "foo\"bar\\" considered to be one string.
6158
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6160'readonly' 'ro' boolean (default off)
6161 local to buffer
6162 If on, writes fail unless you use a '!'. Protects you from
6163 accidentally overwriting a file. Default on when Vim is started
6164 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006165 When using ":w!" the 'readonly' option is reset for the current
6166 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006168 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006169 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006171 *'redrawtime'* *'rdt'*
6172'redrawtime' 'rdt' number (default 2000)
6173 global
6174 {not in Vi}
6175 {only available when compiled with the |+reltime|
6176 feature}
6177 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006178 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006179 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006180 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006181 matches will be highlighted.
6182 For syntax highlighting the time applies per window. When over the
6183 limit syntax highlighting is disabled until |CTRL-L| is used.
6184 This is used to avoid that Vim hangs when using a very complicated
6185 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006186
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006187 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006188'regexpengine' 're' number (default 0)
6189 global
6190 {not in Vi}
6191 This selects the default regexp engine. |two-engines|
6192 The possible values are:
6193 0 automatic selection
6194 1 old engine
6195 2 NFA engine
6196 Note that when using the NFA engine and the pattern contains something
6197 that is not supported the pattern will not match. This is only useful
6198 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006199 Using automatic selection enables Vim to switch the engine, if the
6200 default engine becomes too costly. E.g., when the NFA engine uses too
6201 many states. This should prevent Vim from hanging on a combination of
6202 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006203
Bram Moolenaar64486672010-05-16 15:46:46 +02006204 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6205'relativenumber' 'rnu' boolean (default off)
6206 local to window
6207 {not in Vi}
6208 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006209 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006210 precede some vertical motion commands (e.g. j k + -) with, without
6211 having to calculate it yourself. Especially useful in combination with
6212 other commands (e.g. y d c < > gq gw =).
6213 When the 'n' option is excluded from 'cpoptions' a wrapped
6214 line will not use the column of line numbers (this is the default when
6215 'compatible' isn't set).
6216 The 'numberwidth' option can be used to set the room used for the line
6217 number.
6218 When a long, wrapped line doesn't start with the first character, '-'
6219 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006220 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6221 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006222
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006223 The number in front of the cursor line also depends on the value of
6224 'number', see |number_relativenumber| for all combinations of the two
6225 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006226
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 *'remap'* *'noremap'*
6228'remap' boolean (default on)
6229 global
6230 Allows for mappings to work recursively. If you do not want this for
6231 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006232 NOTE: To avoid portability problems with Vim scripts, always keep
6233 this option at the default "on". Only switch it off when working with
6234 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006236 *'renderoptions'* *'rop'*
6237'renderoptions' 'rop' string (default: empty)
6238 global
6239 {not in Vi}
6240 {only available when compiled with GUI and DIRECTX on
6241 MS-Windows}
6242 Select a text renderer and set its options. The options depend on the
6243 renderer.
6244
6245 Syntax: >
6246 set rop=type:{renderer}(,{name}:{value})*
6247<
6248 Currently, only one optional renderer is available.
6249
6250 render behavior ~
6251 directx Vim will draw text using DirectX (DirectWrite). It makes
6252 drawn glyphs more beautiful than default GDI.
6253 It requires 'encoding' is "utf-8", and only works on
6254 MS-Windows Vista or newer version.
6255
6256 Options:
6257 name meaning type value ~
6258 gamma gamma float 1.0 - 2.2 (maybe)
6259 contrast enhancedContrast float (unknown)
6260 level clearTypeLevel float (unknown)
6261 geom pixelGeometry int 0 - 2 (see below)
6262 renmode renderingMode int 0 - 6 (see below)
6263 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006264 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006265
Bram Moolenaar92467d32017-12-05 13:22:16 +01006266 See this URL for detail (except for scrlines):
6267 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006268
6269 For geom: structure of a device pixel.
6270 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6271 1 - DWRITE_PIXEL_GEOMETRY_RGB
6272 2 - DWRITE_PIXEL_GEOMETRY_BGR
6273
6274 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006275 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006276
6277 For renmode: method of rendering glyphs.
6278 0 - DWRITE_RENDERING_MODE_DEFAULT
6279 1 - DWRITE_RENDERING_MODE_ALIASED
6280 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6281 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6282 4 - DWRITE_RENDERING_MODE_NATURAL
6283 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6284 6 - DWRITE_RENDERING_MODE_OUTLINE
6285
6286 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006287 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006288
6289 For taamode: antialiasing mode used for drawing text.
6290 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6291 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6292 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6293 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6294
6295 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006296 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6297
Bram Moolenaara338adc2018-01-31 20:51:47 +01006298 For scrlines:
6299 This was used for optimizing scrolling behavior, however this
6300 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006301
6302 Example: >
6303 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006304 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006305 set rop=type:directx
6306<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006307 If select a raster font (Courier, Terminal or FixedSys which
6308 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006309 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006310
6311 NOTE: It is known that some fonts and options combination
6312 causes trouble on drawing glyphs.
6313
Bram Moolenaar92467d32017-12-05 13:22:16 +01006314 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006315 special made fonts (True-Type fonts which includes only
6316 bitmap glyphs).
6317 - 'taamode:3' will not work with some vector fonts.
6318
6319 NOTE: With this option, you can display colored emoji
6320 (emoticon) in Windows 8.1 or later. To display colored emoji,
6321 there are some conditions which you should notice.
6322
6323 - If your font includes non-colored emoji already, it will
6324 be used.
6325 - If your font doesn't have emoji, the system chooses an
6326 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6327 will be used.
6328 - When this alternative font didn't have fixed width glyph,
6329 emoji might be rendered beyond the bounding box of drawing
6330 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006331
6332 Other render types are currently not supported.
6333
Bram Moolenaar071d4272004-06-13 20:20:40 +00006334 *'report'*
6335'report' number (default 2)
6336 global
6337 Threshold for reporting number of lines changed. When the number of
6338 changed lines is more than 'report' a message will be given for most
6339 ":" commands. If you want it always, set 'report' to 0.
6340 For the ":substitute" command the number of substitutions is used
6341 instead of the number of lines.
6342
6343 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6344'restorescreen' 'rs' boolean (default on)
6345 global
6346 {not in Vi} {only in Windows 95/NT console version}
6347 When set, the screen contents is restored when exiting Vim. This also
6348 happens when executing external commands.
6349
6350 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6351 options in your .vimrc. To disable restoring:
6352 set t_ti= t_te=
6353 To enable restoring (for an xterm):
6354 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6355 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6356
6357 *'revins'* *'ri'* *'norevins'* *'nori'*
6358'revins' 'ri' boolean (default off)
6359 global
6360 {not in Vi}
6361 {only available when compiled with the |+rightleft|
6362 feature}
6363 Inserting characters in Insert mode will work backwards. See "typing
6364 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6365 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006366 NOTE: This option is reset when 'compatible' is set.
6367 This option is reset when 'paste' is set and restored when 'paste' is
6368 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369
6370 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6371'rightleft' 'rl' boolean (default off)
6372 local to window
6373 {not in Vi}
6374 {only available when compiled with the |+rightleft|
6375 feature}
6376 When on, display orientation becomes right-to-left, i.e., characters
6377 that are stored in the file appear from the right to the left.
6378 Using this option, it is possible to edit files for languages that
6379 are written from the right to the left such as Hebrew and Arabic.
6380 This option is per window, so it is possible to edit mixed files
6381 simultaneously, or to view the same file in both ways (this is
6382 useful whenever you have a mixed text file with both right-to-left
6383 and left-to-right strings so that both sets are displayed properly
6384 in different windows). Also see |rileft.txt|.
6385
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006386 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387'rightleftcmd' 'rlc' string (default "search")
6388 local to window
6389 {not in Vi}
6390 {only available when compiled with the |+rightleft|
6391 feature}
6392 Each word in this option enables the command line editing to work in
6393 right-to-left mode for a group of commands:
6394
6395 search "/" and "?" commands
6396
6397 This is useful for languages such as Hebrew, Arabic and Farsi.
6398 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6399
Bram Moolenaard94464e2015-11-02 15:28:18 +01006400 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006401'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006402 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006403 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006404 {only available when compiled with the |+ruby/dyn|
6405 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006406 Specifies the name of the Ruby shared library. The default is
6407 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006408 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006409 This option cannot be set from a |modeline| or in the |sandbox|, for
6410 security reasons.
6411
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006413'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 global
6415 {not in Vi}
6416 {not available when compiled without the
6417 |+cmdline_info| feature}
6418 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006419 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 text in the file is shown on the far right:
6421 Top first line is visible
6422 Bot last line is visible
6423 All first and last line are visible
6424 45% relative position in the file
6425 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006426 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006428 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 this option takes precedence over 'ruler' and 'rulerformat'
6430 If the number of characters displayed is different from the number of
6431 bytes in the text (e.g., for a TAB or a multi-byte character), both
6432 the text column (byte number) and the screen column are shown,
6433 separated with a dash.
6434 For an empty line "0-1" is shown.
6435 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006436 This option is reset when 'paste' is set and restored when 'paste' is
6437 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006438 If you don't want to see the ruler all the time but want to know where
6439 you are, use "g CTRL-G" |g_CTRL-G|.
6440 NOTE: This option is reset when 'compatible' is set.
6441
6442 *'rulerformat'* *'ruf'*
6443'rulerformat' 'ruf' string (default empty)
6444 global
6445 {not in Vi}
6446 {not available when compiled without the |+statusline|
6447 feature}
6448 When this option is not empty, it determines the content of the ruler
6449 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006450 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 The default ruler width is 17 characters. To make the ruler 15
6452 characters wide, put "%15(" at the start and "%)" at the end.
6453 Example: >
6454 :set rulerformat=%15(%c%V\ %p%%%)
6455<
6456 *'runtimepath'* *'rtp'* *vimfiles*
6457'runtimepath' 'rtp' string (default:
6458 Unix: "$HOME/.vim,
6459 $VIM/vimfiles,
6460 $VIMRUNTIME,
6461 $VIM/vimfiles/after,
6462 $HOME/.vim/after"
6463 Amiga: "home:vimfiles,
6464 $VIM/vimfiles,
6465 $VIMRUNTIME,
6466 $VIM/vimfiles/after,
6467 home:vimfiles/after"
6468 PC, OS/2: "$HOME/vimfiles,
6469 $VIM/vimfiles,
6470 $VIMRUNTIME,
6471 $VIM/vimfiles/after,
6472 $HOME/vimfiles/after"
6473 Macintosh: "$VIM:vimfiles,
6474 $VIMRUNTIME,
6475 $VIM:vimfiles:after"
6476 RISC-OS: "Choices:vimfiles,
6477 $VIMRUNTIME,
6478 Choices:vimfiles/after"
6479 VMS: "sys$login:vimfiles,
6480 $VIM/vimfiles,
6481 $VIMRUNTIME,
6482 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006483 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 global
6485 {not in Vi}
6486 This is a list of directories which will be searched for runtime
6487 files:
6488 filetype.vim filetypes by file name |new-filetype|
6489 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006490 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 colors/ color scheme files |:colorscheme|
6492 compiler/ compiler files |:compiler|
6493 doc/ documentation |write-local-help|
6494 ftplugin/ filetype plugins |write-filetype-plugin|
6495 indent/ indent scripts |indent-expression|
6496 keymap/ key mapping files |mbyte-keymap|
6497 lang/ menu translations |:menutrans|
6498 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006499 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 plugin/ plugin scripts |write-plugin|
6501 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006502 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 syntax/ syntax files |mysyntaxfile|
6504 tutor/ files for vimtutor |tutor|
6505
6506 And any other file searched for with the |:runtime| command.
6507
6508 The defaults for most systems are setup to search five locations:
6509 1. In your home directory, for your personal preferences.
6510 2. In a system-wide Vim directory, for preferences from the system
6511 administrator.
6512 3. In $VIMRUNTIME, for files distributed with Vim.
6513 *after-directory*
6514 4. In the "after" directory in the system-wide Vim directory. This is
6515 for the system administrator to overrule or add to the distributed
6516 defaults (rarely needed)
6517 5. In the "after" directory in your home directory. This is for
6518 personal preferences to overrule or add to the distributed defaults
6519 or system-wide settings (rarely needed).
6520
Bram Moolenaard0796902016-09-16 20:02:31 +02006521 More entries are added when using |packages|. If it gets very long
6522 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6523 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006524
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6526 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006527 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 wildcards.
6529 See |:runtime|.
6530 Example: >
6531 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6532< This will use the directory "~/vimruntime" first (containing your
6533 personal Vim runtime files), then "/mygroup/vim" (shared between a
6534 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6535 files).
6536 You probably should always include $VIMRUNTIME somewhere, to use the
6537 distributed runtime files. You can put a directory before $VIMRUNTIME
6538 to find files which replace a distributed runtime files. You can put
6539 a directory after $VIMRUNTIME to find files which add to distributed
6540 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006541 When Vim is started with |--clean| the home directory entries are not
6542 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 This option cannot be set from a |modeline| or in the |sandbox|, for
6544 security reasons.
6545
6546 *'scroll'* *'scr'*
6547'scroll' 'scr' number (default: half the window height)
6548 local to window
6549 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6550 set to half the number of lines in the window when the window size
6551 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006552 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6554 the number of screen lines instead of file lines, makes a difference
6555 when lines wrap}
6556
6557 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6558'scrollbind' 'scb' boolean (default off)
6559 local to window
6560 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 See also |scroll-binding|. When this option is set, the current
6562 window scrolls as other scrollbind windows (windows that also have
6563 this option set) scroll. This option is useful for viewing the
6564 differences between two versions of a file, see 'diff'.
6565 See |'scrollopt'| for options that determine how this option should be
6566 interpreted.
6567 This option is mostly reset when splitting a window to edit another
6568 file. This means that ":split | edit file" results in two windows
6569 with scroll-binding, but ":split file" does not.
6570
6571 *'scrolljump'* *'sj'*
6572'scrolljump' 'sj' number (default 1)
6573 global
6574 {not in Vi}
6575 Minimal number of lines to scroll when the cursor gets off the
6576 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6577 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006578 When set to a negative number from -1 to -100 this is used as the
6579 percentage of the window height. Thus -50 scrolls half the window
6580 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 NOTE: This option is set to 1 when 'compatible' is set.
6582
6583 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006584'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006585 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 {not in Vi}
6587 Minimal number of screen lines to keep above and below the cursor.
6588 This will make some context visible around where you are working. If
6589 you set it to a very large value (999) the cursor line will always be
6590 in the middle of the window (except at the start or end of the file or
6591 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006592 After using the local value, go back the global value with one of
6593 these two: >
6594 setlocal scrolloff<
6595 setlocal scrolloff=-1
6596< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 NOTE: This option is set to 0 when 'compatible' is set.
6598
6599 *'scrollopt'* *'sbo'*
6600'scrollopt' 'sbo' string (default "ver,jump")
6601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 {not in Vi}
6603 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006604 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6605 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 The following words are available:
6607 ver Bind vertical scrolling for 'scrollbind' windows
6608 hor Bind horizontal scrolling for 'scrollbind' windows
6609 jump Applies to the offset between two windows for vertical
6610 scrolling. This offset is the difference in the first
6611 displayed line of the bound windows. When moving
6612 around in a window, another 'scrollbind' window may
6613 reach a position before the start or after the end of
6614 the buffer. The offset is not changed though, when
6615 moving back the 'scrollbind' window will try to scroll
6616 to the desired position when possible.
6617 When now making that window the current one, two
6618 things can be done with the relative offset:
6619 1. When "jump" is not included, the relative offset is
6620 adjusted for the scroll position in the new current
6621 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006622 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 2. When "jump" is included, the other windows are
6624 scrolled to keep the same relative offset. When
6625 going back to the other window, it still uses the
6626 same relative offset.
6627 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006628 When 'diff' mode is active there always is vertical scroll binding,
6629 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630
6631 *'sections'* *'sect'*
6632'sections' 'sect' string (default "SHNHH HUnhsh")
6633 global
6634 Specifies the nroff macros that separate sections. These are pairs of
6635 two letters (See |object-motions|). The default makes a section start
6636 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6637
6638 *'secure'* *'nosecure'* *E523*
6639'secure' boolean (default off)
6640 global
6641 {not in Vi}
6642 When on, ":autocmd", shell and write commands are not allowed in
6643 ".vimrc" and ".exrc" in the current directory and map commands are
6644 displayed. Switch it off only if you know that you will not run into
6645 problems, or when the 'exrc' option is off. On Unix this option is
6646 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 'secure' at the end of your ~/.vimrc then.
6649 This option cannot be set from a |modeline| or in the |sandbox|, for
6650 security reasons.
6651
6652 *'selection'* *'sel'*
6653'selection' 'sel' string (default "inclusive")
6654 global
6655 {not in Vi}
6656 This option defines the behavior of the selection. It is only used
6657 in Visual and Select mode.
6658 Possible values:
6659 value past line inclusive ~
6660 old no yes
6661 inclusive yes yes
6662 exclusive yes no
6663 "past line" means that the cursor is allowed to be positioned one
6664 character past the line.
6665 "inclusive" means that the last character of the selection is included
6666 in an operation. For example, when "x" is used to delete the
6667 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006668 When "old" is used and 'virtualedit' allows the cursor to move past
6669 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 Note that when "exclusive" is used and selecting from the end
6671 backwards, you cannot include the last character of a line, when
6672 starting in Normal mode and 'virtualedit' empty.
6673
6674 The 'selection' option is set by the |:behave| command.
6675
6676 *'selectmode'* *'slm'*
6677'selectmode' 'slm' string (default "")
6678 global
6679 {not in Vi}
6680 This is a comma separated list of words, which specifies when to start
6681 Select mode instead of Visual mode, when a selection is started.
6682 Possible values:
6683 mouse when using the mouse
6684 key when using shifted special keys
6685 cmd when using "v", "V" or CTRL-V
6686 See |Select-mode|.
6687 The 'selectmode' option is set by the |:behave| command.
6688
6689 *'sessionoptions'* *'ssop'*
6690'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006691 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 global
6693 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006694 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 feature}
6696 Changes the effect of the |:mksession| command. It is a comma
6697 separated list of words. Each word enables saving and restoring
6698 something:
6699 word save and restore ~
6700 blank empty windows
6701 buffers hidden and unloaded buffers, not just those in windows
6702 curdir the current directory
6703 folds manually created folds, opened/closed folds and local
6704 fold options
6705 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006706 and contain at least one lowercase letter. Only
6707 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 help the help window
6709 localoptions options and mappings local to a window or buffer (not
6710 global values for local options)
6711 options all options and mappings (also global values for local
6712 options)
6713 resize size of the Vim window: 'lines' and 'columns'
6714 sesdir the directory in which the session file is located
6715 will become the current directory (useful with
6716 projects accessed over a network from different
6717 systems)
6718 slash backslashes in file names replaced with forward
6719 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006720 tabpages all tab pages; without this only the current tab page
6721 is restored, so that you can make a session for each
6722 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006723 terminal include terminal windows where the command can be
6724 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 unix with Unix end-of-line format (single <NL>), even when
6726 on Windows or DOS
6727 winpos position of the whole Vim window
6728 winsize window sizes
6729
6730 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006731 When neither "curdir" nor "sesdir" is included, file names are stored
6732 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733 "slash" and "unix" are useful on Windows when sharing session files
6734 with Unix. The Unix version of Vim cannot source dos format scripts,
6735 but the Windows version of Vim can source unix format scripts.
6736
6737 *'shell'* *'sh'* *E91*
6738'shell' 'sh' string (default $SHELL or "sh",
6739 MS-DOS and Win32: "command.com" or
6740 "cmd.exe", OS/2: "cmd")
6741 global
6742 Name of the shell to use for ! and :! commands. When changing the
6743 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6744 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006745 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 See |option-backslash| about including spaces and backslashes.
6747 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006748
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006750 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6752< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006753 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006755 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006757 Example with escaped space (Vim will do this when initializing the
6758 option from $SHELL): >
6759 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006760< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006761 backslashes are consumed by `:set`.
6762
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 Under MS-Windows, when the executable ends in ".com" it must be
6764 included. Thus setting the shell to "command.com" or "4dos.com"
6765 works, but "command" and "4dos" do not work for all commands (e.g.,
6766 filtering).
6767 For unknown reasons, when using "4dos.com" the current directory is
6768 changed to "C:\". To avoid this set 'shell' like this: >
6769 :set shell=command.com\ /c\ 4dos
6770< This option cannot be set from a |modeline| or in the |sandbox|, for
6771 security reasons.
6772
6773 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006774'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006775 MS-DOS and Win32, when 'shell' does not
6776 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 global
6778 {not in Vi}
6779 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6780 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6781 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006782 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006783 On Unix it can have more than one flag. Each white space separated
6784 part is passed as an argument to the shell command.
6785 See |option-backslash| about including spaces and backslashes.
6786 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 This option cannot be set from a |modeline| or in the |sandbox|, for
6788 security reasons.
6789
6790 *'shellpipe'* *'sp'*
6791'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6792 global
6793 {not in Vi}
6794 {not available when compiled without the |+quickfix|
6795 feature}
6796 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006797 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 including spaces and backslashes.
6799 The name of the temporary file can be represented by "%s" if necessary
6800 (the file name is appended automatically if no %s appears in the value
6801 of this option).
6802 For the Amiga and MS-DOS the default is ">". The output is directly
6803 saved in a file and not echoed to the screen.
6804 For Unix the default it "| tee". The stdout of the compiler is saved
6805 in a file and echoed to the screen. If the 'shell' option is "csh" or
6806 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006807 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6808 default becomes "2>&1| tee". This means that stderr is also included.
6809 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6810 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 The initialization of this option is done after reading the ".vimrc"
6812 and the other initializations, so that when the 'shell' option is set
6813 there, the 'shellpipe' option changes automatically, unless it was
6814 explicitly set before.
6815 When 'shellpipe' is set to an empty string, no redirection of the
6816 ":make" output will be done. This is useful if you use a 'makeprg'
6817 that writes to 'makeef' by itself. If you want no piping, but do
6818 want to include the 'makeef', set 'shellpipe' to a single space.
6819 Don't forget to precede the space with a backslash: ":set sp=\ ".
6820 In the future pipes may be used for filtering and this option will
6821 become obsolete (at least for Unix).
6822 This option cannot be set from a |modeline| or in the |sandbox|, for
6823 security reasons.
6824
6825 *'shellquote'* *'shq'*
6826'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6827 contains "sh" somewhere: "\"")
6828 global
6829 {not in Vi}
6830 Quoting character(s), put around the command passed to the shell, for
6831 the "!" and ":!" commands. The redirection is kept outside of the
6832 quoting. See 'shellxquote' to include the redirection. It's
6833 probably not useful to set both options.
6834 This is an empty string by default. Only known to be useful for
6835 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6836 or bash, where it should be "\"". The default is adjusted according
6837 the value of 'shell', to reduce the need to set this option by the
6838 user. See |dos-shell|.
6839 This option cannot be set from a |modeline| or in the |sandbox|, for
6840 security reasons.
6841
6842 *'shellredir'* *'srr'*
6843'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6844 global
6845 {not in Vi}
6846 String to be used to put the output of a filter command in a temporary
6847 file. See also |:!|. See |option-backslash| about including spaces
6848 and backslashes.
6849 The name of the temporary file can be represented by "%s" if necessary
6850 (the file name is appended automatically if no %s appears in the value
6851 of this option).
6852 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6853 or "zsh" during initializations, the default becomes ">&". If the
6854 'shell' option is "sh", "ksh" or "bash" the default becomes
6855 ">%s 2>&1". This means that stderr is also included.
6856 For Win32, the Unix checks are done and additionally "cmd" is checked
6857 for, which makes the default ">%s 2>&1". Also, the same names with
6858 ".exe" appended are checked for.
6859 The initialization of this option is done after reading the ".vimrc"
6860 and the other initializations, so that when the 'shell' option is set
6861 there, the 'shellredir' option changes automatically unless it was
6862 explicitly set before.
6863 In the future pipes may be used for filtering and this option will
6864 become obsolete (at least for Unix).
6865 This option cannot be set from a |modeline| or in the |sandbox|, for
6866 security reasons.
6867
6868 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6869'shellslash' 'ssl' boolean (default off)
6870 global
6871 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6872 When set, a forward slash is used when expanding file names. This is
6873 useful when a Unix-like shell is used instead of command.com or
6874 cmd.exe. Backward slashes can still be typed, but they are changed to
6875 forward slashes by Vim.
6876 Note that setting or resetting this option has no effect for some
6877 existing file names, thus this option needs to be set before opening
6878 any file for best results. This might change in the future.
6879 'shellslash' only works when a backslash can be used as a path
6880 separator. To test if this is so use: >
6881 if exists('+shellslash')
6882<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006883 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6884'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6885 global
6886 {not in Vi}
6887 When on, use temp files for shell commands. When off use a pipe.
6888 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006889 Currently a pipe is only supported on Unix and MS-Windows 2K and
6890 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006891 :if has("filterpipe")
6892< The advantage of using a pipe is that nobody can read the temp file
6893 and the 'shell' command does not need to support redirection.
6894 The advantage of using a temp file is that the file type and encoding
6895 can be detected.
6896 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6897 |FilterWritePost| autocommands event are not triggered when
6898 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006899 The `system()` function does not respect this option and always uses
6900 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006901 NOTE: This option is set to the Vim default value when 'compatible'
6902 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006903
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 *'shelltype'* *'st'*
6905'shelltype' 'st' number (default 0)
6906 global
6907 {not in Vi} {only for the Amiga}
6908 On the Amiga this option influences the way how the commands work
6909 which use a shell.
6910 0 and 1: always use the shell
6911 2 and 3: use the shell only to filter lines
6912 4 and 5: use shell only for ':sh' command
6913 When not using the shell, the command is executed directly.
6914
6915 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6916 1 and 3: use "shell cmd" to start external commands
6917
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006918 *'shellxescape'* *'sxe'*
6919'shellxescape' 'sxe' string (default: "";
6920 for MS-DOS and MS-Windows: "\"&|<>()@^")
6921 global
6922 {not in Vi}
6923 When 'shellxquote' is set to "(" then the characters listed in this
6924 option will be escaped with a '^' character. This makes it possible
6925 to execute most external commands with cmd.exe.
6926
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 *'shellxquote'* *'sxq'*
6928'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006929 for Win32, when 'shell' is cmd.exe: "("
6930 for Win32, when 'shell' contains "sh"
6931 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 for Unix, when using system(): "\"")
6933 global
6934 {not in Vi}
6935 Quoting character(s), put around the command passed to the shell, for
6936 the "!" and ":!" commands. Includes the redirection. See
6937 'shellquote' to exclude the redirection. It's probably not useful
6938 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006939 When the value is '(' then ')' is appended. When the value is '"('
6940 then ')"' is appended.
6941 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006942 This is an empty string by default on most systems, but is known to be
6943 useful for on Win32 version, either for cmd.exe which automatically
6944 strips off the first and last quote on a command, or 3rd-party shells
6945 such as the MKS Korn Shell or bash, where it should be "\"". The
6946 default is adjusted according the value of 'shell', to reduce the need
6947 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 This option cannot be set from a |modeline| or in the |sandbox|, for
6949 security reasons.
6950
6951 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6952'shiftround' 'sr' boolean (default off)
6953 global
6954 {not in Vi}
6955 Round indent to multiple of 'shiftwidth'. Applies to > and <
6956 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6957 a multiple of 'shiftwidth' (this is Vi compatible).
6958 NOTE: This option is reset when 'compatible' is set.
6959
6960 *'shiftwidth'* *'sw'*
6961'shiftwidth' 'sw' number (default 8)
6962 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006963 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006965 When zero the 'ts' value will be used. Use the |shiftwidth()|
6966 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967
6968 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006969'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6970 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 global
6972 {not in Vi}
6973 This option helps to avoid all the |hit-enter| prompts caused by file
6974 messages, for example with CTRL-G, and to avoid some other messages.
6975 It is a list of flags:
6976 flag meaning when present ~
6977 f use "(3 of 5)" instead of "(file 3 of 5)"
6978 i use "[noeol]" instead of "[Incomplete last line]"
6979 l use "999L, 888C" instead of "999 lines, 888 characters"
6980 m use "[+]" instead of "[Modified]"
6981 n use "[New]" instead of "[New File]"
6982 r use "[RO]" instead of "[readonly]"
6983 w use "[w]" instead of "written" for file write message
6984 and "[a]" instead of "appended" for ':w >> file' command
6985 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6986 "[unix format]" and "[mac]" instead of "[mac format]".
6987 a all of the above abbreviations
6988
6989 o overwrite message for writing a file with subsequent message
6990 for reading a file (useful for ":wn" or when 'autowrite' on)
6991 O message for reading a file overwrites any previous message.
6992 Also for quickfix message (e.g., ":cn").
6993 s don't give "search hit BOTTOM, continuing at TOP" or "search
6994 hit TOP, continuing at BOTTOM" messages
6995 t truncate file message at the start if it is too long to fit
6996 on the command-line, "<" will appear in the left most column.
6997 Ignored in Ex mode.
6998 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006999 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 Ignored in Ex mode.
7001 W don't give "written" or "[w]" when writing a file
7002 A don't give the "ATTENTION" message when an existing swap file
7003 is found.
7004 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02007005 c don't give |ins-completion-menu| messages. For example,
7006 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
7007 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01007008 q use "recording" instead of "recording @a"
7009 F don't give the file info when editing a file, like `:silent`
7010 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011
7012 This gives you the opportunity to avoid that a change between buffers
7013 requires you to hit <Enter>, but still gives as useful a message as
7014 possible for the space available. To get the whole message that you
7015 would have got with 'shm' empty, use ":file!"
7016 Useful values:
7017 shm= No abbreviation of message.
7018 shm=a Abbreviation, but no loss of information.
7019 shm=at Abbreviation, and truncate message when necessary.
7020
7021 NOTE: This option is set to the Vi default value when 'compatible' is
7022 set and to the Vim default value when 'compatible' is reset.
7023
7024 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
7025'shortname' 'sn' boolean (default off)
7026 local to buffer
7027 {not in Vi, not in MS-DOS versions}
7028 Filenames are assumed to be 8 characters plus one extension of 3
7029 characters. Multiple dots in file names are not allowed. When this
7030 option is on, dots in file names are replaced with underscores when
7031 adding an extension (".~" or ".swp"). This option is not available
7032 for MS-DOS, because then it would always be on. This option is useful
7033 when editing files on an MS-DOS compatible filesystem, e.g., messydos
7034 or crossdos. When running the Win32 GUI version under Win32s, this
7035 option is always on by default.
7036
7037 *'showbreak'* *'sbr'* *E595*
7038'showbreak' 'sbr' string (default "")
7039 global
7040 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007041 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 feature}
7043 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007044 values are "> " or "+++ ": >
7045 :set showbreak=>\
7046< Note the backslash to escape the trailing space. It's easier like
7047 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007048 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007049< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 comma (in a future version the comma might be used to separate the
7051 part that is shown at the end and at the start of a line).
7052 The characters are highlighted according to the '@' flag in
7053 'highlight'.
7054 Note that tabs after the showbreak will be displayed differently.
7055 If you want the 'showbreak' to appear in between line numbers, add the
7056 "n" flag to 'cpoptions'.
7057
7058 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007059'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7060 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 global
7062 {not in Vi}
7063 {not available when compiled without the
7064 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007065 Show (partial) command in the last line of the screen. Set this
7066 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 In Visual mode the size of the selected area is shown:
7068 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007069 If the number of bytes is different it is also displayed: "2-6"
7070 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007072 - When selecting a block, the size in screen characters:
7073 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 NOTE: This option is set to the Vi default value when 'compatible' is
7075 set and to the Vim default value when 'compatible' is reset.
7076
7077 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7078'showfulltag' 'sft' boolean (default off)
7079 global
7080 {not in Vi}
7081 When completing a word in insert mode (see |ins-completion|) from the
7082 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007083 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 matched a C function, you can see a template for what arguments are
7085 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007086 Note that this doesn't work well together with having "longest" in
7087 'completeopt', because the completion from the search pattern may not
7088 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089
7090 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7091'showmatch' 'sm' boolean (default off)
7092 global
7093 When a bracket is inserted, briefly jump to the matching one. The
7094 jump is only done if the match can be seen on the screen. The time to
7095 show the match can be set with 'matchtime'.
7096 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007097 seen or not).
7098 This option is reset when 'paste' is set and restored when 'paste' is
7099 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 When the 'm' flag is not included in 'cpoptions', typing a character
7101 will immediately move the cursor back to where it belongs.
7102 See the "sm" field in 'guicursor' for setting the cursor shape and
7103 blinking when showing the match.
7104 The 'matchpairs' option can be used to specify the characters to show
7105 matches for. 'rightleft' and 'revins' are used to look for opposite
7106 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007107 Also see the matchparen plugin for highlighting the match when moving
7108 around |pi_paren.txt|.
7109 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110
7111 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7112'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7113 global
7114 If in Insert, Replace or Visual mode put a message on the last line.
7115 Use the 'M' flag in 'highlight' to set the type of highlighting for
7116 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007117 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 doesn't mean XIM is really active, especially when 'imactivatekey' is
7119 not set.
7120 NOTE: This option is set to the Vi default value when 'compatible' is
7121 set and to the Vim default value when 'compatible' is reset.
7122
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007123 *'showtabline'* *'stal'*
7124'showtabline' 'stal' number (default 1)
7125 global
7126 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007127 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007128 feature}
7129 The value of this option specifies when the line with tab page labels
7130 will be displayed:
7131 0: never
7132 1: only if there are at least two tab pages
7133 2: always
7134 This is both for the GUI and non-GUI implementation of the tab pages
7135 line.
7136 See |tab-page| for more information about tab pages.
7137
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 *'sidescroll'* *'ss'*
7139'sidescroll' 'ss' number (default 0)
7140 global
7141 {not in Vi}
7142 The minimal number of columns to scroll horizontally. Used only when
7143 the 'wrap' option is off and the cursor is moved off of the screen.
7144 When it is zero the cursor will be put in the middle of the screen.
7145 When using a slow terminal set it to a large number or 0. When using
7146 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7147 commands.
7148
7149 *'sidescrolloff'* *'siso'*
7150'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007151 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 {not in Vi}
7153 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007154 right of the cursor if 'nowrap' is set. Setting this option to a
7155 value greater than 0 while having |'sidescroll'| also at a non-zero
7156 value makes some context visible in the line you are scrolling in
7157 horizontally (except at beginning of the line). Setting this option
7158 to a large value (like 999) has the effect of keeping the cursor
7159 horizontally centered in the window, as long as one does not come too
7160 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007161 After using the local value, go back the global value with one of
7162 these two: >
7163 setlocal sidescrolloff<
7164 setlocal sidescrolloff=-1
7165< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166
7167 Example: Try this together with 'sidescroll' and 'listchars' as
7168 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007169 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170
7171 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7172 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007173<
7174 *'signcolumn'* *'scl'*
7175'signcolumn' 'scl' string (default "auto")
7176 local to window
7177 {not in Vi}
7178 {not available when compiled without the |+signs|
7179 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007180 Whether or not to draw the signcolumn. Valid values are:
7181 "auto" only when there is a sign to display
7182 "no" never
7183 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184
7185
7186 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7187'smartcase' 'scs' boolean (default off)
7188 global
7189 {not in Vi}
7190 Override the 'ignorecase' option if the search pattern contains upper
7191 case characters. Only used when the search pattern is typed and
7192 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007193 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7195 recalling the search pattern from history and hitting <Enter>.
7196 NOTE: This option is reset when 'compatible' is set.
7197
7198 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7199'smartindent' 'si' boolean (default off)
7200 local to buffer
7201 {not in Vi}
7202 {not available when compiled without the
7203 |+smartindent| feature}
7204 Do smart autoindenting when starting a new line. Works for C-like
7205 programs, but can also be used for other languages. 'cindent' does
7206 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007207 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007208 setting 'si' has no effect. 'indentexpr' is a more advanced
7209 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 Normally 'autoindent' should also be on when using 'smartindent'.
7211 An indent is automatically inserted:
7212 - After a line ending in '{'.
7213 - After a line starting with a keyword from 'cinwords'.
7214 - Before a line starting with '}' (only with the "O" command).
7215 When typing '}' as the first character in a new line, that line is
7216 given the same indent as the matching '{'.
7217 When typing '#' as the first character in a new line, the indent for
7218 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007219 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007220 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7221 When using the ">>" command, lines starting with '#' are not shifted
7222 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007223 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007224 This option is reset when 'paste' is set and restored when 'paste' is
7225 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226
7227 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7228'smarttab' 'sta' boolean (default off)
7229 global
7230 {not in Vi}
7231 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007232 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7233 <BS> will delete a 'shiftwidth' worth of space at the start of the
7234 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007235 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007236 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7237 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007238 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007240 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007241 This option is reset when 'paste' is set and restored when 'paste' is
7242 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 NOTE: This option is reset when 'compatible' is set.
7244
7245 *'softtabstop'* *'sts'*
7246'softtabstop' 'sts' number (default 0)
7247 local to buffer
7248 {not in Vi}
7249 Number of spaces that a <Tab> counts for while performing editing
7250 operations, like inserting a <Tab> or using <BS>. It "feels" like
7251 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7252 used. This is useful to keep the 'ts' setting at its standard value
7253 of 8, while being able to edit like it is set to 'sts'. However,
7254 commands like "x" still work on the actual characters.
7255 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007256 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007257 'softtabstop' is set to 0 when the 'paste' option is set and restored
7258 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7260 spaces is minimized by using <Tab>s.
7261 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7262 set.
7263 NOTE: This option is set to 0 when 'compatible' is set.
7264
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007265 If Vim is compiled with the |+vartabs| feature then the value of
7266 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7267 anything other than an empty string.
7268
Bram Moolenaar217ad922005-03-20 22:37:15 +00007269 *'spell'* *'nospell'*
7270'spell' boolean (default off)
7271 local to window
7272 {not in Vi}
7273 {not available when compiled without the |+syntax|
7274 feature}
7275 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007276 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007277
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007278 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007279'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007280 local to buffer
7281 {not in Vi}
7282 {not available when compiled without the |+syntax|
7283 feature}
7284 Pattern to locate the end of a sentence. The following word will be
7285 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007286 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007287 When this check is not wanted make this option empty.
7288 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007289 Be careful with special characters, see |option-backslash| about
7290 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007291 To set this option automatically depending on the language, see
7292 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007293
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007294 *'spellfile'* *'spf'*
7295'spellfile' 'spf' string (default empty)
7296 local to buffer
7297 {not in Vi}
7298 {not available when compiled without the |+syntax|
7299 feature}
7300 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007301 commands. It must end in ".{encoding}.add". You need to include the
7302 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007303 *E765*
7304 It may also be a comma separated list of names. A count before the
7305 |zg| and |zw| commands can be used to access each. This allows using
7306 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007307 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007308 you: Using the first directory in 'runtimepath' that is writable. If
7309 there is no "spell" directory yet it will be created. For the file
7310 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007311 ignoring the region.
7312 The resulting ".spl" file will be used for spell checking, it does not
7313 have to appear in 'spelllang'.
7314 Normally one file is used for all regions, but you can add the region
7315 name if you want to. However, it will then only be used when
7316 'spellfile' is set to it, for entries in 'spelllang' only files
7317 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007318 This option cannot be set from a |modeline| or in the |sandbox|, for
7319 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007320
Bram Moolenaar217ad922005-03-20 22:37:15 +00007321 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007322'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007323 local to buffer
7324 {not in Vi}
7325 {not available when compiled without the |+syntax|
7326 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007327 A comma separated list of word list names. When the 'spell' option is
7328 on spellchecking will be done for these languages. Example: >
7329 set spelllang=en_us,nl,medical
7330< This means US English, Dutch and medical words are recognized. Words
7331 that are not recognized will be highlighted.
7332 The word list name must not include a comma or dot. Using a dash is
7333 recommended to separate the two letter language name from a
7334 specification. Thus "en-rare" is used for rare English words.
7335 A region name must come last and have the form "_xx", where "xx" is
7336 the two-letter, lower case region name. You can use more than one
7337 region by listing them: "en_us,en_ca" supports both US and Canadian
7338 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007339 Britain. (Note: currently en_au and en_nz dictionaries are older than
7340 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007341 If the name "cjk" is included East Asian characters are excluded from
7342 spell checking. This is useful when editing text that also has Asian
7343 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007344 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007345 As a special case the name of a .spl file can be given as-is. The
7346 first "_xx" in the name is removed and used as the region name
7347 (_xx is an underscore, two letters and followed by a non-letter).
7348 This is mainly for testing purposes. You must make sure the correct
7349 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007350 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007351 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7352 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007353 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007354
Bram Moolenaar98692072006-02-04 00:57:42 +00007355 If the |spellfile.vim| plugin is active and you use a language name
7356 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7357 will ask you if you want to download the file.
7358
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007359 After this option has been set successfully, Vim will source the files
7360 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007361 up to the first character that is not an ASCII letter or number and
7362 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007363
7364
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007365 *'spellsuggest'* *'sps'*
7366'spellsuggest' 'sps' string (default "best")
7367 global
7368 {not in Vi}
7369 {not available when compiled without the |+syntax|
7370 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007371 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007372 the |spellsuggest()| function. This is a comma-separated list of
7373 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007374
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007375 best Internal method that works best for English. Finds
7376 changes like "fast" and uses a bit of sound-a-like
7377 scoring to improve the ordering.
7378
7379 double Internal method that uses two methods and mixes the
7380 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007381 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007382 word. That only works when the language specifies
7383 sound folding. Can be slow and doesn't always give
7384 better results.
7385
7386 fast Internal method that only checks for simple changes:
7387 character inserts/deletes/swaps. Works well for
7388 simple typing mistakes.
7389
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007390 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007391 Not used for |spellsuggest()|. The number of
7392 suggestions is never more than the value of 'lines'
7393 minus two.
7394
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007395 file:{filename} Read file {filename}, which must have two columns,
7396 separated by a slash. The first column contains the
7397 bad word, the second column the suggested good word.
7398 Example:
7399 theribal/terrible ~
7400 Use this for common mistakes that do not appear at the
7401 top of the suggestion list with the internal methods.
7402 Lines without a slash are ignored, use this for
7403 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007404 The word in the second column must be correct,
7405 otherwise it will not be used. Add the word to an
7406 ".add" file if it is currently flagged as a spelling
7407 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007408 The file is used for all languages.
7409
7410 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7411 trouble with spaces. |v:val| holds the badly spelled
7412 word. The expression must evaluate to a List of
7413 Lists, each with a suggestion and a score.
7414 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007415 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007416 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007417 internal methods use. A lower score is better.
7418 This may invoke |spellsuggest()| if you temporarily
7419 set 'spellsuggest' to exclude the "expr:" part.
7420 Errors are silently ignored, unless you set the
7421 'verbose' option to a non-zero value.
7422
7423 Only one of "best", "double" or "fast" may be used. The others may
7424 appear several times in any order. Example: >
7425 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7426<
7427 This option cannot be set from a |modeline| or in the |sandbox|, for
7428 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007429
7430
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7432'splitbelow' 'sb' boolean (default off)
7433 global
7434 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007435 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 feature}
7437 When on, splitting a window will put the new window below the current
7438 one. |:split|
7439
7440 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7441'splitright' 'spr' boolean (default off)
7442 global
7443 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007444 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445 feature}
7446 When on, splitting a window will put the new window right of the
7447 current one. |:vsplit|
7448
7449 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7450'startofline' 'sol' boolean (default on)
7451 global
7452 {not in Vi}
7453 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007454 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007455 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007456 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 with a linewise operator, with "%" with a count and to buffer changing
7458 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7459 only has a line number, e.g., ":25" or ":+".
7460 In case of buffer changing commands the cursor is placed at the column
7461 where it was the last time the buffer was edited.
7462 NOTE: This option is set when 'compatible' is set.
7463
Bram Moolenaar00654022011-02-25 14:42:19 +01007464 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007466 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 {not in Vi}
7468 {not available when compiled without the |+statusline|
7469 feature}
7470 When nonempty, this option determines the content of the status line.
7471 Also see |status-line|.
7472
7473 The option consists of printf style '%' items interspersed with
7474 normal text. Each status line item is of the form:
7475 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007476 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007477 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478
Bram Moolenaar238a5642006-02-21 22:12:05 +00007479 When the option starts with "%!" then it is used as an expression,
7480 evaluated and the result is used as the option value. Example: >
7481 :set statusline=%!MyStatusLine()
7482< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007483 Note that the "%!" expression is evaluated in the context of the
7484 current window and buffer, while %{} items are evaluated in the
7485 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007486
7487 When there is error while evaluating the option then it will be made
7488 empty to avoid further errors. Otherwise screen updating would loop.
7489
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 Note that the only effect of 'ruler' when this option is set (and
7491 'laststatus' is 2) is controlling the output of |CTRL-G|.
7492
7493 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007494 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007496 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 minwid Minimum width of the item, padding as set by '-' & '0'.
7498 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007499 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 on the left for text items. Numeric items will be
7501 shifted down to maxwid-2 digits followed by '>'number
7502 where number is the amount of missing digits, much like
7503 an exponential notation.
7504 item A one letter code as described below.
7505
7506 Following is a description of the possible statusline items. The
7507 second character in "item" is the type:
7508 N for number
7509 S for string
7510 F for flags as described below
7511 - not applicable
7512
7513 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007514 f S Path to the file in the buffer, as typed or relative to current
7515 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 F S Full path to the file in the buffer.
7517 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007518 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007520 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007522 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007524 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007526 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007528 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7530 being used: "<keymap>"
7531 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007532 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533 B N As above, in hexadecimal.
7534 o N Byte number in file of byte under cursor, first byte is 1.
7535 Mnemonic: Offset from start of file (with one added)
7536 {not available when compiled without |+byte_offset| feature}
7537 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007538 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 l N Line number.
7540 L N Number of lines in buffer.
7541 c N Column number.
7542 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007543 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 p N Percentage through file in lines as in |CTRL-G|.
7545 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007546 percentage described for 'ruler'. Always 3 in length, unless
7547 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007548 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007550 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007551 Note that there is no '%' before the closing '}'. The
7552 expression cannot contain a '}' character, call a function to
7553 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 ( - Start of item group. Can be used for setting the width and
7555 alignment of a section. Must be followed by %) somewhere.
7556 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007557 T N For 'tabline': start of tab page N label. Use %T after the last
7558 label. This information is used for mouse clicks.
7559 X N For 'tabline': start of close tab N label. Use %X after the
7560 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7561 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 < - Where to truncate line if too long. Default is at the start.
7563 No width fields allowed.
7564 = - Separation point between left and right aligned items.
7565 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007566 # - Set highlight group. The name must follow and then a # again.
7567 Thus use %#HLname# for highlight group HLname. The same
7568 highlighting is used, also for the statusline of non-current
7569 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007571 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 The difference between User{N} and StatusLine will be applied
7573 to StatusLineNC for the statusline of non-current windows.
7574 The number N must be between 1 and 9. See |hl-User1..9|
7575
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007576 When displaying a flag, Vim removes the leading comma, if any, when
7577 that flag comes right after plaintext. This will make a nice display
7578 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579
Bram Moolenaar582fd852005-03-28 20:58:01 +00007580 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 not set) and a minwid is not set for the group, the whole group will
7582 become empty. This will make a group like the following disappear
7583 completely from the statusline when none of the flags are set. >
7584 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007585< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 Beware that an expression is evaluated each and every time the status
7587 line is displayed. The current buffer and current window will be set
7588 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007589 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007590 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007591 real current buffer.
7592
Bram Moolenaar30b65812012-07-12 22:01:11 +02007593 The 'statusline' option will be evaluated in the |sandbox| if set from
7594 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007595
7596 It is not allowed to change text or jump to another window while
7597 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598
7599 If the statusline is not updated when you want it (e.g., after setting
7600 a variable that's used in an expression), you can force an update by
7601 setting an option without changing its value. Example: >
7602 :let &ro = &ro
7603
7604< A result of all digits is regarded a number for display purposes.
7605 Otherwise the result is taken as flag text and applied to the rules
7606 described above.
7607
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007608 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007610 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611
7612 Examples:
7613 Emulate standard status line with 'ruler' set >
7614 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7615< Similar, but add ASCII value of char under the cursor (like "ga") >
7616 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7617< Display byte count and byte value, modified flag in red. >
7618 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7619 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7620< Display a ,GZ flag if a compressed file is loaded >
7621 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7622< In the |:autocmd|'s: >
7623 :let b:gzflag = 1
7624< And: >
7625 :unlet b:gzflag
7626< And define this function: >
7627 :function VarExists(var, val)
7628 : if exists(a:var) | return a:val | else | return '' | endif
7629 :endfunction
7630<
7631 *'suffixes'* *'su'*
7632'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7633 global
7634 {not in Vi}
7635 Files with these suffixes get a lower priority when multiple files
7636 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007637 suffixes. Spaces after the comma are ignored. A dot is also seen as
7638 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 separator, precede it with a backslash (see |option-backslash| about
7640 including spaces and backslashes).
7641 See 'wildignore' for completely ignoring files.
7642 The use of |:set+=| and |:set-=| is preferred when adding or removing
7643 suffixes from the list. This avoids problems when a future version
7644 uses another default.
7645
7646 *'suffixesadd'* *'sua'*
7647'suffixesadd' 'sua' string (default "")
7648 local to buffer
7649 {not in Vi}
7650 {not available when compiled without the
7651 |+file_in_path| feature}
7652 Comma separated list of suffixes, which are used when searching for a
7653 file for the "gf", "[I", etc. commands. Example: >
7654 :set suffixesadd=.java
7655<
7656 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7657'swapfile' 'swf' boolean (default on)
7658 local to buffer
7659 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007660 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 swapfile is not wanted for a specific buffer. For example, with
7662 confidential information that even root must not be able to access.
7663 Careful: All text will be in memory:
7664 - Don't use this for big files.
7665 - Recovery will be impossible!
7666 A swapfile will only be present when |'updatecount'| is non-zero and
7667 'swapfile' is set.
7668 When 'swapfile' is reset, the swap file for the current buffer is
7669 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7670 non-zero, a swap file is immediately created.
7671 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007672 If you want to open a new buffer without creating a swap file for it,
7673 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007674 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675
7676 This option is used together with 'bufhidden' and 'buftype' to
7677 specify special kinds of buffers. See |special-buffers|.
7678
7679 *'swapsync'* *'sws'*
7680'swapsync' 'sws' string (default "fsync")
7681 global
7682 {not in Vi}
7683 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007684 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 When this option is empty parts of the swap file may be in memory and
7686 not written to disk. When the system crashes you may lose more work.
7687 On Unix the system does a sync now and then without Vim asking for it,
7688 so the disadvantage of setting this option off is small. On some
7689 systems the swap file will not be written at all. For a unix system
7690 setting it to "sync" will use the sync() call instead of the default
7691 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007692 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693
7694 *'switchbuf'* *'swb'*
7695'switchbuf' 'swb' string (default "")
7696 global
7697 {not in Vi}
7698 This option controls the behavior when switching between buffers.
7699 Possible values (comma separated list):
7700 useopen If included, jump to the first open window that
7701 contains the specified buffer (if there is one).
7702 Otherwise: Do not examine other windows.
7703 This setting is checked with |quickfix| commands, when
7704 jumping to errors (":cc", ":cn", "cp", etc.). It is
7705 also used in all buffer related split commands, for
7706 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007707 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007708 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007710 a buffer for a |quickfix| command that display errors.
7711 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007712 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007713 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007714 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007716 *'synmaxcol'* *'smc'*
7717'synmaxcol' 'smc' number (default 3000)
7718 local to buffer
7719 {not in Vi}
7720 {not available when compiled without the |+syntax|
7721 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007722 Maximum column in which to search for syntax items. In long lines the
7723 text after this column is not highlighted and following lines may not
7724 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007725 This helps to avoid very slow redrawing for an XML file that is one
7726 long line.
7727 Set to zero to remove the limit.
7728
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 *'syntax'* *'syn'*
7730'syntax' 'syn' string (default empty)
7731 local to buffer
7732 {not in Vi}
7733 {not available when compiled without the |+syntax|
7734 feature}
7735 When this option is set, the syntax with this name is loaded, unless
7736 syntax highlighting has been switched off with ":syntax off".
7737 Otherwise this option does not always reflect the current syntax (the
7738 b:current_syntax variable does).
7739 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007740 not automatically recognized. Example, in an IDL file:
7741 /* vim: set syntax=idl : */ ~
7742 When a dot appears in the value then this separates two filetype
7743 names. Example:
7744 /* vim: set syntax=c.doxygen : */ ~
7745 This will use the "c" syntax first, then the "doxygen" syntax.
7746 Note that the second one must be prepared to be loaded as an addition,
7747 otherwise it will be skipped. More than one dot may appear.
7748 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 :set syntax=OFF
7750< To switch syntax highlighting on according to the current value of the
7751 'filetype' option: >
7752 :set syntax=ON
7753< What actually happens when setting the 'syntax' option is that the
7754 Syntax autocommand event is triggered with the value as argument.
7755 This option is not copied to another buffer, independent of the 's' or
7756 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007757 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007759 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007760'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007761 global
7762 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007763 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007764 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007765 When nonempty, this option determines the content of the tab pages
7766 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007767 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007768
7769 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007770 option and only when there is no GUI tab line. When 'e' is in
7771 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007772 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007773
7774 The value is evaluated like with 'statusline'. You can use
7775 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007776 the text to be displayed. Use "%1T" for the first label, "%2T" for
7777 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007778
Bram Moolenaare12bab32019-01-08 22:02:56 +01007779 When changing something that is used in 'tabline' that does not
7780 trigger it to be updated, use |:redrawtabline|.
7781
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007782 Keep in mind that only one of the tab pages is the current one, others
7783 are invisible and you can't jump to their windows.
7784
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007785
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007786 *'tabpagemax'* *'tpm'*
7787'tabpagemax' 'tpm' number (default 10)
7788 global
7789 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007790 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007791 feature}
7792 Maximum number of tab pages to be opened by the |-p| command line
7793 argument or the ":tab all" command. |tabpage|
7794
7795
7796 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797'tabstop' 'ts' number (default 8)
7798 local to buffer
7799 Number of spaces that a <Tab> in the file counts for. Also see
7800 |:retab| command, and 'softtabstop' option.
7801
7802 Note: Setting 'tabstop' to any other value than 8 can make your file
7803 appear wrong in many places (e.g., when printing it).
7804
7805 There are four main ways to use tabs in Vim:
7806 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7807 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007808 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 behave like a tab appears every 4 (or 3) characters.
7810 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7811 'expandtab'. This way you will always insert spaces. The
7812 formatting will never be messed up when 'tabstop' is changed.
7813 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007814 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 works when using Vim to edit the file.
7816 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7817 'noexpandtab'. This should then work (for initial indents only)
7818 for any tabstop setting that people use. It might be nice to have
7819 tabs after the first non-blank inserted as spaces if you do this
7820 though. Otherwise aligned comments will be wrong when 'tabstop' is
7821 changed.
7822
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007823 If Vim is compiled with the |+vartabs| feature then the value of
7824 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7825 than an empty string.
7826
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7828'tagbsearch' 'tbs' boolean (default on)
7829 global
7830 {not in Vi}
7831 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007832 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 searching makes searching for a tag a LOT faster, but a linear search
7834 will find more tags if the tags file wasn't properly sorted.
7835 Vim normally assumes that your tags files are sorted, or indicate that
7836 they are not sorted. Only when this is not the case does the
7837 'tagbsearch' option need to be switched off.
7838
7839 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007840 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 certain files, or retry all files with a linear search. When
7842 'tagbsearch' is off, only a linear search is done.
7843
7844 Linear searching is done anyway, for one file, when Vim finds a line
7845 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007846 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847< [The whitespace before and after the '0' must be a single <Tab>]
7848
7849 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007850 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 instead of a normal tag name, a retry is done with a linear search.
7852 Tags in unsorted tags files, and matches with different case will only
7853 be found in the retry.
7854
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007855 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007856 linear search can be avoided when case is ignored. Use a value of '2'
7857 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7858 sorted with the -f switch to "sort" in most unices, as in the command:
7859 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7860 (at least 5.5) the --sort=foldcase switch can be used for this as
7861 well. Note that case must be folded to uppercase for this to work.
7862
7863 By default, tag searches are case-sensitive. Case is ignored when
7864 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7865 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007866 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7867 'tagcase' is "smart", and the pattern contains only lowercase
7868 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
7870 When 'tagbsearch' is off, tags searching is slower when a full match
7871 exists, but faster when no full match exists. Tags in unsorted tags
7872 files may only be found with 'tagbsearch' off.
7873 When the tags file is not sorted, or sorted in a wrong way (not on
7874 ASCII byte value), 'tagbsearch' should be off, or the line given above
7875 must be included in the tags file.
7876 This option doesn't affect commands that find all matching tags (e.g.,
7877 command-line completion and ":help").
7878 {Vi: always uses binary search in some versions}
7879
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007880 *'tagcase'* *'tc'*
7881'tagcase' 'tc' string (default "followic")
7882 global or local to buffer |global-local|
7883 {not in Vi}
7884 This option specifies how case is handled when searching the tags
7885 file:
7886 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007887 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007888 ignore Ignore case
7889 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007890 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007891 NOTE: This option is set to the Vi default value when 'compatible' is
7892 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007893
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 *'taglength'* *'tl'*
7895'taglength' 'tl' number (default 0)
7896 global
7897 If non-zero, tags are significant up to this number of characters.
7898
7899 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7900'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7901 global
7902 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007903 If on and using a tags file in another directory, file names in that
7904 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007905 NOTE: This option is set to the Vi default value when 'compatible' is
7906 set and to the Vim default value when 'compatible' is reset.
7907
7908 *'tags'* *'tag'* *E433*
7909'tags' 'tag' string (default "./tags,tags", when compiled with
7910 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7911 global or local to buffer |global-local|
7912 Filenames for the tag command, separated by spaces or commas. To
7913 include a space or comma in a file name, precede it with a backslash
7914 (see |option-backslash| about including spaces and backslashes).
7915 When a file name starts with "./", the '.' is replaced with the path
7916 of the current file. But only when the 'd' flag is not included in
7917 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7918 |tags-option|.
7919 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007920 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7921 find all files named "tags" below "/lib". The filename itself cannot
7922 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7923 files called "tags?". {not available when compiled without the
7924 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007925 The |tagfiles()| function can be used to get a list of the file names
7926 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7928 files are also supported. They are automatically recognized. The
7929 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7930 differences are ignored (MS-Windows). |emacs-tags|
7931 The use of |:set+=| and |:set-=| is preferred when adding or removing
7932 file names from the list. This avoids problems when a future version
7933 uses another default.
7934 {Vi: default is "tags /usr/lib/tags"}
7935
7936 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7937'tagstack' 'tgst' boolean (default on)
7938 global
7939 {not in all versions of Vi}
7940 When on, the |tagstack| is used normally. When off, a ":tag" or
7941 ":tselect" command with an argument will not push the tag onto the
7942 tagstack. A following ":tag" without an argument, a ":pop" command or
7943 any other command that uses the tagstack will use the unmodified
7944 tagstack, but does change the pointer to the active entry.
7945 Resetting this option is useful when using a ":tag" command in a
7946 mapping which should not change the tagstack.
7947
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007948 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007949'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007950 global
7951 {not in Vi}
7952 {only available when compiled with the |+tcl/dyn|
7953 feature}
7954 Specifies the name of the Tcl shared library. The default is
7955 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007956 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007957 This option cannot be set from a |modeline| or in the |sandbox|, for
7958 security reasons.
7959
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 *'term'* *E529* *E530* *E531*
7961'term' string (default is $TERM, if that fails:
7962 in the GUI: "builtin_gui"
7963 on Amiga: "amiga"
7964 on BeOS: "beos-ansi"
7965 on Mac: "mac-ansi"
7966 on MiNT: "vt52"
7967 on MS-DOS: "pcterm"
7968 on OS/2: "os2ansi"
7969 on Unix: "ansi"
7970 on VMS: "ansi"
7971 on Win 32: "win32")
7972 global
7973 Name of the terminal. Used for choosing the terminal control
7974 characters. Environment variables are expanded |:set_env|.
7975 For example: >
7976 :set term=$TERM
7977< See |termcap|.
7978
7979 *'termbidi'* *'tbidi'*
7980 *'notermbidi'* *'notbidi'*
7981'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7982 global
7983 {not in Vi}
7984 {only available when compiled with the |+arabic|
7985 feature}
7986 The terminal is in charge of Bi-directionality of text (as specified
7987 by Unicode). The terminal is also expected to do the required shaping
7988 that some languages (such as Arabic) require.
7989 Setting this option implies that 'rightleft' will not be set when
7990 'arabic' is set and the value of 'arabicshape' will be ignored.
7991 Note that setting 'termbidi' has the immediate effect that
7992 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7993 This option is reset when the GUI is started.
7994 For further details see |arabic.txt|.
7995
7996 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007997'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 Macintosh GUI: "macroman")
7999 global
8000 {only available when compiled with the |+multi_byte|
8001 feature}
8002 {not in Vi}
8003 Encoding used for the terminal. This specifies what character
8004 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01008005 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00008006 display). Except for the Mac when 'macatsui' is off, then
8007 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01008009 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 successfully initialized, 'termencoding' is forcibly set to "utf-8".
8011 Any attempts to set a different value will be rejected, and an error
8012 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02008013 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 because the Win32 system always passes Unicode characters.
8015 When empty, the same encoding is used as for the 'encoding' option.
8016 This is the normal value.
8017 Not all combinations for 'termencoding' and 'encoding' are valid. See
8018 |encoding-table|.
8019 The value for this option must be supported by internal conversions or
8020 iconv(). When this is not possible no conversion will be done and you
8021 will probably experience problems with non-ASCII characters.
8022 Example: You are working with the locale set to euc-jp (Japanese) and
8023 want to edit a UTF-8 file: >
8024 :let &termencoding = &encoding
8025 :set encoding=utf-8
8026< You need to do this when your system has no locale support for UTF-8.
8027
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008028 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008029'termguicolors' 'tgc' boolean (default off)
8030 global
8031 {not in Vi}
8032 {not available when compiled without the
8033 |+termguicolors| feature}
8034 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008035 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008036
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008037 Requires a ISO-8613-3 compatible terminal. If setting this option
8038 does not work (produces a colorless UI) reading |xterm-true-color|
8039 might help.
8040
8041 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8042 is required. Use this check to find out: >
8043 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008044< This requires Vim to be built with the |+vtp| feature.
8045
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008046 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008047 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008048
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008049 *'termwinscroll'* *'twsl'*
8050'termwinscroll' 'twsl' number (default 10000)
8051 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02008052 {not in Vi}
8053 {not available when compiled without the
8054 |+terminal| feature}
8055 Number of scrollback lines to keep. When going over this limit the
8056 first 10% of the scrollback lines are deleted. This is just to reduce
8057 the memory usage. See |Terminal-Normal|.
8058
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008059 *'termwinkey'* *'twk'*
8060'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008061 local to window
8062 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008063 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008064 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008065 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008066 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008067< The string must be one key stroke but can be multiple bytes.
8068 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008069 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008070 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008071
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008072 *'termwinsize'* *'tws'*
8073'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008074 local to window
8075 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008076 Size of the |terminal| window. Format: {rows}x{columns} or
8077 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008078 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008079 - When set with a "x" (e.g., "24x80") the terminal size is not
8080 adjusted to the window size. If the window is smaller only the
8081 top-left part is displayed.
8082 - When set with a "*" (e.g., "10*50") the terminal size follows the
8083 window size, but will not be smaller than the specified rows and/or
8084 columns.
8085 - When rows is zero then use the height of the window.
8086 - When columns is zero then use the width of the window.
8087 - Using "0x0" or "0*0" is the same as empty.
8088
8089 Examples:
8090 "30x0" uses 30 rows and the current window width.
8091 "20*0" uses at least 20 rows and the current window width.
8092 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008093 Note that the command running in the terminal window may still change
8094 the size of the terminal. In that case the Vim window will be
8095 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008096
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008097 *'termwintype'* *'twt'*
8098'termwintype' 'twt' string (default "")
8099 global
8100 {not in Vi}
8101 {only available when compiled with the |terminal|
8102 feature on MS-Windows}
8103 Specify the virtual console (pty) used when opening the terminal
8104 window.
8105
8106 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008107 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008108 "winpty" use winpty, fail if not supported
8109 "conpty" use |ConPTY|, fail if not supported
8110
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008111 |ConPTY| support depends on the platform. Windows 10 October 2018
8112 Update is the first version that supports ConPTY, however it is still
8113 considered unstable. ConPTY might become stable in the next release
8114 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008115 supported then you cannot open a terminal window.
8116
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 *'terse'* *'noterse'*
8118'terse' boolean (default off)
8119 global
8120 When set: Add 's' flag to 'shortmess' option (this makes the message
8121 for a search that hits the start or end of the file not being
8122 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8123 shortens a lot of messages}
8124
8125 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8126'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8127 global
8128 {not in Vi}
8129 This option is obsolete. Use 'fileformats'.
8130 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8131 set to the default value for the current system. When 'textauto' is
8132 reset, 'fileformats' is made empty.
8133 NOTE: This option is set to the Vi default value when 'compatible' is
8134 set and to the Vim default value when 'compatible' is reset.
8135
8136 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8137'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8138 others: default off)
8139 local to buffer
8140 {not in Vi}
8141 This option is obsolete. Use 'fileformat'.
8142 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8143 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8144 "unix".
8145
8146 *'textwidth'* *'tw'*
8147'textwidth' 'tw' number (default 0)
8148 local to buffer
8149 {not in Vi}
8150 Maximum width of text that is being inserted. A longer line will be
8151 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008152 this.
8153 'textwidth' is set to 0 when the 'paste' option is set and restored
8154 when 'paste' is reset.
8155 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008157 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 NOTE: This option is set to 0 when 'compatible' is set.
8159
8160 *'thesaurus'* *'tsr'*
8161'thesaurus' 'tsr' string (default "")
8162 global or local to buffer |global-local|
8163 {not in Vi}
8164 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008165 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
8166
8167 Each line in the file should contain words with similar meaning,
8168 separated by non-keyword characters (white space is preferred).
8169 Maximum line length is 510 bytes.
8170
Bram Moolenaard47d5222018-12-09 20:43:55 +01008171 An English word list was added to this github issue:
8172 https://github.com/vim/vim/issues/629#issuecomment-443293282
8173 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8174 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8175 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008176
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008177 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 after a comma are ignored, otherwise spaces are included in the file
8179 name. See |option-backslash| about using backslashes.
8180 The use of |:set+=| and |:set-=| is preferred when adding or removing
8181 directories from the list. This avoids problems when a future version
8182 uses another default.
8183 Backticks cannot be used in this option for security reasons.
8184
8185 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8186'tildeop' 'top' boolean (default off)
8187 global
8188 {not in Vi}
8189 When on: The tilde command "~" behaves like an operator.
8190 NOTE: This option is reset when 'compatible' is set.
8191
8192 *'timeout'* *'to'* *'notimeout'* *'noto'*
8193'timeout' 'to' boolean (default on)
8194 global
8195 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008196'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 global
8198 {not in Vi}
8199 These two options together determine the behavior when part of a
8200 mapped key sequence or keyboard code has been received:
8201
8202 'timeout' 'ttimeout' action ~
8203 off off do not time out
8204 on on or off time out on :mappings and key codes
8205 off on time out on key codes
8206
8207 If both options are off, Vim will wait until either the complete
8208 mapping or key sequence has been received, or it is clear that there
8209 is no mapping or key sequence for the received characters. For
8210 example: if you have mapped "vl" and Vim has received 'v', the next
8211 character is needed to see if the 'v' is followed by an 'l'.
8212 When one of the options is on, Vim will wait for about 1 second for
8213 the next character to arrive. After that the already received
8214 characters are interpreted as single characters. The waiting time can
8215 be changed with the 'timeoutlen' option.
8216 On slow terminals or very busy systems timing out may cause
8217 malfunctioning cursor keys. If both options are off, Vim waits
8218 forever after an entered <Esc> if there are key codes that start
8219 with <Esc>. You will have to type <Esc> twice. If you do not have
8220 problems with key codes, but would like to have :mapped key
8221 sequences not timing out in 1 second, set the 'ttimeout' option and
8222 reset the 'timeout' option.
8223
8224 NOTE: 'ttimeout' is reset when 'compatible' is set.
8225
8226 *'timeoutlen'* *'tm'*
8227'timeoutlen' 'tm' number (default 1000)
8228 global
8229 {not in all versions of Vi}
8230 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008231'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 global
8233 {not in Vi}
8234 The time in milliseconds that is waited for a key code or mapped key
8235 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8236 when part of a command has been typed.
8237 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8238 different timeout value for key codes is desired set 'ttimeoutlen' to
8239 a non-negative number.
8240
8241 ttimeoutlen mapping delay key code delay ~
8242 < 0 'timeoutlen' 'timeoutlen'
8243 >= 0 'timeoutlen' 'ttimeoutlen'
8244
8245 The timeout only happens when the 'timeout' and 'ttimeout' options
8246 tell so. A useful setting would be >
8247 :set timeout timeoutlen=3000 ttimeoutlen=100
8248< (time out on mapping after three seconds, time out on key codes after
8249 a tenth of a second).
8250
8251 *'title'* *'notitle'*
8252'title' boolean (default off, on when title can be restored)
8253 global
8254 {not in Vi}
8255 {not available when compiled without the |+title|
8256 feature}
8257 When on, the title of the window will be set to the value of
8258 'titlestring' (if it is not empty), or to:
8259 filename [+=-] (path) - VIM
8260 Where:
8261 filename the name of the file being edited
8262 - indicates the file cannot be modified, 'ma' off
8263 + indicates the file was modified
8264 = indicates the file is read-only
8265 =+ indicates the file is read-only and modified
8266 (path) is the path of the file being edited
8267 - VIM the server name |v:servername| or "VIM"
8268 Only works if the terminal supports setting window titles
8269 (currently Amiga console, Win32 console, all GUI versions and
8270 terminals with a non- empty 't_ts' option - these are Unix xterm and
8271 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8272 *X11*
8273 When Vim was compiled with HAVE_X11 defined, the original title will
8274 be restored if possible. The output of ":version" will include "+X11"
8275 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8276 works for the icon name |'icon'|.
8277 But: When Vim was started with the |-X| argument, restoring the title
8278 will not work (except in the GUI).
8279 If the title cannot be restored, it is set to the value of 'titleold'.
8280 You might want to restore the title outside of Vim then.
8281 When using an xterm from a remote machine you can use this command:
8282 rsh machine_name xterm -display $DISPLAY &
8283 then the WINDOWID environment variable should be inherited and the
8284 title of the window should change back to what it should be after
8285 exiting Vim.
8286
8287 *'titlelen'*
8288'titlelen' number (default 85)
8289 global
8290 {not in Vi}
8291 {not available when compiled without the |+title|
8292 feature}
8293 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008294 title. When the title is longer, only the end of the path name is
8295 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 Using a percentage makes this adapt to the width of the window. But
8297 it won't work perfectly, because the actual number of characters
8298 available also depends on the font used and other things in the title
8299 bar. When 'titlelen' is zero the full path is used. Otherwise,
8300 values from 1 to 30000 percent can be used.
8301 'titlelen' is also used for the 'titlestring' option.
8302
8303 *'titleold'*
8304'titleold' string (default "Thanks for flying Vim")
8305 global
8306 {not in Vi}
8307 {only available when compiled with the |+title|
8308 feature}
8309 This option will be used for the window title when exiting Vim if the
8310 original title cannot be restored. Only happens if 'title' is on or
8311 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008312 This option cannot be set from a |modeline| or in the |sandbox|, for
8313 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 *'titlestring'*
8315'titlestring' string (default "")
8316 global
8317 {not in Vi}
8318 {not available when compiled without the |+title|
8319 feature}
8320 When this option is not empty, it will be used for the title of the
8321 window. This happens only when the 'title' option is on.
8322 Only works if the terminal supports setting window titles (currently
8323 Amiga console, Win32 console, all GUI versions and terminals with a
8324 non-empty 't_ts' option).
8325 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008326 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 When this option contains printf-style '%' items, they will be
8328 expanded according to the rules used for 'statusline'.
8329 Example: >
8330 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8331 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8332< The value of 'titlelen' is used to align items in the middle or right
8333 of the available space.
8334 Some people prefer to have the file name first: >
8335 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8336< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008337 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008338 separating space only when needed.
8339 NOTE: Use of special characters in 'titlestring' may cause the display
8340 to be garbled (e.g., when it contains a CR or NL character).
8341 {not available when compiled without the |+statusline| feature}
8342
8343 *'toolbar'* *'tb'*
8344'toolbar' 'tb' string (default "icons,tooltips")
8345 global
8346 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8347 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008348 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008349 possible values are:
8350 icons Toolbar buttons are shown with icons.
8351 text Toolbar buttons shown with text.
8352 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008353 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 tooltips Tooltips are active for toolbar buttons.
8355 Tooltips refer to the popup help text which appears after the mouse
8356 cursor is placed over a toolbar button for a brief moment.
8357
8358 If you want the toolbar to be shown with icons as well as text, do the
8359 following: >
8360 :set tb=icons,text
8361< Motif and Athena cannot display icons and text at the same time. They
8362 will show icons if both are requested.
8363
8364 If none of the strings specified in 'toolbar' are valid or if
8365 'toolbar' is empty, this option is ignored. If you want to disable
8366 the toolbar, you need to set the 'guioptions' option. For example: >
8367 :set guioptions-=T
8368< Also see |gui-toolbar|.
8369
8370 *'toolbariconsize'* *'tbis'*
8371'toolbariconsize' 'tbis' string (default "small")
8372 global
8373 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008374 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008376 tiny Use tiny icons.
8377 small Use small icons (default).
8378 medium Use medium-sized icons.
8379 large Use large icons.
8380 huge Use even larger icons.
8381 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008382 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008383 the current theme. Common dimensions are giant=48x48, huge=32x32,
8384 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385
8386 If 'toolbariconsize' is empty, the global default size as determined
8387 by user preferences or the current theme is used.
8388
8389 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8390'ttybuiltin' 'tbi' boolean (default on)
8391 global
8392 {not in Vi}
8393 When on, the builtin termcaps are searched before the external ones.
8394 When off the builtin termcaps are searched after the external ones.
8395 When this option is changed, you should set the 'term' option next for
8396 the change to take effect, for example: >
8397 :set notbi term=$TERM
8398< See also |termcap|.
8399 Rationale: The default for this option is "on", because the builtin
8400 termcap entries are generally better (many systems contain faulty
8401 xterm entries...).
8402
8403 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8404'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8405 sun-cmd, screen, rxvt, dtterm or
8406 iris-ansi; also on when running Vim in
8407 a DOS console)
8408 global
8409 {not in Vi}
8410 Indicates a fast terminal connection. More characters will be sent to
8411 the screen for redrawing, instead of using insert/delete line
8412 commands. Improves smoothness of redrawing when there are multiple
8413 windows and the terminal does not support a scrolling region.
8414 Also enables the extra writing of characters at the end of each screen
8415 line for lines that wrap. This helps when using copy/paste with the
8416 mouse in an xterm and other terminals.
8417
8418 *'ttymouse'* *'ttym'*
8419'ttymouse' 'ttym' string (default depends on 'term')
8420 global
8421 {not in Vi}
8422 {only in Unix and VMS, doesn't work in the GUI; not
8423 available when compiled without |+mouse|}
8424 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008425 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 *xterm-mouse*
8427 xterm xterm-like mouse handling. The mouse generates
8428 "<Esc>[Mscr", where "scr" is three bytes:
8429 "s" = button state
8430 "c" = column plus 33
8431 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008432 This only works up to 223 columns! See "dec",
8433 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 xterm2 Works like "xterm", but with the xterm reporting the
8435 mouse position while the mouse is dragged. This works
8436 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008437 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 work. See below for how Vim detects this
8439 automatically.
8440 *netterm-mouse*
8441 netterm NetTerm mouse handling. The mouse generates
8442 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8443 for the row and column.
8444 *dec-mouse*
8445 dec DEC terminal mouse handling. The mouse generates a
8446 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008447 This is also available for an Xterm, if it was
8448 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 *jsbterm-mouse*
8450 jsbterm JSB term mouse handling.
8451 *pterm-mouse*
8452 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008453 *urxvt-mouse*
8454 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008455 The mouse works only if the terminal supports this
8456 encoding style, but it does not have 223 columns limit
8457 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008458 *sgr-mouse*
8459 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008460 mouse reporting. The mouse works even in columns
8461 beyond 223. This option is backward compatible with
8462 "xterm2" because it can also decode "xterm2" style
8463 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464
8465 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008466 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8467 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8469 recognized, if enabled at compile time. DEC terminal mouse codes
8470 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008471 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8472 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008474 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8475 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8476 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008477 Additionally, if vim is compiled with the |+termresponse| feature and
8478 |t_RV| is set to the escape sequence to request the xterm version
8479 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008480 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008481 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8482 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8483 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008484 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8485 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 :set t_RV=
8487<
8488 *'ttyscroll'* *'tsl'*
8489'ttyscroll' 'tsl' number (default 999)
8490 global
8491 Maximum number of lines to scroll the screen. If there are more lines
8492 to scroll the window is redrawn. For terminals where scrolling is
8493 very slow and redrawing is not slow this can be set to a small number,
8494 e.g., 3, to speed up displaying.
8495
8496 *'ttytype'* *'tty'*
8497'ttytype' 'tty' string (default from $TERM)
8498 global
8499 Alias for 'term', see above.
8500
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008501 *'undodir'* *'udir'*
8502'undodir' 'udir' string (default ".")
8503 global
8504 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008505 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008506 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008507 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008508 "." means using the directory of the file. The undo file name for
8509 "file.txt" is ".file.txt.un~".
8510 For other directories the file name is the full path of the edited
8511 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008512 When writing: The first directory that exists is used. "." always
8513 works, no directories after "." will be used for writing.
8514 When reading all entries are tried to find an undo file. The first
8515 undo file that exists is used. When it cannot be read an error is
8516 given, no further entry is used.
8517 See |undo-persistence|.
8518
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008519 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008520'undofile' 'udf' boolean (default off)
8521 local to buffer
8522 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008523 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008524 When on, Vim automatically saves undo history to an undo file when
8525 writing a buffer to a file, and restores undo history from the same
8526 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008527 The directory where the undo file is stored is specified by 'undodir'.
8528 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008529 The undo file is not read when 'undoreload' causes the buffer from
8530 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008531 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008532 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008533
Bram Moolenaar071d4272004-06-13 20:20:40 +00008534 *'undolevels'* *'ul'*
8535'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8536 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008537 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 {not in Vi}
8539 Maximum number of changes that can be undone. Since undo information
8540 is kept in memory, higher numbers will cause more memory to be used
8541 (nevertheless, a single change can use an unlimited amount of memory).
8542 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8543 itself: >
8544 set ul=0
8545< But you can also get Vi compatibility by including the 'u' flag in
8546 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008547 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008548 Set to -1 for no undo at all. You might want to do this only for the
8549 current buffer: >
8550 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008551< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008552
8553 The local value is set to -123456 when the global value is to be used.
8554
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008555 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008557 *'undoreload'* *'ur'*
8558'undoreload' 'ur' number (default 10000)
8559 global
8560 {not in Vi}
8561 Save the whole buffer for undo when reloading it. This applies to the
8562 ":e!" command and reloading for when the buffer changed outside of
8563 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008564 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008565 of lines is smaller than the value of this option.
8566 Set this option to zero to disable undo for a reload.
8567
8568 When saving undo for a reload, any undo file is not read.
8569
8570 Note that this causes the whole buffer to be stored in memory. Set
8571 this option to a lower value if you run out of memory.
8572
Bram Moolenaar071d4272004-06-13 20:20:40 +00008573 *'updatecount'* *'uc'*
8574'updatecount' 'uc' number (default: 200)
8575 global
8576 {not in Vi}
8577 After typing this many characters the swap file will be written to
8578 disk. When zero, no swap file will be created at all (see chapter on
8579 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8580 Vim with the "-n" option, see |startup|. When editing in readonly
8581 mode this option will be initialized to 10000.
8582 The swapfile can be disabled per buffer with |'swapfile'|.
8583 When 'updatecount' is set from zero to non-zero, swap files are
8584 created for all buffers that have 'swapfile' set. When 'updatecount'
8585 is set to zero, existing swap files are not deleted.
8586 Also see |'swapsync'|.
8587 This option has no meaning in buffers where |'buftype'| is "nofile"
8588 or "nowrite".
8589
8590 *'updatetime'* *'ut'*
8591'updatetime' 'ut' number (default 4000)
8592 global
8593 {not in Vi}
8594 If this many milliseconds nothing is typed the swap file will be
8595 written to disk (see |crash-recovery|). Also used for the
8596 |CursorHold| autocommand event.
8597
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008598 *'varsofttabstop'* *'vsts'*
8599'varsofttabstop' 'vsts' string (default "")
8600 local to buffer
8601 {only available when compiled with the |+vartabs|
8602 feature}
8603 {not in Vi}
8604 A list of the number of spaces that a <Tab> counts for while editing,
8605 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8606 width <Tab>s are being inserted, while in fact a mixture of spaces
8607 and <Tab>s is used. Tab widths are separated with commas, with the
8608 final value applying to all subsequent tabs.
8609
8610 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008611 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008612 to use the following: >
8613 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008614< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8615 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008616
8617 Note that the value of |'softtabstop'| will be ignored while
8618 'varsofttabstop' is set.
8619
8620 *'vartabstop'* *'vts'*
8621'vartabstop' 'vts' string (default "")
8622 local to buffer
8623 {only available when compiled with the |+vartabs|
8624 feature}
8625 {not in Vi}
8626 A list of the number of spaces that a <Tab> in the file counts for,
8627 separated by commas. Each value corresponds to one tab, with the
8628 final value applying to all subsequent tabs. For example: >
8629 :set vartabstop=4,20,10,8
8630< This will make the first tab 4 spaces wide, the second 20 spaces,
8631 the third 10 spaces, and all following tabs 8 spaces.
8632
8633 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8634 is set.
8635
Bram Moolenaar071d4272004-06-13 20:20:40 +00008636 *'verbose'* *'vbs'*
8637'verbose' 'vbs' number (default 0)
8638 global
8639 {not in Vi, although some versions have a boolean
8640 verbose option}
8641 When bigger than zero, Vim will give messages about what it is doing.
8642 Currently, these messages are given:
8643 >= 1 When the viminfo file is read or written.
8644 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008645 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008646 >= 8 Files for which a group of autocommands is executed.
8647 >= 9 Every executed autocommand.
8648 >= 12 Every executed function.
8649 >= 13 When an exception is thrown, caught, finished, or discarded.
8650 >= 14 Anything pending in a ":finally" clause.
8651 >= 15 Every executed Ex command (truncated at 200 characters).
8652
8653 This option can also be set with the "-V" argument. See |-V|.
8654 This option is also set by the |:verbose| command.
8655
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008656 When the 'verbosefile' option is set then the verbose messages are not
8657 displayed.
8658
8659 *'verbosefile'* *'vfile'*
8660'verbosefile' 'vfile' string (default empty)
8661 global
8662 {not in Vi}
8663 When not empty all messages are written in a file with this name.
8664 When the file exists messages are appended.
8665 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008666 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008667 Setting 'verbosefile' to a new value is like making it empty first.
8668 The difference with |:redir| is that verbose messages are not
8669 displayed when 'verbosefile' is set.
8670
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 *'viewdir'* *'vdir'*
8672'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8673 "$VIM/vimfiles/view",
8674 for Unix: "~/.vim/view",
8675 for Macintosh: "$VIM:vimfiles:view"
8676 for VMS: "sys$login:vimfiles/view"
8677 for RiscOS: "Choices:vimfiles/view")
8678 global
8679 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008680 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 feature}
8682 Name of the directory where to store files for |:mkview|.
8683 This option cannot be set from a |modeline| or in the |sandbox|, for
8684 security reasons.
8685
8686 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008687'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 global
8689 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008690 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 feature}
8692 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008693 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 word save and restore ~
8695 cursor cursor position in file and in window
8696 folds manually created folds, opened/closed folds and local
8697 fold options
8698 options options and mappings local to a window or buffer (not
8699 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008700 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 slash backslashes in file names replaced with forward
8702 slashes
8703 unix with Unix end-of-line format (single <NL>), even when
8704 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008705 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706
8707 "slash" and "unix" are useful on Windows when sharing view files
8708 with Unix. The Unix version of Vim cannot source dos format scripts,
8709 but the Windows version of Vim can source unix format scripts.
8710
8711 *'viminfo'* *'vi'* *E526* *E527* *E528*
8712'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008713 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8714 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8715 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 global
8717 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008718 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 feature}
8720 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008721 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8722 "NONE".
8723 The string should be a comma separated list of parameters, each
8724 consisting of a single character identifying the particular parameter,
8725 followed by a number or string which specifies the value of that
8726 parameter. If a particular character is left out, then the default
8727 value is used for that parameter. The following is a list of the
8728 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008729 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008730 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 ! When included, save and restore global variables that start
8732 with an uppercase letter, and don't contain a lowercase
8733 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008734 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008735 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008736 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008737 " Maximum number of lines saved for each register. Old name of
8738 the '<' item, with the disadvantage that you need to put a
8739 backslash before the ", otherwise it will be recognized as the
8740 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008741 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008742 % When included, save and restore the buffer list. If Vim is
8743 started with a file name argument, the buffer list is not
8744 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008745 buffer list is restored from the viminfo file. Quickfix
8746 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8747 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008748 When followed by a number, the number specifies the maximum
8749 number of buffers that are stored. Without a number all
8750 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008751 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008752 ' Maximum number of previously edited files for which the marks
8753 are remembered. This parameter must always be included when
8754 'viminfo' is non-empty.
8755 Including this item also means that the |jumplist| and the
8756 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008757 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008758 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008759 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 patterns are also saved. When not included, the value of
8761 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008762 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008764 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008765 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008766 < Maximum number of lines saved for each register. If zero then
8767 registers are not saved. When not included, all lines are
8768 saved. '"' is the old name for this item.
8769 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008770 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008772 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008773 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 c When included, convert the text in the viminfo file from the
8775 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008776 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008777 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008778 f Whether file marks need to be stored. If zero, file marks ('0
8779 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008780 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008781 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008782 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 h Disable the effect of 'hlsearch' when loading the viminfo
8784 file. When not included, it depends on whether ":nohlsearch"
8785 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008786 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008787 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008788 the 'n'. Must be at the end of the option! If the
8789 'viminfofile' option is set, that file name overrides the one
8790 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008791 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008792 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793 r Removable media. The argument is a string (up to the next
8794 ','). This parameter can be given several times. Each
8795 specifies the start of a path for which no marks will be
8796 stored. This is to avoid removable media. For MS-DOS you
8797 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8798 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8799 ignored. Maximum length of each 'r' argument is 50
8800 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008801 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802 s Maximum size of an item in Kbyte. If zero then registers are
8803 not saved. Currently only applies to registers. The default
8804 "s10" will exclude registers with more than 10 Kbyte of text.
8805 Also see the '<' item above: line count limit.
8806
8807 Example: >
8808 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8809<
8810 '50 Marks will be remembered for the last 50 files you
8811 edited.
8812 <1000 Contents of registers (up to 1000 lines each) will be
8813 remembered.
8814 s100 Registers with more than 100 Kbyte text are skipped.
8815 :0 Command-line history will not be saved.
8816 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8817 no / Since '/' is not specified, the default will be used,
8818 that is, save all of the search history, and also the
8819 previous search and substitute patterns.
8820 no % The buffer list will not be saved nor read back.
8821 no h 'hlsearch' highlighting will be restored.
8822
8823 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8824 load the contents of the file, this is not done automatically.
8825
8826 This option cannot be set from a |modeline| or in the |sandbox|, for
8827 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008828 NOTE: This option is set to the Vim default value when 'compatible'
8829 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008831 *'viminfofile'* *'vif'*
8832'viminfofile' 'vif' string (default: "")
8833 global
8834 {not in Vi}
8835 {not available when compiled without the |+viminfo|
8836 feature}
8837 When non-empty, overrides the file name used for viminfo.
8838 When equal to "NONE" no viminfo file will be read or written.
8839 This option can be set with the |-i| command line flag. The |--clean|
8840 command line flag sets it to "NONE".
8841
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842 *'virtualedit'* *'ve'*
8843'virtualedit' 've' string (default "")
8844 global
8845 {not in Vi}
8846 {not available when compiled without the
8847 |+virtualedit| feature}
8848 A comma separated list of these words:
8849 block Allow virtual editing in Visual block mode.
8850 insert Allow virtual editing in Insert mode.
8851 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008852 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008853
Bram Moolenaar071d4272004-06-13 20:20:40 +00008854 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008855 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 of the line. Useful for selecting a rectangle in Visual mode and
8857 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008858 "onemore" is not the same, it will only allow moving the cursor just
8859 after the last character of the line. This makes some commands more
8860 consistent. Previously the cursor was always past the end of the line
8861 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008862 break some plugins or Vim scripts. For example because |l| can move
8863 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008864 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008865 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008866 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008867 It doesn't make sense to combine "all" with "onemore", but you will
8868 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008869 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008870
8871 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8872'visualbell' 'vb' boolean (default off)
8873 global
8874 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008875 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008877 use: >
8878 :set vb t_vb=
8879< If you want a short flash, you can use this on many terminals: >
8880 :set vb t_vb=[?5h$<100>[?5l
8881< Here $<100> specifies the time, you can use a smaller or bigger value
8882 to get a shorter or longer flash.
8883
8884 Note: Vim will limit the bell to once per half a second. This avoids
8885 having to wait for the flashing to finish when there are lots of
8886 bells, e.g. on key repeat. This also happens without 'visualbell'
8887 set.
8888
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8890 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8891 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008892
8893 Note: When the GUI starts, 't_vb' is reset to its default value. You
8894 might want to set it again in your |gvimrc|.
8895
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 Does not work on the Amiga, you always get a screen flash.
8897 Also see 'errorbells'.
8898
8899 *'warn'* *'nowarn'*
8900'warn' boolean (default on)
8901 global
8902 Give a warning message when a shell command is used while the buffer
8903 has been changed.
8904
8905 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8906'weirdinvert' 'wiv' boolean (default off)
8907 global
8908 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008909 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 It is provided for backwards compatibility with version 4.x.
8911 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8912 vice versa. Has no effect when the GUI is running.
8913
8914 *'whichwrap'* *'ww'*
8915'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8916 global
8917 {not in Vi}
8918 Allow specified keys that move the cursor left/right to move to the
8919 previous/next line when the cursor is on the first/last character in
8920 the line. Concatenate characters to allow this for these keys:
8921 char key mode ~
8922 b <BS> Normal and Visual
8923 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008924 h "h" Normal and Visual (not recommended)
8925 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 < <Left> Normal and Visual
8927 > <Right> Normal and Visual
8928 ~ "~" Normal
8929 [ <Left> Insert and Replace
8930 ] <Right> Insert and Replace
8931 For example: >
8932 :set ww=<,>,[,]
8933< allows wrap only when cursor keys are used.
8934 When the movement keys are used in combination with a delete or change
8935 operator, the <EOL> also counts for a character. This makes "3h"
8936 different from "3dh" when the cursor crosses the end of a line. This
8937 is also true for "x" and "X", because they do the same as "dl" and
8938 "dh". If you use this, you may also want to use the mapping
8939 ":map <BS> X" to make backspace delete the character in front of the
8940 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008941 When 'l' is included and it is used after an operator at the end of a
8942 line then it will not move to the next line. This makes "dl", "cl",
8943 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 NOTE: This option is set to the Vi default value when 'compatible' is
8945 set and to the Vim default value when 'compatible' is reset.
8946
8947 *'wildchar'* *'wc'*
8948'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8949 global
8950 {not in Vi}
8951 Character you have to type to start wildcard expansion in the
8952 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008953 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008954 The character is not recognized when used inside a macro. See
8955 'wildcharm' for that.
8956 Although 'wc' is a number option, you can set it to a special key: >
8957 :set wc=<Esc>
8958< NOTE: This option is set to the Vi default value when 'compatible' is
8959 set and to the Vim default value when 'compatible' is reset.
8960
8961 *'wildcharm'* *'wcm'*
8962'wildcharm' 'wcm' number (default: none (0))
8963 global
8964 {not in Vi}
8965 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008966 recognized when used inside a macro. You can find "spare" command-line
8967 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 you'll never actually type 'wildcharm', just use it in mappings that
8969 automatically invoke completion mode, e.g.: >
8970 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008971 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972< Then after typing :ss you can use CTRL-P & CTRL-N.
8973
8974 *'wildignore'* *'wig'*
8975'wildignore' 'wig' string (default "")
8976 global
8977 {not in Vi}
8978 {not available when compiled without the |+wildignore|
8979 feature}
8980 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008981 patterns is ignored when expanding |wildcards|, completing file or
8982 directory names, and influences the result of |expand()|, |glob()| and
8983 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8985 Also see 'suffixes'.
8986 Example: >
8987 :set wildignore=*.o,*.obj
8988< The use of |:set+=| and |:set-=| is preferred when adding or removing
8989 a pattern from the list. This avoids problems when a future version
8990 uses another default.
8991
Bram Moolenaar94950a92010-12-02 16:01:29 +01008992
Bram Moolenaar81af9252010-12-10 20:35:50 +01008993 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008994'wildignorecase' 'wic' boolean (default off)
8995 global
8996 {not in Vi}
8997 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008998 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008999 Does not apply when the shell is used to expand wildcards, which
9000 happens when there are special characters.
9001
9002
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02009004'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005 global
9006 {not in Vi}
9007 {not available if compiled without the |+wildmenu|
9008 feature}
9009 When 'wildmenu' is on, command-line completion operates in an enhanced
9010 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
9011 the possible matches are shown just above the command line, with the
9012 first match highlighted (overwriting the status line, if there is
9013 one). Keys that show the previous/next match, such as <Tab> or
9014 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
9015 When 'wildmode' is used, "wildmenu" mode is used where "full" is
9016 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01009017 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009018 If there are more matches than can fit in the line, a ">" is shown on
9019 the right and/or a "<" is shown on the left. The status line scrolls
9020 as needed.
9021 The "wildmenu" mode is abandoned when a key is hit that is not used
9022 for selecting a completion.
9023 While the "wildmenu" is active the following keys have special
9024 meanings:
9025
9026 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
9027 <Down> - in filename/menu name completion: move into a
9028 subdirectory or submenu.
9029 <CR> - in menu completion, when the cursor is just after a
9030 dot: move into a submenu.
9031 <Up> - in filename/menu name completion: move up into
9032 parent directory or parent menu.
9033
9034 This makes the menus accessible from the console |console-menus|.
9035
9036 If you prefer the <Left> and <Right> keys to move the cursor instead
9037 of selecting a different match, use this: >
9038 :cnoremap <Left> <Space><BS><Left>
9039 :cnoremap <Right> <Space><BS><Right>
9040<
9041 The "WildMenu" highlighting is used for displaying the current match
9042 |hl-WildMenu|.
9043
9044 *'wildmode'* *'wim'*
9045'wildmode' 'wim' string (Vim default: "full")
9046 global
9047 {not in Vi}
9048 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009049 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009050 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009051 first part specifies the behavior for the first use of 'wildchar',
9052 The second part for the second use, etc.
9053 These are the possible values for each part:
9054 "" Complete only the first match.
9055 "full" Complete the next full match. After the last match,
9056 the original string is used and then the first match
9057 again.
9058 "longest" Complete till longest common string. If this doesn't
9059 result in a longer string, use the next part.
9060 "longest:full" Like "longest", but also start 'wildmenu' if it is
9061 enabled.
9062 "list" When more than one match, list all matches.
9063 "list:full" When more than one match, list all matches and
9064 complete first match.
9065 "list:longest" When more than one match, list all matches and
9066 complete till longest common string.
9067 When there is only a single match, it is fully completed in all cases.
9068
9069 Examples: >
9070 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009071< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009072 :set wildmode=longest,full
9073< Complete longest common string, then each full match >
9074 :set wildmode=list:full
9075< List all matches and complete each full match >
9076 :set wildmode=list,full
9077< List all matches without completing, then each full match >
9078 :set wildmode=longest,list
9079< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009080 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009081
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009082 *'wildoptions'* *'wop'*
9083'wildoptions' 'wop' string (default "")
9084 global
9085 {not in Vi}
9086 {not available when compiled without the |+wildignore|
9087 feature}
9088 A list of words that change how command line completion is done.
9089 Currently only one word is allowed:
9090 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009091 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009092 is displayed per line. Often used tag kinds are:
9093 d #define
9094 f function
9095 Also see |cmdline-completion|.
9096
Bram Moolenaar071d4272004-06-13 20:20:40 +00009097 *'winaltkeys'* *'wak'*
9098'winaltkeys' 'wak' string (default "menu")
9099 global
9100 {not in Vi}
9101 {only used in Win32, Motif, GTK and Photon GUI}
9102 Some GUI versions allow the access to menu entries by using the ALT
9103 key in combination with a character that appears underlined in the
9104 menu. This conflicts with the use of the ALT key for mappings and
9105 entering special characters. This option tells what to do:
9106 no Don't use ALT keys for menus. ALT key combinations can be
9107 mapped, but there is no automatic handling. This can then be
9108 done with the |:simalt| command.
9109 yes ALT key handling is done by the windowing system. ALT key
9110 combinations cannot be mapped.
9111 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009112 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009113 keys can be mapped.
9114 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9115 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009116 This option is not used for <F10>; on Win32 and with GTK <F10> will
9117 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009118
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009119 *'window'* *'wi'*
9120'window' 'wi' number (default screen height - 1)
9121 global
9122 Window height. Do not confuse this with the height of the Vim window,
9123 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009124 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9125 value is smaller than 'lines' minus one. The screen will scroll
9126 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009127 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9128 in a much smarter way, taking care of wrapping lines.
9129 When resizing the Vim window, the value is smaller than 1 or more than
9130 or equal to 'lines' it will be set to 'lines' minus 1.
9131 {Vi also uses the option to specify the number of displayed lines}
9132
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 *'winheight'* *'wh'* *E591*
9134'winheight' 'wh' number (default 1)
9135 global
9136 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009137 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009138 feature}
9139 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009140 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009141 focus goes to a window that is smaller, its size is increased, at the
9142 cost of the height of other windows.
9143 Set 'winheight' to a small number for normal editing.
9144 Set it to 999 to make the current window fill most of the screen.
9145 Other windows will be only 'winminheight' high. This has the drawback
9146 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9147 to create only two windows, set the option after startup is done,
9148 using the |VimEnter| event: >
9149 au VimEnter * set winheight=999
9150< Minimum value is 1.
9151 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009152 height of the current window.
9153 'winheight' applies to the current window. Use 'winminheight' to set
9154 the minimal height for other windows.
9155
9156 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9157'winfixheight' 'wfh' boolean (default off)
9158 local to window
9159 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009160 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009161 feature}
9162 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009163 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9164 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009165 The height may be changed anyway when running out of room.
9166
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009167 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9168'winfixwidth' 'wfw' boolean (default off)
9169 local to window
9170 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009171 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009172 feature}
9173 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009174 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009175 The width may be changed anyway when running out of room.
9176
Bram Moolenaar071d4272004-06-13 20:20:40 +00009177 *'winminheight'* *'wmh'*
9178'winminheight' 'wmh' number (default 1)
9179 global
9180 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009181 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009182 feature}
9183 The minimal height of a window, when it's not the current window.
9184 This is a hard minimum, windows will never become smaller.
9185 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9186 status bar) if necessary. They will return to at least one line when
9187 they become active (since the cursor has to have somewhere to go.)
9188 Use 'winheight' to set the minimal height of the current window.
9189 This option is only checked when making a window smaller. Don't use a
9190 large number, it will cause errors when opening more than a few
9191 windows. A value of 0 to 3 is reasonable.
9192
9193 *'winminwidth'* *'wmw'*
9194'winminwidth' 'wmw' number (default 1)
9195 global
9196 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009197 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009198 feature}
9199 The minimal width of a window, when it's not the current window.
9200 This is a hard minimum, windows will never become smaller.
9201 When set to zero, windows may be "squashed" to zero columns (i.e. just
9202 a vertical separator) if necessary. They will return to at least one
9203 line when they become active (since the cursor has to have somewhere
9204 to go.)
9205 Use 'winwidth' to set the minimal width of the current window.
9206 This option is only checked when making a window smaller. Don't use a
9207 large number, it will cause errors when opening more than a few
9208 windows. A value of 0 to 12 is reasonable.
9209
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009210 *'winptydll'*
9211'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9212 global
9213 {not in Vi}
9214 {only available when compiled with the |terminal|
9215 feature on MS-Windows}
9216 Specifies the name of the winpty shared library, used for the
9217 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009218 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009219 a fallback.
9220 Environment variables are expanded |:set_env|.
9221 This option cannot be set from a |modeline| or in the |sandbox|, for
9222 security reasons.
9223
Bram Moolenaar071d4272004-06-13 20:20:40 +00009224 *'winwidth'* *'wiw'* *E592*
9225'winwidth' 'wiw' number (default 20)
9226 global
9227 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009228 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009229 feature}
9230 Minimal number of columns for the current window. This is not a hard
9231 minimum, Vim will use fewer columns if there is not enough room. If
9232 the current window is smaller, its size is increased, at the cost of
9233 the width of other windows. Set it to 999 to make the current window
9234 always fill the screen. Set it to a small number for normal editing.
9235 The width is not adjusted after one of the commands to change the
9236 width of the current window.
9237 'winwidth' applies to the current window. Use 'winminwidth' to set
9238 the minimal width for other windows.
9239
9240 *'wrap'* *'nowrap'*
9241'wrap' boolean (default on)
9242 local to window
9243 {not in Vi}
9244 This option changes how text is displayed. It doesn't change the text
9245 in the buffer, see 'textwidth' for that.
9246 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009247 displaying continues on the next line. When off lines will not wrap
9248 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009249 moved to a part that is not shown, the screen will scroll
9250 horizontally.
9251 The line will be broken in the middle of a word if necessary. See
9252 'linebreak' to get the break at a word boundary.
9253 To make scrolling horizontally a bit more useful, try this: >
9254 :set sidescroll=5
9255 :set listchars+=precedes:<,extends:>
9256< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009257 This option can't be set from a |modeline| when the 'diff' option is
9258 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259
9260 *'wrapmargin'* *'wm'*
9261'wrapmargin' 'wm' number (default 0)
9262 local to buffer
9263 Number of characters from the right window border where wrapping
9264 starts. When typing text beyond this limit, an <EOL> will be inserted
9265 and inserting continues on the next line.
9266 Options that add a margin, such as 'number' and 'foldcolumn', cause
9267 the text width to be further reduced. This is Vi compatible.
9268 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009269 This option is set to 0 when 'paste' is set and restored when 'paste'
9270 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009271 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9272 and less usefully}
9273
9274 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9275'wrapscan' 'ws' boolean (default on) *E384* *E385*
9276 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009277 Searches wrap around the end of the file. Also applies to |]s| and
9278 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009279
9280 *'write'* *'nowrite'*
9281'write' boolean (default on)
9282 global
9283 {not in Vi}
9284 Allows writing files. When not set, writing a file is not allowed.
9285 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009286 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009287 argument. Filtering text is still possible, even though this requires
9288 writing a temporary file.
9289
9290 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9291'writeany' 'wa' boolean (default off)
9292 global
9293 Allows writing to any file with no need for "!" override.
9294
9295 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9296'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9297 otherwise)
9298 global
9299 {not in Vi}
9300 Make a backup before overwriting a file. The backup is removed after
9301 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009302 also on.
9303 WARNING: Switching this option off means that when Vim fails to write
9304 your buffer correctly and then, for whatever reason, Vim exits, you
9305 lose both the original file and what you were writing. Only reset
9306 this option if your file system is almost full and it makes the write
9307 fail (and make sure not to exit Vim until the write was successful).
9308 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009309 When the 'backupskip' pattern matches, a backup is not made anyway.
9310 NOTE: This option is set to the default value when 'compatible' is
9311 set.
9312
9313 *'writedelay'* *'wd'*
9314'writedelay' 'wd' number (default 0)
9315 global
9316 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009317 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009318 screen. When non-zero, characters are sent to the terminal one by
9319 one. For MS-DOS pcterm this does not work. For debugging purposes.
9320
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009321 vim:tw=78:ts=8:noet:ft=help:norl: