blob: 97dbb5af1f8f4b0ed32bdbfd5f2b42823228177b [file] [log] [blame]
Bram Moolenaar26967612019-03-17 17:13:16 +01001*options.txt* For Vim version 8.1. Last change: 2019 Mar 08
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
Bram Moolenaar26967612019-03-17 17:13:16 +0100386 'filetype'. This is to be used for filetype
387 detections that are just a guess. |did_filetype()|
388 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200389
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}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
699 Tells Vim what to do with characters with East Asian Width Class
700 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
701 letters, Cyrillic letters).
702
703 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 expected by most users.
706 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200707 *E834* *E835*
708 The value "double" cannot be used if 'listchars' or 'fillchars'
709 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710
711 There are a number of CJK fonts for which the width of glyphs for
712 those characters are solely based on how many octets they take in
713 legacy/traditional CJK encodings. In those encodings, Euro,
714 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000715 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000717 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 Vim is running inside a terminal (emulators) that uses a CJK font
719 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
720 this option should be set to "double" to match the width perceived
721 by Vim with the width of glyphs in the font. Perhaps it also has
722 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
723 when the system locale is set to one of CJK locales. See Unicode
724 Standard Annex #11 (http://www.unicode.org/reports/tr11).
725
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100726 Vim may set this option automatically at startup time when Vim is
727 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200728 escape sequence to request cursor position report. The response can
729 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100730
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
732'antialias' 'anti' boolean (default: off)
733 global
734 {not in Vi}
735 {only available when compiled with GUI enabled
736 on Mac OS X}
737 This option only has an effect in the GUI version of Vim on Mac OS X
738 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
739 which can be easier to read at certain sizes on certain displays.
740 Setting this option can sometimes cause problems if 'guifont' is set
741 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100742 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
745'autochdir' 'acd' boolean (default off)
746 global
747 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200748 {only available when compiled with it, use
749 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000750 When on, Vim will change the current working directory whenever you
751 open a file, switch buffers, delete a buffer or open/close a window.
752 It will change to the directory containing the file which was opened
753 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000754 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755
756 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
757'arabic' 'arab' boolean (default off)
758 local to window
759 {not in Vi}
760 {only available when compiled with the |+arabic|
761 feature}
762 This option can be set to start editing Arabic text.
763 Setting this option will:
764 - Set the 'rightleft' option, unless 'termbidi' is set.
765 - Set the 'arabicshape' option, unless 'termbidi' is set.
766 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
767 between typing English and Arabic key mapping.
768 - Set the 'delcombine' option
769 Note that 'encoding' must be "utf-8" for working with Arabic text.
770
771 Resetting this option will:
772 - Reset the 'rightleft' option.
773 - Disable the use of 'keymap' (without changing its value).
774 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200775 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100776 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 Also see |arabic.txt|.
778
779 *'arabicshape'* *'arshape'*
780 *'noarabicshape'* *'noarshape'*
781'arabicshape' 'arshape' boolean (default on)
782 global
783 {not in Vi}
784 {only available when compiled with the |+arabic|
785 feature}
786 When on and 'termbidi' is off, the required visual character
787 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200788 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 one which encompasses:
790 a) the changing/morphing of characters based on their location
791 within a word (initial, medial, final and stand-alone).
792 b) the enabling of the ability to compose characters
793 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100794 When disabled the display shows each character's true stand-alone
795 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 Arabic is a complex language which requires other settings, for
797 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100798 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000799
800 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
801'autoindent' 'ai' boolean (default off)
802 local to buffer
803 Copy indent from current line when starting a new line (typing <CR>
804 in Insert mode or when using the "o" or "O" command). If you do not
805 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000806 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
807 to another line has the same effect, unless the 'I' flag is included
808 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000809 When autoindent is on, formatting (with the "gq" command or when you
810 reach 'textwidth' in Insert mode) uses the indentation of the first
811 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812 When 'smartindent' or 'cindent' is on the indent is changed in
813 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200814 The 'autoindent' option is reset when the 'paste' option is set and
815 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 {small difference from Vi: After the indent is deleted when typing
817 <Esc> or <CR>, the cursor position when moving up or down is after the
818 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
819
820 *'autoread'* *'ar'* *'noautoread'* *'noar'*
821'autoread' 'ar' boolean (default off)
822 global or local to buffer |global-local|
823 {not in Vi}
824 When a file has been detected to have been changed outside of Vim and
825 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200826 When the file has been deleted this is not done, so you have the text
827 from before it was deleted. When it appears again then it is read.
828 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 If this option has a local value, use this command to switch back to
830 using the global value: >
831 :set autoread<
832<
833 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
834'autowrite' 'aw' boolean (default off)
835 global
836 Write the contents of the file, if it has been modified, on each
837 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000838 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
840 Note that for some commands the 'autowrite' option is not used, see
841 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200842 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200843 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844
845 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
846'autowriteall' 'awa' boolean (default off)
847 global
848 {not in Vi}
849 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
850 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
851 Setting this option also implies that Vim behaves like 'autowrite' has
852 been set.
853
854 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200855'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 global
857 {not in Vi}
858 When set to "dark", Vim will try to use colors that look good on a
859 dark background. When set to "light", Vim will try to use colors that
860 look good on a light background. Any other value is illegal.
861 Vim tries to set the default value according to the terminal used.
862 This will not always be correct.
863 Setting this option does not change the background color, it tells Vim
864 what the background color looks like. For changing the background
865 color, see |:hi-normal|.
866
867 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000868 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000869 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100870 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 setting 'background' will cause the color scheme to be reloaded. If
872 the color scheme adjusts to the value of 'background' this will work.
873 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100874 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875
876 When setting 'background' to the default value with: >
877 :set background&
878< Vim will guess the value. In the GUI this should work correctly,
879 in other cases Vim might not be able to guess the right value.
880
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200881 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200882 color from the terminal. If the returned RGB value is dark/light and
883 'background' is not dark/light, 'background' will be set and the
884 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200885 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100886 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200887
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 When starting the GUI, the default value for 'background' will be
889 "light". When the value is not set in the .gvimrc, and Vim detects
890 that the background is actually quite dark, 'background' is set to
891 "dark". But this happens only AFTER the .gvimrc file has been read
892 (because the window needs to be opened to find the actual background
893 color). To get around this, force the GUI window to be opened by
894 putting a ":gui" command in the .gvimrc file, before where the value
895 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200896
897 For MS-DOS, Windows and OS/2 the default is "dark".
898 For other systems "dark" is used when 'term' is "linux",
899 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
900 background. Otherwise the default is "light".
901
Bram Moolenaarc572da52017-08-27 16:52:01 +0200902 The |:terminal| command and the |term_start()| function use the
903 'background' value to decide whether the terminal window will start
904 with a white or black background.
905
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906 Normally this option would be set in the .vimrc file. Possibly
907 depending on the terminal name. Example: >
908 :if &term == "pcterm"
909 : set background=dark
910 :endif
911< When this option is set, the default settings for the highlight groups
912 will change. To use other settings, place ":highlight" commands AFTER
913 the setting of the 'background' option.
914 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
915 to select the colors for syntax highlighting. After changing this
916 option, you must load syntax.vim again to see the result. This can be
917 done with ":syntax on".
918
919 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200920'backspace' 'bs' string (default "", set to "indent,eol,start"
921 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 global
923 {not in Vi}
924 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
925 mode. This is a list of items, separated by commas. Each item allows
926 a way to backspace over something:
927 value effect ~
928 indent allow backspacing over autoindent
929 eol allow backspacing over line breaks (join lines)
930 start allow backspacing over the start of insert; CTRL-W and CTRL-U
931 stop once at the start of insert.
932
933 When the value is empty, Vi compatible backspacing is used.
934
935 For backwards compatibility with version 5.4 and earlier:
936 value effect ~
937 0 same as ":set backspace=" (Vi compatible)
938 1 same as ":set backspace=indent,eol"
939 2 same as ":set backspace=indent,eol,start"
940
941 See |:fixdel| if your <BS> or <Del> key does not do what you want.
942 NOTE: This option is set to "" when 'compatible' is set.
943
944 *'backup'* *'bk'* *'nobackup'* *'nobk'*
945'backup' 'bk' boolean (default off)
946 global
947 {not in Vi}
948 Make a backup before overwriting a file. Leave it around after the
949 file has been successfully written. If you do not want to keep the
950 backup file, but you do want a backup while the file is being
951 written, reset this option and set the 'writebackup' option (this is
952 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000953 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 |backup-table| for more explanations.
955 When the 'backupskip' pattern matches, a backup is not made anyway.
956 When 'patchmode' is set, the backup may be renamed to become the
957 oldest version of a file.
958 NOTE: This option is reset when 'compatible' is set.
959
960 *'backupcopy'* *'bkc'*
961'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200962 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 {not in Vi}
964 When writing a file and a backup is made, this option tells how it's
965 done. This is a comma separated list of words.
966
967 The main values are:
968 "yes" make a copy of the file and overwrite the original one
969 "no" rename the file and write a new one
970 "auto" one of the previous, what works best
971
972 Extra values that can be combined with the ones above are:
973 "breaksymlink" always break symlinks when writing
974 "breakhardlink" always break hardlinks when writing
975
976 Making a copy and overwriting the original file:
977 - Takes extra time to copy the file.
978 + When the file has special attributes, is a (hard/symbolic) link or
979 has a resource fork, all this is preserved.
980 - When the file is a link the backup will have the name of the link,
981 not of the real file.
982
983 Renaming the file and writing a new one:
984 + It's fast.
985 - Sometimes not all attributes of the file can be copied to the new
986 file.
987 - When the file is a link the new file will not be a link.
988
989 The "auto" value is the middle way: When Vim sees that renaming file
990 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000991 the file is not a link) that is used. When problems are expected, a
992 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 The "breaksymlink" and "breakhardlink" values can be used in
995 combination with any of "yes", "no" and "auto". When included, they
996 force Vim to always break either symbolic or hard links by doing
997 exactly what the "no" option does, renaming the original file to
998 become the backup and writing a new file in its place. This can be
999 useful for example in source trees where all the files are symbolic or
1000 hard links and any changes should stay in the local source tree, not
1001 be propagated back to the original source.
1002 *crontab*
1003 One situation where "no" and "auto" will cause problems: A program
1004 that opens a file, invokes Vim to edit that file, and then tests if
1005 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001006 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 example.
1008
1009 When a copy is made, the original file is truncated and then filled
1010 with the new text. This means that protection bits, owner and
1011 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001012 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 group of the backup is set to the group of the original file. If this
1014 fails, the protection bits for the group are made the same as for
1015 others.
1016
1017 When the file is renamed this is the other way around: The backup has
1018 the same attributes of the original file, and the newly written file
1019 is owned by the current user. When the file was a (hard/symbolic)
1020 link, the new file will not! That's why the "auto" value doesn't
1021 rename when the file is a link. The owner and group of the newly
1022 written file will be set to the same ones as the original file, but
1023 the system may refuse to do this. In that case the "auto" value will
1024 again not rename the file.
1025
Bram Moolenaar036986f2017-03-16 17:41:02 +01001026 NOTE: This option is set to the Vi default value when 'compatible' is
1027 set and to the Vim default value when 'compatible' is reset.
1028
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 *'backupdir'* *'bdir'*
1030'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001031 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 for Unix: ".,~/tmp,~/")
1033 global
1034 {not in Vi}
1035 List of directories for the backup file, separated with commas.
1036 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001037 where this is possible. The directory must exist, Vim will not
1038 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001039 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 impossible!). Writing may fail because of this.
1041 - A directory "." means to put the backup file in the same directory
1042 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001043 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044 put the backup file relative to where the edited file is. The
1045 leading "." is replaced with the path name of the edited file.
1046 ("." inside a directory name has no special meaning).
1047 - Spaces after the comma are ignored, other spaces are considered part
1048 of the directory name. To have a space at the start of a directory
1049 name, precede it with a backslash.
1050 - To include a comma in a directory name precede it with a backslash.
1051 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001052 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001053 the backup file name will be built from the complete path to the
1054 file with all path separators changed to percent '%' signs. This
1055 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001056 On Win32, it is also possible to end with "\\". However, When a
1057 separating comma is following, you must use "//", since "\\" will
1058 include the comma in the file name. Therefore it is recommended to
1059 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 - Environment variables are expanded |:set_env|.
1061 - Careful with '\' characters, type one before a space, type two to
1062 get one in the option (see |option-backslash|), for example: >
1063 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1064< - For backwards compatibility with Vim version 3.0 a '>' at the start
1065 of the option is removed.
1066 See also 'backup' and 'writebackup' options.
1067 If you want to hide your backup files on Unix, consider this value: >
1068 :set backupdir=./.backup,~/.backup,.,/tmp
1069< You must create a ".backup" directory in each directory and in your
1070 home directory for this to work properly.
1071 The use of |:set+=| and |:set-=| is preferred when adding or removing
1072 directories from the list. This avoids problems when a future version
1073 uses another default.
1074 This option cannot be set from a |modeline| or in the |sandbox|, for
1075 security reasons.
1076
1077 *'backupext'* *'bex'* *E589*
1078'backupext' 'bex' string (default "~", for VMS: "_")
1079 global
1080 {not in Vi}
1081 String which is appended to a file name to make the name of the
1082 backup file. The default is quite unusual, because this avoids
1083 accidentally overwriting existing files with a backup file. You might
1084 prefer using ".bak", but make sure that you don't have files with
1085 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001086 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001088 If you like to keep a lot of backups, you could use a BufWritePre
1089 autocommand to change 'backupext' just before writing the file to
1090 include a timestamp. >
1091 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1092< Use 'backupdir' to put the backup in a different directory.
1093
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001095'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1096 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1097 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098 global
1099 {not in Vi}
1100 {not available when compiled without the |+wildignore|
1101 feature}
1102 A list of file patterns. When one of the patterns matches with the
1103 name of the file which is written, no backup file is created. Both
1104 the specified file name and the full path name of the file are used.
1105 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1106 Watch out for special characters, see |option-backslash|.
1107 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001108 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001109
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001110 WARNING: Not having a backup file means that when Vim fails to write
1111 your buffer correctly and then, for whatever reason, Vim exits, you
1112 lose both the original file and what you were writing. Only disable
1113 backups if you don't care about losing the file.
1114
Bram Moolenaar02467872007-05-06 13:22:01 +00001115 Note that environment variables are not expanded. If you want to use
1116 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001117 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001118
1119< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001120 backup would be made by renaming the original file crontab won't see
1121 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122
1123 *'balloondelay'* *'bdlay'*
1124'balloondelay' 'bdlay' number (default: 600)
1125 global
1126 {not in Vi}
1127 {only available when compiled with the |+balloon_eval|
1128 feature}
1129 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1130
1131 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1132'ballooneval' 'beval' boolean (default off)
1133 global
1134 {not in Vi}
1135 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001136 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001137 Switch on the |balloon-eval| functionality for the GUI.
1138
1139 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1140 *'nobevalterm'*
1141'balloonevalterm' 'bevalterm' boolean (default off)
1142 global
1143 {not in Vi}
1144 {only available when compiled with the
1145 |+balloon_eval_term| feature}
1146 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001148 *'balloonexpr'* *'bexpr'*
1149'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001150 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001151 {not in Vi}
1152 {only available when compiled with the |+balloon_eval|
1153 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001154 Expression for text to show in evaluation balloon. It is only used
1155 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156
1157 v:beval_bufnr number of the buffer in which balloon is going to show
1158 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001159 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001160 v:beval_lnum line number
1161 v:beval_col column number (byte index)
1162 v:beval_text word under or after the mouse pointer
1163
1164 The evaluation of the expression must not have side effects!
1165 Example: >
1166 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001167 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001168 \', column ' . v:beval_col .
1169 \ ' of file ' . bufname(v:beval_bufnr) .
1170 \ ' on word "' . v:beval_text . '"'
1171 endfunction
1172 set bexpr=MyBalloonExpr()
1173 set ballooneval
1174<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001175 Also see |balloon_show()|, can be used if the content of the balloon
1176 is to be fetched asynchronously.
1177
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001178 NOTE: The balloon is displayed only if the cursor is on a text
1179 character. If the result of evaluating 'balloonexpr' is not empty,
1180 Vim does not try to send a message to an external debugger (Netbeans
1181 or Sun Workshop).
1182
Bram Moolenaar30b65812012-07-12 22:01:11 +02001183 The expression will be evaluated in the |sandbox| when set from a
1184 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001185
1186 It is not allowed to change text or jump to another window while
1187 evaluating 'balloonexpr' |textlock|.
1188
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001189 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001190 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001191< When they are supported "\n" characters will start a new line. If the
1192 expression evaluates to a |List| this is equal to using each List item
1193 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001194 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001195
Bram Moolenaar165bc692015-07-21 17:53:25 +02001196 *'belloff'* *'bo'*
1197'belloff' 'bo' string (default "")
1198 global
1199 {not in Vi}
1200 Specifies for which events the bell will not be rung. It is a comma
1201 separated list of items. For each item that is present, the bell
1202 will be silenced. This is most useful to specify specific events in
1203 insert mode to be silenced.
1204
1205 item meaning when present ~
1206 all All events.
1207 backspace When hitting <BS> or <Del> and deleting results in an
1208 error.
1209 cursor Fail to move around using the cursor keys or
1210 <PageUp>/<PageDown> in |Insert-mode|.
1211 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1212 |i_CTRL-X_CTRL-T|.
1213 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1214 |i_CTRL-E|.
1215 ctrlg Unknown Char after <C-G> in Insert mode.
1216 error Other Error occurred (e.g. try to join last line)
1217 (mostly used in |Normal-mode| or |Cmdline-mode|).
1218 esc hitting <Esc> in |Normal-mode|.
1219 ex In |Visual-mode|, hitting |Q| results in an error.
1220 hangul Error occurred when using hangul input.
1221 insertmode Pressing <Esc> in 'insertmode'.
1222 lang Calling the beep module for Lua/Mzscheme/TCL.
1223 mess No output available for |g<|.
1224 showmatch Error occurred for 'showmatch' function.
1225 operator Empty region error |cpo-E|.
1226 register Unknown register after <C-R> in |Insert-mode|.
1227 shell Bell from shell output |:!|.
1228 spell Error happened on spell suggest.
1229 wildmode More matches in |cmdline-completion| available
1230 (depends on the 'wildmode' setting).
1231
Bram Moolenaar036986f2017-03-16 17:41:02 +01001232 This is most useful to fine tune when in Insert mode the bell should
1233 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001234 indicate that an error occurred. It can be silenced by adding the
1235 "error" keyword.
1236
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1238'binary' 'bin' boolean (default off)
1239 local to buffer
1240 {not in Vi}
1241 This option should be set before editing a binary file. You can also
1242 use the |-b| Vim argument. When this option is switched on a few
1243 options will be changed (also when it already was on):
1244 'textwidth' will be set to 0
1245 'wrapmargin' will be set to 0
1246 'modeline' will be off
1247 'expandtab' will be off
1248 Also, 'fileformat' and 'fileformats' options will not be used, the
1249 file is read and written like 'fileformat' was "unix" (a single <NL>
1250 separates lines).
1251 The 'fileencoding' and 'fileencodings' options will not be used, the
1252 file is read without conversion.
1253 NOTE: When you start editing a(nother) file while the 'bin' option is
1254 on, settings from autocommands may change the settings again (e.g.,
1255 'textwidth'), causing trouble when editing. You might want to set
1256 'bin' again when the file has been loaded.
1257 The previous values of these options are remembered and restored when
1258 'bin' is switched from on to off. Each buffer has its own set of
1259 saved option values.
1260 To edit a file with 'binary' set you can use the |++bin| argument.
1261 This avoids you have to do ":set bin", which would have effect for all
1262 files you edit.
1263 When writing a file the <EOL> for the last line is only written if
1264 there was one in the original file (normally Vim appends an <EOL> to
1265 the last line if there is none; this would make the file longer). See
1266 the 'endofline' option.
1267
1268 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1269'bioskey' 'biosk' boolean (default on)
1270 global
1271 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001272 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273
1274 *'bomb'* *'nobomb'*
1275'bomb' boolean (default off)
1276 local to buffer
1277 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278 When writing a file and the following conditions are met, a BOM (Byte
1279 Order Mark) is prepended to the file:
1280 - this option is on
1281 - the 'binary' option is off
1282 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1283 endian variants.
1284 Some applications use the BOM to recognize the encoding of the file.
1285 Often used for UCS-2 files on MS-Windows. For other applications it
1286 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001287 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1289 check for the presence of the BOM is done and 'bomb' set accordingly.
1290 Unless 'binary' is set, it is removed from the first line, so that you
1291 don't see it when editing. When you don't change the options, the BOM
1292 will be restored when writing the file.
1293
1294 *'breakat'* *'brk'*
1295'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1296 global
1297 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001298 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 feature}
1300 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001301 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1302 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001304 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305'breakindent' 'bri' boolean (default off)
1306 local to window
1307 {not in Vi}
1308 {not available when compiled without the |+linebreak|
1309 feature}
1310 Every wrapped line will continue visually indented (same amount of
1311 space as the beginning of that line), thus preserving horizontal blocks
1312 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001313 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001314
1315 *'breakindentopt'* *'briopt'*
1316'breakindentopt' 'briopt' string (default empty)
1317 local to window
1318 {not in Vi}
1319 {not available when compiled without the |+linebreak|
1320 feature}
1321 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001322 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001323 min:{n} Minimum text width that will be kept after
1324 applying 'breakindent', even if the resulting
1325 text should normally be narrower. This prevents
1326 text indented almost to the right window border
1327 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001328 shift:{n} After applying 'breakindent', the wrapped line's
1329 beginning will be shifted by the given number of
1330 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001331 indentation (negative) or emphasizing the line
1332 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001333 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001334 additional indent.
1335 The default value for min is 20 and shift is 0.
1336
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001338'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001340 {not in Vi} {only for Motif, Athena, GTK, Mac and
1341 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001343 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001344 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 buffer Use the directory of the related buffer.
1346 current Use the current directory.
1347 {path} Use the specified directory
1348
1349 *'bufhidden'* *'bh'*
1350'bufhidden' 'bh' string (default: "")
1351 local to buffer
1352 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 This option specifies what happens when a buffer is no longer
1354 displayed in a window:
1355 <empty> follow the global 'hidden' option
1356 hide hide the buffer (don't unload it), also when 'hidden'
1357 is not set
1358 unload unload the buffer, also when 'hidden' is set or using
1359 |:hide|
1360 delete delete the buffer from the buffer list, also when
1361 'hidden' is set or using |:hide|, like using
1362 |:bdelete|
1363 wipe wipe out the buffer from the buffer list, also when
1364 'hidden' is set or using |:hide|, like using
1365 |:bwipeout|
1366
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001367 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001368 are lost without a warning. Also, these values may break autocommands
1369 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 This option is used together with 'buftype' and 'swapfile' to specify
1371 special kinds of buffers. See |special-buffers|.
1372
1373 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1374'buflisted' 'bl' boolean (default: on)
1375 local to buffer
1376 {not in Vi}
1377 When this option is set, the buffer shows up in the buffer list. If
1378 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1379 This option is reset by Vim for buffers that are only used to remember
1380 a file name or marks. Vim sets it when starting to edit a buffer.
1381 But not when moving to a buffer with ":buffer".
1382
1383 *'buftype'* *'bt'* *E382*
1384'buftype' 'bt' string (default: "")
1385 local to buffer
1386 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 The value of this option specifies the type of a buffer:
1388 <empty> normal buffer
1389 nofile buffer which is not related to a file and will not be
1390 written
1391 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001392 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001393 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001395 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 help help buffer (you are not supposed to set this
1397 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001398 terminal buffer for a |terminal| (you are not supposed to set
1399 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001400 prompt buffer where only the last line can be edited, meant
1401 to be used by a plugin, see |prompt-buffer|
1402 {only when compiled with the |+channel| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 This option is used together with 'bufhidden' and 'swapfile' to
1405 specify special kinds of buffers. See |special-buffers|.
1406
1407 Be careful with changing this option, it can have many side effects!
1408
Bram Moolenaar280f1262006-01-30 00:14:18 +00001409 A "quickfix" buffer is only used for the error list and the location
1410 list. This value is set by the |:cwindow| and |:lwindow| commands and
1411 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001412
1413 "nofile" and "nowrite" buffers are similar:
1414 both: The buffer is not to be written to disk, ":w" doesn't
1415 work (":w filename" does work though).
1416 both: The buffer is never considered to be |'modified'|.
1417 There is no warning when the changes will be lost, for
1418 example when you quit Vim.
1419 both: A swap file is only created when using too much memory
1420 (when 'swapfile' has been reset there is never a swap
1421 file).
1422 nofile only: The buffer name is fixed, it is not handled like a
1423 file name. It is not modified in response to a |:cd|
1424 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001425 both: When using ":e bufname" and already editing "bufname"
1426 the buffer is made empty and autocommands are
1427 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001428 *E676*
1429 "acwrite" implies that the buffer name is not related to a file, like
1430 "nofile", but it will be written. Thus, in contrast to "nofile" and
1431 "nowrite", ":w" does work and a modified buffer can't be abandoned
1432 without saving. For writing there must be matching |BufWriteCmd|,
1433 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434
1435 *'casemap'* *'cmp'*
1436'casemap' 'cmp' string (default: "internal,keepascii")
1437 global
1438 {not in Vi}
1439 Specifies details about changing the case of letters. It may contain
1440 these words, separated by a comma:
1441 internal Use internal case mapping functions, the current
1442 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001443 matters when 'encoding' is a Unicode encoding,
1444 "latin1" or "iso-8859-15". When "internal" is
1445 omitted, the towupper() and towlower() system library
1446 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1448 case mapping, the current locale is not effective.
1449 This probably only matters for Turkish.
1450
1451 *'cdpath'* *'cd'* *E344* *E346*
1452'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1453 global
1454 {not in Vi}
1455 {not available when compiled without the
1456 |+file_in_path| feature}
1457 This is a list of directories which will be searched when using the
1458 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001459 for has a relative path, not an absolute part starting with "/", "./"
1460 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 The 'cdpath' option's value has the same form and semantics as
1462 |'path'|. Also see |file-searching|.
1463 The default value is taken from $CDPATH, with a "," prepended to look
1464 in the current directory first.
1465 If the default value taken from $CDPATH is not what you want, include
1466 a modified version of the following command in your vimrc file to
1467 override it: >
1468 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1469< This option cannot be set from a |modeline| or in the |sandbox|, for
1470 security reasons.
1471 (parts of 'cdpath' can be passed to the shell to expand file names).
1472
1473 *'cedit'*
1474'cedit' string (Vi default: "", Vim default: CTRL-F)
1475 global
1476 {not in Vi}
1477 {not available when compiled without the |+vertsplit|
1478 feature}
1479 The key used in Command-line Mode to open the command-line window.
1480 The default is CTRL-F when 'compatible' is off.
1481 Only non-printable keys are allowed.
1482 The key can be specified as a single character, but it is difficult to
1483 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001484 :exe "set cedit=\<C-Y>"
1485 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486< |Nvi| also has this option, but it only uses the first character.
1487 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001488 NOTE: This option is set to the Vim default value when 'compatible'
1489 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
1491 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1492'charconvert' 'ccv' string (default "")
1493 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001494 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 {not in Vi}
1496 An expression that is used for character encoding conversion. It is
1497 evaluated when a file that is to be read or has been written has a
1498 different encoding from what is desired.
1499 'charconvert' is not used when the internal iconv() function is
1500 supported and is able to do the conversion. Using iconv() is
1501 preferred, because it is much faster.
1502 'charconvert' is not used when reading stdin |--|, because there is no
1503 file to convert from. You will have to save the text in a file first.
1504 The expression must return zero or an empty string for success,
1505 non-zero for failure.
1506 The possible encoding names encountered are in 'encoding'.
1507 Additionally, names given in 'fileencodings' and 'fileencoding' are
1508 used.
1509 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1510 is done internally by Vim, 'charconvert' is not used for this.
1511 'charconvert' is also used to convert the viminfo file, if the 'c'
1512 flag is present in 'viminfo'. Also used for Unicode conversion.
1513 Example: >
1514 set charconvert=CharConvert()
1515 fun CharConvert()
1516 system("recode "
1517 \ . v:charconvert_from . ".." . v:charconvert_to
1518 \ . " <" . v:fname_in . " >" v:fname_out)
1519 return v:shell_error
1520 endfun
1521< The related Vim variables are:
1522 v:charconvert_from name of the current encoding
1523 v:charconvert_to name of the desired encoding
1524 v:fname_in name of the input file
1525 v:fname_out name of the output file
1526 Note that v:fname_in and v:fname_out will never be the same.
1527 Note that v:charconvert_from and v:charconvert_to may be different
1528 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1529 Encryption is not done by Vim when using 'charconvert'. If you want
1530 to encrypt the file after conversion, 'charconvert' should take care
1531 of this.
1532 This option cannot be set from a |modeline| or in the |sandbox|, for
1533 security reasons.
1534
1535 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1536'cindent' 'cin' boolean (default off)
1537 local to buffer
1538 {not in Vi}
1539 {not available when compiled without the |+cindent|
1540 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001541 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 that trigger reindenting in insert mode and 'cinoptions' to set your
1543 preferred indent style.
1544 If 'indentexpr' is not empty, it overrules 'cindent'.
1545 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1546 the "=" operator indents using this algorithm rather than calling an
1547 external program.
1548 See |C-indenting|.
1549 When you don't like the way 'cindent' works, try the 'smartindent'
1550 option or 'indentexpr'.
1551 This option is not used when 'paste' is set.
1552 NOTE: This option is reset when 'compatible' is set.
1553
1554 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001555'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 local to buffer
1557 {not in Vi}
1558 {not available when compiled without the |+cindent|
1559 feature}
1560 A list of keys that, when typed in Insert mode, cause reindenting of
1561 the current line. Only used if 'cindent' is on and 'indentexpr' is
1562 empty.
1563 For the format of this option see |cinkeys-format|.
1564 See |C-indenting|.
1565
1566 *'cinoptions'* *'cino'*
1567'cinoptions' 'cino' string (default "")
1568 local to buffer
1569 {not in Vi}
1570 {not available when compiled without the |+cindent|
1571 feature}
1572 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1573 program. See |cinoptions-values| for the values of this option, and
1574 |C-indenting| for info on C indenting in general.
1575
1576
1577 *'cinwords'* *'cinw'*
1578'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1579 local to buffer
1580 {not in Vi}
1581 {not available when compiled without both the
1582 |+cindent| and the |+smartindent| features}
1583 These keywords start an extra indent in the next line when
1584 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1585 an appropriate place (inside {}).
1586 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1587 matter, include the keyword both the uppercase and lowercase:
1588 "if,If,IF".
1589
1590 *'clipboard'* *'cb'*
1591'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1592 for X-windows, "" otherwise)
1593 global
1594 {not in Vi}
1595 {only in GUI versions or when the |+xterm_clipboard|
1596 feature is included}
1597 This option is a list of comma separated names.
1598 These names are recognized:
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 unnamed When included, Vim will use the clipboard register '*'
1602 for all yank, delete, change and put operations which
1603 would normally go to the unnamed register. When a
1604 register is explicitly specified, it will always be
1605 used regardless of whether "unnamed" is in 'clipboard'
1606 or not. The clipboard register can always be
1607 explicitly accessed using the "* notation. Also see
1608 |gui-clipboard|.
1609
Bram Moolenaar30b65812012-07-12 22:01:11 +02001610 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001611 unnamedplus A variant of the "unnamed" flag which uses the
1612 clipboard register '+' (|quoteplus|) instead of
1613 register '*' for all yank, delete, change and put
1614 operations which would normally go to the unnamed
1615 register. When "unnamed" is also included to the
1616 option, yank operations (but not delete, change or
1617 put) will additionally copy the text into register
1618 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001619 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001620 Availability can be checked with: >
1621 if has('unnamedplus')
1622<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001623 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 autoselect Works like the 'a' flag in 'guioptions': If present,
1625 then whenever Visual mode is started, or the Visual
1626 area extended, Vim tries to become the owner of the
1627 windowing system's global selection or put the
1628 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001629 register "*. See |'go-a'| and |quotestar| for details.
1630 When the GUI is active, the 'a' flag in 'guioptions'
1631 is used, when the GUI is not active, this "autoselect"
1632 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 Also applies to the modeless selection.
1634
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001635 *clipboard-autoselectplus*
1636 autoselectplus Like "autoselect" but using the + register instead of
1637 the * register. Compare to the 'P' flag in
1638 'guioptions'.
1639
1640 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 autoselectml Like "autoselect", but for the modeless selection
1642 only. Compare to the 'A' flag in 'guioptions'.
1643
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001644 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001645 html When the clipboard contains HTML, use this when
1646 pasting. When putting text on the clipboard, mark it
1647 as HTML. This works to copy rendered HTML from
1648 Firefox, paste it as raw HTML in Vim, select the HTML
1649 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001650 You probably want to add this only temporarily,
1651 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001652 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001653
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001654 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 exclude:{pattern}
1656 Defines a pattern that is matched against the name of
1657 the terminal 'term'. If there is a match, no
1658 connection will be made to the X server. This is
1659 useful in this situation:
1660 - Running Vim in a console.
1661 - $DISPLAY is set to start applications on another
1662 display.
1663 - You do not want to connect to the X server in the
1664 console, but do want this in a terminal emulator.
1665 To never connect to the X server use: >
1666 exclude:.*
1667< This has the same effect as using the |-X| argument.
1668 Note that when there is no connection to the X server
1669 the window title won't be restored and the clipboard
1670 cannot be accessed.
1671 The value of 'magic' is ignored, {pattern} is
1672 interpreted as if 'magic' was on.
1673 The rest of the option value will be used for
1674 {pattern}, this must be the last entry.
1675
1676 *'cmdheight'* *'ch'*
1677'cmdheight' 'ch' number (default 1)
1678 global
1679 {not in Vi}
1680 Number of screen lines to use for the command-line. Helps avoiding
1681 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001682 The value of this option is stored with the tab page, so that each tab
1683 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684
1685 *'cmdwinheight'* *'cwh'*
1686'cmdwinheight' 'cwh' number (default 7)
1687 global
1688 {not in Vi}
1689 {not available when compiled without the |+vertsplit|
1690 feature}
1691 Number of screen lines to use for the command-line window. |cmdwin|
1692
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001693 *'colorcolumn'* *'cc'*
1694'colorcolumn' 'cc' string (default "")
1695 local to window
1696 {not in Vi}
1697 {not available when compiled without the |+syntax|
1698 feature}
1699 'colorcolumn' is a comma separated list of screen columns that are
1700 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1701 text. Will make screen redrawing slower.
1702 The screen column can be an absolute number, or a number preceded with
1703 '+' or '-', which is added to or subtracted from 'textwidth'. >
1704
1705 :set cc=+1 " highlight column after 'textwidth'
1706 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1707 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1708<
1709 When 'textwidth' is zero then the items with '-' and '+' are not used.
1710 A maximum of 256 columns are highlighted.
1711
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 *'columns'* *'co'* *E594*
1713'columns' 'co' number (default 80 or terminal width)
1714 global
1715 {not in Vi}
1716 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001717 initialization and does not have to be set by hand. Also see
1718 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 When Vim is running in the GUI or in a resizable window, setting this
1720 option will cause the window size to be changed. When you only want
1721 to use the size for the GUI, put the command in your |gvimrc| file.
1722 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001723 number of columns of the display, the display may be messed up. For
1724 the GUI it is always possible and Vim limits the number of columns to
1725 what fits on the screen. You can use this command to get the widest
1726 window possible: >
1727 :set columns=9999
1728< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729
1730 *'comments'* *'com'* *E524* *E525*
1731'comments' 'com' string (default
1732 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1733 local to buffer
1734 {not in Vi}
1735 {not available when compiled without the |+comments|
1736 feature}
1737 A comma separated list of strings that can start a comment line. See
1738 |format-comments|. See |option-backslash| about using backslashes to
1739 insert a space.
1740
1741 *'commentstring'* *'cms'* *E537*
1742'commentstring' 'cms' string (default "/*%s*/")
1743 local to buffer
1744 {not in Vi}
1745 {not available when compiled without the |+folding|
1746 feature}
1747 A template for a comment. The "%s" in the value is replaced with the
1748 comment text. Currently only used to add markers for folding, see
1749 |fold-marker|.
1750
1751 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001752'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001753 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 global
1755 {not in Vi}
1756 This option has the effect of making Vim either more Vi-compatible, or
1757 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001758
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001760 other options are also changed as a side effect.
1761 NOTE: Setting or resetting this option can have a lot of unexpected
1762 effects: Mappings are interpreted in another way, undo behaves
1763 differently, etc. If you set this option in your vimrc file, you
1764 should probably put it at the very start.
1765
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 By default this option is on and the Vi defaults are used for the
1767 options. This default was chosen for those people who want to use Vim
1768 just like Vi, and don't even (want to) know about the 'compatible'
1769 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001770 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001771 this option is switched off, and all options that have not been
1772 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001773 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001774 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001775 happen for the system-wide vimrc or gvimrc file, nor for a file given
1776 with the |-u| argument). Also see |compatible-default| and
1777 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 You can also set this option with the "-C" argument, and reset it with
1779 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001780 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781
Bram Moolenaar214641f2017-03-05 17:04:09 +01001782 When this option is set, numerous other options are set to make Vim as
1783 Vi-compatible as possible. When this option is unset, various options
1784 are set to make Vim more useful. The table below lists all the
1785 options affected.
1786 The {?} column indicates when the options are affected:
1787 + Means that the option is set to the value given in {set value} when
1788 'compatible' is set.
1789 & Means that the option is set to the value given in {set value} when
1790 'compatible' is set AND is set to its Vim default value when
1791 'compatible' is unset.
1792 - Means the option is NOT changed when setting 'compatible' but IS
1793 set to its Vim default when 'compatible' is unset.
1794 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795
Bram Moolenaar036986f2017-03-16 17:41:02 +01001796 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001797
1798 'allowrevins' + off no CTRL-_ command
1799 'antialias' + off don't use antialiased fonts
1800 'arabic' + off reset arabic-related options
1801 'arabicshape' + on correct character shapes
1802 'backspace' + "" normal backspace
1803 'backup' + off no backup file
1804 'backupcopy' & Unix: "yes" backup file is a copy
1805 else: "auto" copy or rename backup file
1806 'balloonexpr' + "" text to show in evaluation balloon
1807 'breakindent' + off don't indent when wrapping lines
1808 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1809 'cindent' + off no C code indentation
1810 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1811 'copyindent' + off don't copy indent structure
1812 'cpoptions' & (all flags) Vi-compatible flags
1813 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001814 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001815 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001816 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001817 'cscopeverbose' + off see |cscopeverbose|
1818 'delcombine' + off unicode: delete whole char combination
1819 'digraph' + off no digraphs
1820 'esckeys' & off no <Esc>-keys in Insert mode
1821 'expandtab' + off tabs not expanded to spaces
1822 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001824 'formatexpr' + "" use 'formatprg' for auto-formatting
1825 'formatoptions' & "vt" Vi compatible formatting
1826 'gdefault' + off no default 'g' flag for ":s"
1827 'history' & 0 no commandline history
1828 'hkmap' + off no Hebrew keyboard mapping
1829 'hkmapp' + off no phonetic Hebrew keyboard mapping
1830 'hlsearch' + off no highlighting of search matches
1831 'incsearch' + off no incremental searching
1832 'indentexpr' + "" no indenting by expression
1833 'insertmode' + off do not start in Insert mode
1834 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001836 'joinspaces' + on insert 2 spaces after period
1837 'modeline' & off no modelines
1838 'more' & off no pauses in listings
1839 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1840 'numberwidth' & 8 min number of columns for line number
1841 'preserveindent'+ off don't preserve current indent structure
1842 when changing it
1843 'revins' + off no reverse insert
1844 'ruler' + off no ruler
1845 'scrolljump' + 1 no jump scroll
1846 'scrolloff' + 0 no scroll offset
1847 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1848 'shiftround' + off indent not rounded to shiftwidth
1849 'shortmess' & "" no shortening of messages
1850 'showcmd' & off command characters not shown
1851 'showmode' & off current mode not shown
1852 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1853 'smartcase' + off no automatic ignore case switch
1854 'smartindent' + off no smart indentation
1855 'smarttab' + off no smart tab size
1856 'softtabstop' + 0 tabs are always 'tabstop' positions
1857 'startofline' + on goto startofline with some commands
1858 'tagcase' & "followic" 'ignorecase' when searching tags file
1859 'tagrelative' & off tag file names are not relative
1860 'termguicolors' + off don't use highlight-(guifg|guibg)
1861 'textauto' & off no automatic textmode detection
1862 'textwidth' + 0 no automatic line wrap
1863 'tildeop' + off tilde is not an operator
1864 'ttimeout' + off no terminal timeout
1865 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001866 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001867 'virtualedit' + "" cursor can only be placed on characters
1868 'whichwrap' & "" left-right movements don't wrap
1869 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001871 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872
1873 *'complete'* *'cpt'* *E535*
1874'complete' 'cpt' string (default: ".,w,b,u,t,i")
1875 local to buffer
1876 {not in Vi}
1877 This option specifies how keyword completion |ins-completion| works
1878 when CTRL-P or CTRL-N are used. It is also used for whole-line
1879 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1880 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001881 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 w scan buffers from other windows
1883 b scan other loaded buffers that are in the buffer list
1884 u scan the unloaded buffers that are in the buffer list
1885 U scan the buffers that are not in the buffer list
1886 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001887 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 k{dict} scan the file {dict}. Several "k" flags can be given,
1889 patterns are valid too. For example: >
1890 :set cpt=k/usr/dict/*,k~/spanish
1891< s scan the files given with the 'thesaurus' option
1892 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1893 are valid too.
1894 i scan current and included files
1895 d scan current and included files for defined name or macro
1896 |i_CTRL-X_CTRL-D|
1897 ] tag completion
1898 t same as "]"
1899
1900 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1901 not executed, this may lead to unexpected completions from some files
1902 (gzipped files for example). Unloaded buffers are not scanned for
1903 whole-line completion.
1904
1905 The default is ".,w,b,u,t,i", which means to scan:
1906 1. the current buffer
1907 2. buffers in other windows
1908 3. other loaded buffers
1909 4. unloaded buffers
1910 5. tags
1911 6. included files
1912
1913 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001914 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1915 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001917 *'completefunc'* *'cfu'*
1918'completefunc' 'cfu' string (default: empty)
1919 local to buffer
1920 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001921 {not available when compiled without the |+eval|
1922 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001923 This option specifies a function to be used for Insert mode completion
1924 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001925 See |complete-functions| for an explanation of how the function is
1926 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001927 This option cannot be set from a |modeline| or in the |sandbox|, for
1928 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001929
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001930 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001931'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001932 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001933 {not available when compiled without the
1934 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001935 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001936 A comma separated list of options for Insert mode completion
1937 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001938
1939 menu Use a popup menu to show the possible completions. The
1940 menu is only shown when there is more than one match and
1941 sufficient colors are available. |ins-completion-menu|
1942
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001943 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001944 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001945 match, e.g., what file it comes from.
1946
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001947 longest Only insert the longest common text of the matches. If
1948 the menu is displayed you can use CTRL-L to add more
1949 characters. Whether case is ignored depends on the kind
1950 of completion. For buffer text the 'ignorecase' option is
1951 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001952
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001953 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001954 completion in the preview window. Only works in
1955 combination with "menu" or "menuone".
1956
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001957 noinsert Do not insert any text for a match until the user selects
1958 a match from the menu. Only works in combination with
1959 "menu" or "menuone". No effect if "longest" is present.
1960
1961 noselect Do not select a match in the menu, force the user to
1962 select one from the menu. Only works in combination with
1963 "menu" or "menuone".
1964
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001965
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001966 *'concealcursor'* *'cocu'*
1967'concealcursor' 'cocu' string (default: "")
1968 local to window
1969 {not in Vi}
1970 {not available when compiled without the |+conceal|
1971 feature}
1972 Sets the modes in which text in the cursor line can also be concealed.
1973 When the current mode is listed then concealing happens just like in
1974 other lines.
1975 n Normal mode
1976 v Visual mode
1977 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001978 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001980 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001981 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001982 are moving around text is concealed, but when starting to insert text
1983 or selecting a Visual area the concealed text is displayed, so that
1984 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001985 Keep in mind that the cursor position is not always where it's
1986 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001987
1988
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001989 *'conceallevel'* *'cole'*
1990'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001991 local to window
1992 {not in Vi}
1993 {not available when compiled without the |+conceal|
1994 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001995 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1996 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001997
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001998 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001999 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02002000 1 Each block of concealed text is replaced with one
2001 character. If the syntax item does not have a custom
2002 replacement character defined (see |:syn-cchar|) the
2003 character defined in 'listchars' is used (default is a
2004 space).
2005 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002006 2 Concealed text is completely hidden unless it has a
2007 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002008 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002009 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002010
Bram Moolenaara7781e02010-07-19 20:13:22 +02002011 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002012 edit and copy the text. This can be changed with the 'concealcursor'
2013 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002014
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2016'confirm' 'cf' boolean (default off)
2017 global
2018 {not in Vi}
2019 When 'confirm' is on, certain operations that would normally
2020 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2021 instead raise a |dialog| asking if you wish to save the current
2022 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2023 If 'confirm' is off you can still activate confirmation for one
2024 command only (this is most useful in mappings) with the |:confirm|
2025 command.
2026 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2027
2028 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2029'conskey' 'consk' boolean (default off)
2030 global
2031 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002032 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033
2034 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2035'copyindent' 'ci' boolean (default off)
2036 local to buffer
2037 {not in Vi}
2038 Copy the structure of the existing lines indent when autoindenting a
2039 new line. Normally the new indent is reconstructed by a series of
2040 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2041 in which case only spaces are used). Enabling this option makes the
2042 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002043 existing line. 'expandtab' has no effect on these characters, a Tab
2044 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002046 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 Also see 'preserveindent'.
2048
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002049 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050'cpoptions' 'cpo' string (Vim default: "aABceFs",
2051 Vi default: all flags)
2052 global
2053 {not in Vi}
2054 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002055 this indicates Vi-compatible behavior. This is used for things where
2056 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 'cpoptions' stands for "compatible-options".
2058 Commas can be added for readability.
2059 To avoid problems with flags that are added in the future, use the
2060 "+=" and "-=" feature of ":set" |add-option-flags|.
2061 NOTE: This option is set to the Vi default value when 'compatible' is
2062 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002063 NOTE: This option is set to the POSIX default value at startup when
2064 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002065 variable exists |posix|. This means Vim tries to behave like the
2066 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067
2068 contains behavior ~
2069 *cpo-a*
2070 a When included, a ":read" command with a file name
2071 argument will set the alternate file name for the
2072 current window.
2073 *cpo-A*
2074 A When included, a ":write" command with a file name
2075 argument will set the alternate file name for the
2076 current window.
2077 *cpo-b*
2078 b "\|" in a ":map" command is recognized as the end of
2079 the map command. The '\' is included in the mapping,
2080 the text after the '|' is interpreted as the next
2081 command. Use a CTRL-V instead of a backslash to
2082 include the '|' in the mapping. Applies to all
2083 mapping, abbreviation, menu and autocmd commands.
2084 See also |map_bar|.
2085 *cpo-B*
2086 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002087 abbreviations, user commands and the "to" part of the
2088 menu commands. Remove this flag to be able to use a
2089 backslash like a CTRL-V. For example, the command
2090 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 'B' included: "\^[" (^[ is a real <Esc>)
2092 'B' excluded: "<Esc>" (5 characters)
2093 ('<' excluded in both cases)
2094 *cpo-c*
2095 c Searching continues at the end of any match at the
2096 cursor position, but not further than the start of the
2097 next line. When not present searching continues
2098 one character from the cursor position. With 'c'
2099 "abababababab" only gets three matches when repeating
2100 "/abab", without 'c' there are five matches.
2101 *cpo-C*
2102 C Do not concatenate sourced lines that start with a
2103 backslash. See |line-continuation|.
2104 *cpo-d*
2105 d Using "./" in the 'tags' option doesn't mean to use
2106 the tags file relative to the current file, but the
2107 tags file in the current directory.
2108 *cpo-D*
2109 D Can't use CTRL-K to enter a digraph after Normal mode
2110 commands with a character argument, like |r|, |f| and
2111 |t|.
2112 *cpo-e*
2113 e When executing a register with ":@r", always add a
2114 <CR> to the last line, also when the register is not
2115 linewise. If this flag is not present, the register
2116 is not linewise and the last line does not end in a
2117 <CR>, then the last line is put on the command-line
2118 and can be edited before hitting <CR>.
2119 *cpo-E*
2120 E It is an error when using "y", "d", "c", "g~", "gu" or
2121 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002122 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 This makes "y0" fail in the first column.
2124 *cpo-f*
2125 f When included, a ":read" command with a file name
2126 argument will set the file name for the current buffer,
2127 if the current buffer doesn't have a file name yet.
2128 *cpo-F*
2129 F When included, a ":write" command with a file name
2130 argument will set the file name for the current
2131 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002132 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-g*
2134 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002135 *cpo-H*
2136 H When using "I" on a line with only blanks, insert
2137 before the last blank. Without this flag insert after
2138 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 *cpo-i*
2140 i When included, interrupting the reading of a file will
2141 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002142 *cpo-I*
2143 I When moving the cursor up or down just after inserting
2144 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 *cpo-j*
2146 j When joining lines, only add two spaces after a '.',
2147 not after '!' or '?'. Also see 'joinspaces'.
2148 *cpo-J*
2149 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002150 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 white space.
2152 *cpo-k*
2153 k Disable the recognition of raw key codes in
2154 mappings, abbreviations, and the "to" part of menu
2155 commands. For example, if <Key> sends ^[OA (where ^[
2156 is <Esc>), the command ":map X ^[OA" results in X
2157 being mapped to:
2158 'k' included: "^[OA" (3 characters)
2159 'k' excluded: "<Key>" (one key code)
2160 Also see the '<' flag below.
2161 *cpo-K*
2162 K Don't wait for a key code to complete when it is
2163 halfway a mapping. This breaks mapping <F1><F1> when
2164 only part of the second <F1> has been read. It
2165 enables cancelling the mapping by typing <F1><Esc>.
2166 *cpo-l*
2167 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002168 literally, only "\]", "\^", "\-" and "\\" are special.
2169 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2171 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002172 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002173 *cpo-L*
2174 L When the 'list' option is set, 'wrapmargin',
2175 'textwidth', 'softtabstop' and Virtual Replace mode
2176 (see |gR|) count a <Tab> as two characters, instead of
2177 the normal behavior of a <Tab>.
2178 *cpo-m*
2179 m When included, a showmatch will always wait half a
2180 second. When not included, a showmatch will wait half
2181 a second or until a character is typed. |'showmatch'|
2182 *cpo-M*
2183 M When excluded, "%" matching will take backslashes into
2184 account. Thus in "( \( )" and "\( ( \)" the outer
2185 parenthesis match. When included "%" ignores
2186 backslashes, which is Vi compatible.
2187 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002188 n When included, the column used for 'number' and
2189 'relativenumber' will also be used for text of wrapped
2190 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 *cpo-o*
2192 o Line offset to search command is not remembered for
2193 next search.
2194 *cpo-O*
2195 O Don't complain if a file is being overwritten, even
2196 when it didn't exist when editing it. This is a
2197 protection against a file unexpectedly created by
2198 someone else. Vi didn't complain about this.
2199 *cpo-p*
2200 p Vi compatible Lisp indenting. When not present, a
2201 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002202 *cpo-P*
2203 P When included, a ":write" command that appends to a
2204 file will set the file name for the current buffer, if
2205 the current buffer doesn't have a file name yet and
2206 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002207 *cpo-q*
2208 q When joining multiple lines leave the cursor at the
2209 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002210 *cpo-r*
2211 r Redo ("." command) uses "/" to repeat a search
2212 command, instead of the actually used search string.
2213 *cpo-R*
2214 R Remove marks from filtered lines. Without this flag
2215 marks are kept like |:keepmarks| was used.
2216 *cpo-s*
2217 s Set buffer options when entering the buffer for the
2218 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002219 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 set when the buffer is created.
2221 *cpo-S*
2222 S Set buffer options always when entering a buffer
2223 (except 'readonly', 'fileformat', 'filetype' and
2224 'syntax'). This is the (most) Vi compatible setting.
2225 The options are set to the values in the current
2226 buffer. When you change an option and go to another
2227 buffer, the value is copied. Effectively makes the
2228 buffer options global to all buffers.
2229
2230 's' 'S' copy buffer options
2231 no no when buffer created
2232 yes no when buffer first entered (default)
2233 X yes each time when buffer entered (vi comp.)
2234 *cpo-t*
2235 t Search pattern for the tag command is remembered for
2236 "n" command. Otherwise Vim only puts the pattern in
2237 the history for search pattern, but doesn't change the
2238 last used search pattern.
2239 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002240 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 *cpo-v*
2242 v Backspaced characters remain visible on the screen in
2243 Insert mode. Without this flag the characters are
2244 erased from the screen right away. With this flag the
2245 screen newly typed text overwrites backspaced
2246 characters.
2247 *cpo-w*
2248 w When using "cw" on a blank character, only change one
2249 character and not all blanks until the start of the
2250 next word.
2251 *cpo-W*
2252 W Don't overwrite a readonly file. When omitted, ":w!"
2253 overwrites a readonly file, if possible.
2254 *cpo-x*
2255 x <Esc> on the command-line executes the command-line.
2256 The default in Vim is to abandon the command-line,
2257 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002258 *cpo-X*
2259 X When using a count with "R" the replaced text is
2260 deleted only once. Also when repeating "R" with "."
2261 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002263 y A yank command can be redone with ".". Think twice if
2264 you really want to use this, it may break some
2265 plugins, since most people expect "." to only repeat a
2266 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002267 *cpo-Z*
2268 Z When using "w!" while the 'readonly' option is set,
2269 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 *cpo-!*
2271 ! When redoing a filter command, use the last used
2272 external command, whatever it was. Otherwise the last
2273 used -filter- command is used.
2274 *cpo-$*
2275 $ When making a change to one line, don't redisplay the
2276 line, but put a '$' at the end of the changed text.
2277 The changed text will be overwritten when you type the
2278 new text. The line is redisplayed if you type any
2279 command that moves the cursor from the insertion
2280 point.
2281 *cpo-%*
2282 % Vi-compatible matching is done for the "%" command.
2283 Does not recognize "#if", "#endif", etc.
2284 Does not recognize "/*" and "*/".
2285 Parens inside single and double quotes are also
2286 counted, causing a string that contains a paren to
2287 disturb the matching. For example, in a line like
2288 "if (strcmp("foo(", s))" the first paren does not
2289 match the last one. When this flag is not included,
2290 parens inside single and double quotes are treated
2291 specially. When matching a paren outside of quotes,
2292 everything inside quotes is ignored. When matching a
2293 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002294 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002295 This flag is also used for other features, such as
2296 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002297 *cpo--*
2298 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002299 it would go above the first line or below the last
2300 line. Without it the cursor moves to the first or
2301 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002302 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002303 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002304 *cpo-+*
2305 + When included, a ":write file" command will reset the
2306 'modified' flag of the buffer, even though the buffer
2307 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002308 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 * Use ":*" in the same way as ":@". When not included,
2310 ":*" is an alias for ":'<,'>", select the Visual area.
2311 *cpo-<*
2312 < Disable the recognition of special key codes in |<>|
2313 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002314 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 ":map X <Tab>" results in X being mapped to:
2316 '<' included: "<Tab>" (5 characters)
2317 '<' excluded: "^I" (^I is a real <Tab>)
2318 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002319 *cpo->*
2320 > When appending to a register, put a line break before
2321 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002322 *cpo-;*
2323 ; When using |,| or |;| to repeat the last |t| search
2324 and the cursor is right in front of the searched
2325 character, the cursor won't move. When not included,
2326 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002327 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328
2329 POSIX flags. These are not included in the Vi default value, except
2330 when $VIM_POSIX was set on startup. |posix|
2331
2332 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002333 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002334 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002335 *cpo-&*
2336 & When ":preserve" was used keep the swap file when
2337 exiting normally while this buffer is still loaded.
2338 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002339 *cpo-\*
2340 \ Backslash in a [] range in a search pattern is taken
2341 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002342 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2343 '\' excluded: "/[ \-]" finds <Space> and '-'
2344 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002345 *cpo-/*
2346 / When "%" is used as the replacement string in a |:s|
2347 command, use the previous replacement string. |:s%|
2348 *cpo-{*
2349 { The |{| and |}| commands also stop at a "{" character
2350 at the start of a line.
2351 *cpo-.*
2352 . The ":chdir" and ":cd" commands fail if the current
2353 buffer is modified, unless ! is used. Vim doesn't
2354 need this, since it remembers the full path of an
2355 opened file.
2356 *cpo-bar*
2357 | The value of the $LINES and $COLUMNS environment
2358 variables overrule the terminal size values obtained
2359 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002360
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002362 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002363'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002364 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002365 {not in Vi}
2366 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002367 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002368 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002369 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002370 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002371 blowfish Blowfish method. Medium strong encryption but it has
2372 an implementation flaw. Requires Vim 7.3 or later,
2373 files can NOT be read by Vim 7.2 and older. This adds
2374 a "seed" to the file, every time you write the file
2375 the encrypted bytes will be different.
2376 *blowfish2*
2377 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002378 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002379 and older. This adds a "seed" to the file, every time
2380 you write the file the encrypted bytes will be
2381 different. The whole undo file is encrypted, not just
2382 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002383
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002384 You should use "blowfish2", also to re-encrypt older files.
2385
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002386 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002387 to the detected method of the file being read. Thus if you write it
2388 without changing 'cryptmethod' the same method will be used.
2389 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002390 explicitly write it, you don't get a warning unless there are other
2391 modifications. Also see |:X|.
2392
2393 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002394 the value "blowfish2". When setting the local value to an empty
2395 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002396
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002397 When a new encryption method is added in a later version of Vim, and
2398 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002399 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002400
2401
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 *'cscopepathcomp'* *'cspc'*
2403'cscopepathcomp' 'cspc' number (default 0)
2404 global
2405 {not available when compiled without the |+cscope|
2406 feature}
2407 {not in Vi}
2408 Determines how many components of the path to show in a list of tags.
2409 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002410 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411
2412 *'cscopeprg'* *'csprg'*
2413'cscopeprg' 'csprg' string (default "cscope")
2414 global
2415 {not available when compiled without the |+cscope|
2416 feature}
2417 {not in Vi}
2418 Specifies the command to execute cscope. See |cscopeprg|.
2419 This option cannot be set from a |modeline| or in the |sandbox|, for
2420 security reasons.
2421
2422 *'cscopequickfix'* *'csqf'*
2423'cscopequickfix' 'csqf' string (default "")
2424 global
2425 {not available when compiled without the |+cscope|
2426 or |+quickfix| features}
2427 {not in Vi}
2428 Specifies whether to use quickfix window to show cscope results.
2429 See |cscopequickfix|.
2430
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002431 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002432'cscoperelative' 'csre' boolean (default off)
2433 global
2434 {not available when compiled without the |+cscope|
2435 feature}
2436 {not in Vi}
2437 In the absence of a prefix (-P) for cscope. setting this option enables
2438 to use the basename of cscope.out path as the prefix.
2439 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002440 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002441
Bram Moolenaar071d4272004-06-13 20:20:40 +00002442 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2443'cscopetag' 'cst' boolean (default off)
2444 global
2445 {not available when compiled without the |+cscope|
2446 feature}
2447 {not in Vi}
2448 Use cscope for tag commands. See |cscope-options|.
2449 NOTE: This option is reset when 'compatible' is set.
2450
2451 *'cscopetagorder'* *'csto'*
2452'cscopetagorder' 'csto' number (default 0)
2453 global
2454 {not available when compiled without the |+cscope|
2455 feature}
2456 {not in Vi}
2457 Determines the order in which ":cstag" performs a search. See
2458 |cscopetagorder|.
2459 NOTE: This option is set to 0 when 'compatible' is set.
2460
2461 *'cscopeverbose'* *'csverb'*
2462 *'nocscopeverbose'* *'nocsverb'*
2463'cscopeverbose' 'csverb' boolean (default off)
2464 global
2465 {not available when compiled without the |+cscope|
2466 feature}
2467 {not in Vi}
2468 Give messages when adding a cscope database. See |cscopeverbose|.
2469 NOTE: This option is reset when 'compatible' is set.
2470
Bram Moolenaar860cae12010-06-05 23:22:07 +02002471 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2472'cursorbind' 'crb' boolean (default off)
2473 local to window
2474 {not in Vi}
Bram Moolenaar860cae12010-06-05 23:22:07 +02002475 When this option is set, as the cursor in the current
2476 window moves other cursorbound windows (windows that also have
2477 this option set) move their cursors to the corresponding line and
2478 column. This option is useful for viewing the
2479 differences between two versions of a file (see 'diff'); in diff mode,
2480 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002481 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002482
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002483
2484 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2485'cursorcolumn' 'cuc' boolean (default off)
2486 local to window
2487 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002488 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002489 feature}
2490 Highlight the screen column of the cursor with CursorColumn
2491 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2492 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002493 If you only want the highlighting in the current window you can use
2494 these autocommands: >
2495 au WinLeave * set nocursorline nocursorcolumn
2496 au WinEnter * set cursorline cursorcolumn
2497<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002498
2499 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2500'cursorline' 'cul' boolean (default off)
2501 local to window
2502 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002503 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002504 feature}
2505 Highlight the screen line of the cursor with CursorLine
2506 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2507 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002508 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002509 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002510
2511
Bram Moolenaar071d4272004-06-13 20:20:40 +00002512 *'debug'*
2513'debug' string (default "")
2514 global
2515 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002516 These values can be used:
2517 msg Error messages that would otherwise be omitted will be given
2518 anyway.
2519 throw Error messages that would otherwise be omitted will be given
2520 anyway and also throw an exception and set |v:errmsg|.
2521 beep A message will be given when otherwise only a beep would be
2522 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002523 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002524 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2525 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526
2527 *'define'* *'def'*
2528'define' 'def' string (default "^\s*#\s*define")
2529 global or local to buffer |global-local|
2530 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002531 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 pattern, just like for the "/" command. This option is used for the
2533 commands like "[i" and "[d" |include-search|. The 'isident' option is
2534 used to recognize the defined name after the match:
2535 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2536 See |option-backslash| about inserting backslashes to include a space
2537 or backslash.
2538 The default value is for C programs. For C++ this value would be
2539 useful, to include const type declarations: >
2540 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2541< When using the ":set" command, you need to double the backslashes!
2542
2543 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2544'delcombine' 'deco' boolean (default off)
2545 global
2546 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 If editing Unicode and this option is set, backspace and Normal mode
2548 "x" delete each combining character on its own. When it is off (the
2549 default) the character along with its combining characters are
2550 deleted.
2551 Note: When 'delcombine' is set "xx" may work different from "2x"!
2552
2553 This is useful for Arabic, Hebrew and many other languages where one
2554 may have combining characters overtop of base characters, and want
2555 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002556 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557
2558 *'dictionary'* *'dict'*
2559'dictionary' 'dict' string (default "")
2560 global or local to buffer |global-local|
2561 {not in Vi}
2562 List of file names, separated by commas, that are used to lookup words
2563 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2564 contain a list of words. This can be one word per line, or several
2565 words per line, separated by non-keyword characters (white space is
2566 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002567
2568 When this option is empty or an entry "spell" is present, and spell
2569 checking is enabled, words in the word lists for the currently active
2570 'spelllang' are used. See |spell|.
2571
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 after a comma are ignored, otherwise spaces are included in the file
2574 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002575 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 Where to find a list of words?
2577 - On FreeBSD, there is the file "/usr/share/dict/words".
2578 - In the Simtel archive, look in the "msdos/linguist" directory.
2579 - In "miscfiles" of the GNU collection.
2580 The use of |:set+=| and |:set-=| is preferred when adding or removing
2581 directories from the list. This avoids problems when a future version
2582 uses another default.
2583 Backticks cannot be used in this option for security reasons.
2584
2585 *'diff'* *'nodiff'*
2586'diff' boolean (default off)
2587 local to window
2588 {not in Vi}
2589 {not available when compiled without the |+diff|
2590 feature}
2591 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002592 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 *'dex'* *'diffexpr'*
2595'diffexpr' 'dex' string (default "")
2596 global
2597 {not in Vi}
2598 {not available when compiled without the |+diff|
2599 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002600 Expression which is evaluated to obtain a diff file (either ed-style
2601 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 This option cannot be set from a |modeline| or in the |sandbox|, for
2603 security reasons.
2604
2605 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002606'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 global
2608 {not in Vi}
2609 {not available when compiled without the |+diff|
2610 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002611 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 All are optional. Items must be separated by a comma.
2613
2614 filler Show filler lines, to keep the text
2615 synchronized with a window that has inserted
2616 lines at the same position. Mostly useful
2617 when windows are side-by-side and 'scrollbind'
2618 is set.
2619
2620 context:{n} Use a context of {n} lines between a change
2621 and a fold that contains unchanged lines.
2622 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002623 When using zero the context is actually one,
2624 since folds require a line in between, also
2625 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 See |fold-diff|.
2627
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002628 iblank Ignore changes where lines are all blank. Adds
2629 the "-B" flag to the "diff" command if
2630 'diffexpr' is empty. Check the documentation
2631 of the "diff" command for what this does
2632 exactly.
2633 NOTE: the diff windows will get out of sync,
2634 because no differences between blank lines are
2635 taken into account.
2636
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 icase Ignore changes in case of text. "a" and "A"
2638 are considered the same. Adds the "-i" flag
2639 to the "diff" command if 'diffexpr' is empty.
2640
2641 iwhite Ignore changes in amount of white space. Adds
2642 the "-b" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly. It should ignore adding trailing
2646 white space, but not leading white space.
2647
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002648 iwhiteall Ignore all white space changes. Adds
2649 the "-w" flag to the "diff" command if
2650 'diffexpr' is empty. Check the documentation
2651 of the "diff" command for what this does
2652 exactly.
2653
2654 iwhiteeol Ignore white space changes at end of line.
2655 Adds the "-Z" flag to the "diff" command if
2656 'diffexpr' is empty. Check the documentation
2657 of the "diff" command for what this does
2658 exactly.
2659
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002660 horizontal Start diff mode with horizontal splits (unless
2661 explicitly specified otherwise).
2662
2663 vertical Start diff mode with vertical splits (unless
2664 explicitly specified otherwise).
2665
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002666 hiddenoff Do not use diff mode for a buffer when it
2667 becomes hidden.
2668
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002669 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2670 starting diff mode. Without this 2 is used.
2671
Bram Moolenaare828b762018-09-10 17:51:58 +02002672 internal Use the internal diff library. This is
2673 ignored when 'diffexpr' is set. *E960*
2674 When running out of memory when writing a
2675 buffer this item will be ignored for diffs
2676 involving that buffer. Set the 'verbose'
2677 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678
Bram Moolenaare828b762018-09-10 17:51:58 +02002679 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002680 Use the indent heuristic for the internal
2681 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002682
2683 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002684 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002685 algorithms are:
2686 myers the default algorithm
2687 minimal spend extra time to generate the
2688 smallest possible diff
2689 patience patience diff algorithm
2690 histogram histogram diff algorithm
2691
2692 Examples: >
2693 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002695 :set diffopt=internal,filler,foldcolumn:3
2696 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697<
2698 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2699'digraph' 'dg' boolean (default off)
2700 global
2701 {not in Vi}
2702 {not available when compiled without the |+digraphs|
2703 feature}
2704 Enable the entering of digraphs in Insert mode with {char1} <BS>
2705 {char2}. See |digraphs|.
2706 NOTE: This option is reset when 'compatible' is set.
2707
2708 *'directory'* *'dir'*
2709'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002710 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 for Unix: ".,~/tmp,/var/tmp,/tmp")
2712 global
2713 List of directory names for the swap file, separated with commas.
2714 - The swap file will be created in the first directory where this is
2715 possible.
2716 - Empty means that no swap file will be used (recovery is
2717 impossible!).
2718 - A directory "." means to put the swap file in the same directory as
2719 the edited file. On Unix, a dot is prepended to the file name, so
2720 it doesn't show in a directory listing. On MS-Windows the "hidden"
2721 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002722 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 put the swap file relative to where the edited file is. The leading
2724 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002725 - For Unix and Win32, if a directory ends in two path separators "//",
2726 the swap file name will be built from the complete path to the file
2727 with all path separators substituted to percent '%' signs. This will
2728 ensure file name uniqueness in the preserve directory.
2729 On Win32, it is also possible to end with "\\". However, When a
2730 separating comma is following, you must use "//", since "\\" will
2731 include the comma in the file name. Therefore it is recommended to
2732 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 - Spaces after the comma are ignored, other spaces are considered part
2734 of the directory name. To have a space at the start of a directory
2735 name, precede it with a backslash.
2736 - To include a comma in a directory name precede it with a backslash.
2737 - A directory name may end in an ':' or '/'.
2738 - Environment variables are expanded |:set_env|.
2739 - Careful with '\' characters, type one before a space, type two to
2740 get one in the option (see |option-backslash|), for example: >
2741 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2742< - For backwards compatibility with Vim version 3.0 a '>' at the start
2743 of the option is removed.
2744 Using "." first in the list is recommended. This means that editing
2745 the same file twice will result in a warning. Using "/tmp" on Unix is
2746 discouraged: When the system crashes you lose the swap file.
2747 "/var/tmp" is often not cleared when rebooting, thus is a better
2748 choice than "/tmp". But it can contain a lot of files, your swap
2749 files get lost in the crowd. That is why a "tmp" directory in your
2750 home directory is tried first.
2751 The use of |:set+=| and |:set-=| is preferred when adding or removing
2752 directories from the list. This avoids problems when a future version
2753 uses another default.
2754 This option cannot be set from a |modeline| or in the |sandbox|, for
2755 security reasons.
2756 {Vi: directory to put temp file in, defaults to "/tmp"}
2757
2758 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002759'display' 'dy' string (default "", set to "truncate" in
2760 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 global
2762 {not in Vi}
2763 Change the way text is displayed. This is comma separated list of
2764 flags:
2765 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002766 in a window will be displayed. "@@@" is put in the
2767 last columns of the last screen line to indicate the
2768 rest of the line is not displayed.
2769 truncate Like "lastline", but "@@@" is displayed in the first
2770 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 uhex Show unprintable characters hexadecimal as <xx>
2772 instead of using ^C and ~C.
2773
Bram Moolenaard0796902016-09-16 20:02:31 +02002774 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002775 doesn't fit is replaced with "@" lines.
2776
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 *'eadirection'* *'ead'*
2778'eadirection' 'ead' string (default "both")
2779 global
2780 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002781 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 feature}
2783 Tells when the 'equalalways' option applies:
2784 ver vertically, width of windows is not affected
2785 hor horizontally, height of windows is not affected
2786 both width and height of windows is affected
2787
2788 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2789'edcompatible' 'ed' boolean (default off)
2790 global
2791 Makes the 'g' and 'c' flags of the ":substitute" command to be
2792 toggled each time the flag is given. See |complex-change|. See
2793 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002794 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
Bram Moolenaar03413f42016-04-12 21:07:15 +02002796 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002797'emoji' 'emo' boolean (default: on)
2798 global
2799 {not in Vi}
Bram Moolenaar3848e002016-03-19 18:42:29 +01002800 When on all Unicode emoji characters are considered to be full width.
2801
2802
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 *'encoding'* *'enc'* *E543*
2804'encoding' 'enc' string (default: "latin1" or value from $LANG)
2805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 {not in Vi}
2807 Sets the character encoding used inside Vim. It applies to text in
2808 the buffers, registers, Strings in expressions, text stored in the
2809 viminfo file, etc. It sets the kind of characters which Vim can work
2810 with. See |encoding-names| for the possible values.
2811
2812 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002813 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002815 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
Bram Moolenaar865242e2010-07-14 21:12:05 +02002817 This option cannot be set from a |modeline|. It would most likely
2818 corrupt the text.
2819
Bram Moolenaar3df01732017-02-17 22:47:16 +01002820 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2821 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 'encoding', "utf-8" is the natural choice for the environment and
2823 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002824 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 versions, and to avoid changing the encoding of newly created files
2826 without your knowledge (in case 'fileencodings' is empty).
2827
2828 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002829 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 iconv() or as specified with 'charconvert'.
2831
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002832 If you need to know whether 'encoding' is a multi-byte encoding, you
2833 can use: >
2834 if has("multi_byte_encoding")
2835<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 Normally 'encoding' will be equal to your current locale. This will
2837 be the default if Vim recognizes your environment settings. If
2838 'encoding' is not set to the current locale, 'termencoding' must be
2839 set to convert typed and displayed text. See |encoding-table|.
2840
2841 When you set this option, it fires the |EncodingChanged| autocommand
2842 event so that you can set up fonts if necessary.
2843
2844 When the option is set, the value is converted to lowercase. Thus
2845 you can set it with uppercase values too. Underscores are translated
2846 to '-' signs.
2847 When the encoding is recognized, it is changed to the standard name.
2848 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2849 "iso-8859-2" and "utf8" becomes "utf-8".
2850
2851 Note: "latin1" is also used when the encoding could not be detected.
2852 This only works when editing files in the same encoding! When the
2853 actual character set is not latin1, make sure 'fileencoding' and
2854 'fileencodings' are empty. When conversion is needed, switch to using
2855 utf-8.
2856
2857 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2858 You don't notice this while editing, but it does matter for the
2859 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2860 setting 'encoding' to one of these values instead of utf-8 only has
2861 effect for encoding used for files when 'fileencoding' is empty.
2862
Bram Moolenaar661b1822005-07-28 22:36:45 +00002863 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2864 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865
2866 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2867'endofline' 'eol' boolean (default on)
2868 local to buffer
2869 {not in Vi}
2870 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002871 is on, or 'fixeol' option is off, no <EOL> will be written for the
2872 last line in the file. This option is automatically set or reset when
2873 starting to edit a new file, depending on whether file has an <EOL>
2874 for the last line in the file. Normally you don't have to set or
2875 reset this option.
2876 When 'binary' is off and 'fixeol' is on the value is not used when
2877 writing the file. When 'binary' is on or 'fixeol' is off it is used
2878 to remember the presence of a <EOL> for the last line in the file, so
2879 that when you write the file the situation from the original file can
2880 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881
2882 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2883'equalalways' 'ea' boolean (default on)
2884 global
2885 {not in Vi}
2886 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002887 splitting or closing a window. This also happens the moment the
2888 option is switched on. When off, splitting a window will reduce the
2889 size of the current window and leave the other windows the same. When
2890 closing a window the extra lines are given to the window next to it
2891 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 When mixing vertically and horizontally split windows, a minimal size
2893 is computed and some windows may be larger if there is room. The
2894 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002895 Changing the height and width of a window can be avoided by setting
2896 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002897 If a window size is specified when creating a new window sizes are
2898 currently not equalized (it's complicated, but may be implemented in
2899 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900
2901 *'equalprg'* *'ep'*
2902'equalprg' 'ep' string (default "")
2903 global or local to buffer |global-local|
2904 {not in Vi}
2905 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002906 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002907 or 'indentexpr'. When Vim was compiled without internal formatting,
2908 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002909 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 about including spaces and backslashes.
2911 This option cannot be set from a |modeline| or in the |sandbox|, for
2912 security reasons.
2913
2914 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2915'errorbells' 'eb' boolean (default off)
2916 global
2917 Ring the bell (beep or screen flash) for error messages. This only
2918 makes a difference for error messages, the bell will be used always
2919 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002921 screen flash or do nothing. See 'belloff' to finetune when to ring the
2922 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923
2924 *'errorfile'* *'ef'*
2925'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2926 others: "errors.err")
2927 global
2928 {not in Vi}
2929 {not available when compiled without the |+quickfix|
2930 feature}
2931 Name of the errorfile for the QuickFix mode (see |:cf|).
2932 When the "-q" command-line argument is used, 'errorfile' is set to the
2933 following argument. See |-q|.
2934 NOT used for the ":make" command. See 'makeef' for that.
2935 Environment variables are expanded |:set_env|.
2936 See |option-backslash| about including spaces and backslashes.
2937 This option cannot be set from a |modeline| or in the |sandbox|, for
2938 security reasons.
2939
2940 *'errorformat'* *'efm'*
2941'errorformat' 'efm' string (default is very long)
2942 global or local to buffer |global-local|
2943 {not in Vi}
2944 {not available when compiled without the |+quickfix|
2945 feature}
2946 Scanf-like description of the format for the lines in the error file
2947 (see |errorformat|).
2948
2949 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2950'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2951 global
2952 {not in Vi}
2953 Function keys that start with an <Esc> are recognized in Insert
2954 mode. When this option is off, the cursor and function keys cannot be
2955 used in Insert mode if they start with an <Esc>. The advantage of
2956 this is that the single <Esc> is recognized immediately, instead of
2957 after one second. Instead of resetting this option, you might want to
2958 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2959 when 'esckeys' is off, you can still map anything, but the cursor keys
2960 won't work by default.
2961 NOTE: This option is set to the Vi default value when 'compatible' is
2962 set and to the Vim default value when 'compatible' is reset.
2963
2964 *'eventignore'* *'ei'*
2965'eventignore' 'ei' string (default "")
2966 global
2967 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002969 When set to "all" or when "all" is one of the items, all autocommand
2970 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 Otherwise this is a comma separated list of event names. Example: >
2972 :set ei=WinEnter,WinLeave
2973<
2974 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2975'expandtab' 'et' boolean (default off)
2976 local to buffer
2977 {not in Vi}
2978 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002979 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2981 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002982 This option is reset when the 'paste' option is set and restored when
2983 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 NOTE: This option is reset when 'compatible' is set.
2985
2986 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2987'exrc' 'ex' boolean (default off)
2988 global
2989 {not in Vi}
2990 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002991 directory.
2992
2993 Setting this option is a potential security leak. E.g., consider
2994 unpacking a package or fetching files from github, a .vimrc in there
2995 might be a trojan horse. BETTER NOT SET THIS OPTION!
2996 Instead, define an autocommand in your .vimrc to set options for a
2997 matching directory.
2998
2999 If you do switch this option on you should also consider setting the
3000 'secure' option (see |initialization|).
3001 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 This option cannot be set from a |modeline| or in the |sandbox|, for
3003 security reasons.
3004
3005 *'fileencoding'* *'fenc'* *E213*
3006'fileencoding' 'fenc' string (default: "")
3007 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 {not in Vi}
3009 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003010
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003012 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 When 'fileencoding' is empty, the same value as 'encoding' will be
3014 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003015 No error will be given when the value is set, only when it is used,
3016 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003017 Conversion will also be done when 'encoding' and 'fileencoding' are
3018 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3019 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003021 'encoding' is "utf-8" or another Unicode encoding, conversion
3022 is most likely done in a way that the reverse conversion
3023 results in the same text. When 'encoding' is not "utf-8" some
3024 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003025
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 See 'encoding' for the possible values. Additionally, values may be
3027 specified that can be handled by the converter, see
3028 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 When reading a file 'fileencoding' will be set from 'fileencodings'.
3031 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003032 'fileencoding', use the |++enc| argument. One exception: when
3033 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003034 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3037 When the option is set, the value is converted to lowercase. Thus
3038 you can set it with uppercase values too. '_' characters are
3039 replaced with '-'. If a name is recognized from the list for
3040 'encoding', it is replaced by the standard name. For example
3041 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003042
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 When this option is set, after starting to edit a file, the 'modified'
3044 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003045
3046 Keep in mind that changing 'fenc' from a modeline happens
3047 AFTER the text has been read, thus it applies to when the file will be
3048 written. If you do set 'fenc' in a modeline, you might want to set
3049 'nomodified' to avoid not being able to ":q".
3050
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 This option can not be changed when 'modifiable' is off.
3052
3053 *'fe'*
3054 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003055 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 old short name was 'fe', which is no longer used.
3057
3058 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003059'fileencodings' 'fencs' string (default: "ucs-bom",
3060 "ucs-bom,utf-8,default,latin1" when
3061 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 {not in Vi}
3064 This is a list of character encodings considered when starting to edit
3065 an existing file. When a file is read, Vim tries to use the first
3066 mentioned character encoding. If an error is detected, the next one
3067 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003068 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 an empty string, which means the value of 'encoding' is used.
3070 WARNING: Conversion can cause loss of information! When
3071 'encoding' is "utf-8" (or one of the other Unicode variants)
3072 conversion is most likely done in a way that the reverse
3073 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003074 "utf-8" some non-ASCII characters may be lost! You can use
3075 the |++bad| argument to specify what is done with characters
3076 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 For an empty file or a file with only ASCII characters most encodings
3078 will work and the first entry of 'fileencodings' will be used (except
3079 "ucs-bom", which requires the BOM to be present). If you prefer
3080 another encoding use an BufReadPost autocommand event to test if your
3081 preferred encoding is to be used. Example: >
3082 au BufReadPost * if search('\S', 'w') == 0 |
3083 \ set fenc=iso-2022-jp | endif
3084< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3085 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003086 When the |++enc| argument is used then the value of 'fileencodings' is
3087 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003088 Note that 'fileencodings' is not used for a new file, the global value
3089 of 'fileencoding' is used instead. You can set it with: >
3090 :setglobal fenc=iso-8859-2
3091< This means that a non-existing file may get a different encoding than
3092 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 The special value "ucs-bom" can be used to check for a Unicode BOM
3094 (Byte Order Mark) at the start of the file. It must not be preceded
3095 by "utf-8" or another Unicode encoding for this to work properly.
3096 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3097 because Vim cannot detect an error, thus the encoding is always
3098 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003099 The special value "default" can be used for the encoding from the
3100 environment. This is the default value for 'encoding'. It is useful
3101 when 'encoding' is set to "utf-8" and your environment uses a
3102 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003103 When 'encoding' is "utf-8" and a file contains an illegal byte
3104 sequence it won't be recognized as UTF-8. You can use the |8g8|
3105 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 WRONG VALUES: WHAT'S WRONG:
3107 latin1,utf-8 "latin1" will always be used
3108 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3109 file
3110 cp1250,latin1 "cp1250" will always be used
3111 If 'fileencodings' is empty, 'fileencoding' is not modified.
3112 See 'fileencoding' for the possible values.
3113 Setting this option does not have an effect until the next time a file
3114 is read.
3115
3116 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003117'fileformat' 'ff' string (MS-Windows default: "dos",
3118 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 local to buffer
3120 {not in Vi}
3121 This gives the <EOL> of the current buffer, which is used for
3122 reading/writing the buffer from/to a file:
3123 dos <CR> <NL>
3124 unix <NL>
3125 mac <CR>
3126 When "dos" is used, CTRL-Z at the end of a file is ignored.
3127 See |file-formats| and |file-read|.
3128 For the character encoding of the file see 'fileencoding'.
3129 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003130 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 This option is set automatically when starting to edit a file and
3132 'fileformats' is not empty and 'binary' is off.
3133 When this option is set, after starting to edit a file, the 'modified'
3134 option is set, because the file would be different when written.
3135 This option can not be changed when 'modifiable' is off.
3136 For backwards compatibility: When this option is set to "dos",
3137 'textmode' is set, otherwise 'textmode' is reset.
3138
3139 *'fileformats'* *'ffs'*
3140'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003141 Vim+Vi MS-Windows: "dos,unix",
3142 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 Vi Cygwin: "unix,dos",
3144 Vi others: "")
3145 global
3146 {not in Vi}
3147 This gives the end-of-line (<EOL>) formats that will be tried when
3148 starting to edit a new buffer and when reading a file into an existing
3149 buffer:
3150 - When empty, the format defined with 'fileformat' will be used
3151 always. It is not set automatically.
3152 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003153 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 'fileformats' name will be used when a file is read into an existing
3155 buffer, no matter what 'fileformat' for that buffer is set to.
3156 - When more than one name is present, separated by commas, automatic
3157 <EOL> detection will be done when reading a file. When starting to
3158 edit a file, a check is done for the <EOL>:
3159 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3160 'fileformat' is set to "dos".
3161 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003162 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003164 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3165 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003166 This means that "mac" is only chosen when:
3167 "unix" is not present or no <NL> is found in the file, and
3168 "dos" is not present or no <CR><NL> is found in the file.
3169 Except: if "unix" was chosen, but there is a <CR> before
3170 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003171 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 4. If 'fileformat' is still not set, the first name from
3173 'fileformats' is used.
3174 When reading a file into an existing buffer, the same is done, but
3175 this happens like 'fileformat' has been set appropriately for that
3176 file only, the option is not changed.
3177 When 'binary' is set, the value of 'fileformats' is not used.
3178
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003179 When Vim starts up with an empty buffer the first item is used. You
3180 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003181
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3183 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3184 done:
3185 - When 'fileformats' is empty, there is no automatic detection. Dos
3186 format will be used.
3187 - When 'fileformats' is set to one or more names, automatic detection
3188 is done. This is based on the first <NL> in the file: If there is a
3189 <CR> in front of it, Dos format is used, otherwise Unix format is
3190 used.
3191 Also see |file-formats|.
3192 For backwards compatibility: When this option is set to an empty
3193 string or one format (no comma is included), 'textauto' is reset,
3194 otherwise 'textauto' is set.
3195 NOTE: This option is set to the Vi default value when 'compatible' is
3196 set and to the Vim default value when 'compatible' is reset.
3197
Bram Moolenaarbf884932013-04-05 22:26:15 +02003198 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3199'fileignorecase' 'fic' boolean (default on for systems where case in file
3200 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003201 global
3202 {not in Vi}
3203 When set case is ignored when using file names and directories.
3204 See 'wildignorecase' for only ignoring case when doing completion.
3205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 *'filetype'* *'ft'*
3207'filetype' 'ft' string (default: "")
3208 local to buffer
3209 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 When this option is set, the FileType autocommand event is triggered.
3211 All autocommands that match with the value of this option will be
3212 executed. Thus the value of 'filetype' is used in place of the file
3213 name.
3214 Otherwise this option does not always reflect the current file type.
3215 This option is normally set when the file type is detected. To enable
3216 this use the ":filetype on" command. |:filetype|
3217 Setting this option to a different value is most useful in a modeline,
3218 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003219 Example, for in an IDL file:
3220 /* vim: set filetype=idl : */ ~
3221 |FileType| |filetypes|
3222 When a dot appears in the value then this separates two filetype
3223 names. Example:
3224 /* vim: set filetype=c.doxygen : */ ~
3225 This will use the "c" filetype first, then the "doxygen" filetype.
3226 This works both for filetype plugins and for syntax files. More than
3227 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 This option is not copied to another buffer, independent of the 's' or
3229 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003230 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
3232 *'fillchars'* *'fcs'*
3233'fillchars' 'fcs' string (default "vert:|,fold:-")
3234 global
3235 {not in Vi}
3236 {not available when compiled without the |+windows|
3237 and |+folding| features}
3238 Characters to fill the statuslines and vertical separators.
3239 It is a comma separated list of items:
3240
3241 item default Used for ~
3242 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003243 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 vert:c '|' vertical separators |:vsplit|
3245 fold:c '-' filling 'foldtext'
3246 diff:c '-' deleted lines of the 'diff' option
3247
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003248 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003249 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 otherwise.
3251
3252 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003253 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254< This is similar to the default, except that these characters will also
3255 be used when there is highlighting.
3256
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003257 for "stl" and "stlnc" only single-byte values are supported.
3258
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 The highlighting used for these items:
3260 item highlight group ~
3261 stl:c StatusLine |hl-StatusLine|
3262 stlnc:c StatusLineNC |hl-StatusLineNC|
3263 vert:c VertSplit |hl-VertSplit|
3264 fold:c Folded |hl-Folded|
3265 diff:c DiffDelete |hl-DiffDelete|
3266
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003267 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3268'fixendofline' 'fixeol' boolean (default on)
3269 local to buffer
3270 {not in Vi}
3271 When writing a file and this option is on, <EOL> at the end of file
3272 will be restored if missing. Turn this option off if you want to
3273 preserve the situation from the original file.
3274 When the 'binary' option is set the value of this option doesn't
3275 matter.
3276 See the 'endofline' option.
3277
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3279'fkmap' 'fk' boolean (default off) *E198*
3280 global
3281 {not in Vi}
3282 {only available when compiled with the |+rightleft|
3283 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003284 This option was for using Farsi, which has been removed. See
3285 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286
3287 *'foldclose'* *'fcl'*
3288'foldclose' 'fcl' string (default "")
3289 global
3290 {not in Vi}
3291 {not available when compiled without the |+folding|
3292 feature}
3293 When set to "all", a fold is closed when the cursor isn't in it and
3294 its level is higher than 'foldlevel'. Useful if you want folds to
3295 automatically close when moving out of them.
3296
3297 *'foldcolumn'* *'fdc'*
3298'foldcolumn' 'fdc' number (default 0)
3299 local to window
3300 {not in Vi}
3301 {not available when compiled without the |+folding|
3302 feature}
3303 When non-zero, a column with the specified width is shown at the side
3304 of the window which indicates open and closed folds. The maximum
3305 value is 12.
3306 See |folding|.
3307
3308 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3309'foldenable' 'fen' boolean (default on)
3310 local to window
3311 {not in Vi}
3312 {not available when compiled without the |+folding|
3313 feature}
3314 When off, all folds are open. This option can be used to quickly
3315 switch between showing all text unfolded and viewing the text with
3316 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003317 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 'foldenable' is off.
3319 This option is set by commands that create a new fold or close a fold.
3320 See |folding|.
3321
3322 *'foldexpr'* *'fde'*
3323'foldexpr' 'fde' string (default: "0")
3324 local to window
3325 {not in Vi}
3326 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003327 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003329 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003330
Bram Moolenaar30b65812012-07-12 22:01:11 +02003331 The expression will be evaluated in the |sandbox| if set from a
3332 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003333 This option can't be set from a |modeline| when the 'diff' option is
3334 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003335
3336 It is not allowed to change text or jump to another window while
3337 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338
3339 *'foldignore'* *'fdi'*
3340'foldignore' 'fdi' string (default: "#")
3341 local to window
3342 {not in Vi}
3343 {not available when compiled without the |+folding|
3344 feature}
3345 Used only when 'foldmethod' is "indent". Lines starting with
3346 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003347 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 The default "#" works well for C programs. See |fold-indent|.
3349
3350 *'foldlevel'* *'fdl'*
3351'foldlevel' 'fdl' number (default: 0)
3352 local to window
3353 {not in Vi}
3354 {not available when compiled without the |+folding|
3355 feature}
3356 Sets the fold level: Folds with a higher level will be closed.
3357 Setting this option to zero will close all folds. Higher numbers will
3358 close fewer folds.
3359 This option is set by commands like |zm|, |zM| and |zR|.
3360 See |fold-foldlevel|.
3361
3362 *'foldlevelstart'* *'fdls'*
3363'foldlevelstart' 'fdls' number (default: -1)
3364 global
3365 {not in Vi}
3366 {not available when compiled without the |+folding|
3367 feature}
3368 Sets 'foldlevel' when starting to edit another buffer in a window.
3369 Useful to always start editing with all folds closed (value zero),
3370 some folds closed (one) or no folds closed (99).
3371 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003372 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 ignores this option and closes all folds.
3374 It is also done before BufReadPre autocommands, to allow an autocmd to
3375 overrule the 'foldlevel' value for specific files.
3376 When the value is negative, it is not used.
3377
3378 *'foldmarker'* *'fmr'* *E536*
3379'foldmarker' 'fmr' string (default: "{{{,}}}")
3380 local to window
3381 {not in Vi}
3382 {not available when compiled without the |+folding|
3383 feature}
3384 The start and end marker used when 'foldmethod' is "marker". There
3385 must be one comma, which separates the start and end marker. The
3386 marker is a literal string (a regular expression would be too slow).
3387 See |fold-marker|.
3388
3389 *'foldmethod'* *'fdm'*
3390'foldmethod' 'fdm' string (default: "manual")
3391 local to window
3392 {not in Vi}
3393 {not available when compiled without the |+folding|
3394 feature}
3395 The kind of folding used for the current window. Possible values:
3396 |fold-manual| manual Folds are created manually.
3397 |fold-indent| indent Lines with equal indent form a fold.
3398 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3399 |fold-marker| marker Markers are used to specify folds.
3400 |fold-syntax| syntax Syntax highlighting items specify folds.
3401 |fold-diff| diff Fold text that is not changed.
3402
3403 *'foldminlines'* *'fml'*
3404'foldminlines' 'fml' number (default: 1)
3405 local to window
3406 {not in Vi}
3407 {not available when compiled without the |+folding|
3408 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003409 Sets the number of screen lines above which a fold can be displayed
3410 closed. Also for manually closed folds. With the default value of
3411 one a fold can only be closed if it takes up two or more screen lines.
3412 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003413 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 "zc" to close a fold, which is displayed open because it's smaller
3415 than 'foldminlines', a following "zc" may close a containing fold.
3416
3417 *'foldnestmax'* *'fdn'*
3418'foldnestmax' 'fdn' number (default: 20)
3419 local to window
3420 {not in Vi}
3421 {not available when compiled without the |+folding|
3422 feature}
3423 Sets the maximum nesting of folds for the "indent" and "syntax"
3424 methods. This avoids that too many folds will be created. Using more
3425 than 20 doesn't work, because the internal limit is 20.
3426
3427 *'foldopen'* *'fdo'*
3428'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3429 search,tag,undo")
3430 global
3431 {not in Vi}
3432 {not available when compiled without the |+folding|
3433 feature}
3434 Specifies for which type of commands folds will be opened, if the
3435 command moves the cursor into a closed fold. It is a comma separated
3436 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003437 NOTE: When the command is part of a mapping this option is not used.
3438 Add the |zv| command to the mapping to get the same effect.
3439 (rationale: the mapping may want to control opening folds itself)
3440
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 item commands ~
3442 all any
3443 block "(", "{", "[[", "[{", etc.
3444 hor horizontal movements: "l", "w", "fx", etc.
3445 insert any command in Insert mode
3446 jump far jumps: "G", "gg", etc.
3447 mark jumping to a mark: "'m", CTRL-O, etc.
3448 percent "%"
3449 quickfix ":cn", ":crew", ":make", etc.
3450 search search for a pattern: "/", "n", "*", "gd", etc.
3451 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003452 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 tag jumping to a tag: ":ta", CTRL-T, etc.
3454 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 When a movement command is used for an operator (e.g., "dl" or "y%")
3456 this option is not used. This means the operator will include the
3457 whole closed fold.
3458 Note that vertical movements are not here, because it would make it
3459 very difficult to move onto a closed fold.
3460 In insert mode the folds containing the cursor will always be open
3461 when text is inserted.
3462 To close folds you can re-apply 'foldlevel' with the |zx| command or
3463 set the 'foldclose' option to "all".
3464
3465 *'foldtext'* *'fdt'*
3466'foldtext' 'fdt' string (default: "foldtext()")
3467 local to window
3468 {not in Vi}
3469 {not available when compiled without the |+folding|
3470 feature}
3471 An expression which is used to specify the text displayed for a closed
3472 fold. See |fold-foldtext|.
3473
Bram Moolenaar30b65812012-07-12 22:01:11 +02003474 The expression will be evaluated in the |sandbox| if set from a
3475 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003476
3477 It is not allowed to change text or jump to another window while
3478 evaluating 'foldtext' |textlock|.
3479
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003480 *'formatexpr'* *'fex'*
3481'formatexpr' 'fex' string (default "")
3482 local to buffer
3483 {not in Vi}
3484 {not available when compiled without the |+eval|
3485 feature}
3486 Expression which is evaluated to format a range of lines for the |gq|
3487 operator or automatic formatting (see 'formatoptions'). When this
3488 option is empty 'formatprg' is used.
3489
3490 The |v:lnum| variable holds the first line to be formatted.
3491 The |v:count| variable holds the number of lines to be formatted.
3492 The |v:char| variable holds the character that is going to be
3493 inserted if the expression is being evaluated due to
3494 automatic formatting. This can be empty. Don't insert
3495 it yet!
3496
3497 Example: >
3498 :set formatexpr=mylang#Format()
3499< This will invoke the mylang#Format() function in the
3500 autoload/mylang.vim file in 'runtimepath'. |autoload|
3501
3502 The expression is also evaluated when 'textwidth' is set and adding
3503 text beyond that limit. This happens under the same conditions as
3504 when internal formatting is used. Make sure the cursor is kept in the
3505 same spot relative to the text then! The |mode()| function will
3506 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003507
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003508 When the expression evaluates to non-zero Vim will fall back to using
3509 the internal format mechanism.
3510
3511 The expression will be evaluated in the |sandbox| when set from a
3512 modeline, see |sandbox-option|. That stops the option from working,
3513 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003514 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003515
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 *'formatoptions'* *'fo'*
3517'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3518 local to buffer
3519 {not in Vi}
3520 This is a sequence of letters which describes how automatic
3521 formatting is to be done. See |fo-table|. When the 'paste' option is
3522 on, no formatting is done (like 'formatoptions' is empty). Commas can
3523 be inserted for readability.
3524 To avoid problems with flags that are added in the future, use the
3525 "+=" and "-=" feature of ":set" |add-option-flags|.
3526 NOTE: This option is set to the Vi default value when 'compatible' is
3527 set and to the Vim default value when 'compatible' is reset.
3528
Bram Moolenaar86b68352004-12-27 21:59:20 +00003529 *'formatlistpat'* *'flp'*
3530'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3531 local to buffer
3532 {not in Vi}
3533 A pattern that is used to recognize a list header. This is used for
3534 the "n" flag in 'formatoptions'.
3535 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003536 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003537 while still checking more characters. There must be a character
3538 following the pattern, when it matches the whole line it is handled
3539 like there is no match.
3540 The default recognizes a number, followed by an optional punctuation
3541 character and white space.
3542
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 *'formatprg'* *'fp'*
3544'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003545 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 {not in Vi}
3547 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003548 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003550 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003551 If the 'formatexpr' option is not empty it will be used instead.
3552 Otherwise, if 'formatprg' option is an empty string, the internal
3553 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003554 Environment variables are expanded |:set_env|. See |option-backslash|
3555 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003556 This option cannot be set from a |modeline| or in the |sandbox|, for
3557 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
Bram Moolenaard94464e2015-11-02 15:28:18 +01003559 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003560'fsync' 'fs' boolean (default on)
3561 global
3562 {not in Vi}
3563 When on, the library function fsync() will be called after writing a
3564 file. This will flush a file to disk, ensuring that it is safely
3565 written even on filesystems which do metadata-only journaling. This
3566 will force the harddrive to spin up on Linux systems running in laptop
3567 mode, so it may be undesirable in some situations. Be warned that
3568 turning this off increases the chances of data loss after a crash. On
3569 systems without an fsync() implementation, this variable is always
3570 off.
3571 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003572 'fsync' also applies to |writefile()|, unless a flag is used to
3573 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003574
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3576'gdefault' 'gd' boolean (default off)
3577 global
3578 {not in Vi}
3579 When on, the ":substitute" flag 'g' is default on. This means that
3580 all matches in a line are substituted instead of one. When a 'g' flag
3581 is given to a ":substitute" command, this will toggle the substitution
3582 of all or one match. See |complex-change|.
3583
3584 command 'gdefault' on 'gdefault' off ~
3585 :s/// subst. all subst. one
3586 :s///g subst. one subst. all
3587 :s///gg subst. all subst. one
3588
3589 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003590 DEPRECATED: Setting this option may break plugins that are not aware
3591 of this option. Also, many users get confused that adding the /g flag
3592 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593
3594 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003595'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 global
3597 {not in Vi}
3598 Format to recognize for the ":grep" command output.
3599 This is a scanf-like string that uses the same format as the
3600 'errorformat' option: see |errorformat|.
3601
3602 *'grepprg'* *'gp'*
3603'grepprg' 'gp' string (default "grep -n ",
3604 Unix: "grep -n $* /dev/null",
3605 Win32: "findstr /n" or "grep -n",
3606 VMS: "SEARCH/NUMBERS ")
3607 global or local to buffer |global-local|
3608 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003609 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 and '#' characters, which are expanded like when used in a command-
3611 line. The placeholder "$*" is allowed to specify where the arguments
3612 will be included. Environment variables are expanded |:set_env|. See
3613 |option-backslash| about including spaces and backslashes.
3614 When your "grep" accepts the "-H" argument, use this to make ":grep"
3615 also work well with a single file: >
3616 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003617< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003618 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3619 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003620 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 apply equally to 'grepprg'.
3622 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3623 otherwise it's "grep -n".
3624 This option cannot be set from a |modeline| or in the |sandbox|, for
3625 security reasons.
3626
3627 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3628'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3629 ve:ver35-Cursor,
3630 o:hor50-Cursor,
3631 i-ci:ver25-Cursor/lCursor,
3632 r-cr:hor20-Cursor/lCursor,
3633 sm:block-Cursor
3634 -blinkwait175-blinkoff150-blinkon175",
3635 for MS-DOS and Win32 console:
3636 "n-v-c:block,o:hor50,i-ci:hor15,
3637 r-cr:hor30,sm:block")
3638 global
3639 {not in Vi}
3640 {only available when compiled with GUI enabled, and
3641 for MS-DOS and Win32 console}
3642 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003643 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 the height of the cursor can be changed. This can be done by
3645 specifying a block cursor, or a percentage for a vertical or
3646 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003647 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3648 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003650 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 mode-list and an argument-list:
3652 mode-list:argument-list,mode-list:argument-list,..
3653 The mode-list is a dash separated list of these modes:
3654 n Normal mode
3655 v Visual mode
3656 ve Visual mode with 'selection' "exclusive" (same as 'v',
3657 if not specified)
3658 o Operator-pending mode
3659 i Insert mode
3660 r Replace mode
3661 c Command-line Normal (append) mode
3662 ci Command-line Insert mode
3663 cr Command-line Replace mode
3664 sm showmatch in Insert mode
3665 a all modes
3666 The argument-list is a dash separated list of these arguments:
3667 hor{N} horizontal bar, {N} percent of the character height
3668 ver{N} vertical bar, {N} percent of the character width
3669 block block cursor, fills the whole character
3670 [only one of the above three should be present]
3671 blinkwait{N} *cursor-blinking*
3672 blinkon{N}
3673 blinkoff{N}
3674 blink times for cursor: blinkwait is the delay before
3675 the cursor starts blinking, blinkon is the time that
3676 the cursor is shown and blinkoff is the time that the
3677 cursor is not shown. The times are in msec. When one
3678 of the numbers is zero, there is no blinking. The
3679 default is: "blinkwait700-blinkon400-blinkoff250".
3680 These numbers are used for a missing entry. This
3681 means that blinking is enabled by default. To switch
3682 blinking off you can use "blinkon0". The cursor only
3683 blinks when Vim is waiting for input, not while
3684 executing a command.
3685 To make the cursor blink in an xterm, see
3686 |xterm-blink|.
3687 {group-name}
3688 a highlight group name, that sets the color and font
3689 for the cursor
3690 {group-name}/{group-name}
3691 Two highlight group names, the first is used when
3692 no language mappings are used, the other when they
3693 are. |language-mapping|
3694
3695 Examples of parts:
3696 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3697 block cursor with colors from the "nCursor"
3698 highlight group
3699 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3700 In Insert and Command-line Insert mode, use a
3701 30% vertical bar cursor with colors from the
3702 "iCursor" highlight group. Blink a bit
3703 faster.
3704
3705 The 'a' mode is different. It will set the given argument-list for
3706 all modes. It does not reset anything to defaults. This can be used
3707 to do a common setting for all modes. For example, to switch off
3708 blinking: "a:blinkon0"
3709
3710 Examples of cursor highlighting: >
3711 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3712 :highlight Cursor gui=NONE guifg=bg guibg=fg
3713<
3714 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003715 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716'guifont' 'gfn' string (default "")
3717 global
3718 {not in Vi}
3719 {only available when compiled with GUI enabled}
3720 This is a list of fonts which will be used for the GUI version of Vim.
3721 In its simplest form the value is just one font name. When
3722 the font cannot be found you will get an error message. To try other
3723 font names a list can be specified, font names separated with commas.
3724 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003725
Bram Moolenaar05159a02005-02-26 23:04:13 +00003726 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3727 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003728
Bram Moolenaar3df01732017-02-17 22:47:16 +01003729 Note: As to the GTK GUIs, no error is given against any invalid names,
3730 and the first element of the list is always picked up and made use of.
3731 This is because, instead of identifying a given name with a font, the
3732 GTK GUIs use it to construct a pattern and try to look up a font which
3733 best matches the pattern among available fonts, and this way, the
3734 matching never fails. An invalid name doesn't matter because a number
3735 of font properties other than name will do to get the matching done.
3736
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 Spaces after a comma are ignored. To include a comma in a font name
3738 precede it with a backslash. Setting an option requires an extra
3739 backslash before a space and a backslash. See also
3740 |option-backslash|. For example: >
3741 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003742< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003744
3745 If none of the fonts can be loaded, Vim will keep the current setting.
3746 If an empty font list is given, Vim will try using other resource
3747 settings (for X, it will use the Vim.font resource), and finally it
3748 will try some builtin default which should always be there ("7x13" in
3749 the case of X). The font names given should be "normal" fonts. Vim
3750 will try to find the related bold and italic fonts.
3751
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003752 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003753 :set guifont=*
3754< will bring up a font requester, where you can pick the font you want.
3755
3756 The font name depends on the GUI used. See |setting-guifont| for a
3757 way to set 'guifont' for various systems.
3758
Bram Moolenaar3df01732017-02-17 22:47:16 +01003759 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003761< That's all. XLFDs are not used. For Chinese this is reported to work
3762 well: >
3763 if has("gui_gtk2")
3764 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3765 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3766 endif
3767<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003768 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3769
Bram Moolenaar05159a02005-02-26 23:04:13 +00003770 For Mac OSX you can use something like this: >
3771 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003772< Also see 'macatsui', it can help fix display problems.
3773 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003775 width). An exception is GTK: all fonts are accepted, but mono-spaced
3776 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003777
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 To preview a font on X11, you might be able to use the "xfontsel"
3779 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003780
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 For the Win32 GUI *E244* *E245*
3782 - takes these options in the font name:
3783 hXX - height is XX (points, can be floating-point)
3784 wXX - width is XX (points, can be floating-point)
3785 b - bold
3786 i - italic
3787 u - underline
3788 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003789 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3791 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3792 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003793 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003794 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003795 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003796 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003797 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798
3799 Use a ':' to separate the options.
3800 - A '_' can be used in the place of a space, so you don't need to use
3801 backslashes to escape the spaces.
3802 - Examples: >
3803 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3804 :set guifont=Andale_Mono:h7.5:w4.5
3805< See also |font-sizes|.
3806
3807 *'guifontset'* *'gfs'*
3808 *E250* *E252* *E234* *E597* *E598*
3809'guifontset' 'gfs' string (default "")
3810 global
3811 {not in Vi}
3812 {only available when compiled with GUI enabled and
3813 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003814 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 When not empty, specifies two (or more) fonts to be used. The first
3816 one for normal English, the second one for your special language. See
3817 |xfontset|.
3818 Setting this option also means that all font names will be handled as
3819 a fontset name. Also the ones used for the "font" argument of the
3820 |:highlight| command.
3821 The fonts must match with the current locale. If fonts for the
3822 character sets that the current locale uses are not included, setting
3823 'guifontset' will fail.
3824 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3825 the comma-separated names are alternative names, one of which will be
3826 used. In 'guifontset' the whole string is one fontset name,
3827 including the commas. It is not possible to specify alternative
3828 fontset names.
3829 This example works on many X11 systems: >
3830 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3831<
3832 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3833'guifontwide' 'gfw' string (default "")
3834 global
3835 {not in Vi}
3836 {only available when compiled with GUI enabled}
3837 When not empty, specifies a comma-separated list of fonts to be used
3838 for double-width characters. The first font that can be loaded is
3839 used.
3840 Note: The size of these fonts must be exactly twice as wide as the one
3841 specified with 'guifont' and the same height.
3842
Bram Moolenaar3df01732017-02-17 22:47:16 +01003843 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844
3845 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3846 'guifontset' is empty or invalid.
3847 When 'guifont' is set and a valid font is found in it and
3848 'guifontwide' is empty Vim will attempt to find a matching
3849 double-width font and set 'guifontwide' to it.
3850
Bram Moolenaar3df01732017-02-17 22:47:16 +01003851 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852
3853 If set and valid, 'guifontwide' is always used for double width
3854 characters, even if 'encoding' is not set to "utf-8".
3855 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003856 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857 font for characters not available in 'guifont'. Thus you do not need
3858 to set 'guifontwide' at all unless you want to override the choice
3859 made by Pango/Xft.
3860
Bram Moolenaar0f272122013-01-23 18:37:40 +01003861 Windows +multibyte only: *guifontwide_win_mbyte*
3862
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003863 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003864
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 *'guiheadroom'* *'ghr'*
3866'guiheadroom' 'ghr' number (default 50)
3867 global
3868 {not in Vi} {only for GTK and X11 GUI}
3869 The number of pixels subtracted from the screen height when fitting
3870 the GUI window on the screen. Set this before the GUI is started,
3871 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003872 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 lines will be left for window decorations and other items on the
3874 screen. Set it to a negative value to allow windows taller than the
3875 screen.
3876
3877 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003878'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3879 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003880 "aegimrLtT" (GTK, Motif and Athena),
3881 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 global
3883 {not in Vi}
3884 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003885 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 sequence of letters which describes what components and options of the
3887 GUI should be used.
3888 To avoid problems with flags that are added in the future, use the
3889 "+=" and "-=" feature of ":set" |add-option-flags|.
3890
Bram Moolenaar13568252018-03-16 20:46:58 +01003891 Valid characters are as follows:
3892 *'go-!'*
3893 '!' External commands are executed in a terminal window. Without
3894 this flag the MS-Windows GUI will open a console window to
3895 execute the command. The Unix GUI will simulate a dumb
3896 terminal to list the command output.
3897 The terminal window will be positioned at the bottom, and grow
3898 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003899 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'a' Autoselect: If present, then whenever VISUAL mode is started,
3901 or the Visual area extended, Vim tries to become the owner of
3902 the windowing system's global selection. This means that the
3903 Visually highlighted text is available for pasting into other
3904 applications as well as into Vim itself. When the Visual mode
3905 ends, possibly due to an operation on the text, or when an
3906 application wants to paste the selection, the highlighted text
3907 is automatically yanked into the "* selection register.
3908 Thus the selection is still available for pasting into other
3909 applications after the VISUAL mode has ended.
3910 If not present, then Vim won't become the owner of the
3911 windowing system's global selection unless explicitly told to
3912 by a yank or delete operation for the "* register.
3913 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003914 *'go-P'*
3915 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003916 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003918 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 applies to the modeless selection.
3920
3921 'guioptions' autoselect Visual autoselect modeless ~
3922 "" - -
3923 "a" yes yes
3924 "A" - yes
3925 "aA" yes yes
3926
Bram Moolenaar02467872007-05-06 13:22:01 +00003927 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'c' Use console dialogs instead of popup dialogs for simple
3929 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003930 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003931 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003932 'guitablabel' can be used to change the text in the labels.
3933 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003934 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003935 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003936 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 'f' Foreground: Don't use fork() to detach the GUI from the shell
3938 where it was started. Use this for programs that wait for the
3939 editor to finish (e.g., an e-mail program). Alternatively you
3940 can use "gvim -f" or ":gui -f" to start the GUI in the
3941 foreground. |gui-fork|
3942 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003943 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003944 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3946 corner of the window. It's black&white on non-GTK, because of
3947 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003948 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003950 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003951 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003953 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003955 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003956 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 'g' Grey menu items: Make menu items that are not active grey. If
3958 'g' is not included inactive menu items are not shown at all.
3959 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003960 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 't' Include tearoff menu items. Currently only works for Win32,
3962 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003963 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003964 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003965 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003966 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003968 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 'R' Right-hand scrollbar is present when there is a vertically
3970 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003971 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003973 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 'L' Left-hand scrollbar is present when there is a vertically
3975 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003976 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3978 the longest visible line, or on the cursor line if the 'h'
3979 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003980 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 'h' Limit horizontal scrollbar size to the length of the cursor
3982 line. Reduces computations. |gui-horiz-scroll|
3983
3984 And yes, you may even have scrollbars on the left AND the right if
3985 you really want to :-). See |gui-scrollbars| for more information.
3986
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003987 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 'v' Use a vertical button layout for dialogs. When not included,
3989 a horizontal layout is preferred, but when it doesn't fit a
3990 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003991 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 'p' Use Pointer callbacks for X11 GUI. This is required for some
3993 window managers. If the cursor is not blinking or hollow at
3994 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003995 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003997 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003998 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003999 *'go-k'*
4000 'k' Keep the GUI window size when adding/removing a scrollbar, or
4001 toolbar, tabline, etc. Instead, the behavior is similar to
4002 when the window is maximized and will adjust 'lines' and
4003 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01004004 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01004005 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00004006
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 *'guipty'* *'noguipty'*
4008'guipty' boolean (default on)
4009 global
4010 {not in Vi}
4011 {only available when compiled with GUI enabled}
4012 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
4013 I/O to/from shell commands. See |gui-pty|.
4014
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004015 *'guitablabel'* *'gtl'*
4016'guitablabel' 'gtl' string (default empty)
4017 global
4018 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004019 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004020 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004021 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00004022 pages line. When empty and when the result is empty Vim will use a
4023 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004024
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004025 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00004026 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01004027 The expression will be evaluated in the |sandbox| when set from a
4028 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00004029
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00004030 Only used when the GUI tab pages line is displayed. 'e' must be
4031 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
4032 used.
4033
Bram Moolenaar57657d82006-04-21 22:12:41 +00004034 *'guitabtooltip'* *'gtt'*
4035'guitabtooltip' 'gtt' string (default empty)
4036 global
4037 {not in Vi}
4038 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02004039 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00004040 When nonempty describes the text to use in a tooltip for the GUI tab
4041 pages line. When empty Vim will use a default tooltip.
4042 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004043 You can include a line break. Simplest method is to use |:let|: >
4044 :let &guitabtooltip = "line one\nline two"
4045<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004046
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 *'helpfile'* *'hf'*
4048'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4049 (others) "$VIMRUNTIME/doc/help.txt")
4050 global
4051 {not in Vi}
4052 Name of the main help file. All distributed help files should be
4053 placed together in one directory. Additionally, all "doc" directories
4054 in 'runtimepath' will be used.
4055 Environment variables are expanded |:set_env|. For example:
4056 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004057 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 spaces and backslashes.
4059 This option cannot be set from a |modeline| or in the |sandbox|, for
4060 security reasons.
4061
4062 *'helpheight'* *'hh'*
4063'helpheight' 'hh' number (default 20)
4064 global
4065 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004066 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 feature}
4068 Minimal initial height of the help window when it is opened with the
4069 ":help" command. The initial height of the help window is half of the
4070 current window, or (when the 'ea' option is on) the same as other
4071 windows. When the height is less than 'helpheight', the height is
4072 set to 'helpheight'. Set to zero to disable.
4073
4074 *'helplang'* *'hlg'*
4075'helplang' 'hlg' string (default: messages language or empty)
4076 global
4077 {only available when compiled with the |+multi_lang|
4078 feature}
4079 {not in Vi}
4080 Comma separated list of languages. Vim will use the first language
4081 for which the desired help can be found. The English help will always
4082 be used as a last resort. You can add "en" to prefer English over
4083 another language, but that will only find tags that exist in that
4084 language and not in the English help.
4085 Example: >
4086 :set helplang=de,it
4087< This will first search German, then Italian and finally English help
4088 files.
4089 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4090 try to find the tag in the current language before using this option.
4091 See |help-translated|.
4092
4093 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4094'hidden' 'hid' boolean (default off)
4095 global
4096 {not in Vi}
4097 When off a buffer is unloaded when it is |abandon|ed. When on a
4098 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4099 displayed in another window, it does not become hidden, of course.
4100 The commands that move through the buffer list sometimes make a buffer
4101 hidden although the 'hidden' option is off: When the buffer is
4102 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004104 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 This option is set for one command with ":hide {command}" |:hide|.
4106 WARNING: It's easy to forget that you have changes in hidden buffers.
4107 Think twice when using ":q!" or ":qa!".
4108
4109 *'highlight'* *'hl'*
4110'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004111 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4112 d:Directory,e:ErrorMsg,i:IncSearch,
4113 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4114 N:CursorLineNr,r:Question,s:StatusLine,
4115 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004116 v:Visual,V:VisualNOS,w:WarningMsg,
4117 W:WildMenu,f:Folded,F:FoldColumn,
4118 A:DiffAdd,C:DiffChange,D:DiffDelete,
4119 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01004120 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004121 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004122 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4123 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004124 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004125 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126 global
4127 {not in Vi}
4128 This option can be used to set highlighting mode for various
4129 occasions. It is a comma separated list of character pairs. The
4130 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004131 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004133 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4134 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 characters from 'showbreak'
4136 |hl-Directory| d directories in CTRL-D listing and other special
4137 things in listings
4138 |hl-ErrorMsg| e error messages
4139 h (obsolete, ignored)
4140 |hl-IncSearch| i 'incsearch' highlighting
4141 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4142 |hl-MoreMsg| m |more-prompt|
4143 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004144 |hl-LineNr| n line number for ":number" and ":#" commands, and
4145 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004146 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4147 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 |hl-Question| r |hit-enter| prompt and yes/no questions
4149 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004150 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4152 |hl-VertSplit| c column used to separate vertically split windows
4153 |hl-Visual| v Visual mode
4154 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4155 Selection" Only X11 Gui's |gui-x11| and
4156 |xterm-clipboard|.
4157 |hl-WarningMsg| w warning messages
4158 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4159 |hl-Folded| f line used for closed folds
4160 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004161 |hl-DiffAdd| A added line in diff mode
4162 |hl-DiffChange| C changed line in diff mode
4163 |hl-DiffDelete| D deleted line in diff mode
4164 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004166 |hl-Conceal| - the placeholders used for concealed characters
4167 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004168 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004169 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004170 |hl-SpellRare| R rare word |spell|
4171 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004172 |hl-Pmenu| + popup menu normal line
4173 |hl-PmenuSel| = popup menu selected line
4174 |hl-PmenuSbar| x popup menu scrollbar
4175 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176
4177 The display modes are:
4178 r reverse (termcap entry "mr" and "me")
4179 i italic (termcap entry "ZH" and "ZR")
4180 b bold (termcap entry "md" and "me")
4181 s standout (termcap entry "so" and "se")
4182 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004183 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004184 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 n no highlighting
4186 - no highlighting
4187 : use a highlight group
4188 The default is used for occasions that are not included.
4189 If you want to change what the display modes do, see |dos-colors|
4190 for an example.
4191 When using the ':' display mode, this must be followed by the name of
4192 a highlight group. A highlight group can be used to define any type
4193 of highlighting, including using color. See |:highlight| on how to
4194 define one. The default uses a different group for each occasion.
4195 See |highlight-default| for the default highlight groups.
4196
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004198'history' 'hi' number (Vim default: 50, Vi default: 0,
4199 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 global
4201 {not in Vi}
4202 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004203 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004205 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 NOTE: This option is set to the Vi default value when 'compatible' is
4207 set and to the Vim default value when 'compatible' is reset.
4208
4209 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4210'hkmap' 'hk' boolean (default off)
4211 global
4212 {not in Vi}
4213 {only available when compiled with the |+rightleft|
4214 feature}
4215 When on, the keyboard is mapped for the Hebrew character set.
4216 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4217 toggle this option. See |rileft.txt|.
4218 NOTE: This option is reset when 'compatible' is set.
4219
4220 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4221'hkmapp' 'hkp' boolean (default off)
4222 global
4223 {not in Vi}
4224 {only available when compiled with the |+rightleft|
4225 feature}
4226 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4227 This is useful if you have a non-Hebrew keyboard.
4228 See |rileft.txt|.
4229 NOTE: This option is reset when 'compatible' is set.
4230
Bram Moolenaar036986f2017-03-16 17:41:02 +01004231 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4232'hlsearch' 'hls' boolean (default off)
4233 global
4234 {not in Vi}
4235 {not available when compiled without the
4236 |+extra_search| feature}
4237 When there is a previous search pattern, highlight all its matches.
4238 The type of highlighting used can be set with the 'l' occasion in the
4239 'highlight' option. This uses the "Search" highlight group by
4240 default. Note that only the matching text is highlighted, any offsets
4241 are not applied.
4242 See also: 'incsearch' and |:match|.
4243 When you get bored looking at the highlighted matches, you can turn it
4244 off with |:nohlsearch|. This does not change the option value, as
4245 soon as you use a search command, the highlighting comes back.
4246 'redrawtime' specifies the maximum time spent on finding matches.
4247 When the search pattern can match an end-of-line, Vim will try to
4248 highlight all of the matched text. However, this depends on where the
4249 search starts. This will be the first line in the window or the first
4250 line below a closed fold. A match in a previous line which is not
4251 drawn may not continue in a newly drawn line.
4252 You can specify whether the highlight status is restored on startup
4253 with the 'h' flag in 'viminfo' |viminfo-h|.
4254 NOTE: This option is reset when 'compatible' is set.
4255
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 *'icon'* *'noicon'*
4257'icon' boolean (default off, on when title can be restored)
4258 global
4259 {not in Vi}
4260 {not available when compiled without the |+title|
4261 feature}
4262 When on, the icon text of the window will be set to the value of
4263 'iconstring' (if it is not empty), or to the name of the file
4264 currently being edited. Only the last part of the name is used.
4265 Overridden by the 'iconstring' option.
4266 Only works if the terminal supports setting window icons (currently
4267 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4268 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4269 builtin termcap).
4270 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004271 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004272 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004273 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275 *'iconstring'*
4276'iconstring' string (default "")
4277 global
4278 {not in Vi}
4279 {not available when compiled without the |+title|
4280 feature}
4281 When this option is not empty, it will be used for the icon text of
4282 the window. This happens only when the 'icon' option is on.
4283 Only works if the terminal supports setting window icon text
4284 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4285 Does not work for MS Windows.
4286 When Vim was compiled with HAVE_X11 defined, the original icon will be
4287 restored if possible |X11|.
4288 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004289 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 'titlestring' for example settings.
4291 {not available when compiled without the |+statusline| feature}
4292
4293 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4294'ignorecase' 'ic' boolean (default off)
4295 global
4296 Ignore case in search patterns. Also used when searching in the tags
4297 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004298 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 Can be overruled by using "\c" or "\C" in the pattern, see
4300 |/ignorecase|.
4301
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004302 *'imactivatefunc'* *'imaf'*
4303'imactivatefunc' 'imaf' string (default "")
4304 global
4305 {not in Vi}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004306 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004307 activate or deactivate the Input Method.
4308 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004309
4310 Example: >
4311 function ImActivateFunc(active)
4312 if a:active
4313 ... do something
4314 else
4315 ... do something
4316 endif
4317 " return value is not used
4318 endfunction
4319 set imactivatefunc=ImActivateFunc
4320<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 *'imactivatekey'* *'imak'*
4322'imactivatekey' 'imak' string (default "")
4323 global
4324 {not in Vi}
4325 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004326 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 Specifies the key that your Input Method in X-Windows uses for
4328 activation. When this is specified correctly, vim can fully control
4329 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4330 You can't use this option to change the activation key, the option
4331 tells Vim what the key is.
4332 Format:
4333 [MODIFIER_FLAG-]KEY_STRING
4334
4335 These characters can be used for MODIFIER_FLAG (case is ignored):
4336 S Shift key
4337 L Lock key
4338 C Control key
4339 1 Mod1 key
4340 2 Mod2 key
4341 3 Mod3 key
4342 4 Mod4 key
4343 5 Mod5 key
4344 Combinations are allowed, for example "S-C-space" or "SC-space" are
4345 both shift+ctrl+space.
4346 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4347
4348 Example: >
4349 :set imactivatekey=S-space
4350< "S-space" means shift+space. This is the activation key for kinput2 +
4351 canna (Japanese), and ami (Korean).
4352
4353 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4354'imcmdline' 'imc' boolean (default off)
4355 global
4356 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 When set the Input Method is always on when starting to edit a command
4358 line, unless entering a search pattern (see 'imsearch' for that).
4359 Setting this option is useful when your input method allows entering
4360 English characters directly, e.g., when it's used to type accented
4361 characters with dead keys.
4362
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004363 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4365 global
4366 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 When set the Input Method is never used. This is useful to disable
4368 the IM when it doesn't work properly.
4369 Currently this option is on by default for SGI/IRIX machines. This
4370 may change in later releases.
4371
4372 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004373'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 local to buffer
4375 {not in Vi}
4376 Specifies whether :lmap or an Input Method (IM) is to be used in
4377 Insert mode. Valid values:
4378 0 :lmap is off and IM is off
4379 1 :lmap is ON and IM is off
4380 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 To always reset the option to zero when leaving Insert mode with <Esc>
4382 this can be used: >
4383 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4384< This makes :lmap and IM turn off automatically when leaving Insert
4385 mode.
4386 Note that this option changes when using CTRL-^ in Insert mode
4387 |i_CTRL-^|.
4388 The value is set to 1 when setting 'keymap' to a valid keymap name.
4389 It is also used for the argument of commands like "r" and "f".
4390 The value 0 may not work correctly with Athena and Motif with some XIM
4391 methods. Use 'imdisable' to disable XIM then.
4392
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004393 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004394 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004395 |+multi_byte_ime| or |global-ime|.
4396
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004398'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 local to buffer
4400 {not in Vi}
4401 Specifies whether :lmap or an Input Method (IM) is to be used when
4402 entering a search pattern. Valid values:
4403 -1 the value of 'iminsert' is used, makes it look like
4404 'iminsert' is also used when typing a search pattern
4405 0 :lmap is off and IM is off
4406 1 :lmap is ON and IM is off
4407 2 :lmap is off and IM is ON
4408 Note that this option changes when using CTRL-^ in Command-line mode
4409 |c_CTRL-^|.
4410 The value is set to 1 when it is not -1 and setting the 'keymap'
4411 option to a valid keymap name.
4412 The value 0 may not work correctly with Athena and Motif with some XIM
4413 methods. Use 'imdisable' to disable XIM then.
4414
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004415 *'imstatusfunc'* *'imsf'*
4416'imstatusfunc' 'imsf' string (default "")
4417 global
4418 {not in Vi}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004419 This option specifies a function that is called to obtain the status
4420 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004421 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004422
4423 Example: >
4424 function ImStatusFunc()
4425 let is_active = ...do something
4426 return is_active ? 1 : 0
4427 endfunction
4428 set imstatusfunc=ImStatusFunc
4429<
4430 NOTE: This function is invoked very often. Keep it fast.
4431
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004432 *'imstyle'* *'imst'*
4433'imstyle' 'imst' number (default 1)
4434 global
4435 {not in Vi}
4436 {only available when compiled with |+xim| and
4437 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004438 This option specifies the input style of Input Method:
4439 0 use on-the-spot style
4440 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004441 See: |xim-input-style|
4442
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004443 For a long time on-the-spot style had been used in the GTK version of
4444 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004445 |single-repeat|, etc. Therefore over-the-spot style becomes the
4446 default now. This should work fine for most people, however if you
4447 have any problem with it, try using on-the-spot style.
4448
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 *'include'* *'inc'*
4450'include' 'inc' string (default "^\s*#\s*include")
4451 global or local to buffer |global-local|
4452 {not in Vi}
4453 {not available when compiled without the
4454 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004455 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 pattern, just like for the "/" command (See |pattern|). The default
4457 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004458 "]I", "[d", etc.
4459 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004460 comes after the matched pattern. But if "\zs" appears in the pattern
4461 then the text matched from "\zs" to the end, or until "\ze" if it
4462 appears, is used as the file name. Use this to include characters
4463 that are not in 'isfname', such as a space. You can then use
4464 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004465 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466
4467 *'includeexpr'* *'inex'*
4468'includeexpr' 'inex' string (default "")
4469 local to buffer
4470 {not in Vi}
4471 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004472 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004474 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 :set includeexpr=substitute(v:fname,'\\.','/','g')
4476< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004477
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004479 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 Also used for |<cfile>|.
4481
Bram Moolenaar30b65812012-07-12 22:01:11 +02004482 The expression will be evaluated in the |sandbox| when set from a
4483 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004484
4485 It is not allowed to change text or jump to another window while
4486 evaluating 'includeexpr' |textlock|.
4487
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004489'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4490 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 global
4492 {not in Vi}
4493 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004494 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004495 While typing a search command, show where the pattern, as it was typed
4496 so far, matches. The matched string is highlighted. If the pattern
4497 is invalid or not found, nothing is shown. The screen will be updated
4498 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004499 Also applies to the pattern in commands: >
4500 :global
4501 :lvimgrep
4502 :lvimgrepadd
4503 :smagic
4504 :snomagic
4505 :sort
4506 :substitute
4507 :vglobal
4508 :vimgrep
4509 :vimgrepadd
4510< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004511 original position when no match is found and when pressing <Esc>. You
4512 still need to finish the search command with <Enter> to move the
4513 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004514 You can use the CTRL-G and CTRL-T keys to move to the next and
4515 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004516 When compiled with the |+reltime| feature Vim only searches for about
4517 half a second. With a complicated pattern and/or a lot of text the
4518 match may not be found. This is to avoid that Vim hangs while you
4519 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004520 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004521 When 'hlsearch' is on, all matched strings are highlighted too while
4522 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004523 If you don't want to turn 'hlsearch' on, but want to highlight all
4524 matches while searching, you can turn on and off 'hlsearch' with
4525 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004526 augroup vimrc-incsearch-highlight
4527 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004528 autocmd CmdlineEnter /,\? :set hlsearch
4529 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004530 augroup END
4531<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004532 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004533 to the command line. If 'ignorecase' and 'smartcase' are set and the
4534 command line has no uppercase characters, the added character is
4535 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004536 CTRL-R CTRL-W can be used to add the word at the end of the current
4537 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 NOTE: This option is reset when 'compatible' is set.
4539
4540 *'indentexpr'* *'inde'*
4541'indentexpr' 'inde' string (default "")
4542 local to buffer
4543 {not in Vi}
4544 {not available when compiled without the |+cindent|
4545 or |+eval| features}
4546 Expression which is evaluated to obtain the proper indent for a line.
4547 It is used when a new line is created, for the |=| operator and
4548 in Insert mode as specified with the 'indentkeys' option.
4549 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004550 'smartindent' indenting. When 'lisp' is set, this option is
4551 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 When 'paste' is set this option is not used for indenting.
4553 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004554 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 when the expression is evaluated (but it may be moved around).
4556 The expression must return the number of spaces worth of indent. It
4557 can return "-1" to keep the current indent (this means 'autoindent' is
4558 used for the indent).
4559 Functions useful for computing the indent are |indent()|, |cindent()|
4560 and |lispindent()|.
4561 The evaluation of the expression must not have side effects! It must
4562 not change the text, jump to another window, etc. Afterwards the
4563 cursor position is always restored, thus the cursor may be moved.
4564 Normally this option would be set to call a function: >
4565 :set indentexpr=GetMyIndent()
4566< Error messages will be suppressed, unless the 'debug' option contains
4567 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004568 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004569 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
Bram Moolenaar30b65812012-07-12 22:01:11 +02004571 The expression will be evaluated in the |sandbox| when set from a
4572 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004573
4574 It is not allowed to change text or jump to another window while
4575 evaluating 'indentexpr' |textlock|.
4576
4577
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004579'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 local to buffer
4581 {not in Vi}
4582 {not available when compiled without the |+cindent|
4583 feature}
4584 A list of keys that, when typed in Insert mode, cause reindenting of
4585 the current line. Only happens if 'indentexpr' isn't empty.
4586 The format is identical to 'cinkeys', see |indentkeys-format|.
4587 See |C-indenting| and |indent-expression|.
4588
4589 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4590'infercase' 'inf' boolean (default off)
4591 local to buffer
4592 {not in Vi}
4593 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004594 'ignorecase' is also on, the case of the match is adjusted depending
4595 on the typed text. If the typed text contains a lowercase letter
4596 where the match has an upper case letter, the completed part is made
4597 lowercase. If the typed text has no lowercase letters and the match
4598 has a lowercase letter where the typed text has an uppercase letter,
4599 and there is a letter before it, the completed part is made uppercase.
4600 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
4602 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4603'insertmode' 'im' boolean (default off)
4604 global
4605 {not in Vi}
4606 Makes Vim work in a way that Insert mode is the default mode. Useful
4607 if you want to use Vim as a modeless editor. Used for |evim|.
4608 These Insert mode commands will be useful:
4609 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004610 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 this is a mapping, it is executed as if 'insertmode' was off.
4612 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004614 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4615 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
4617 These items change when 'insertmode' is set:
4618 - when starting to edit of a file, Vim goes to Insert mode.
4619 - <Esc> in Insert mode is a no-op and beeps.
4620 - <Esc> in Normal mode makes Vim go to Insert mode.
4621 - CTRL-L in Insert mode is a command, it is not inserted.
4622 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4623 However, when <Esc> is used inside a mapping, it behaves like
4624 'insertmode' was not set. This was done to be able to use the same
4625 mappings with 'insertmode' set or not set.
4626 When executing commands with |:normal| 'insertmode' is not used.
4627
4628 NOTE: This option is reset when 'compatible' is set.
4629
4630 *'isfname'* *'isf'*
4631'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4632 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4633 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4634 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4635 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4636 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4637 global
4638 {not in Vi}
4639 The characters specified by this option are included in file names and
4640 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004641 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 Multi-byte characters 256 and above are always included, only the
4643 characters up to 255 are specified with this option.
4644 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004645 Think twice before adding white space to this option. Although a
4646 space may appear inside a file name, the effect will be that Vim
4647 doesn't know where a file name starts or ends when doing completion.
4648 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649
4650 Note that on systems using a backslash as path separator, Vim tries to
4651 do its best to make it work as you would expect. That is a bit
4652 tricky, since Vi originally used the backslash to escape special
4653 characters. Vim will not remove a backslash in front of a normal file
4654 name character on these systems, but it will on Unix and alikes. The
4655 '&' and '^' are not included by default, because these are special for
4656 cmd.exe.
4657
4658 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004659 Each part can be a single character number or a range. A range is two
4660 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 decimal number between 0 and 255 or the ASCII character itself (does
4662 not work for digits). Example:
4663 "_,-,128-140,#-43" (include '_' and '-' and the range
4664 128 to 140 and '#' to 43)
4665 If a part starts with '^', the following character number or range
4666 will be excluded from the option. The option is interpreted from left
4667 to right. Put the excluded character after the range where it is
4668 included. To include '^' itself use it as the last character of the
4669 option or the end of a range. Example:
4670 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4671 If the character is '@', all characters where isalpha() returns TRUE
4672 are included. Normally these are the characters a to z and A to Z,
4673 plus accented characters. To include '@' itself use "@-@". Examples:
4674 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004675 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 "a-z,A-Z,@-@" All letters plus the '@' character.
4677 A comma can be included by using it where a character number is
4678 expected. Example:
4679 "48-57,,,_" Digits, comma and underscore.
4680 A comma can be excluded by prepending a '^'. Example:
4681 " -~,^,,9" All characters from space to '~', excluding
4682 comma, plus <Tab>.
4683 See |option-backslash| about including spaces and backslashes.
4684
4685 *'isident'* *'isi'*
4686'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4687 "@,48-57,_,128-167,224-235"
4688 otherwise: "@,48-57,_,192-255")
4689 global
4690 {not in Vi}
4691 The characters given by this option are included in identifiers.
4692 Identifiers are used in recognizing environment variables and after a
4693 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004694 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004695 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004697 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4699
4700 *'iskeyword'* *'isk'*
4701'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4702 "@,48-57,_,128-167,224-235"
4703 otherwise: "@,48-57,_,192-255"
4704 Vi default: "@,48-57,_")
4705 local to buffer
4706 {not in Vi}
4707 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004708 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004709 'isfname' for a description of the format of this option. For '@'
4710 characters above 255 check the "word" character class.
4711 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 For a help file it is set to all non-blank printable characters except
4713 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4714 command).
4715 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004716 This option also influences syntax highlighting, unless the syntax
4717 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 NOTE: This option is set to the Vi default value when 'compatible' is
4719 set and to the Vim default value when 'compatible' is reset.
4720
4721 *'isprint'* *'isp'*
4722'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4723 "@,~-255"; otherwise: "@,161-255")
4724 global
4725 {not in Vi}
4726 The characters given by this option are displayed directly on the
4727 screen. It is also used for "\p" in a |pattern|. The characters from
4728 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4729 even when they are not included in 'isprint' or excluded. See
4730 'isfname' for a description of the format of this option.
4731
4732 Non-printable characters are displayed with two characters:
4733 0 - 31 "^@" - "^_"
4734 32 - 126 always single characters
4735 127 "^?"
4736 128 - 159 "~@" - "~_"
4737 160 - 254 "| " - "|~"
4738 255 "~?"
4739 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4740 displayed as <xx>, with the hexadecimal value of the byte.
4741 When 'display' contains "uhex" all unprintable characters are
4742 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004743 The SpecialKey highlighting will be used for unprintable characters.
4744 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745
4746 Multi-byte characters 256 and above are always included, only the
4747 characters up to 255 are specified with this option. When a character
4748 is printable but it is not available in the current font, a
4749 replacement character will be shown.
4750 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4751 There is no option to specify these characters.
4752
4753 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4754'joinspaces' 'js' boolean (default on)
4755 global
4756 {not in Vi}
4757 Insert two spaces after a '.', '?' and '!' with a join command.
4758 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4759 Otherwise only one space is inserted.
4760 NOTE: This option is set when 'compatible' is set.
4761
4762 *'key'*
4763'key' string (default "")
4764 local to buffer
4765 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004766 {only available when compiled with the |+cryptv|
4767 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004769 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 Careful: Do not set the key value by hand, someone might see the typed
4771 key. Use the |:X| command. But you can make 'key' empty: >
4772 :set key=
4773< It is not possible to get the value of this option with ":set key" or
4774 "echo &key". This is to avoid showing it to someone who shouldn't
4775 know. It also means you cannot see it yourself once you have set it,
4776 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004777 You can use "&key" in an expression to detect whether encryption is
4778 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779
4780 *'keymap'* *'kmp'* *E544*
4781'keymap' 'kmp' string (default "")
4782 local to buffer
4783 {not in Vi}
4784 {only available when compiled with the |+keymap|
4785 feature}
4786 Name of a keyboard mapping. See |mbyte-keymap|.
4787 Setting this option to a valid keymap name has the side effect of
4788 setting 'iminsert' to one, so that the keymap becomes effective.
4789 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004790 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
4792 *'keymodel'* *'km'*
4793'keymodel' 'km' string (default "")
4794 global
4795 {not in Vi}
4796 List of comma separated words, which enable special things that keys
4797 can do. These values can be used:
4798 startsel Using a shifted special key starts selection (either
4799 Select mode or Visual mode, depending on "key" being
4800 present in 'selectmode').
4801 stopsel Using a not-shifted special key stops selection.
4802 Special keys in this context are the cursor keys, <End>, <Home>,
4803 <PageUp> and <PageDown>.
4804 The 'keymodel' option is set by the |:behave| command.
4805
4806 *'keywordprg'* *'kp'*
4807'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004808 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 global or local to buffer |global-local|
4810 {not in Vi}
4811 Program to use for the |K| command. Environment variables are
4812 expanded |:set_env|. ":help" may be used to access the Vim internal
4813 help. (Note that previously setting the global option to the empty
4814 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004815 When the first character is ":", the command is invoked as a Vim
4816 Ex command prefixed with [count].
4817 When "man", "man -s" or an Ex command is used, Vim will automatically
4818 translate a count for the "K" command and pass it as the first
4819 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 See |option-backslash| about including spaces and backslashes.
4821 Example: >
4822 :set keywordprg=man\ -s
4823< This option cannot be set from a |modeline| or in the |sandbox|, for
4824 security reasons.
4825
4826 *'langmap'* *'lmap'* *E357* *E358*
4827'langmap' 'lmap' string (default "")
4828 global
4829 {not in Vi}
4830 {only available when compiled with the |+langmap|
4831 feature}
4832 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004833 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004834 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 care of translating these special characters to the original meaning
4836 of the key. This means you don't have to change the keyboard mode to
4837 be able to execute Normal mode commands.
4838 This is the opposite of the 'keymap' option, where characters are
4839 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004840 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004841 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004842 This option cannot be set from a |modeline| or in the |sandbox|, for
4843 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004845 Example (for Greek, in UTF-8): *greek* >
4846 :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 +00004847< Example (exchanges meaning of z and y for commands): >
4848 :set langmap=zy,yz,ZY,YZ
4849<
4850 The 'langmap' option is a list of parts, separated with commas. Each
4851 part can be in one of two forms:
4852 1. A list of pairs. Each pair is a "from" character immediately
4853 followed by the "to" character. Examples: "aA", "aAbBcC".
4854 2. A list of "from" characters, a semi-colon and a list of "to"
4855 characters. Example: "abc;ABC"
4856 Example: "aA,fgh;FGH,cCdDeE"
4857 Special characters need to be preceded with a backslash. These are
4858 ";", ',' and backslash itself.
4859
4860 This will allow you to activate vim actions without having to switch
4861 back and forth between the languages. Your language characters will
4862 be understood as normal vim English characters (according to the
4863 langmap mappings) in the following cases:
4864 o Normal/Visual mode (commands, buffer/register names, user mappings)
4865 o Insert/Replace Mode: Register names after CTRL-R
4866 o Insert/Replace Mode: Mappings
4867 Characters entered in Command-line mode will NOT be affected by
4868 this option. Note that this option can be changed at any time
4869 allowing to switch between mappings for different languages/encodings.
4870 Use a mapping to avoid having to type it each time!
4871
4872 *'langmenu'* *'lm'*
4873'langmenu' 'lm' string (default "")
4874 global
4875 {not in Vi}
4876 {only available when compiled with the |+menu| and
4877 |+multi_lang| features}
4878 Language to use for menu translation. Tells which file is loaded
4879 from the "lang" directory in 'runtimepath': >
4880 "lang/menu_" . &langmenu . ".vim"
4881< (without the spaces). For example, to always use the Dutch menus, no
4882 matter what $LANG is set to: >
4883 :set langmenu=nl_NL.ISO_8859-1
4884< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004885 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 If your $LANG is set to a non-English language but you do want to use
4887 the English menus: >
4888 :set langmenu=none
4889< This option must be set before loading menus, switching on filetype
4890 detection or syntax highlighting. Once the menus are defined setting
4891 this option has no effect. But you could do this: >
4892 :source $VIMRUNTIME/delmenu.vim
4893 :set langmenu=de_DE.ISO_8859-1
4894 :source $VIMRUNTIME/menu.vim
4895< Warning: This deletes all menus that you defined yourself!
4896
Bram Moolenaard94464e2015-11-02 15:28:18 +01004897 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004898'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004899 global
4900 {not in Vi}
4901 {only available when compiled with the |+langmap|
4902 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004903 This is just like 'langremap' but with the value inverted. It only
4904 exists for backwards compatibility. When setting 'langremap' then
4905 'langnoremap' is set to the inverted value, and the other way around.
4906
4907 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4908'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4909 global
4910 {not in Vi}
4911 {only available when compiled with the |+langmap|
4912 feature}
4913 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004914 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004915 'langmap' disables some of your mappings, try resetting this option.
4916 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004917 that works for you to avoid mappings to break.
4918
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 *'laststatus'* *'ls'*
4920'laststatus' 'ls' number (default 1)
4921 global
4922 {not in Vi}
4923 The value of this option influences when the last window will have a
4924 status line:
4925 0: never
4926 1: only if there are at least two windows
4927 2: always
4928 The screen looks nicer with a status line if you have several
4929 windows, but it takes another screen line. |status-line|
4930
4931 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4932'lazyredraw' 'lz' boolean (default off)
4933 global
4934 {not in Vi}
4935 When this option is set, the screen will not be redrawn while
4936 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004937 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004938 update use |:redraw|.
4939
4940 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4941'linebreak' 'lbr' boolean (default off)
4942 local to window
4943 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004944 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004946 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 than at the last character that fits on the screen. Unlike
4948 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004949 it only affects the way the file is displayed, not its contents.
4950 If 'breakindent' is set, line is visually indented. Then, the value
4951 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004952 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 Note that <Tab> characters after an <EOL> are mostly not displayed
4954 with the right amount of white space.
4955
4956 *'lines'* *E593*
4957'lines' number (default 24 or terminal height)
4958 global
4959 Number of lines of the Vim window.
4960 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004961 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 When Vim is running in the GUI or in a resizable window, setting this
4963 option will cause the window size to be changed. When you only want
4964 to use the size for the GUI, put the command in your |gvimrc| file.
4965 Vim limits the number of lines to what fits on the screen. You can
4966 use this command to get the tallest window possible: >
4967 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004968< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004969 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 When you set this option and Vim is unable to change the physical
4971 number of lines of the display, the display may be messed up.
4972
4973 *'linespace'* *'lsp'*
4974'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4975 global
4976 {not in Vi}
4977 {only in the GUI}
4978 Number of pixel lines inserted between characters. Useful if the font
4979 uses the full character cell height, making lines touch each other.
4980 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004981 With some fonts there can be too much room between lines (to have
4982 space for ascents and descents). Then it makes sense to set
4983 'linespace' to a negative value. This may cause display problems
4984 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
4986 *'lisp'* *'nolisp'*
4987'lisp' boolean (default off)
4988 local to buffer
4989 {not available when compiled without the |+lispindent|
4990 feature}
4991 Lisp mode: When <Enter> is typed in insert mode set the indent for
4992 the next line to Lisp standards (well, sort of). Also happens with
4993 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4994 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4995 better. Also see 'lispwords'.
4996 The '-' character is included in keyword characters. Redefines the
4997 "=" operator to use this same indentation algorithm rather than
4998 calling an external program if 'equalprg' is empty.
4999 This option is not used when 'paste' is set.
5000 {Vi: Does it a little bit differently}
5001
5002 *'lispwords'* *'lw'*
5003'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01005004 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 {not in Vi}
5006 {not available when compiled without the |+lispindent|
5007 feature}
5008 Comma separated list of words that influence the Lisp indenting.
5009 |'lisp'|
5010
5011 *'list'* *'nolist'*
5012'list' boolean (default off)
5013 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005014 List mode: Show tabs as CTRL-I is displayed, display $ after end of
5015 line. Useful to see the difference between tabs and spaces and for
5016 trailing blanks. Further changed by the 'listchars' option.
5017
5018 The cursor is displayed at the start of the space a Tab character
5019 occupies, not at the end as usual in Normal mode. To get this cursor
5020 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02005021 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005022<
5023 Note that list mode will also affect formatting (set with 'textwidth'
5024 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 changing the way tabs are displayed.
5026
5027 *'listchars'* *'lcs'*
5028'listchars' 'lcs' string (default "eol:$")
5029 global
5030 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02005031 Strings to use in 'list' mode and for the |:list| command. It is a
5032 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02005033 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 eol:c Character to show at the end of each line. When
5035 omitted, there is no extra character at the end of the
5036 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02005037 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01005038 tab:xy[z] Two or three characters to be used to show a tab.
5039 The third character is optional.
5040
5041 tab:xy The 'x' is always used, then 'y' as many times as will
5042 fit. Thus "tab:>-" displays:
5043 >
5044 >-
5045 >--
5046 etc.
5047
5048 tab:xyz The 'z' is always used, then 'x' is prepended, and
5049 then 'y' is used as many times as will fit. Thus
5050 "tab:<->" displays:
5051 >
5052 <>
5053 <->
5054 <-->
5055 etc.
5056
5057 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02005058 *lcs-space*
5059 space:c Character to show for a space. When omitted, spaces
5060 are left blank.
5061 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005062 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02005063 trailing spaces are blank. Overrides the "space"
5064 setting for trailing spaces.
5065 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005066 extends:c Character to show in the last column, when 'wrap' is
5067 off and the line continues beyond the right of the
5068 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02005069 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 precedes:c Character to show in the first column, when 'wrap'
5071 is off and there is text preceding the character
5072 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005073 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005074 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005075 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005076 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005077 nbsp:c Character to show for a non-breakable space character
5078 (0xA0 (160 decimal) and U+202F). Left blank when
5079 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005080
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005081 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005083 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084
5085 Examples: >
5086 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005087 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 :set lcs=extends:>,precedes:<
5089< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005090 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005091 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092
5093 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5094'loadplugins' 'lpl' boolean (default on)
5095 global
5096 {not in Vi}
5097 When on the plugin scripts are loaded when starting up |load-plugins|.
5098 This option can be reset in your |vimrc| file to disable the loading
5099 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005100 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5101 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102
Bram Moolenaard94464e2015-11-02 15:28:18 +01005103 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005104'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005105 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005106 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005107 {only available when compiled with the |+lua/dyn|
5108 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005109 Specifies the name of the Lua shared library. The default is
5110 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005111 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005112 This option cannot be set from a |modeline| or in the |sandbox|, for
5113 security reasons.
5114
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005115 *'macatsui'* *'nomacatsui'*
5116'macatsui' boolean (default on)
5117 global
5118 {only available in Mac GUI version}
5119 This is a workaround for when drawing doesn't work properly. When set
5120 and compiled with multi-byte support ATSUI text drawing is used. When
5121 not set ATSUI text drawing is not used. Switch this option off when
5122 you experience drawing problems. In a future version the problems may
5123 be solved and this option becomes obsolete. Therefore use this method
5124 to unset it: >
5125 if exists('&macatsui')
5126 set nomacatsui
5127 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005128< Another option to check if you have drawing problems is
5129 'termencoding'.
5130
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 *'magic'* *'nomagic'*
5132'magic' boolean (default on)
5133 global
5134 Changes the special characters that can be used in search patterns.
5135 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005136 WARNING: Switching this option off most likely breaks plugins! That
5137 is because many patterns assume it's on and will fail when it's off.
5138 Only switch it off when working with old Vi scripts. In any other
5139 situation write patterns that work when 'magic' is on. Include "\M"
5140 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
5142 *'makeef'* *'mef'*
5143'makeef' 'mef' string (default: "")
5144 global
5145 {not in Vi}
5146 {not available when compiled without the |+quickfix|
5147 feature}
5148 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5149 and the |:grep| command.
5150 When it is empty, an internally generated temp file will be used.
5151 When "##" is included, it is replaced by a number to make the name
5152 unique. This makes sure that the ":make" command doesn't overwrite an
5153 existing file.
5154 NOT used for the ":cf" command. See 'errorfile' for that.
5155 Environment variables are expanded |:set_env|.
5156 See |option-backslash| about including spaces and backslashes.
5157 This option cannot be set from a |modeline| or in the |sandbox|, for
5158 security reasons.
5159
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005160 *'makeencoding'* *'menc'*
5161'makeencoding' 'menc' string (default "")
5162 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005163 {not in Vi}
5164 Encoding used for reading the output of external commands. When empty,
5165 encoding is not converted.
5166 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5167 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5168 and `:laddfile`.
5169
5170 This would be mostly useful when you use MS-Windows and set 'encoding'
5171 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5172 'makeencoding' to "char" has the same effect as setting to the system
5173 locale encoding. Example: >
5174 :set encoding=utf-8
5175 :set makeencoding=char " system locale is used
5176<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 *'makeprg'* *'mp'*
5178'makeprg' 'mp' string (default "make", VMS: "MMS")
5179 global or local to buffer |global-local|
5180 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005181 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005182 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5183 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01005184 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005185 Environment variables are expanded |:set_env|. See |option-backslash|
5186 about including spaces and backslashes.
5187 Note that a '|' must be escaped twice: once for ":set" and once for
5188 the interpretation of a command. When you use a filter called
5189 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190 :set makeprg=gmake\ \\\|\ myfilter
5191< The placeholder "$*" can be given (even multiple times) to specify
5192 where the arguments will be included, for example: >
5193 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5194< This option cannot be set from a |modeline| or in the |sandbox|, for
5195 security reasons.
5196
5197 *'matchpairs'* *'mps'*
5198'matchpairs' 'mps' string (default "(:),{:},[:]")
5199 local to buffer
5200 {not in Vi}
5201 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005202 other.
5203 Only character pairs are allowed that are different, thus you cannot
5204 jump between two double quotes.
5205 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005206 The pairs must be separated by a comma. Example for including '<' and
5207 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 :set mps+=<:>
5209
5210< A more exotic example, to jump between the '=' and ';' in an
5211 assignment, useful for languages like C and Java: >
5212 :au FileType c,cpp,java set mps+==:;
5213
5214< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005215 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
5217 *'matchtime'* *'mat'*
5218'matchtime' 'mat' number (default 5)
5219 global
5220 {not in Vi}{in Nvi}
5221 Tenths of a second to show the matching paren, when 'showmatch' is
5222 set. Note that this is not in milliseconds, like other options that
5223 set a time. This is to be compatible with Nvi.
5224
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005225 *'maxcombine'* *'mco'*
5226'maxcombine' 'mco' number (default 2)
5227 global
5228 {not in Vi}
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005229 The maximum number of combining characters supported for displaying.
5230 Only used when 'encoding' is "utf-8".
5231 The default is OK for most languages. Hebrew may require 4.
5232 Maximum value is 6.
5233 Even when this option is set to 2 you can still edit text with more
5234 combining characters, you just can't see them. Use |g8| or |ga|.
5235 See |mbyte-combining|.
5236
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 *'maxfuncdepth'* *'mfd'*
5238'maxfuncdepth' 'mfd' number (default 100)
5239 global
5240 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005241 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005242 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 Maximum depth of function calls for user functions. This normally
5244 catches endless recursion. When using a recursive function with
5245 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5246 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005247 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005248 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 See also |:function|.
5250
5251 *'maxmapdepth'* *'mmd'* *E223*
5252'maxmapdepth' 'mmd' number (default 1000)
5253 global
5254 {not in Vi}
5255 Maximum number of times a mapping is done without resulting in a
5256 character to be used. This normally catches endless mappings, like
5257 ":map x y" with ":map y x". It still does not catch ":map g wg",
5258 because the 'w' is used before the next mapping is done. See also
5259 |key-mapping|.
5260
5261 *'maxmem'* *'mm'*
5262'maxmem' 'mm' number (default between 256 to 5120 (system
5263 dependent) or half the amount of memory
5264 available)
5265 global
5266 {not in Vi}
5267 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5268 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005269 other memory to be freed.
5270 The maximum usable value is about 2000000. Use this to work without a
5271 limit.
5272 The value is ignored when 'swapfile' is off.
5273 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005275 *'maxmempattern'* *'mmp'*
5276'maxmempattern' 'mmp' number (default 1000)
5277 global
5278 {not in Vi}
5279 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005280 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005281 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005282 When Vim runs into the limit it gives an error message and mostly
5283 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005284 Running into the limit often means that the pattern is very
5285 inefficient or too complex. This may already happen with the pattern
5286 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005287 Might also happen on redraw, when syntax rules try to match a complex
5288 text structure.
5289 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5290 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005291
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 *'maxmemtot'* *'mmt'*
5293'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5294 dependent) or half the amount of memory
5295 available)
5296 global
5297 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005298 Maximum amount of memory in Kbyte to use for all buffers together.
5299 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005300 without a limit.
5301 On 64 bit machines higher values might work. But hey, do you really
5302 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005303 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005304 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005305 Buffers with 'swapfile' off still count to the total amount of memory
5306 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005307 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
5309 *'menuitems'* *'mis'*
5310'menuitems' 'mis' number (default 25)
5311 global
5312 {not in Vi}
5313 {not available when compiled without the |+menu|
5314 feature}
5315 Maximum number of items to use in a menu. Used for menus that are
5316 generated from a list of items, e.g., the Buffers menu. Changing this
5317 option has no direct effect, the menu must be refreshed first.
5318
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005319 *'mkspellmem'* *'msm'*
5320'mkspellmem' 'msm' string (default "460000,2000,500")
5321 global
5322 {not in Vi}
5323 {not available when compiled without the |+syntax|
5324 feature}
5325 Parameters for |:mkspell|. This tunes when to start compressing the
5326 word tree. Compression can be slow when there are many words, but
5327 it's needed to avoid running out of memory. The amount of memory used
5328 per word depends very much on how similar the words are, that's why
5329 this tuning is complicated.
5330
5331 There are three numbers, separated by commas:
5332 {start},{inc},{added}
5333
5334 For most languages the uncompressed word tree fits in memory. {start}
5335 gives the amount of memory in Kbyte that can be used before any
5336 compression is done. It should be a bit smaller than the amount of
5337 memory that is available to Vim.
5338
5339 When going over the {start} limit the {inc} number specifies the
5340 amount of memory in Kbyte that can be allocated before another
5341 compression is done. A low number means compression is done after
5342 less words are added, which is slow. A high number means more memory
5343 will be allocated.
5344
5345 After doing compression, {added} times 1024 words can be added before
5346 the {inc} limit is ignored and compression is done when any extra
5347 amount of memory is needed. A low number means there is a smaller
5348 chance of hitting the {inc} limit, less memory is used but it's
5349 slower.
5350
5351 The languages for which these numbers are important are Italian and
5352 Hungarian. The default works for when you have about 512 Mbyte. If
5353 you have 1 Gbyte you could use: >
5354 :set mkspellmem=900000,3000,800
5355< If you have less than 512 Mbyte |:mkspell| may fail for some
5356 languages, no matter what you set 'mkspellmem' to.
5357
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005359'modeline' 'ml' boolean (Vim default: on (off for root),
5360 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 local to buffer
5362 *'modelines'* *'mls'*
5363'modelines' 'mls' number (default 5)
5364 global
5365 {not in Vi}
5366 If 'modeline' is on 'modelines' gives the number of lines that is
5367 checked for set commands. If 'modeline' is off or 'modelines' is zero
5368 no lines are checked. See |modeline|.
5369 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5370 set and to the Vim default value when 'compatible' is reset.
5371
5372 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5373'modifiable' 'ma' boolean (default on)
5374 local to buffer
5375 {not in Vi} *E21*
5376 When off the buffer contents cannot be changed. The 'fileformat' and
5377 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005378 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5381'modified' 'mod' boolean (default off)
5382 local to buffer
5383 {not in Vi}
5384 When on, the buffer is considered to be modified. This option is set
5385 when:
5386 1. A change was made to the text since it was last written. Using the
5387 |undo| command to go back to the original text will reset the
5388 option. But undoing changes that were made before writing the
5389 buffer will set the option again, since the text is different from
5390 when it was written.
5391 2. 'fileformat' or 'fileencoding' is different from its original
5392 value. The original value is set when the buffer is read or
5393 written. A ":set nomodified" command also resets the original
5394 values to the current values and the 'modified' option will be
5395 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005396 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005397 This option is not set when a change is made to the buffer as the
5398 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5399 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5400 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5402 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005403 Note that the text may actually be the same, e.g. 'modified' is set
5404 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405
5406 *'more'* *'nomore'*
5407'more' boolean (Vim default: on, Vi default: off)
5408 global
5409 {not in Vi}
5410 When on, listings pause when the whole screen is filled. You will get
5411 the |more-prompt|. When this option is off there are no pauses, the
5412 listing continues until finished.
5413 NOTE: This option is set to the Vi default value when 'compatible' is
5414 set and to the Vim default value when 'compatible' is reset.
5415
5416 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005417'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5418 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 global
5420 {not in Vi}
5421 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005422 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5423 sysmouse and Linux console with gpm). For using the mouse in the
5424 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005426 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 v Visual mode
5428 i Insert mode
5429 c Command-line mode
5430 h all previous modes when editing a help file
5431 a all previous modes
5432 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005433 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 :set mouse=a
5435< When the mouse is not enabled, the GUI will still use the mouse for
5436 modeless selection. This doesn't move the text cursor.
5437
5438 See |mouse-using|. Also see |'clipboard'|.
5439
5440 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005441 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 the mouse buttons can still be used by keeping the shift key pressed.
5443 Also see the 'clipboard' option.
5444
5445 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5446'mousefocus' 'mousef' boolean (default off)
5447 global
5448 {not in Vi}
5449 {only works in the GUI}
5450 The window that the mouse pointer is on is automatically activated.
5451 When changing the window layout or window focus in another way, the
5452 mouse pointer is moved to the window with keyboard focus. Off is the
5453 default because it makes using the pull down menus a little goofy, as
5454 a pointer transit may activate a window unintentionally.
5455
5456 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5457'mousehide' 'mh' boolean (default on)
5458 global
5459 {not in Vi}
5460 {only works in the GUI}
5461 When on, the mouse pointer is hidden when characters are typed.
5462 The mouse pointer is restored when the mouse is moved.
5463
5464 *'mousemodel'* *'mousem'*
5465'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5466 global
5467 {not in Vi}
5468 Sets the model to use for the mouse. The name mostly specifies what
5469 the right mouse button is used for:
5470 extend Right mouse button extends a selection. This works
5471 like in an xterm.
5472 popup Right mouse button pops up a menu. The shifted left
5473 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005474 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 popup_setpos Like "popup", but the cursor will be moved to the
5476 position where the mouse was clicked, and thus the
5477 selected operation will act upon the clicked object.
5478 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005479 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 course, that right clicking outside a selection will
5481 end Visual mode.
5482 Overview of what button does what for each model:
5483 mouse extend popup(_setpos) ~
5484 left click place cursor place cursor
5485 left drag start selection start selection
5486 shift-left search word extend selection
5487 right click extend selection popup menu (place cursor)
5488 right drag extend selection -
5489 middle click paste paste
5490
5491 In the "popup" model the right mouse button produces a pop-up menu.
5492 You need to define this first, see |popup-menu|.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005493 In a terminal the popup menu works if Vim is compiled with the
5494 |+insert_expand| option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495
5496 Note that you can further refine the meaning of buttons with mappings.
5497 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5498 selection (because that's handled in the GUI code directly).
5499
5500 The 'mousemodel' option is set by the |:behave| command.
5501
5502 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005503'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5504 vs:leftright,vd:lrsizing,m:no,
5505 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 global
5507 {not in Vi}
5508 {only available when compiled with the |+mouseshape|
5509 feature}
5510 This option tells Vim what the mouse pointer should look like in
5511 different modes. The option is a comma separated list of parts, much
5512 like used for 'guicursor'. Each part consist of a mode/location-list
5513 and an argument-list:
5514 mode-list:shape,mode-list:shape,..
5515 The mode-list is a dash separated list of these modes/locations:
5516 In a normal window: ~
5517 n Normal mode
5518 v Visual mode
5519 ve Visual mode with 'selection' "exclusive" (same as 'v',
5520 if not specified)
5521 o Operator-pending mode
5522 i Insert mode
5523 r Replace mode
5524
5525 Others: ~
5526 c appending to the command-line
5527 ci inserting in the command-line
5528 cr replacing in the command-line
5529 m at the 'Hit ENTER' or 'More' prompts
5530 ml idem, but cursor in the last line
5531 e any mode, pointer below last window
5532 s any mode, pointer on a status line
5533 sd any mode, while dragging a status line
5534 vs any mode, pointer on a vertical separator line
5535 vd any mode, while dragging a vertical separator line
5536 a everywhere
5537
5538 The shape is one of the following:
5539 avail name looks like ~
5540 w x arrow Normal mouse pointer
5541 w x blank no pointer at all (use with care!)
5542 w x beam I-beam
5543 w x updown up-down sizing arrows
5544 w x leftright left-right sizing arrows
5545 w x busy The system's usual busy pointer
5546 w x no The system's usual 'no input' pointer
5547 x udsizing indicates up-down resizing
5548 x lrsizing indicates left-right resizing
5549 x crosshair like a big thin +
5550 x hand1 black hand
5551 x hand2 white hand
5552 x pencil what you write with
5553 x question big ?
5554 x rightup-arrow arrow pointing right-up
5555 w x up-arrow arrow pointing up
5556 x <number> any X11 pointer number (see X11/cursorfont.h)
5557
5558 The "avail" column contains a 'w' if the shape is available for Win32,
5559 x for X11.
5560 Any modes not specified or shapes not available use the normal mouse
5561 pointer.
5562
5563 Example: >
5564 :set mouseshape=s:udsizing,m:no
5565< will make the mouse turn to a sizing arrow over the status lines and
5566 indicate no input when the hit-enter prompt is displayed (since
5567 clicking the mouse has no effect in this state.)
5568
5569 *'mousetime'* *'mouset'*
5570'mousetime' 'mouset' number (default 500)
5571 global
5572 {not in Vi}
5573 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5574 time in msec between two mouse clicks for the second click to be
5575 recognized as a multi click.
5576
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005577 *'mzschemedll'*
5578'mzschemedll' string (default depends on the build)
5579 global
5580 {not in Vi}
5581 {only available when compiled with the |+mzscheme/dyn|
5582 feature}
5583 Specifies the name of the MzScheme shared library. The default is
5584 DYNAMIC_MZSCH_DLL which was specified at compile time.
5585 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005586 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005587 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005588 This option cannot be set from a |modeline| or in the |sandbox|, for
5589 security reasons.
5590
5591 *'mzschemegcdll'*
5592'mzschemegcdll' string (default depends on the build)
5593 global
5594 {not in Vi}
5595 {only available when compiled with the |+mzscheme/dyn|
5596 feature}
5597 Specifies the name of the MzScheme GC shared library. The default is
5598 DYNAMIC_MZGC_DLL which was specified at compile time.
5599 The value can be equal to 'mzschemedll' if it includes the GC code.
5600 Environment variables are expanded |:set_env|.
5601 This option cannot be set from a |modeline| or in the |sandbox|, for
5602 security reasons.
5603
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005604 *'mzquantum'* *'mzq'*
5605'mzquantum' 'mzq' number (default 100)
5606 global
5607 {not in Vi}
5608 {not available when compiled without the |+mzscheme|
5609 feature}
5610 The number of milliseconds between polls for MzScheme threads.
5611 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005612 NOTE: This option is set to the Vim default value when 'compatible'
5613 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005616'nrformats' 'nf' string (default "bin,octal,hex",
5617 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 local to buffer
5619 {not in Vi}
5620 This defines what bases Vim will consider for numbers when using the
5621 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5622 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005623 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005625 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005626 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005628 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 considered to be hexadecimal. Example: Using CTRL-X on
5630 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005631 bin If included, numbers starting with "0b" or "0B" will be
5632 considered to be binary. Example: Using CTRL-X on
5633 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 Numbers which simply begin with a digit in the range 1-9 are always
5635 considered decimal. This also happens for numbers that are not
5636 recognized as octal or hex.
5637
5638 *'number'* *'nu'* *'nonumber'* *'nonu'*
5639'number' 'nu' boolean (default off)
5640 local to window
5641 Print the line number in front of each line. When the 'n' option is
5642 excluded from 'cpoptions' a wrapped line will not use the column of
5643 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005644 The 'numberwidth' option can be used to set the room used for the line
5645 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 When a long, wrapped line doesn't start with the first character, '-'
5647 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005648 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5649 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005650 *number_relativenumber*
5651 The 'relativenumber' option changes the displayed number to be
5652 relative to the cursor. Together with 'number' there are these
5653 four combinations (cursor in line 3):
5654
Bram Moolenaar3848e002016-03-19 18:42:29 +01005655 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005656 'nornu' 'nornu' 'rnu' 'rnu'
5657
5658 |apple | 1 apple | 2 apple | 2 apple
5659 |pear | 2 pear | 1 pear | 1 pear
5660 |nobody | 3 nobody | 0 nobody |3 nobody
5661 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005663 *'numberwidth'* *'nuw'*
5664'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5665 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005666 {not in Vi}
5667 {only available when compiled with the |+linebreak|
5668 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005669 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005670 when the 'number' or 'relativenumber' option is set or printing lines
5671 with a line number. Since one space is always between the number and
5672 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005673 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005674 fit the highest line number in the buffer respectively the number of
5675 rows in the window, depending on whether 'number' or 'relativenumber'
5676 is set. Thus with the Vim default of 4 there is room for a line number
5677 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005678 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005679 NOTE: This option is set to the Vi default value when 'compatible' is
5680 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005681
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005682 *'omnifunc'* *'ofu'*
5683'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005684 local to buffer
5685 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005686 {not available when compiled without the |+eval|
5687 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005688 This option specifies a function to be used for Insert mode omni
5689 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005690 See |complete-functions| for an explanation of how the function is
5691 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005692 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005693 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005694 This option cannot be set from a |modeline| or in the |sandbox|, for
5695 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005696
5697
Bram Moolenaar02467872007-05-06 13:22:01 +00005698 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005699'opendevice' 'odev' boolean (default off)
5700 global
5701 {not in Vi}
5702 {only for MS-DOS, MS-Windows and OS/2}
5703 Enable reading and writing from devices. This may get Vim stuck on a
5704 device that can be opened but doesn't actually do the I/O. Therefore
5705 it is off by default.
5706 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5707 result in editing a device.
5708
5709
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005710 *'operatorfunc'* *'opfunc'*
5711'operatorfunc' 'opfunc' string (default: empty)
5712 global
5713 {not in Vi}
5714 This option specifies a function to be called by the |g@| operator.
5715 See |:map-operator| for more info and an example.
5716
5717 This option cannot be set from a |modeline| or in the |sandbox|, for
5718 security reasons.
5719
5720
Bram Moolenaar251e1912011-06-19 05:09:16 +02005721 *'osfiletype'* *'oft'*
5722'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 local to buffer
5724 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005725 This option was supported on RISC OS, which has been removed.
5726
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005728 *'packpath'* *'pp'*
5729'packpath' 'pp' string (default: see 'runtimepath')
5730 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005731 Directories used to find packages. See |packages|.
5732
5733
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005735'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 global
5737 Specifies the nroff macros that separate paragraphs. These are pairs
5738 of two letters (see |object-motions|).
5739
5740 *'paste'* *'nopaste'*
5741'paste' boolean (default off)
5742 global
5743 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005744 Put Vim in Paste mode. This is useful if you want to cut or copy
5745 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 unexpected effects.
5747 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005748 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 knows about pasting and will mostly do the right thing without 'paste'
5750 being set. The same is true for a terminal where Vim handles the
5751 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005752 This option is reset when starting the GUI. Thus if you set it in
5753 your .vimrc it will work in a terminal, but not in the GUI. Setting
5754 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5755 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 When the 'paste' option is switched on (also when it was already on):
5757 - mapping in Insert mode and Command-line mode is disabled
5758 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005760 - 'expandtab' is reset
5761 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 - 'revins' is reset
5763 - 'ruler' is reset
5764 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005765 - 'smartindent' is reset
5766 - 'smarttab' is reset
5767 - 'softtabstop' is set to 0
5768 - 'textwidth' is set to 0
5769 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005772 - 'indentexpr'
5773 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 NOTE: When you start editing another file while the 'paste' option is
5775 on, settings from the modelines or autocommands may change the
5776 settings again, causing trouble when pasting text. You might want to
5777 set the 'paste' option again.
5778 When the 'paste' option is reset the mentioned options are restored to
5779 the value before the moment 'paste' was switched from off to on.
5780 Resetting 'paste' before ever setting it does not have any effect.
5781 Since mapping doesn't work while 'paste' is active, you need to use
5782 the 'pastetoggle' option to toggle the 'paste' option with some key.
5783
5784 *'pastetoggle'* *'pt'*
5785'pastetoggle' 'pt' string (default "")
5786 global
5787 {not in Vi}
5788 When non-empty, specifies the key sequence that toggles the 'paste'
5789 option. This is like specifying a mapping: >
5790 :map {keys} :set invpaste<CR>
5791< Where {keys} is the value of 'pastetoggle'.
5792 The difference is that it will work even when 'paste' is set.
5793 'pastetoggle' works in Insert mode and Normal mode, but not in
5794 Command-line mode.
5795 Mappings are checked first, thus overrule 'pastetoggle'. However,
5796 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5797 this: >
5798 :map <F10> :set paste<CR>
5799 :map <F11> :set nopaste<CR>
5800 :imap <F10> <C-O>:set paste<CR>
5801 :imap <F11> <nop>
5802 :set pastetoggle=<F11>
5803< This will make <F10> start paste mode and <F11> stop paste mode.
5804 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5805 mode everything is inserted literally, except the 'pastetoggle' key
5806 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005807 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808
5809 *'pex'* *'patchexpr'*
5810'patchexpr' 'pex' string (default "")
5811 global
5812 {not in Vi}
5813 {not available when compiled without the |+diff|
5814 feature}
5815 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005816 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817
Bram Moolenaardbc28022014-07-26 13:40:44 +02005818 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819'patchmode' 'pm' string (default "")
5820 global
5821 {not in Vi}
5822 When non-empty the oldest version of a file is kept. This can be used
5823 to keep the original version of a file if you are changing files in a
5824 source distribution. Only the first time that a file is written a
5825 copy of the original file will be kept. The name of the copy is the
5826 name of the original file with the string in the 'patchmode' option
5827 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005828 ".orig" or ".org". 'backupdir' must not be empty for this to work
5829 (Detail: The backup file is renamed to the patchmode file after the
5830 new file has been successfully written, that's why it must be possible
5831 to write a backup file). If there was no file to be backed up, an
5832 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 When the 'backupskip' pattern matches, a patchmode file is not made.
5834 Using 'patchmode' for compressed files appends the extension at the
5835 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5836 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005837 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005839 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840'path' 'pa' string (default on Unix: ".,/usr/include,,"
5841 on OS/2: ".,/emx/include,,"
5842 other systems: ".,,")
5843 global or local to buffer |global-local|
5844 {not in Vi}
5845 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005846 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5847 provided that the file being searched for has a relative path (not
5848 starting with "/", "./" or "../"). The directories in the 'path'
5849 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 - Use commas to separate directory names: >
5851 :set path=.,/usr/local/include,/usr/include
5852< - Spaces can also be used to separate directory names (for backwards
5853 compatibility with version 3.0). To have a space in a directory
5854 name, precede it with an extra backslash, and escape the space: >
5855 :set path=.,/dir/with\\\ space
5856< - To include a comma in a directory name precede it with an extra
5857 backslash: >
5858 :set path=.,/dir/with\\,comma
5859< - To search relative to the directory of the current file, use: >
5860 :set path=.
5861< - To search in the current directory use an empty string between two
5862 commas: >
5863 :set path=,,
5864< - A directory name may end in a ':' or '/'.
5865 - Environment variables are expanded |:set_env|.
5866 - When using |netrw.vim| URLs can be used. For example, adding
5867 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005868 - Search upwards and downwards in a directory tree using "*", "**" and
5869 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 {not available when compiled without the |+path_extra| feature}
5871 - Careful with '\' characters, type two to get one in the option: >
5872 :set path=.,c:\\include
5873< Or just use '/' instead: >
5874 :set path=.,c:/include
5875< Don't forget "." or files won't even be found in the same directory as
5876 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 it is something like 256 or 1024 characters.
5879 You can check if all the include files are found, using the value of
5880 'path', see |:checkpath|.
5881 The use of |:set+=| and |:set-=| is preferred when adding or removing
5882 directories from the list. This avoids problems when a future version
5883 uses another default. To remove the current directory use: >
5884 :set path-=
5885< To add the current directory use: >
5886 :set path+=
5887< To use an environment variable, you probably need to replace the
5888 separator. Here is an example to append $INCL, in which directory
5889 names are separated with a semi-colon: >
5890 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5891< Replace the ';' with a ':' or whatever separator is used. Note that
5892 this doesn't work when $INCL contains a comma or white space.
5893
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005894 *'perldll'*
5895'perldll' string (default depends on the build)
5896 global
5897 {not in Vi}
5898 {only available when compiled with the |+perl/dyn|
5899 feature}
5900 Specifies the name of the Perl shared library. The default is
5901 DYNAMIC_PERL_DLL, which was specified at compile time.
5902 Environment variables are expanded |:set_env|.
5903 This option cannot be set from a |modeline| or in the |sandbox|, for
5904 security reasons.
5905
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5907'preserveindent' 'pi' boolean (default off)
5908 local to buffer
5909 {not in Vi}
5910 When changing the indent of the current line, preserve as much of the
5911 indent structure as possible. Normally the indent is replaced by a
5912 series of tabs followed by spaces as required (unless |'expandtab'| is
5913 enabled, in which case only spaces are used). Enabling this option
5914 means the indent will preserve as many existing characters as possible
5915 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005916 'expandtab' does not apply to the preserved white space, a Tab remains
5917 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 NOTE: When using ">>" multiple times the resulting indent is a mix of
5919 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005920 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 Also see 'copyindent'.
5922 Use |:retab| to clean up white space.
5923
5924 *'previewheight'* *'pvh'*
5925'previewheight' 'pvh' number (default 12)
5926 global
5927 {not in Vi}
5928 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005929 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 Default height for a preview window. Used for |:ptag| and associated
5931 commands. Used for |CTRL-W_}| when no count is given.
5932
5933 *'previewwindow'* *'nopreviewwindow'*
5934 *'pvw'* *'nopvw'* *E590*
5935'previewwindow' 'pvw' boolean (default off)
5936 local to window
5937 {not in Vi}
5938 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005939 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005940 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005941 set. It's normally not set directly, but by using one of the commands
5942 |:ptag|, |:pedit|, etc.
5943
5944 *'printdevice'* *'pdev'*
5945'printdevice' 'pdev' string (default empty)
5946 global
5947 {not in Vi}
5948 {only available when compiled with the |+printer|
5949 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005950 The name of the printer to be used for |:hardcopy|.
5951 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005952 This option cannot be set from a |modeline| or in the |sandbox|, for
5953 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954
Bram Moolenaar8299df92004-07-10 09:47:34 +00005955 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005956'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 global
5958 {not in Vi}
5959 {only available when compiled with the |+printer|
5960 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005961 Sets the character encoding used when printing.
5962 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963
5964 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005965'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 global
5967 {not in Vi}
5968 {only available when compiled with the |+printer|
5969 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005970 Expression used to print the PostScript produced with |:hardcopy|.
5971 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005972 This option cannot be set from a |modeline| or in the |sandbox|, for
5973 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974
Bram Moolenaar8299df92004-07-10 09:47:34 +00005975 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976'printfont' 'pfn' string (default "courier")
5977 global
5978 {not in Vi}
5979 {only available when compiled with the |+printer|
5980 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005981 The name of the font that will be used for |:hardcopy|.
5982 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983
5984 *'printheader'* *'pheader'*
5985'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5986 global
5987 {not in Vi}
5988 {only available when compiled with the |+printer|
5989 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005990 The format of the header produced in |:hardcopy| output.
5991 See |pheader-option|.
5992
5993 *'printmbcharset'* *'pmbcs'*
5994'printmbcharset' 'pmbcs' string (default "")
5995 global
5996 {not in Vi}
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005997 {only available when compiled with the |+printer|
5998 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005999 The CJK character set to be used for CJK output from |:hardcopy|.
6000 See |pmbcs-option|.
6001
6002 *'printmbfont'* *'pmbfn'*
6003'printmbfont' 'pmbfn' string (default "")
6004 global
6005 {not in Vi}
Bram Moolenaar4c92e752019-02-17 21:18:32 +01006006 {only available when compiled with the |+printer|
6007 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006008 List of font names to be used for CJK output from |:hardcopy|.
6009 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010
6011 *'printoptions'* *'popt'*
6012'printoptions' 'popt' string (default "")
6013 global
6014 {not in Vi}
6015 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00006016 List of items that control the format of the output of |:hardcopy|.
6017 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006018
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006019 *'prompt'* *'noprompt'*
6020'prompt' boolean (default on)
6021 global
6022 When on a ":" prompt is used in Ex mode.
6023
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006024 *'pumheight'* *'ph'*
6025'pumheight' 'ph' number (default 0)
6026 global
6027 {not available when compiled without the
6028 |+insert_expand| feature}
6029 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00006030 Determines the maximum number of items to show in the popup menu for
6031 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006032 |ins-completion-menu|.
6033
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006034 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006035'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006036 global
6037 {not available when compiled without the
6038 |+insert_expand| feature}
6039 {not in Vi}
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006040 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01006041 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01006042
Bram Moolenaard94464e2015-11-02 15:28:18 +01006043 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006044'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006045 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006046 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006047 {only available when compiled with the |+python/dyn|
6048 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006049 Specifies the name of the Python 2.x shared library. The default is
6050 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006051 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006052 This option cannot be set from a |modeline| or in the |sandbox|, for
6053 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00006054
Bram Moolenaar94073162018-01-31 21:49:05 +01006055 *'pythonhome'*
6056'pythonhome' string (default "")
6057 global
6058 {not in Vi}
6059 {only available when compiled with the |+python/dyn|
6060 feature}
6061 Specifies the name of the Python 2.x home directory. When 'pythonhome'
6062 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
6063 which was specified at compile time, will be used for the Python 2.x
6064 home directory.
6065 Environment variables are expanded |:set_env|.
6066 This option cannot be set from a |modeline| or in the |sandbox|, for
6067 security reasons.
6068
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006069 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006070'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006071 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006072 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006073 {only available when compiled with the |+python3/dyn|
6074 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006075 Specifies the name of the Python 3 shared library. The default is
6076 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006077 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01006078 This option cannot be set from a |modeline| or in the |sandbox|, for
6079 security reasons.
6080
Bram Moolenaar94073162018-01-31 21:49:05 +01006081 *'pythonthreehome'*
6082'pythonthreehome' string (default "")
6083 global
6084 {not in Vi}
6085 {only available when compiled with the |+python3/dyn|
6086 feature}
6087 Specifies the name of the Python 3 home directory. When
6088 'pythonthreehome' and the PYTHONHOME environment variable are not set,
6089 PYTHON3_HOME, which was specified at compile time, will be used for
6090 the Python 3 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 Moolenaarf42dd3c2017-01-28 16:06:38 +01006095 *'pyxversion'* *'pyx'*
6096'pyxversion' 'pyx' number (default depends on the build)
6097 global
6098 {not in Vi}
6099 {only available when compiled with the |+python| or
6100 the |+python3| feature}
6101 Specifies the python version used for pyx* functions and commands
6102 |python_x|. The default value is as follows:
6103
6104 Compiled with Default ~
6105 |+python| and |+python3| 0
6106 only |+python| 2
6107 only |+python3| 3
6108
6109 Available values are 0, 2 and 3.
6110 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
6111 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
6112 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
6113 to 2 if Python 2 is available.
6114 See also: |has-pythonx|
6115
6116 If Vim is compiled with only |+python| or |+python3| setting
6117 'pyxversion' has no effect. The pyx* functions and commands are
6118 always the same as the compiled version.
6119
6120 This option cannot be set from a |modeline| or in the |sandbox|, for
6121 security reasons.
6122
Bram Moolenaar677ee682005-01-27 14:41:15 +00006123 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006124'quoteescape' 'qe' string (default "\")
6125 local to buffer
6126 {not in Vi}
6127 The characters that are used to escape quotes in a string. Used for
6128 objects like a', a" and a` |a'|.
6129 When one of the characters in this option is found inside a string,
6130 the following character will be skipped. The default value makes the
6131 text "foo\"bar\\" considered to be one string.
6132
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6134'readonly' 'ro' boolean (default off)
6135 local to buffer
6136 If on, writes fail unless you use a '!'. Protects you from
6137 accidentally overwriting a file. Default on when Vim is started
6138 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006139 When using ":w!" the 'readonly' option is reset for the current
6140 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006142 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006143 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006145 *'redrawtime'* *'rdt'*
6146'redrawtime' 'rdt' number (default 2000)
6147 global
6148 {not in Vi}
6149 {only available when compiled with the |+reltime|
6150 feature}
6151 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02006152 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006153 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006154 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006155 matches will be highlighted.
6156 For syntax highlighting the time applies per window. When over the
6157 limit syntax highlighting is disabled until |CTRL-L| is used.
6158 This is used to avoid that Vim hangs when using a very complicated
6159 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006160
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006161 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006162'regexpengine' 're' number (default 0)
6163 global
6164 {not in Vi}
6165 This selects the default regexp engine. |two-engines|
6166 The possible values are:
6167 0 automatic selection
6168 1 old engine
6169 2 NFA engine
6170 Note that when using the NFA engine and the pattern contains something
6171 that is not supported the pattern will not match. This is only useful
6172 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006173 Using automatic selection enables Vim to switch the engine, if the
6174 default engine becomes too costly. E.g., when the NFA engine uses too
6175 many states. This should prevent Vim from hanging on a combination of
6176 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006177
Bram Moolenaar64486672010-05-16 15:46:46 +02006178 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6179'relativenumber' 'rnu' boolean (default off)
6180 local to window
6181 {not in Vi}
6182 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006183 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006184 precede some vertical motion commands (e.g. j k + -) with, without
6185 having to calculate it yourself. Especially useful in combination with
6186 other commands (e.g. y d c < > gq gw =).
6187 When the 'n' option is excluded from 'cpoptions' a wrapped
6188 line will not use the column of line numbers (this is the default when
6189 'compatible' isn't set).
6190 The 'numberwidth' option can be used to set the room used for the line
6191 number.
6192 When a long, wrapped line doesn't start with the first character, '-'
6193 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006194 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6195 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01006196
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006197 The number in front of the cursor line also depends on the value of
6198 'number', see |number_relativenumber| for all combinations of the two
6199 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006200
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 *'remap'* *'noremap'*
6202'remap' boolean (default on)
6203 global
6204 Allows for mappings to work recursively. If you do not want this for
6205 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006206 NOTE: To avoid portability problems with Vim scripts, always keep
6207 this option at the default "on". Only switch it off when working with
6208 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006210 *'renderoptions'* *'rop'*
6211'renderoptions' 'rop' string (default: empty)
6212 global
6213 {not in Vi}
6214 {only available when compiled with GUI and DIRECTX on
6215 MS-Windows}
6216 Select a text renderer and set its options. The options depend on the
6217 renderer.
6218
6219 Syntax: >
6220 set rop=type:{renderer}(,{name}:{value})*
6221<
6222 Currently, only one optional renderer is available.
6223
6224 render behavior ~
6225 directx Vim will draw text using DirectX (DirectWrite). It makes
6226 drawn glyphs more beautiful than default GDI.
6227 It requires 'encoding' is "utf-8", and only works on
6228 MS-Windows Vista or newer version.
6229
6230 Options:
6231 name meaning type value ~
6232 gamma gamma float 1.0 - 2.2 (maybe)
6233 contrast enhancedContrast float (unknown)
6234 level clearTypeLevel float (unknown)
6235 geom pixelGeometry int 0 - 2 (see below)
6236 renmode renderingMode int 0 - 6 (see below)
6237 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006238 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006239
Bram Moolenaar92467d32017-12-05 13:22:16 +01006240 See this URL for detail (except for scrlines):
6241 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006242
6243 For geom: structure of a device pixel.
6244 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6245 1 - DWRITE_PIXEL_GEOMETRY_RGB
6246 2 - DWRITE_PIXEL_GEOMETRY_BGR
6247
6248 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006249 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006250
6251 For renmode: method of rendering glyphs.
6252 0 - DWRITE_RENDERING_MODE_DEFAULT
6253 1 - DWRITE_RENDERING_MODE_ALIASED
6254 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6255 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6256 4 - DWRITE_RENDERING_MODE_NATURAL
6257 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6258 6 - DWRITE_RENDERING_MODE_OUTLINE
6259
6260 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006261 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006262
6263 For taamode: antialiasing mode used for drawing text.
6264 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6265 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6266 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6267 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6268
6269 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006270 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6271
Bram Moolenaara338adc2018-01-31 20:51:47 +01006272 For scrlines:
6273 This was used for optimizing scrolling behavior, however this
6274 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006275
6276 Example: >
6277 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006278 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006279 set rop=type:directx
6280<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006281 If select a raster font (Courier, Terminal or FixedSys which
6282 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006283 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006284
6285 NOTE: It is known that some fonts and options combination
6286 causes trouble on drawing glyphs.
6287
Bram Moolenaar92467d32017-12-05 13:22:16 +01006288 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006289 special made fonts (True-Type fonts which includes only
6290 bitmap glyphs).
6291 - 'taamode:3' will not work with some vector fonts.
6292
6293 NOTE: With this option, you can display colored emoji
6294 (emoticon) in Windows 8.1 or later. To display colored emoji,
6295 there are some conditions which you should notice.
6296
6297 - If your font includes non-colored emoji already, it will
6298 be used.
6299 - If your font doesn't have emoji, the system chooses an
6300 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6301 will be used.
6302 - When this alternative font didn't have fixed width glyph,
6303 emoji might be rendered beyond the bounding box of drawing
6304 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006305
6306 Other render types are currently not supported.
6307
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 *'report'*
6309'report' number (default 2)
6310 global
6311 Threshold for reporting number of lines changed. When the number of
6312 changed lines is more than 'report' a message will be given for most
6313 ":" commands. If you want it always, set 'report' to 0.
6314 For the ":substitute" command the number of substitutions is used
6315 instead of the number of lines.
6316
6317 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6318'restorescreen' 'rs' boolean (default on)
6319 global
6320 {not in Vi} {only in Windows 95/NT console version}
6321 When set, the screen contents is restored when exiting Vim. This also
6322 happens when executing external commands.
6323
6324 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6325 options in your .vimrc. To disable restoring:
6326 set t_ti= t_te=
6327 To enable restoring (for an xterm):
6328 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6329 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6330
6331 *'revins'* *'ri'* *'norevins'* *'nori'*
6332'revins' 'ri' boolean (default off)
6333 global
6334 {not in Vi}
6335 {only available when compiled with the |+rightleft|
6336 feature}
6337 Inserting characters in Insert mode will work backwards. See "typing
6338 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6339 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006340 NOTE: This option is reset when 'compatible' is set.
6341 This option is reset when 'paste' is set and restored when 'paste' is
6342 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343
6344 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6345'rightleft' 'rl' boolean (default off)
6346 local to window
6347 {not in Vi}
6348 {only available when compiled with the |+rightleft|
6349 feature}
6350 When on, display orientation becomes right-to-left, i.e., characters
6351 that are stored in the file appear from the right to the left.
6352 Using this option, it is possible to edit files for languages that
6353 are written from the right to the left such as Hebrew and Arabic.
6354 This option is per window, so it is possible to edit mixed files
6355 simultaneously, or to view the same file in both ways (this is
6356 useful whenever you have a mixed text file with both right-to-left
6357 and left-to-right strings so that both sets are displayed properly
6358 in different windows). Also see |rileft.txt|.
6359
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006360 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361'rightleftcmd' 'rlc' string (default "search")
6362 local to window
6363 {not in Vi}
6364 {only available when compiled with the |+rightleft|
6365 feature}
6366 Each word in this option enables the command line editing to work in
6367 right-to-left mode for a group of commands:
6368
6369 search "/" and "?" commands
6370
6371 This is useful for languages such as Hebrew, Arabic and Farsi.
6372 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6373
Bram Moolenaard94464e2015-11-02 15:28:18 +01006374 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006375'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006376 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006377 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006378 {only available when compiled with the |+ruby/dyn|
6379 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006380 Specifies the name of the Ruby shared library. The default is
6381 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006382 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006383 This option cannot be set from a |modeline| or in the |sandbox|, for
6384 security reasons.
6385
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006387'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 global
6389 {not in Vi}
6390 {not available when compiled without the
6391 |+cmdline_info| feature}
6392 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006393 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 text in the file is shown on the far right:
6395 Top first line is visible
6396 Bot last line is visible
6397 All first and last line are visible
6398 45% relative position in the file
6399 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006400 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006402 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 this option takes precedence over 'ruler' and 'rulerformat'
6404 If the number of characters displayed is different from the number of
6405 bytes in the text (e.g., for a TAB or a multi-byte character), both
6406 the text column (byte number) and the screen column are shown,
6407 separated with a dash.
6408 For an empty line "0-1" is shown.
6409 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006410 This option is reset when 'paste' is set and restored when 'paste' is
6411 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 If you don't want to see the ruler all the time but want to know where
6413 you are, use "g CTRL-G" |g_CTRL-G|.
6414 NOTE: This option is reset when 'compatible' is set.
6415
6416 *'rulerformat'* *'ruf'*
6417'rulerformat' 'ruf' string (default empty)
6418 global
6419 {not in Vi}
6420 {not available when compiled without the |+statusline|
6421 feature}
6422 When this option is not empty, it determines the content of the ruler
6423 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006424 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 The default ruler width is 17 characters. To make the ruler 15
6426 characters wide, put "%15(" at the start and "%)" at the end.
6427 Example: >
6428 :set rulerformat=%15(%c%V\ %p%%%)
6429<
6430 *'runtimepath'* *'rtp'* *vimfiles*
6431'runtimepath' 'rtp' string (default:
6432 Unix: "$HOME/.vim,
6433 $VIM/vimfiles,
6434 $VIMRUNTIME,
6435 $VIM/vimfiles/after,
6436 $HOME/.vim/after"
6437 Amiga: "home:vimfiles,
6438 $VIM/vimfiles,
6439 $VIMRUNTIME,
6440 $VIM/vimfiles/after,
6441 home:vimfiles/after"
6442 PC, OS/2: "$HOME/vimfiles,
6443 $VIM/vimfiles,
6444 $VIMRUNTIME,
6445 $VIM/vimfiles/after,
6446 $HOME/vimfiles/after"
6447 Macintosh: "$VIM:vimfiles,
6448 $VIMRUNTIME,
6449 $VIM:vimfiles:after"
6450 RISC-OS: "Choices:vimfiles,
6451 $VIMRUNTIME,
6452 Choices:vimfiles/after"
6453 VMS: "sys$login:vimfiles,
6454 $VIM/vimfiles,
6455 $VIMRUNTIME,
6456 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006457 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 global
6459 {not in Vi}
6460 This is a list of directories which will be searched for runtime
6461 files:
6462 filetype.vim filetypes by file name |new-filetype|
6463 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006464 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 colors/ color scheme files |:colorscheme|
6466 compiler/ compiler files |:compiler|
6467 doc/ documentation |write-local-help|
6468 ftplugin/ filetype plugins |write-filetype-plugin|
6469 indent/ indent scripts |indent-expression|
6470 keymap/ key mapping files |mbyte-keymap|
6471 lang/ menu translations |:menutrans|
6472 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006473 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 plugin/ plugin scripts |write-plugin|
6475 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006476 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 syntax/ syntax files |mysyntaxfile|
6478 tutor/ files for vimtutor |tutor|
6479
6480 And any other file searched for with the |:runtime| command.
6481
6482 The defaults for most systems are setup to search five locations:
6483 1. In your home directory, for your personal preferences.
6484 2. In a system-wide Vim directory, for preferences from the system
6485 administrator.
6486 3. In $VIMRUNTIME, for files distributed with Vim.
6487 *after-directory*
6488 4. In the "after" directory in the system-wide Vim directory. This is
6489 for the system administrator to overrule or add to the distributed
6490 defaults (rarely needed)
6491 5. In the "after" directory in your home directory. This is for
6492 personal preferences to overrule or add to the distributed defaults
6493 or system-wide settings (rarely needed).
6494
Bram Moolenaard0796902016-09-16 20:02:31 +02006495 More entries are added when using |packages|. If it gets very long
6496 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6497 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006498
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6500 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006501 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 wildcards.
6503 See |:runtime|.
6504 Example: >
6505 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6506< This will use the directory "~/vimruntime" first (containing your
6507 personal Vim runtime files), then "/mygroup/vim" (shared between a
6508 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6509 files).
6510 You probably should always include $VIMRUNTIME somewhere, to use the
6511 distributed runtime files. You can put a directory before $VIMRUNTIME
6512 to find files which replace a distributed runtime files. You can put
6513 a directory after $VIMRUNTIME to find files which add to distributed
6514 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006515 When Vim is started with |--clean| the home directory entries are not
6516 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 This option cannot be set from a |modeline| or in the |sandbox|, for
6518 security reasons.
6519
6520 *'scroll'* *'scr'*
6521'scroll' 'scr' number (default: half the window height)
6522 local to window
6523 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6524 set to half the number of lines in the window when the window size
6525 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006526 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6528 the number of screen lines instead of file lines, makes a difference
6529 when lines wrap}
6530
6531 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6532'scrollbind' 'scb' boolean (default off)
6533 local to window
6534 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 See also |scroll-binding|. When this option is set, the current
6536 window scrolls as other scrollbind windows (windows that also have
6537 this option set) scroll. This option is useful for viewing the
6538 differences between two versions of a file, see 'diff'.
6539 See |'scrollopt'| for options that determine how this option should be
6540 interpreted.
6541 This option is mostly reset when splitting a window to edit another
6542 file. This means that ":split | edit file" results in two windows
6543 with scroll-binding, but ":split file" does not.
6544
6545 *'scrolljump'* *'sj'*
6546'scrolljump' 'sj' number (default 1)
6547 global
6548 {not in Vi}
6549 Minimal number of lines to scroll when the cursor gets off the
6550 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6551 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006552 When set to a negative number from -1 to -100 this is used as the
6553 percentage of the window height. Thus -50 scrolls half the window
6554 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 NOTE: This option is set to 1 when 'compatible' is set.
6556
6557 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006558'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006559 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 {not in Vi}
6561 Minimal number of screen lines to keep above and below the cursor.
6562 This will make some context visible around where you are working. If
6563 you set it to a very large value (999) the cursor line will always be
6564 in the middle of the window (except at the start or end of the file or
6565 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006566 After using the local value, go back the global value with one of
6567 these two: >
6568 setlocal scrolloff<
6569 setlocal scrolloff=-1
6570< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 NOTE: This option is set to 0 when 'compatible' is set.
6572
6573 *'scrollopt'* *'sbo'*
6574'scrollopt' 'sbo' string (default "ver,jump")
6575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 {not in Vi}
6577 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006578 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6579 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 The following words are available:
6581 ver Bind vertical scrolling for 'scrollbind' windows
6582 hor Bind horizontal scrolling for 'scrollbind' windows
6583 jump Applies to the offset between two windows for vertical
6584 scrolling. This offset is the difference in the first
6585 displayed line of the bound windows. When moving
6586 around in a window, another 'scrollbind' window may
6587 reach a position before the start or after the end of
6588 the buffer. The offset is not changed though, when
6589 moving back the 'scrollbind' window will try to scroll
6590 to the desired position when possible.
6591 When now making that window the current one, two
6592 things can be done with the relative offset:
6593 1. When "jump" is not included, the relative offset is
6594 adjusted for the scroll position in the new current
6595 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006596 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 2. When "jump" is included, the other windows are
6598 scrolled to keep the same relative offset. When
6599 going back to the other window, it still uses the
6600 same relative offset.
6601 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006602 When 'diff' mode is active there always is vertical scroll binding,
6603 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604
6605 *'sections'* *'sect'*
6606'sections' 'sect' string (default "SHNHH HUnhsh")
6607 global
6608 Specifies the nroff macros that separate sections. These are pairs of
6609 two letters (See |object-motions|). The default makes a section start
6610 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6611
6612 *'secure'* *'nosecure'* *E523*
6613'secure' boolean (default off)
6614 global
6615 {not in Vi}
6616 When on, ":autocmd", shell and write commands are not allowed in
6617 ".vimrc" and ".exrc" in the current directory and map commands are
6618 displayed. Switch it off only if you know that you will not run into
6619 problems, or when the 'exrc' option is off. On Unix this option is
6620 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006621 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 'secure' at the end of your ~/.vimrc then.
6623 This option cannot be set from a |modeline| or in the |sandbox|, for
6624 security reasons.
6625
6626 *'selection'* *'sel'*
6627'selection' 'sel' string (default "inclusive")
6628 global
6629 {not in Vi}
6630 This option defines the behavior of the selection. It is only used
6631 in Visual and Select mode.
6632 Possible values:
6633 value past line inclusive ~
6634 old no yes
6635 inclusive yes yes
6636 exclusive yes no
6637 "past line" means that the cursor is allowed to be positioned one
6638 character past the line.
6639 "inclusive" means that the last character of the selection is included
6640 in an operation. For example, when "x" is used to delete the
6641 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006642 When "old" is used and 'virtualedit' allows the cursor to move past
6643 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 Note that when "exclusive" is used and selecting from the end
6645 backwards, you cannot include the last character of a line, when
6646 starting in Normal mode and 'virtualedit' empty.
6647
6648 The 'selection' option is set by the |:behave| command.
6649
6650 *'selectmode'* *'slm'*
6651'selectmode' 'slm' string (default "")
6652 global
6653 {not in Vi}
6654 This is a comma separated list of words, which specifies when to start
6655 Select mode instead of Visual mode, when a selection is started.
6656 Possible values:
6657 mouse when using the mouse
6658 key when using shifted special keys
6659 cmd when using "v", "V" or CTRL-V
6660 See |Select-mode|.
6661 The 'selectmode' option is set by the |:behave| command.
6662
6663 *'sessionoptions'* *'ssop'*
6664'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006665 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 global
6667 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006668 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 feature}
6670 Changes the effect of the |:mksession| command. It is a comma
6671 separated list of words. Each word enables saving and restoring
6672 something:
6673 word save and restore ~
6674 blank empty windows
6675 buffers hidden and unloaded buffers, not just those in windows
6676 curdir the current directory
6677 folds manually created folds, opened/closed folds and local
6678 fold options
6679 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006680 and contain at least one lowercase letter. Only
6681 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 help the help window
6683 localoptions options and mappings local to a window or buffer (not
6684 global values for local options)
6685 options all options and mappings (also global values for local
6686 options)
6687 resize size of the Vim window: 'lines' and 'columns'
6688 sesdir the directory in which the session file is located
6689 will become the current directory (useful with
6690 projects accessed over a network from different
6691 systems)
6692 slash backslashes in file names replaced with forward
6693 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006694 tabpages all tab pages; without this only the current tab page
6695 is restored, so that you can make a session for each
6696 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006697 terminal include terminal windows where the command can be
6698 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 unix with Unix end-of-line format (single <NL>), even when
6700 on Windows or DOS
6701 winpos position of the whole Vim window
6702 winsize window sizes
6703
6704 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006705 When neither "curdir" nor "sesdir" is included, file names are stored
6706 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 "slash" and "unix" are useful on Windows when sharing session files
6708 with Unix. The Unix version of Vim cannot source dos format scripts,
6709 but the Windows version of Vim can source unix format scripts.
6710
6711 *'shell'* *'sh'* *E91*
6712'shell' 'sh' string (default $SHELL or "sh",
6713 MS-DOS and Win32: "command.com" or
6714 "cmd.exe", OS/2: "cmd")
6715 global
6716 Name of the shell to use for ! and :! commands. When changing the
6717 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6718 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006719 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 See |option-backslash| about including spaces and backslashes.
6721 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006722
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006724 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6726< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006727 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006729 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006731 Example with escaped space (Vim will do this when initializing the
6732 option from $SHELL): >
6733 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006734< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006735 backslashes are consumed by `:set`.
6736
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 Under MS-Windows, when the executable ends in ".com" it must be
6738 included. Thus setting the shell to "command.com" or "4dos.com"
6739 works, but "command" and "4dos" do not work for all commands (e.g.,
6740 filtering).
6741 For unknown reasons, when using "4dos.com" the current directory is
6742 changed to "C:\". To avoid this set 'shell' like this: >
6743 :set shell=command.com\ /c\ 4dos
6744< This option cannot be set from a |modeline| or in the |sandbox|, for
6745 security reasons.
6746
6747 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006748'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006749 MS-DOS and Win32, when 'shell' does not
6750 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 global
6752 {not in Vi}
6753 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6754 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6755 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006756 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006757 On Unix it can have more than one flag. Each white space separated
6758 part is passed as an argument to the shell command.
6759 See |option-backslash| about including spaces and backslashes.
6760 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 This option cannot be set from a |modeline| or in the |sandbox|, for
6762 security reasons.
6763
6764 *'shellpipe'* *'sp'*
6765'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6766 global
6767 {not in Vi}
6768 {not available when compiled without the |+quickfix|
6769 feature}
6770 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 including spaces and backslashes.
6773 The name of the temporary file can be represented by "%s" if necessary
6774 (the file name is appended automatically if no %s appears in the value
6775 of this option).
6776 For the Amiga and MS-DOS the default is ">". The output is directly
6777 saved in a file and not echoed to the screen.
6778 For Unix the default it "| tee". The stdout of the compiler is saved
6779 in a file and echoed to the screen. If the 'shell' option is "csh" or
6780 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006781 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6782 default becomes "2>&1| tee". This means that stderr is also included.
6783 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6784 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 The initialization of this option is done after reading the ".vimrc"
6786 and the other initializations, so that when the 'shell' option is set
6787 there, the 'shellpipe' option changes automatically, unless it was
6788 explicitly set before.
6789 When 'shellpipe' is set to an empty string, no redirection of the
6790 ":make" output will be done. This is useful if you use a 'makeprg'
6791 that writes to 'makeef' by itself. If you want no piping, but do
6792 want to include the 'makeef', set 'shellpipe' to a single space.
6793 Don't forget to precede the space with a backslash: ":set sp=\ ".
6794 In the future pipes may be used for filtering and this option will
6795 become obsolete (at least for Unix).
6796 This option cannot be set from a |modeline| or in the |sandbox|, for
6797 security reasons.
6798
6799 *'shellquote'* *'shq'*
6800'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6801 contains "sh" somewhere: "\"")
6802 global
6803 {not in Vi}
6804 Quoting character(s), put around the command passed to the shell, for
6805 the "!" and ":!" commands. The redirection is kept outside of the
6806 quoting. See 'shellxquote' to include the redirection. It's
6807 probably not useful to set both options.
6808 This is an empty string by default. Only known to be useful for
6809 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6810 or bash, where it should be "\"". The default is adjusted according
6811 the value of 'shell', to reduce the need to set this option by the
6812 user. See |dos-shell|.
6813 This option cannot be set from a |modeline| or in the |sandbox|, for
6814 security reasons.
6815
6816 *'shellredir'* *'srr'*
6817'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6818 global
6819 {not in Vi}
6820 String to be used to put the output of a filter command in a temporary
6821 file. See also |:!|. See |option-backslash| about including spaces
6822 and backslashes.
6823 The name of the temporary file can be represented by "%s" if necessary
6824 (the file name is appended automatically if no %s appears in the value
6825 of this option).
6826 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6827 or "zsh" during initializations, the default becomes ">&". If the
6828 'shell' option is "sh", "ksh" or "bash" the default becomes
6829 ">%s 2>&1". This means that stderr is also included.
6830 For Win32, the Unix checks are done and additionally "cmd" is checked
6831 for, which makes the default ">%s 2>&1". Also, the same names with
6832 ".exe" appended are checked for.
6833 The initialization of this option is done after reading the ".vimrc"
6834 and the other initializations, so that when the 'shell' option is set
6835 there, the 'shellredir' option changes automatically unless it was
6836 explicitly set before.
6837 In the future pipes may be used for filtering and this option will
6838 become obsolete (at least for Unix).
6839 This option cannot be set from a |modeline| or in the |sandbox|, for
6840 security reasons.
6841
6842 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6843'shellslash' 'ssl' boolean (default off)
6844 global
6845 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6846 When set, a forward slash is used when expanding file names. This is
6847 useful when a Unix-like shell is used instead of command.com or
6848 cmd.exe. Backward slashes can still be typed, but they are changed to
6849 forward slashes by Vim.
6850 Note that setting or resetting this option has no effect for some
6851 existing file names, thus this option needs to be set before opening
6852 any file for best results. This might change in the future.
6853 'shellslash' only works when a backslash can be used as a path
6854 separator. To test if this is so use: >
6855 if exists('+shellslash')
6856<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006857 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6858'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6859 global
6860 {not in Vi}
6861 When on, use temp files for shell commands. When off use a pipe.
6862 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006863 Currently a pipe is only supported on Unix and MS-Windows 2K and
6864 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006865 :if has("filterpipe")
6866< The advantage of using a pipe is that nobody can read the temp file
6867 and the 'shell' command does not need to support redirection.
6868 The advantage of using a temp file is that the file type and encoding
6869 can be detected.
6870 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6871 |FilterWritePost| autocommands event are not triggered when
6872 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006873 The `system()` function does not respect this option and always uses
6874 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006875 NOTE: This option is set to the Vim default value when 'compatible'
6876 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006877
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 *'shelltype'* *'st'*
6879'shelltype' 'st' number (default 0)
6880 global
6881 {not in Vi} {only for the Amiga}
6882 On the Amiga this option influences the way how the commands work
6883 which use a shell.
6884 0 and 1: always use the shell
6885 2 and 3: use the shell only to filter lines
6886 4 and 5: use shell only for ':sh' command
6887 When not using the shell, the command is executed directly.
6888
6889 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6890 1 and 3: use "shell cmd" to start external commands
6891
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006892 *'shellxescape'* *'sxe'*
6893'shellxescape' 'sxe' string (default: "";
6894 for MS-DOS and MS-Windows: "\"&|<>()@^")
6895 global
6896 {not in Vi}
6897 When 'shellxquote' is set to "(" then the characters listed in this
6898 option will be escaped with a '^' character. This makes it possible
6899 to execute most external commands with cmd.exe.
6900
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 *'shellxquote'* *'sxq'*
6902'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006903 for Win32, when 'shell' is cmd.exe: "("
6904 for Win32, when 'shell' contains "sh"
6905 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 for Unix, when using system(): "\"")
6907 global
6908 {not in Vi}
6909 Quoting character(s), put around the command passed to the shell, for
6910 the "!" and ":!" commands. Includes the redirection. See
6911 'shellquote' to exclude the redirection. It's probably not useful
6912 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006913 When the value is '(' then ')' is appended. When the value is '"('
6914 then ')"' is appended.
6915 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006916 This is an empty string by default on most systems, but is known to be
6917 useful for on Win32 version, either for cmd.exe which automatically
6918 strips off the first and last quote on a command, or 3rd-party shells
6919 such as the MKS Korn Shell or bash, where it should be "\"". The
6920 default is adjusted according the value of 'shell', to reduce the need
6921 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 This option cannot be set from a |modeline| or in the |sandbox|, for
6923 security reasons.
6924
6925 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6926'shiftround' 'sr' boolean (default off)
6927 global
6928 {not in Vi}
6929 Round indent to multiple of 'shiftwidth'. Applies to > and <
6930 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6931 a multiple of 'shiftwidth' (this is Vi compatible).
6932 NOTE: This option is reset when 'compatible' is set.
6933
6934 *'shiftwidth'* *'sw'*
6935'shiftwidth' 'sw' number (default 8)
6936 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006937 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006939 When zero the 'ts' value will be used. Use the |shiftwidth()|
6940 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941
6942 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006943'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6944 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 global
6946 {not in Vi}
6947 This option helps to avoid all the |hit-enter| prompts caused by file
6948 messages, for example with CTRL-G, and to avoid some other messages.
6949 It is a list of flags:
6950 flag meaning when present ~
6951 f use "(3 of 5)" instead of "(file 3 of 5)"
6952 i use "[noeol]" instead of "[Incomplete last line]"
6953 l use "999L, 888C" instead of "999 lines, 888 characters"
6954 m use "[+]" instead of "[Modified]"
6955 n use "[New]" instead of "[New File]"
6956 r use "[RO]" instead of "[readonly]"
6957 w use "[w]" instead of "written" for file write message
6958 and "[a]" instead of "appended" for ':w >> file' command
6959 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6960 "[unix format]" and "[mac]" instead of "[mac format]".
6961 a all of the above abbreviations
6962
6963 o overwrite message for writing a file with subsequent message
6964 for reading a file (useful for ":wn" or when 'autowrite' on)
6965 O message for reading a file overwrites any previous message.
6966 Also for quickfix message (e.g., ":cn").
6967 s don't give "search hit BOTTOM, continuing at TOP" or "search
6968 hit TOP, continuing at BOTTOM" messages
6969 t truncate file message at the start if it is too long to fit
6970 on the command-line, "<" will appear in the left most column.
6971 Ignored in Ex mode.
6972 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006973 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 Ignored in Ex mode.
6975 W don't give "written" or "[w]" when writing a file
6976 A don't give the "ATTENTION" message when an existing swap file
6977 is found.
6978 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006979 c don't give |ins-completion-menu| messages. For example,
6980 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6981 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006982 q use "recording" instead of "recording @a"
6983 F don't give the file info when editing a file, like `:silent`
6984 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985
6986 This gives you the opportunity to avoid that a change between buffers
6987 requires you to hit <Enter>, but still gives as useful a message as
6988 possible for the space available. To get the whole message that you
6989 would have got with 'shm' empty, use ":file!"
6990 Useful values:
6991 shm= No abbreviation of message.
6992 shm=a Abbreviation, but no loss of information.
6993 shm=at Abbreviation, and truncate message when necessary.
6994
6995 NOTE: This option is set to the Vi default value when 'compatible' is
6996 set and to the Vim default value when 'compatible' is reset.
6997
6998 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6999'shortname' 'sn' boolean (default off)
7000 local to buffer
7001 {not in Vi, not in MS-DOS versions}
7002 Filenames are assumed to be 8 characters plus one extension of 3
7003 characters. Multiple dots in file names are not allowed. When this
7004 option is on, dots in file names are replaced with underscores when
7005 adding an extension (".~" or ".swp"). This option is not available
7006 for MS-DOS, because then it would always be on. This option is useful
7007 when editing files on an MS-DOS compatible filesystem, e.g., messydos
7008 or crossdos. When running the Win32 GUI version under Win32s, this
7009 option is always on by default.
7010
7011 *'showbreak'* *'sbr'* *E595*
7012'showbreak' 'sbr' string (default "")
7013 global
7014 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007015 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007016 feature}
7017 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007018 values are "> " or "+++ ": >
7019 :set showbreak=>\
7020< Note the backslash to escape the trailing space. It's easier like
7021 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02007022 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007023< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 comma (in a future version the comma might be used to separate the
7025 part that is shown at the end and at the start of a line).
7026 The characters are highlighted according to the '@' flag in
7027 'highlight'.
7028 Note that tabs after the showbreak will be displayed differently.
7029 If you want the 'showbreak' to appear in between line numbers, add the
7030 "n" flag to 'cpoptions'.
7031
7032 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02007033'showcmd' 'sc' boolean (Vim default: on, off for Unix,
7034 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 global
7036 {not in Vi}
7037 {not available when compiled without the
7038 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00007039 Show (partial) command in the last line of the screen. Set this
7040 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 In Visual mode the size of the selected area is shown:
7042 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02007043 If the number of bytes is different it is also displayed: "2-6"
7044 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007046 - When selecting a block, the size in screen characters:
7047 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 NOTE: This option is set to the Vi default value when 'compatible' is
7049 set and to the Vim default value when 'compatible' is reset.
7050
7051 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
7052'showfulltag' 'sft' boolean (default off)
7053 global
7054 {not in Vi}
7055 When completing a word in insert mode (see |ins-completion|) from the
7056 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007057 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 matched a C function, you can see a template for what arguments are
7059 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00007060 Note that this doesn't work well together with having "longest" in
7061 'completeopt', because the completion from the search pattern may not
7062 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063
7064 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
7065'showmatch' 'sm' boolean (default off)
7066 global
7067 When a bracket is inserted, briefly jump to the matching one. The
7068 jump is only done if the match can be seen on the screen. The time to
7069 show the match can be set with 'matchtime'.
7070 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02007071 seen or not).
7072 This option is reset when 'paste' is set and restored when 'paste' is
7073 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007074 When the 'm' flag is not included in 'cpoptions', typing a character
7075 will immediately move the cursor back to where it belongs.
7076 See the "sm" field in 'guicursor' for setting the cursor shape and
7077 blinking when showing the match.
7078 The 'matchpairs' option can be used to specify the characters to show
7079 matches for. 'rightleft' and 'revins' are used to look for opposite
7080 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007081 Also see the matchparen plugin for highlighting the match when moving
7082 around |pi_paren.txt|.
7083 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084
7085 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
7086'showmode' 'smd' boolean (Vim default: on, Vi default: off)
7087 global
7088 If in Insert, Replace or Visual mode put a message on the last line.
7089 Use the 'M' flag in 'highlight' to set the type of highlighting for
7090 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 doesn't mean XIM is really active, especially when 'imactivatekey' is
7093 not set.
7094 NOTE: This option is set to the Vi default value when 'compatible' is
7095 set and to the Vim default value when 'compatible' is reset.
7096
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007097 *'showtabline'* *'stal'*
7098'showtabline' 'stal' number (default 1)
7099 global
7100 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007101 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007102 feature}
7103 The value of this option specifies when the line with tab page labels
7104 will be displayed:
7105 0: never
7106 1: only if there are at least two tab pages
7107 2: always
7108 This is both for the GUI and non-GUI implementation of the tab pages
7109 line.
7110 See |tab-page| for more information about tab pages.
7111
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 *'sidescroll'* *'ss'*
7113'sidescroll' 'ss' number (default 0)
7114 global
7115 {not in Vi}
7116 The minimal number of columns to scroll horizontally. Used only when
7117 the 'wrap' option is off and the cursor is moved off of the screen.
7118 When it is zero the cursor will be put in the middle of the screen.
7119 When using a slow terminal set it to a large number or 0. When using
7120 a fast terminal use a small number or 1. Not used for "zh" and "zl"
7121 commands.
7122
7123 *'sidescrolloff'* *'siso'*
7124'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01007125 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 {not in Vi}
7127 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00007128 right of the cursor if 'nowrap' is set. Setting this option to a
7129 value greater than 0 while having |'sidescroll'| also at a non-zero
7130 value makes some context visible in the line you are scrolling in
7131 horizontally (except at beginning of the line). Setting this option
7132 to a large value (like 999) has the effect of keeping the cursor
7133 horizontally centered in the window, as long as one does not come too
7134 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01007135 After using the local value, go back the global value with one of
7136 these two: >
7137 setlocal sidescrolloff<
7138 setlocal sidescrolloff=-1
7139< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140
7141 Example: Try this together with 'sidescroll' and 'listchars' as
7142 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007143 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144
7145 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
7146 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02007147<
7148 *'signcolumn'* *'scl'*
7149'signcolumn' 'scl' string (default "auto")
7150 local to window
7151 {not in Vi}
7152 {not available when compiled without the |+signs|
7153 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02007154 Whether or not to draw the signcolumn. Valid values are:
7155 "auto" only when there is a sign to display
7156 "no" never
7157 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158
7159
7160 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7161'smartcase' 'scs' boolean (default off)
7162 global
7163 {not in Vi}
7164 Override the 'ignorecase' option if the search pattern contains upper
7165 case characters. Only used when the search pattern is typed and
7166 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007167 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7169 recalling the search pattern from history and hitting <Enter>.
7170 NOTE: This option is reset when 'compatible' is set.
7171
7172 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7173'smartindent' 'si' boolean (default off)
7174 local to buffer
7175 {not in Vi}
7176 {not available when compiled without the
7177 |+smartindent| feature}
7178 Do smart autoindenting when starting a new line. Works for C-like
7179 programs, but can also be used for other languages. 'cindent' does
7180 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007181 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007182 setting 'si' has no effect. 'indentexpr' is a more advanced
7183 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 Normally 'autoindent' should also be on when using 'smartindent'.
7185 An indent is automatically inserted:
7186 - After a line ending in '{'.
7187 - After a line starting with a keyword from 'cinwords'.
7188 - Before a line starting with '}' (only with the "O" command).
7189 When typing '}' as the first character in a new line, that line is
7190 given the same indent as the matching '{'.
7191 When typing '#' as the first character in a new line, the indent for
7192 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007193 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7195 When using the ">>" command, lines starting with '#' are not shifted
7196 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007197 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007198 This option is reset when 'paste' is set and restored when 'paste' is
7199 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200
7201 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7202'smarttab' 'sta' boolean (default off)
7203 global
7204 {not in Vi}
7205 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007206 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7207 <BS> will delete a 'shiftwidth' worth of space at the start of the
7208 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007209 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007210 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7211 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007212 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007214 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007215 This option is reset when 'paste' is set and restored when 'paste' is
7216 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 NOTE: This option is reset when 'compatible' is set.
7218
7219 *'softtabstop'* *'sts'*
7220'softtabstop' 'sts' number (default 0)
7221 local to buffer
7222 {not in Vi}
7223 Number of spaces that a <Tab> counts for while performing editing
7224 operations, like inserting a <Tab> or using <BS>. It "feels" like
7225 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7226 used. This is useful to keep the 'ts' setting at its standard value
7227 of 8, while being able to edit like it is set to 'sts'. However,
7228 commands like "x" still work on the actual characters.
7229 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007230 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007231 'softtabstop' is set to 0 when the 'paste' option is set and restored
7232 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7234 spaces is minimized by using <Tab>s.
7235 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7236 set.
7237 NOTE: This option is set to 0 when 'compatible' is set.
7238
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007239 If Vim is compiled with the |+vartabs| feature then the value of
7240 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7241 anything other than an empty string.
7242
Bram Moolenaar217ad922005-03-20 22:37:15 +00007243 *'spell'* *'nospell'*
7244'spell' boolean (default off)
7245 local to window
7246 {not in Vi}
7247 {not available when compiled without the |+syntax|
7248 feature}
7249 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007250 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007251
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007252 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007253'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007254 local to buffer
7255 {not in Vi}
7256 {not available when compiled without the |+syntax|
7257 feature}
7258 Pattern to locate the end of a sentence. The following word will be
7259 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007260 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007261 When this check is not wanted make this option empty.
7262 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007263 Be careful with special characters, see |option-backslash| about
7264 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007265 To set this option automatically depending on the language, see
7266 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007267
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007268 *'spellfile'* *'spf'*
7269'spellfile' 'spf' string (default empty)
7270 local to buffer
7271 {not in Vi}
7272 {not available when compiled without the |+syntax|
7273 feature}
7274 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007275 commands. It must end in ".{encoding}.add". You need to include the
7276 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007277 *E765*
7278 It may also be a comma separated list of names. A count before the
7279 |zg| and |zw| commands can be used to access each. This allows using
7280 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007281 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007282 you: Using the first directory in 'runtimepath' that is writable. If
7283 there is no "spell" directory yet it will be created. For the file
7284 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007285 ignoring the region.
7286 The resulting ".spl" file will be used for spell checking, it does not
7287 have to appear in 'spelllang'.
7288 Normally one file is used for all regions, but you can add the region
7289 name if you want to. However, it will then only be used when
7290 'spellfile' is set to it, for entries in 'spelllang' only files
7291 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007292 This option cannot be set from a |modeline| or in the |sandbox|, for
7293 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007294
Bram Moolenaar217ad922005-03-20 22:37:15 +00007295 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007296'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007297 local to buffer
7298 {not in Vi}
7299 {not available when compiled without the |+syntax|
7300 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007301 A comma separated list of word list names. When the 'spell' option is
7302 on spellchecking will be done for these languages. Example: >
7303 set spelllang=en_us,nl,medical
7304< This means US English, Dutch and medical words are recognized. Words
7305 that are not recognized will be highlighted.
7306 The word list name must not include a comma or dot. Using a dash is
7307 recommended to separate the two letter language name from a
7308 specification. Thus "en-rare" is used for rare English words.
7309 A region name must come last and have the form "_xx", where "xx" is
7310 the two-letter, lower case region name. You can use more than one
7311 region by listing them: "en_us,en_ca" supports both US and Canadian
7312 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007313 Britain. (Note: currently en_au and en_nz dictionaries are older than
7314 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007315 If the name "cjk" is included East Asian characters are excluded from
7316 spell checking. This is useful when editing text that also has Asian
7317 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007318 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007319 As a special case the name of a .spl file can be given as-is. The
7320 first "_xx" in the name is removed and used as the region name
7321 (_xx is an underscore, two letters and followed by a non-letter).
7322 This is mainly for testing purposes. You must make sure the correct
7323 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007324 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007325 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7326 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007327 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007328
Bram Moolenaar98692072006-02-04 00:57:42 +00007329 If the |spellfile.vim| plugin is active and you use a language name
7330 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7331 will ask you if you want to download the file.
7332
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007333 After this option has been set successfully, Vim will source the files
7334 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007335 up to the first character that is not an ASCII letter or number and
7336 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007337
7338
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007339 *'spellsuggest'* *'sps'*
7340'spellsuggest' 'sps' string (default "best")
7341 global
7342 {not in Vi}
7343 {not available when compiled without the |+syntax|
7344 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007345 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007346 the |spellsuggest()| function. This is a comma-separated list of
7347 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007348
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007349 best Internal method that works best for English. Finds
7350 changes like "fast" and uses a bit of sound-a-like
7351 scoring to improve the ordering.
7352
7353 double Internal method that uses two methods and mixes the
7354 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007355 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007356 word. That only works when the language specifies
7357 sound folding. Can be slow and doesn't always give
7358 better results.
7359
7360 fast Internal method that only checks for simple changes:
7361 character inserts/deletes/swaps. Works well for
7362 simple typing mistakes.
7363
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007364 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007365 Not used for |spellsuggest()|. The number of
7366 suggestions is never more than the value of 'lines'
7367 minus two.
7368
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007369 file:{filename} Read file {filename}, which must have two columns,
7370 separated by a slash. The first column contains the
7371 bad word, the second column the suggested good word.
7372 Example:
7373 theribal/terrible ~
7374 Use this for common mistakes that do not appear at the
7375 top of the suggestion list with the internal methods.
7376 Lines without a slash are ignored, use this for
7377 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007378 The word in the second column must be correct,
7379 otherwise it will not be used. Add the word to an
7380 ".add" file if it is currently flagged as a spelling
7381 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007382 The file is used for all languages.
7383
7384 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7385 trouble with spaces. |v:val| holds the badly spelled
7386 word. The expression must evaluate to a List of
7387 Lists, each with a suggestion and a score.
7388 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007389 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007390 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007391 internal methods use. A lower score is better.
7392 This may invoke |spellsuggest()| if you temporarily
7393 set 'spellsuggest' to exclude the "expr:" part.
7394 Errors are silently ignored, unless you set the
7395 'verbose' option to a non-zero value.
7396
7397 Only one of "best", "double" or "fast" may be used. The others may
7398 appear several times in any order. Example: >
7399 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7400<
7401 This option cannot be set from a |modeline| or in the |sandbox|, for
7402 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007403
7404
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7406'splitbelow' 'sb' boolean (default off)
7407 global
7408 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007409 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 feature}
7411 When on, splitting a window will put the new window below the current
7412 one. |:split|
7413
7414 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7415'splitright' 'spr' boolean (default off)
7416 global
7417 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007418 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 feature}
7420 When on, splitting a window will put the new window right of the
7421 current one. |:vsplit|
7422
7423 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7424'startofline' 'sol' boolean (default on)
7425 global
7426 {not in Vi}
7427 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007428 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007429 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007430 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 with a linewise operator, with "%" with a count and to buffer changing
7432 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7433 only has a line number, e.g., ":25" or ":+".
7434 In case of buffer changing commands the cursor is placed at the column
7435 where it was the last time the buffer was edited.
7436 NOTE: This option is set when 'compatible' is set.
7437
Bram Moolenaar00654022011-02-25 14:42:19 +01007438 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007440 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 {not in Vi}
7442 {not available when compiled without the |+statusline|
7443 feature}
7444 When nonempty, this option determines the content of the status line.
7445 Also see |status-line|.
7446
7447 The option consists of printf style '%' items interspersed with
7448 normal text. Each status line item is of the form:
7449 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007450 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007451 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007452
Bram Moolenaar238a5642006-02-21 22:12:05 +00007453 When the option starts with "%!" then it is used as an expression,
7454 evaluated and the result is used as the option value. Example: >
7455 :set statusline=%!MyStatusLine()
7456< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007457 Note that the "%!" expression is evaluated in the context of the
7458 current window and buffer, while %{} items are evaluated in the
7459 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007460
7461 When there is error while evaluating the option then it will be made
7462 empty to avoid further errors. Otherwise screen updating would loop.
7463
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 Note that the only effect of 'ruler' when this option is set (and
7465 'laststatus' is 2) is controlling the output of |CTRL-G|.
7466
7467 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007468 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007469 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007470 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 minwid Minimum width of the item, padding as set by '-' & '0'.
7472 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 on the left for text items. Numeric items will be
7475 shifted down to maxwid-2 digits followed by '>'number
7476 where number is the amount of missing digits, much like
7477 an exponential notation.
7478 item A one letter code as described below.
7479
7480 Following is a description of the possible statusline items. The
7481 second character in "item" is the type:
7482 N for number
7483 S for string
7484 F for flags as described below
7485 - not applicable
7486
7487 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007488 f S Path to the file in the buffer, as typed or relative to current
7489 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 F S Full path to the file in the buffer.
7491 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007492 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007494 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007496 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007498 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007500 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007502 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007503 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7504 being used: "<keymap>"
7505 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007506 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507 B N As above, in hexadecimal.
7508 o N Byte number in file of byte under cursor, first byte is 1.
7509 Mnemonic: Offset from start of file (with one added)
7510 {not available when compiled without |+byte_offset| feature}
7511 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007512 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 l N Line number.
7514 L N Number of lines in buffer.
7515 c N Column number.
7516 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007517 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 p N Percentage through file in lines as in |CTRL-G|.
7519 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007520 percentage described for 'ruler'. Always 3 in length, unless
7521 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007522 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007524 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007525 Note that there is no '%' before the closing '}'. The
7526 expression cannot contain a '}' character, call a function to
7527 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 ( - Start of item group. Can be used for setting the width and
7529 alignment of a section. Must be followed by %) somewhere.
7530 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007531 T N For 'tabline': start of tab page N label. Use %T after the last
7532 label. This information is used for mouse clicks.
7533 X N For 'tabline': start of close tab N label. Use %X after the
7534 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7535 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 < - Where to truncate line if too long. Default is at the start.
7537 No width fields allowed.
7538 = - Separation point between left and right aligned items.
7539 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007540 # - Set highlight group. The name must follow and then a # again.
7541 Thus use %#HLname# for highlight group HLname. The same
7542 highlighting is used, also for the statusline of non-current
7543 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007545 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 The difference between User{N} and StatusLine will be applied
7547 to StatusLineNC for the statusline of non-current windows.
7548 The number N must be between 1 and 9. See |hl-User1..9|
7549
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007550 When displaying a flag, Vim removes the leading comma, if any, when
7551 that flag comes right after plaintext. This will make a nice display
7552 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553
Bram Moolenaar582fd852005-03-28 20:58:01 +00007554 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 not set) and a minwid is not set for the group, the whole group will
7556 become empty. This will make a group like the following disappear
7557 completely from the statusline when none of the flags are set. >
7558 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007559< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 Beware that an expression is evaluated each and every time the status
7561 line is displayed. The current buffer and current window will be set
7562 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007563 currently being drawn. The expression will evaluate in this context.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02007564 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007565 real current buffer.
7566
Bram Moolenaar30b65812012-07-12 22:01:11 +02007567 The 'statusline' option will be evaluated in the |sandbox| if set from
7568 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007569
7570 It is not allowed to change text or jump to another window while
7571 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572
7573 If the statusline is not updated when you want it (e.g., after setting
7574 a variable that's used in an expression), you can force an update by
7575 setting an option without changing its value. Example: >
7576 :let &ro = &ro
7577
7578< A result of all digits is regarded a number for display purposes.
7579 Otherwise the result is taken as flag text and applied to the rules
7580 described above.
7581
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007582 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007584 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585
7586 Examples:
7587 Emulate standard status line with 'ruler' set >
7588 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7589< Similar, but add ASCII value of char under the cursor (like "ga") >
7590 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7591< Display byte count and byte value, modified flag in red. >
7592 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7593 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7594< Display a ,GZ flag if a compressed file is loaded >
7595 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7596< In the |:autocmd|'s: >
7597 :let b:gzflag = 1
7598< And: >
7599 :unlet b:gzflag
7600< And define this function: >
7601 :function VarExists(var, val)
7602 : if exists(a:var) | return a:val | else | return '' | endif
7603 :endfunction
7604<
7605 *'suffixes'* *'su'*
7606'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7607 global
7608 {not in Vi}
7609 Files with these suffixes get a lower priority when multiple files
7610 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007611 suffixes. Spaces after the comma are ignored. A dot is also seen as
7612 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 separator, precede it with a backslash (see |option-backslash| about
7614 including spaces and backslashes).
7615 See 'wildignore' for completely ignoring files.
7616 The use of |:set+=| and |:set-=| is preferred when adding or removing
7617 suffixes from the list. This avoids problems when a future version
7618 uses another default.
7619
7620 *'suffixesadd'* *'sua'*
7621'suffixesadd' 'sua' string (default "")
7622 local to buffer
7623 {not in Vi}
7624 {not available when compiled without the
7625 |+file_in_path| feature}
7626 Comma separated list of suffixes, which are used when searching for a
7627 file for the "gf", "[I", etc. commands. Example: >
7628 :set suffixesadd=.java
7629<
7630 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7631'swapfile' 'swf' boolean (default on)
7632 local to buffer
7633 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007634 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 swapfile is not wanted for a specific buffer. For example, with
7636 confidential information that even root must not be able to access.
7637 Careful: All text will be in memory:
7638 - Don't use this for big files.
7639 - Recovery will be impossible!
7640 A swapfile will only be present when |'updatecount'| is non-zero and
7641 'swapfile' is set.
7642 When 'swapfile' is reset, the swap file for the current buffer is
7643 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7644 non-zero, a swap file is immediately created.
7645 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007646 If you want to open a new buffer without creating a swap file for it,
7647 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007648 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649
7650 This option is used together with 'bufhidden' and 'buftype' to
7651 specify special kinds of buffers. See |special-buffers|.
7652
7653 *'swapsync'* *'sws'*
7654'swapsync' 'sws' string (default "fsync")
7655 global
7656 {not in Vi}
7657 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007658 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 When this option is empty parts of the swap file may be in memory and
7660 not written to disk. When the system crashes you may lose more work.
7661 On Unix the system does a sync now and then without Vim asking for it,
7662 so the disadvantage of setting this option off is small. On some
7663 systems the swap file will not be written at all. For a unix system
7664 setting it to "sync" will use the sync() call instead of the default
7665 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007666 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667
7668 *'switchbuf'* *'swb'*
7669'switchbuf' 'swb' string (default "")
7670 global
7671 {not in Vi}
7672 This option controls the behavior when switching between buffers.
7673 Possible values (comma separated list):
7674 useopen If included, jump to the first open window that
7675 contains the specified buffer (if there is one).
7676 Otherwise: Do not examine other windows.
7677 This setting is checked with |quickfix| commands, when
7678 jumping to errors (":cc", ":cn", "cp", etc.). It is
7679 also used in all buffer related split commands, for
7680 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007681 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007682 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007684 a buffer for a |quickfix| command that display errors.
7685 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007686 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007687 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007688 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007690 *'synmaxcol'* *'smc'*
7691'synmaxcol' 'smc' number (default 3000)
7692 local to buffer
7693 {not in Vi}
7694 {not available when compiled without the |+syntax|
7695 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007696 Maximum column in which to search for syntax items. In long lines the
7697 text after this column is not highlighted and following lines may not
7698 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007699 This helps to avoid very slow redrawing for an XML file that is one
7700 long line.
7701 Set to zero to remove the limit.
7702
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 *'syntax'* *'syn'*
7704'syntax' 'syn' string (default empty)
7705 local to buffer
7706 {not in Vi}
7707 {not available when compiled without the |+syntax|
7708 feature}
7709 When this option is set, the syntax with this name is loaded, unless
7710 syntax highlighting has been switched off with ":syntax off".
7711 Otherwise this option does not always reflect the current syntax (the
7712 b:current_syntax variable does).
7713 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007714 not automatically recognized. Example, in an IDL file:
7715 /* vim: set syntax=idl : */ ~
7716 When a dot appears in the value then this separates two filetype
7717 names. Example:
7718 /* vim: set syntax=c.doxygen : */ ~
7719 This will use the "c" syntax first, then the "doxygen" syntax.
7720 Note that the second one must be prepared to be loaded as an addition,
7721 otherwise it will be skipped. More than one dot may appear.
7722 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 :set syntax=OFF
7724< To switch syntax highlighting on according to the current value of the
7725 'filetype' option: >
7726 :set syntax=ON
7727< What actually happens when setting the 'syntax' option is that the
7728 Syntax autocommand event is triggered with the value as argument.
7729 This option is not copied to another buffer, independent of the 's' or
7730 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007731 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007733 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007734'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007735 global
7736 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007737 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007738 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007739 When nonempty, this option determines the content of the tab pages
7740 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007741 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007742
7743 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007744 option and only when there is no GUI tab line. When 'e' is in
7745 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007746 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007747
7748 The value is evaluated like with 'statusline'. You can use
7749 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007750 the text to be displayed. Use "%1T" for the first label, "%2T" for
7751 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007752
Bram Moolenaare12bab32019-01-08 22:02:56 +01007753 When changing something that is used in 'tabline' that does not
7754 trigger it to be updated, use |:redrawtabline|.
7755
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007756 Keep in mind that only one of the tab pages is the current one, others
7757 are invisible and you can't jump to their windows.
7758
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007759
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007760 *'tabpagemax'* *'tpm'*
7761'tabpagemax' 'tpm' number (default 10)
7762 global
7763 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007764 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007765 feature}
7766 Maximum number of tab pages to be opened by the |-p| command line
7767 argument or the ":tab all" command. |tabpage|
7768
7769
7770 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771'tabstop' 'ts' number (default 8)
7772 local to buffer
7773 Number of spaces that a <Tab> in the file counts for. Also see
7774 |:retab| command, and 'softtabstop' option.
7775
7776 Note: Setting 'tabstop' to any other value than 8 can make your file
7777 appear wrong in many places (e.g., when printing it).
7778
7779 There are four main ways to use tabs in Vim:
7780 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7781 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007782 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 behave like a tab appears every 4 (or 3) characters.
7784 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7785 'expandtab'. This way you will always insert spaces. The
7786 formatting will never be messed up when 'tabstop' is changed.
7787 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007788 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 works when using Vim to edit the file.
7790 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7791 'noexpandtab'. This should then work (for initial indents only)
7792 for any tabstop setting that people use. It might be nice to have
7793 tabs after the first non-blank inserted as spaces if you do this
7794 though. Otherwise aligned comments will be wrong when 'tabstop' is
7795 changed.
7796
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007797 If Vim is compiled with the |+vartabs| feature then the value of
7798 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7799 than an empty string.
7800
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7802'tagbsearch' 'tbs' boolean (default on)
7803 global
7804 {not in Vi}
7805 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007806 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 searching makes searching for a tag a LOT faster, but a linear search
7808 will find more tags if the tags file wasn't properly sorted.
7809 Vim normally assumes that your tags files are sorted, or indicate that
7810 they are not sorted. Only when this is not the case does the
7811 'tagbsearch' option need to be switched off.
7812
7813 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007814 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 certain files, or retry all files with a linear search. When
7816 'tagbsearch' is off, only a linear search is done.
7817
7818 Linear searching is done anyway, for one file, when Vim finds a line
7819 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007820 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821< [The whitespace before and after the '0' must be a single <Tab>]
7822
7823 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007824 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 instead of a normal tag name, a retry is done with a linear search.
7826 Tags in unsorted tags files, and matches with different case will only
7827 be found in the retry.
7828
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007829 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007830 linear search can be avoided when case is ignored. Use a value of '2'
7831 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7832 sorted with the -f switch to "sort" in most unices, as in the command:
7833 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7834 (at least 5.5) the --sort=foldcase switch can be used for this as
7835 well. Note that case must be folded to uppercase for this to work.
7836
7837 By default, tag searches are case-sensitive. Case is ignored when
7838 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7839 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007840 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7841 'tagcase' is "smart", and the pattern contains only lowercase
7842 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843
7844 When 'tagbsearch' is off, tags searching is slower when a full match
7845 exists, but faster when no full match exists. Tags in unsorted tags
7846 files may only be found with 'tagbsearch' off.
7847 When the tags file is not sorted, or sorted in a wrong way (not on
7848 ASCII byte value), 'tagbsearch' should be off, or the line given above
7849 must be included in the tags file.
7850 This option doesn't affect commands that find all matching tags (e.g.,
7851 command-line completion and ":help").
7852 {Vi: always uses binary search in some versions}
7853
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007854 *'tagcase'* *'tc'*
7855'tagcase' 'tc' string (default "followic")
7856 global or local to buffer |global-local|
7857 {not in Vi}
7858 This option specifies how case is handled when searching the tags
7859 file:
7860 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007861 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007862 ignore Ignore case
7863 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007864 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007865 NOTE: This option is set to the Vi default value when 'compatible' is
7866 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007867
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 *'taglength'* *'tl'*
7869'taglength' 'tl' number (default 0)
7870 global
7871 If non-zero, tags are significant up to this number of characters.
7872
7873 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7874'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7875 global
7876 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007877 If on and using a tags file in another directory, file names in that
7878 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 NOTE: This option is set to the Vi default value when 'compatible' is
7880 set and to the Vim default value when 'compatible' is reset.
7881
7882 *'tags'* *'tag'* *E433*
7883'tags' 'tag' string (default "./tags,tags", when compiled with
7884 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7885 global or local to buffer |global-local|
7886 Filenames for the tag command, separated by spaces or commas. To
7887 include a space or comma in a file name, precede it with a backslash
7888 (see |option-backslash| about including spaces and backslashes).
7889 When a file name starts with "./", the '.' is replaced with the path
7890 of the current file. But only when the 'd' flag is not included in
7891 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7892 |tags-option|.
7893 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007894 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7895 find all files named "tags" below "/lib". The filename itself cannot
7896 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7897 files called "tags?". {not available when compiled without the
7898 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007899 The |tagfiles()| function can be used to get a list of the file names
7900 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7902 files are also supported. They are automatically recognized. The
7903 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7904 differences are ignored (MS-Windows). |emacs-tags|
7905 The use of |:set+=| and |:set-=| is preferred when adding or removing
7906 file names from the list. This avoids problems when a future version
7907 uses another default.
7908 {Vi: default is "tags /usr/lib/tags"}
7909
7910 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7911'tagstack' 'tgst' boolean (default on)
7912 global
7913 {not in all versions of Vi}
7914 When on, the |tagstack| is used normally. When off, a ":tag" or
7915 ":tselect" command with an argument will not push the tag onto the
7916 tagstack. A following ":tag" without an argument, a ":pop" command or
7917 any other command that uses the tagstack will use the unmodified
7918 tagstack, but does change the pointer to the active entry.
7919 Resetting this option is useful when using a ":tag" command in a
7920 mapping which should not change the tagstack.
7921
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007922 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007923'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007924 global
7925 {not in Vi}
7926 {only available when compiled with the |+tcl/dyn|
7927 feature}
7928 Specifies the name of the Tcl shared library. The default is
7929 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007930 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007931 This option cannot be set from a |modeline| or in the |sandbox|, for
7932 security reasons.
7933
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 *'term'* *E529* *E530* *E531*
7935'term' string (default is $TERM, if that fails:
7936 in the GUI: "builtin_gui"
7937 on Amiga: "amiga"
7938 on BeOS: "beos-ansi"
7939 on Mac: "mac-ansi"
7940 on MiNT: "vt52"
7941 on MS-DOS: "pcterm"
7942 on OS/2: "os2ansi"
7943 on Unix: "ansi"
7944 on VMS: "ansi"
7945 on Win 32: "win32")
7946 global
7947 Name of the terminal. Used for choosing the terminal control
7948 characters. Environment variables are expanded |:set_env|.
7949 For example: >
7950 :set term=$TERM
7951< See |termcap|.
7952
7953 *'termbidi'* *'tbidi'*
7954 *'notermbidi'* *'notbidi'*
7955'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7956 global
7957 {not in Vi}
7958 {only available when compiled with the |+arabic|
7959 feature}
7960 The terminal is in charge of Bi-directionality of text (as specified
7961 by Unicode). The terminal is also expected to do the required shaping
7962 that some languages (such as Arabic) require.
7963 Setting this option implies that 'rightleft' will not be set when
7964 'arabic' is set and the value of 'arabicshape' will be ignored.
7965 Note that setting 'termbidi' has the immediate effect that
7966 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7967 This option is reset when the GUI is started.
7968 For further details see |arabic.txt|.
7969
7970 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007971'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 Macintosh GUI: "macroman")
7973 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 {not in Vi}
7975 Encoding used for the terminal. This specifies what character
7976 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007977 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007978 display). Except for the Mac when 'macatsui' is off, then
7979 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007981 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7983 Any attempts to set a different value will be rejected, and an error
7984 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007985 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 because the Win32 system always passes Unicode characters.
7987 When empty, the same encoding is used as for the 'encoding' option.
7988 This is the normal value.
7989 Not all combinations for 'termencoding' and 'encoding' are valid. See
7990 |encoding-table|.
7991 The value for this option must be supported by internal conversions or
7992 iconv(). When this is not possible no conversion will be done and you
7993 will probably experience problems with non-ASCII characters.
7994 Example: You are working with the locale set to euc-jp (Japanese) and
7995 want to edit a UTF-8 file: >
7996 :let &termencoding = &encoding
7997 :set encoding=utf-8
7998< You need to do this when your system has no locale support for UTF-8.
7999
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008000 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008001'termguicolors' 'tgc' boolean (default off)
8002 global
8003 {not in Vi}
8004 {not available when compiled without the
8005 |+termguicolors| feature}
8006 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008007 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008008
Bram Moolenaarcafafb32018-02-22 21:07:09 +01008009 Requires a ISO-8613-3 compatible terminal. If setting this option
8010 does not work (produces a colorless UI) reading |xterm-true-color|
8011 might help.
8012
8013 For Win32 console, Windows 10 version 1703 (Creators Update) or later
8014 is required. Use this check to find out: >
8015 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01008016< This requires Vim to be built with the |+vtp| feature.
8017
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02008018 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008019 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02008020
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008021 *'termwinscroll'* *'twsl'*
8022'termwinscroll' 'twsl' number (default 10000)
8023 local to buffer
Bram Moolenaar8c041b62018-04-14 18:14:06 +02008024 {not in Vi}
8025 {not available when compiled without the
8026 |+terminal| feature}
8027 Number of scrollback lines to keep. When going over this limit the
8028 first 10% of the scrollback lines are deleted. This is just to reduce
8029 the memory usage. See |Terminal-Normal|.
8030
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008031 *'termwinkey'* *'twk'*
8032'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008033 local to window
8034 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008035 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02008036 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008037 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008038 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008039< The string must be one key stroke but can be multiple bytes.
8040 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008041 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02008042 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008043
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02008044 *'termwinsize'* *'tws'*
8045'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02008046 local to window
8047 {not in Vi}
Bram Moolenaar498c2562018-04-15 23:45:15 +02008048 Size of the |terminal| window. Format: {rows}x{columns} or
8049 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008050 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02008051 - When set with a "x" (e.g., "24x80") the terminal size is not
8052 adjusted to the window size. If the window is smaller only the
8053 top-left part is displayed.
8054 - When set with a "*" (e.g., "10*50") the terminal size follows the
8055 window size, but will not be smaller than the specified rows and/or
8056 columns.
8057 - When rows is zero then use the height of the window.
8058 - When columns is zero then use the width of the window.
8059 - Using "0x0" or "0*0" is the same as empty.
8060
8061 Examples:
8062 "30x0" uses 30 rows and the current window width.
8063 "20*0" uses at least 20 rows and the current window width.
8064 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02008065 Note that the command running in the terminal window may still change
8066 the size of the terminal. In that case the Vim window will be
8067 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008068
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008069 *'termwintype'* *'twt'*
8070'termwintype' 'twt' string (default "")
8071 global
8072 {not in Vi}
8073 {only available when compiled with the |terminal|
8074 feature on MS-Windows}
8075 Specify the virtual console (pty) used when opening the terminal
8076 window.
8077
8078 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008079 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008080 "winpty" use winpty, fail if not supported
8081 "conpty" use |ConPTY|, fail if not supported
8082
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01008083 |ConPTY| support depends on the platform. Windows 10 October 2018
8084 Update is the first version that supports ConPTY, however it is still
8085 considered unstable. ConPTY might become stable in the next release
8086 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01008087 supported then you cannot open a terminal window.
8088
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 *'terse'* *'noterse'*
8090'terse' boolean (default off)
8091 global
8092 When set: Add 's' flag to 'shortmess' option (this makes the message
8093 for a search that hits the start or end of the file not being
8094 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
8095 shortens a lot of messages}
8096
8097 *'textauto'* *'ta'* *'notextauto'* *'nota'*
8098'textauto' 'ta' boolean (Vim default: on, Vi default: off)
8099 global
8100 {not in Vi}
8101 This option is obsolete. Use 'fileformats'.
8102 For backwards compatibility, when 'textauto' is set, 'fileformats' is
8103 set to the default value for the current system. When 'textauto' is
8104 reset, 'fileformats' is made empty.
8105 NOTE: This option is set to the Vi default value when 'compatible' is
8106 set and to the Vim default value when 'compatible' is reset.
8107
8108 *'textmode'* *'tx'* *'notextmode'* *'notx'*
8109'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
8110 others: default off)
8111 local to buffer
8112 {not in Vi}
8113 This option is obsolete. Use 'fileformat'.
8114 For backwards compatibility, when 'textmode' is set, 'fileformat' is
8115 set to "dos". When 'textmode' is reset, 'fileformat' is set to
8116 "unix".
8117
8118 *'textwidth'* *'tw'*
8119'textwidth' 'tw' number (default 0)
8120 local to buffer
8121 {not in Vi}
8122 Maximum width of text that is being inserted. A longer line will be
8123 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02008124 this.
8125 'textwidth' is set to 0 when the 'paste' option is set and restored
8126 when 'paste' is reset.
8127 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00008129 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 NOTE: This option is set to 0 when 'compatible' is set.
8131
8132 *'thesaurus'* *'tsr'*
8133'thesaurus' 'tsr' string (default "")
8134 global or local to buffer |global-local|
8135 {not in Vi}
8136 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008137 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
8138
8139 Each line in the file should contain words with similar meaning,
8140 separated by non-keyword characters (white space is preferred).
8141 Maximum line length is 510 bytes.
8142
Bram Moolenaard47d5222018-12-09 20:43:55 +01008143 An English word list was added to this github issue:
8144 https://github.com/vim/vim/issues/629#issuecomment-443293282
8145 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
8146 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
8147 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01008148
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008149 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 after a comma are ignored, otherwise spaces are included in the file
8151 name. See |option-backslash| about using backslashes.
8152 The use of |:set+=| and |:set-=| is preferred when adding or removing
8153 directories from the list. This avoids problems when a future version
8154 uses another default.
8155 Backticks cannot be used in this option for security reasons.
8156
8157 *'tildeop'* *'top'* *'notildeop'* *'notop'*
8158'tildeop' 'top' boolean (default off)
8159 global
8160 {not in Vi}
8161 When on: The tilde command "~" behaves like an operator.
8162 NOTE: This option is reset when 'compatible' is set.
8163
8164 *'timeout'* *'to'* *'notimeout'* *'noto'*
8165'timeout' 'to' boolean (default on)
8166 global
8167 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008168'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 global
8170 {not in Vi}
8171 These two options together determine the behavior when part of a
8172 mapped key sequence or keyboard code has been received:
8173
8174 'timeout' 'ttimeout' action ~
8175 off off do not time out
8176 on on or off time out on :mappings and key codes
8177 off on time out on key codes
8178
8179 If both options are off, Vim will wait until either the complete
8180 mapping or key sequence has been received, or it is clear that there
8181 is no mapping or key sequence for the received characters. For
8182 example: if you have mapped "vl" and Vim has received 'v', the next
8183 character is needed to see if the 'v' is followed by an 'l'.
8184 When one of the options is on, Vim will wait for about 1 second for
8185 the next character to arrive. After that the already received
8186 characters are interpreted as single characters. The waiting time can
8187 be changed with the 'timeoutlen' option.
8188 On slow terminals or very busy systems timing out may cause
8189 malfunctioning cursor keys. If both options are off, Vim waits
8190 forever after an entered <Esc> if there are key codes that start
8191 with <Esc>. You will have to type <Esc> twice. If you do not have
8192 problems with key codes, but would like to have :mapped key
8193 sequences not timing out in 1 second, set the 'ttimeout' option and
8194 reset the 'timeout' option.
8195
8196 NOTE: 'ttimeout' is reset when 'compatible' is set.
8197
8198 *'timeoutlen'* *'tm'*
8199'timeoutlen' 'tm' number (default 1000)
8200 global
8201 {not in all versions of Vi}
8202 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02008203'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008204 global
8205 {not in Vi}
8206 The time in milliseconds that is waited for a key code or mapped key
8207 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
8208 when part of a command has been typed.
8209 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
8210 different timeout value for key codes is desired set 'ttimeoutlen' to
8211 a non-negative number.
8212
8213 ttimeoutlen mapping delay key code delay ~
8214 < 0 'timeoutlen' 'timeoutlen'
8215 >= 0 'timeoutlen' 'ttimeoutlen'
8216
8217 The timeout only happens when the 'timeout' and 'ttimeout' options
8218 tell so. A useful setting would be >
8219 :set timeout timeoutlen=3000 ttimeoutlen=100
8220< (time out on mapping after three seconds, time out on key codes after
8221 a tenth of a second).
8222
8223 *'title'* *'notitle'*
8224'title' boolean (default off, on when title can be restored)
8225 global
8226 {not in Vi}
8227 {not available when compiled without the |+title|
8228 feature}
8229 When on, the title of the window will be set to the value of
8230 'titlestring' (if it is not empty), or to:
8231 filename [+=-] (path) - VIM
8232 Where:
8233 filename the name of the file being edited
8234 - indicates the file cannot be modified, 'ma' off
8235 + indicates the file was modified
8236 = indicates the file is read-only
8237 =+ indicates the file is read-only and modified
8238 (path) is the path of the file being edited
8239 - VIM the server name |v:servername| or "VIM"
8240 Only works if the terminal supports setting window titles
8241 (currently Amiga console, Win32 console, all GUI versions and
8242 terminals with a non- empty 't_ts' option - these are Unix xterm and
8243 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8244 *X11*
8245 When Vim was compiled with HAVE_X11 defined, the original title will
8246 be restored if possible. The output of ":version" will include "+X11"
8247 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8248 works for the icon name |'icon'|.
8249 But: When Vim was started with the |-X| argument, restoring the title
8250 will not work (except in the GUI).
8251 If the title cannot be restored, it is set to the value of 'titleold'.
8252 You might want to restore the title outside of Vim then.
8253 When using an xterm from a remote machine you can use this command:
8254 rsh machine_name xterm -display $DISPLAY &
8255 then the WINDOWID environment variable should be inherited and the
8256 title of the window should change back to what it should be after
8257 exiting Vim.
8258
8259 *'titlelen'*
8260'titlelen' number (default 85)
8261 global
8262 {not in Vi}
8263 {not available when compiled without the |+title|
8264 feature}
8265 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008266 title. When the title is longer, only the end of the path name is
8267 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 Using a percentage makes this adapt to the width of the window. But
8269 it won't work perfectly, because the actual number of characters
8270 available also depends on the font used and other things in the title
8271 bar. When 'titlelen' is zero the full path is used. Otherwise,
8272 values from 1 to 30000 percent can be used.
8273 'titlelen' is also used for the 'titlestring' option.
8274
8275 *'titleold'*
8276'titleold' string (default "Thanks for flying Vim")
8277 global
8278 {not in Vi}
8279 {only available when compiled with the |+title|
8280 feature}
8281 This option will be used for the window title when exiting Vim if the
8282 original title cannot be restored. Only happens if 'title' is on or
8283 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008284 This option cannot be set from a |modeline| or in the |sandbox|, for
8285 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 *'titlestring'*
8287'titlestring' string (default "")
8288 global
8289 {not in Vi}
8290 {not available when compiled without the |+title|
8291 feature}
8292 When this option is not empty, it will be used for the title of the
8293 window. This happens only when the 'title' option is on.
8294 Only works if the terminal supports setting window titles (currently
8295 Amiga console, Win32 console, all GUI versions and terminals with a
8296 non-empty 't_ts' option).
8297 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008298 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 When this option contains printf-style '%' items, they will be
8300 expanded according to the rules used for 'statusline'.
8301 Example: >
8302 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8303 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8304< The value of 'titlelen' is used to align items in the middle or right
8305 of the available space.
8306 Some people prefer to have the file name first: >
8307 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8308< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008309 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 separating space only when needed.
8311 NOTE: Use of special characters in 'titlestring' may cause the display
8312 to be garbled (e.g., when it contains a CR or NL character).
8313 {not available when compiled without the |+statusline| feature}
8314
8315 *'toolbar'* *'tb'*
8316'toolbar' 'tb' string (default "icons,tooltips")
8317 global
8318 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8319 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008320 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 possible values are:
8322 icons Toolbar buttons are shown with icons.
8323 text Toolbar buttons shown with text.
8324 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008325 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 tooltips Tooltips are active for toolbar buttons.
8327 Tooltips refer to the popup help text which appears after the mouse
8328 cursor is placed over a toolbar button for a brief moment.
8329
8330 If you want the toolbar to be shown with icons as well as text, do the
8331 following: >
8332 :set tb=icons,text
8333< Motif and Athena cannot display icons and text at the same time. They
8334 will show icons if both are requested.
8335
8336 If none of the strings specified in 'toolbar' are valid or if
8337 'toolbar' is empty, this option is ignored. If you want to disable
8338 the toolbar, you need to set the 'guioptions' option. For example: >
8339 :set guioptions-=T
8340< Also see |gui-toolbar|.
8341
8342 *'toolbariconsize'* *'tbis'*
8343'toolbariconsize' 'tbis' string (default "small")
8344 global
8345 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008346 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008348 tiny Use tiny icons.
8349 small Use small icons (default).
8350 medium Use medium-sized icons.
8351 large Use large icons.
8352 huge Use even larger icons.
8353 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008355 the current theme. Common dimensions are giant=48x48, huge=32x32,
8356 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357
8358 If 'toolbariconsize' is empty, the global default size as determined
8359 by user preferences or the current theme is used.
8360
8361 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8362'ttybuiltin' 'tbi' boolean (default on)
8363 global
8364 {not in Vi}
8365 When on, the builtin termcaps are searched before the external ones.
8366 When off the builtin termcaps are searched after the external ones.
8367 When this option is changed, you should set the 'term' option next for
8368 the change to take effect, for example: >
8369 :set notbi term=$TERM
8370< See also |termcap|.
8371 Rationale: The default for this option is "on", because the builtin
8372 termcap entries are generally better (many systems contain faulty
8373 xterm entries...).
8374
8375 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8376'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8377 sun-cmd, screen, rxvt, dtterm or
8378 iris-ansi; also on when running Vim in
8379 a DOS console)
8380 global
8381 {not in Vi}
8382 Indicates a fast terminal connection. More characters will be sent to
8383 the screen for redrawing, instead of using insert/delete line
8384 commands. Improves smoothness of redrawing when there are multiple
8385 windows and the terminal does not support a scrolling region.
8386 Also enables the extra writing of characters at the end of each screen
8387 line for lines that wrap. This helps when using copy/paste with the
8388 mouse in an xterm and other terminals.
8389
8390 *'ttymouse'* *'ttym'*
8391'ttymouse' 'ttym' string (default depends on 'term')
8392 global
8393 {not in Vi}
8394 {only in Unix and VMS, doesn't work in the GUI; not
8395 available when compiled without |+mouse|}
8396 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008397 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 *xterm-mouse*
8399 xterm xterm-like mouse handling. The mouse generates
8400 "<Esc>[Mscr", where "scr" is three bytes:
8401 "s" = button state
8402 "c" = column plus 33
8403 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008404 This only works up to 223 columns! See "dec",
8405 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 xterm2 Works like "xterm", but with the xterm reporting the
8407 mouse position while the mouse is dragged. This works
8408 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008409 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 work. See below for how Vim detects this
8411 automatically.
8412 *netterm-mouse*
8413 netterm NetTerm mouse handling. The mouse generates
8414 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8415 for the row and column.
8416 *dec-mouse*
8417 dec DEC terminal mouse handling. The mouse generates a
8418 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008419 This is also available for an Xterm, if it was
8420 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008421 *jsbterm-mouse*
8422 jsbterm JSB term mouse handling.
8423 *pterm-mouse*
8424 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008425 *urxvt-mouse*
8426 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008427 The mouse works only if the terminal supports this
8428 encoding style, but it does not have 223 columns limit
8429 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008430 *sgr-mouse*
8431 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008432 mouse reporting. The mouse works even in columns
8433 beyond 223. This option is backward compatible with
8434 "xterm2" because it can also decode "xterm2" style
8435 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436
8437 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008438 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8439 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8441 recognized, if enabled at compile time. DEC terminal mouse codes
8442 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008443 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8444 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008446 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8447 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8448 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008449 Additionally, if vim is compiled with the |+termresponse| feature and
8450 |t_RV| is set to the escape sequence to request the xterm version
8451 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008453 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8454 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8455 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008456 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8457 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 :set t_RV=
8459<
8460 *'ttyscroll'* *'tsl'*
8461'ttyscroll' 'tsl' number (default 999)
8462 global
8463 Maximum number of lines to scroll the screen. If there are more lines
8464 to scroll the window is redrawn. For terminals where scrolling is
8465 very slow and redrawing is not slow this can be set to a small number,
8466 e.g., 3, to speed up displaying.
8467
8468 *'ttytype'* *'tty'*
8469'ttytype' 'tty' string (default from $TERM)
8470 global
8471 Alias for 'term', see above.
8472
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008473 *'undodir'* *'udir'*
8474'undodir' 'udir' string (default ".")
8475 global
8476 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008477 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008478 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008479 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008480 "." means using the directory of the file. The undo file name for
8481 "file.txt" is ".file.txt.un~".
8482 For other directories the file name is the full path of the edited
8483 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008484 When writing: The first directory that exists is used. "." always
8485 works, no directories after "." will be used for writing.
8486 When reading all entries are tried to find an undo file. The first
8487 undo file that exists is used. When it cannot be read an error is
8488 given, no further entry is used.
8489 See |undo-persistence|.
8490
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008491 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008492'undofile' 'udf' boolean (default off)
8493 local to buffer
8494 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008495 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008496 When on, Vim automatically saves undo history to an undo file when
8497 writing a buffer to a file, and restores undo history from the same
8498 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008499 The directory where the undo file is stored is specified by 'undodir'.
8500 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008501 The undo file is not read when 'undoreload' causes the buffer from
8502 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008503 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008504 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008505
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 *'undolevels'* *'ul'*
8507'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8508 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008509 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 {not in Vi}
8511 Maximum number of changes that can be undone. Since undo information
8512 is kept in memory, higher numbers will cause more memory to be used
8513 (nevertheless, a single change can use an unlimited amount of memory).
8514 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8515 itself: >
8516 set ul=0
8517< But you can also get Vi compatibility by including the 'u' flag in
8518 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008519 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008520 Set to -1 for no undo at all. You might want to do this only for the
8521 current buffer: >
8522 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008524
8525 The local value is set to -123456 when the global value is to be used.
8526
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008527 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008529 *'undoreload'* *'ur'*
8530'undoreload' 'ur' number (default 10000)
8531 global
8532 {not in Vi}
8533 Save the whole buffer for undo when reloading it. This applies to the
8534 ":e!" command and reloading for when the buffer changed outside of
8535 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008536 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008537 of lines is smaller than the value of this option.
8538 Set this option to zero to disable undo for a reload.
8539
8540 When saving undo for a reload, any undo file is not read.
8541
8542 Note that this causes the whole buffer to be stored in memory. Set
8543 this option to a lower value if you run out of memory.
8544
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 *'updatecount'* *'uc'*
8546'updatecount' 'uc' number (default: 200)
8547 global
8548 {not in Vi}
8549 After typing this many characters the swap file will be written to
8550 disk. When zero, no swap file will be created at all (see chapter on
8551 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8552 Vim with the "-n" option, see |startup|. When editing in readonly
8553 mode this option will be initialized to 10000.
8554 The swapfile can be disabled per buffer with |'swapfile'|.
8555 When 'updatecount' is set from zero to non-zero, swap files are
8556 created for all buffers that have 'swapfile' set. When 'updatecount'
8557 is set to zero, existing swap files are not deleted.
8558 Also see |'swapsync'|.
8559 This option has no meaning in buffers where |'buftype'| is "nofile"
8560 or "nowrite".
8561
8562 *'updatetime'* *'ut'*
8563'updatetime' 'ut' number (default 4000)
8564 global
8565 {not in Vi}
8566 If this many milliseconds nothing is typed the swap file will be
8567 written to disk (see |crash-recovery|). Also used for the
8568 |CursorHold| autocommand event.
8569
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008570 *'varsofttabstop'* *'vsts'*
8571'varsofttabstop' 'vsts' string (default "")
8572 local to buffer
8573 {only available when compiled with the |+vartabs|
8574 feature}
8575 {not in Vi}
8576 A list of the number of spaces that a <Tab> counts for while editing,
8577 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8578 width <Tab>s are being inserted, while in fact a mixture of spaces
8579 and <Tab>s is used. Tab widths are separated with commas, with the
8580 final value applying to all subsequent tabs.
8581
8582 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008583 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008584 to use the following: >
8585 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008586< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8587 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008588
8589 Note that the value of |'softtabstop'| will be ignored while
8590 'varsofttabstop' is set.
8591
8592 *'vartabstop'* *'vts'*
8593'vartabstop' 'vts' string (default "")
8594 local to buffer
8595 {only available when compiled with the |+vartabs|
8596 feature}
8597 {not in Vi}
8598 A list of the number of spaces that a <Tab> in the file counts for,
8599 separated by commas. Each value corresponds to one tab, with the
8600 final value applying to all subsequent tabs. For example: >
8601 :set vartabstop=4,20,10,8
8602< This will make the first tab 4 spaces wide, the second 20 spaces,
8603 the third 10 spaces, and all following tabs 8 spaces.
8604
8605 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8606 is set.
8607
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 *'verbose'* *'vbs'*
8609'verbose' 'vbs' number (default 0)
8610 global
8611 {not in Vi, although some versions have a boolean
8612 verbose option}
8613 When bigger than zero, Vim will give messages about what it is doing.
8614 Currently, these messages are given:
8615 >= 1 When the viminfo file is read or written.
8616 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008617 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 >= 8 Files for which a group of autocommands is executed.
8619 >= 9 Every executed autocommand.
8620 >= 12 Every executed function.
8621 >= 13 When an exception is thrown, caught, finished, or discarded.
8622 >= 14 Anything pending in a ":finally" clause.
8623 >= 15 Every executed Ex command (truncated at 200 characters).
8624
8625 This option can also be set with the "-V" argument. See |-V|.
8626 This option is also set by the |:verbose| command.
8627
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008628 When the 'verbosefile' option is set then the verbose messages are not
8629 displayed.
8630
8631 *'verbosefile'* *'vfile'*
8632'verbosefile' 'vfile' string (default empty)
8633 global
8634 {not in Vi}
8635 When not empty all messages are written in a file with this name.
8636 When the file exists messages are appended.
8637 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008638 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008639 Setting 'verbosefile' to a new value is like making it empty first.
8640 The difference with |:redir| is that verbose messages are not
8641 displayed when 'verbosefile' is set.
8642
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 *'viewdir'* *'vdir'*
8644'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8645 "$VIM/vimfiles/view",
8646 for Unix: "~/.vim/view",
8647 for Macintosh: "$VIM:vimfiles:view"
8648 for VMS: "sys$login:vimfiles/view"
8649 for RiscOS: "Choices:vimfiles/view")
8650 global
8651 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008652 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008653 feature}
8654 Name of the directory where to store files for |:mkview|.
8655 This option cannot be set from a |modeline| or in the |sandbox|, for
8656 security reasons.
8657
8658 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008659'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008660 global
8661 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008662 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 feature}
8664 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008665 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 word save and restore ~
8667 cursor cursor position in file and in window
8668 folds manually created folds, opened/closed folds and local
8669 fold options
8670 options options and mappings local to a window or buffer (not
8671 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008672 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 slash backslashes in file names replaced with forward
8674 slashes
8675 unix with Unix end-of-line format (single <NL>), even when
8676 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008677 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678
8679 "slash" and "unix" are useful on Windows when sharing view files
8680 with Unix. The Unix version of Vim cannot source dos format scripts,
8681 but the Windows version of Vim can source unix format scripts.
8682
8683 *'viminfo'* *'vi'* *E526* *E527* *E528*
8684'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008685 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8686 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8687 for others: '100,<50,s10,h)
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 |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 feature}
8692 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008693 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8694 "NONE".
8695 The string should be a comma separated list of parameters, each
8696 consisting of a single character identifying the particular parameter,
8697 followed by a number or string which specifies the value of that
8698 parameter. If a particular character is left out, then the default
8699 value is used for that parameter. The following is a list of the
8700 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008702 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008703 ! When included, save and restore global variables that start
8704 with an uppercase letter, and don't contain a lowercase
8705 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008706 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008707 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008708 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 " Maximum number of lines saved for each register. Old name of
8710 the '<' item, with the disadvantage that you need to put a
8711 backslash before the ", otherwise it will be recognized as the
8712 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008713 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 % When included, save and restore the buffer list. If Vim is
8715 started with a file name argument, the buffer list is not
8716 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008717 buffer list is restored from the viminfo file. Quickfix
8718 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8719 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008720 When followed by a number, the number specifies the maximum
8721 number of buffers that are stored. Without a number all
8722 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008723 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 ' Maximum number of previously edited files for which the marks
8725 are remembered. This parameter must always be included when
8726 'viminfo' is non-empty.
8727 Including this item also means that the |jumplist| and the
8728 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008729 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008731 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 patterns are also saved. When not included, the value of
8733 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008734 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008736 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008737 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 < Maximum number of lines saved for each register. If zero then
8739 registers are not saved. When not included, all lines are
8740 saved. '"' is the old name for this item.
8741 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008742 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008744 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008745 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008746 c When included, convert the text in the viminfo file from the
8747 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008748 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008749 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 f Whether file marks need to be stored. If zero, file marks ('0
8751 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008752 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008754 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008755 h Disable the effect of 'hlsearch' when loading the viminfo
8756 file. When not included, it depends on whether ":nohlsearch"
8757 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008758 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008760 the 'n'. Must be at the end of the option! If the
8761 'viminfofile' option is set, that file name overrides the one
8762 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008763 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008764 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008765 r Removable media. The argument is a string (up to the next
8766 ','). This parameter can be given several times. Each
8767 specifies the start of a path for which no marks will be
8768 stored. This is to avoid removable media. For MS-DOS you
8769 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8770 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8771 ignored. Maximum length of each 'r' argument is 50
8772 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008773 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 s Maximum size of an item in Kbyte. If zero then registers are
8775 not saved. Currently only applies to registers. The default
8776 "s10" will exclude registers with more than 10 Kbyte of text.
8777 Also see the '<' item above: line count limit.
8778
8779 Example: >
8780 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8781<
8782 '50 Marks will be remembered for the last 50 files you
8783 edited.
8784 <1000 Contents of registers (up to 1000 lines each) will be
8785 remembered.
8786 s100 Registers with more than 100 Kbyte text are skipped.
8787 :0 Command-line history will not be saved.
8788 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8789 no / Since '/' is not specified, the default will be used,
8790 that is, save all of the search history, and also the
8791 previous search and substitute patterns.
8792 no % The buffer list will not be saved nor read back.
8793 no h 'hlsearch' highlighting will be restored.
8794
8795 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8796 load the contents of the file, this is not done automatically.
8797
8798 This option cannot be set from a |modeline| or in the |sandbox|, for
8799 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008800 NOTE: This option is set to the Vim default value when 'compatible'
8801 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008802
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008803 *'viminfofile'* *'vif'*
8804'viminfofile' 'vif' string (default: "")
8805 global
8806 {not in Vi}
8807 {not available when compiled without the |+viminfo|
8808 feature}
8809 When non-empty, overrides the file name used for viminfo.
8810 When equal to "NONE" no viminfo file will be read or written.
8811 This option can be set with the |-i| command line flag. The |--clean|
8812 command line flag sets it to "NONE".
8813
Bram Moolenaar071d4272004-06-13 20:20:40 +00008814 *'virtualedit'* *'ve'*
8815'virtualedit' 've' string (default "")
8816 global
8817 {not in Vi}
8818 {not available when compiled without the
8819 |+virtualedit| feature}
8820 A comma separated list of these words:
8821 block Allow virtual editing in Visual block mode.
8822 insert Allow virtual editing in Insert mode.
8823 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008824 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008825
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008827 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008828 of the line. Useful for selecting a rectangle in Visual mode and
8829 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008830 "onemore" is not the same, it will only allow moving the cursor just
8831 after the last character of the line. This makes some commands more
8832 consistent. Previously the cursor was always past the end of the line
8833 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008834 break some plugins or Vim scripts. For example because |l| can move
8835 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008836 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008837 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008838 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008839 It doesn't make sense to combine "all" with "onemore", but you will
8840 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008841 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008842
8843 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8844'visualbell' 'vb' boolean (default off)
8845 global
8846 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008847 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008849 use: >
8850 :set vb t_vb=
8851< If you want a short flash, you can use this on many terminals: >
8852 :set vb t_vb=[?5h$<100>[?5l
8853< Here $<100> specifies the time, you can use a smaller or bigger value
8854 to get a shorter or longer flash.
8855
8856 Note: Vim will limit the bell to once per half a second. This avoids
8857 having to wait for the flashing to finish when there are lots of
8858 bells, e.g. on key repeat. This also happens without 'visualbell'
8859 set.
8860
Bram Moolenaar071d4272004-06-13 20:20:40 +00008861 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8862 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8863 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008864
8865 Note: When the GUI starts, 't_vb' is reset to its default value. You
8866 might want to set it again in your |gvimrc|.
8867
Bram Moolenaar071d4272004-06-13 20:20:40 +00008868 Does not work on the Amiga, you always get a screen flash.
8869 Also see 'errorbells'.
8870
8871 *'warn'* *'nowarn'*
8872'warn' boolean (default on)
8873 global
8874 Give a warning message when a shell command is used while the buffer
8875 has been changed.
8876
8877 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8878'weirdinvert' 'wiv' boolean (default off)
8879 global
8880 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008881 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008882 It is provided for backwards compatibility with version 4.x.
8883 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8884 vice versa. Has no effect when the GUI is running.
8885
8886 *'whichwrap'* *'ww'*
8887'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8888 global
8889 {not in Vi}
8890 Allow specified keys that move the cursor left/right to move to the
8891 previous/next line when the cursor is on the first/last character in
8892 the line. Concatenate characters to allow this for these keys:
8893 char key mode ~
8894 b <BS> Normal and Visual
8895 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008896 h "h" Normal and Visual (not recommended)
8897 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008898 < <Left> Normal and Visual
8899 > <Right> Normal and Visual
8900 ~ "~" Normal
8901 [ <Left> Insert and Replace
8902 ] <Right> Insert and Replace
8903 For example: >
8904 :set ww=<,>,[,]
8905< allows wrap only when cursor keys are used.
8906 When the movement keys are used in combination with a delete or change
8907 operator, the <EOL> also counts for a character. This makes "3h"
8908 different from "3dh" when the cursor crosses the end of a line. This
8909 is also true for "x" and "X", because they do the same as "dl" and
8910 "dh". If you use this, you may also want to use the mapping
8911 ":map <BS> X" to make backspace delete the character in front of the
8912 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008913 When 'l' is included and it is used after an operator at the end of a
8914 line then it will not move to the next line. This makes "dl", "cl",
8915 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008916 NOTE: This option is set to the Vi default value when 'compatible' is
8917 set and to the Vim default value when 'compatible' is reset.
8918
8919 *'wildchar'* *'wc'*
8920'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8921 global
8922 {not in Vi}
8923 Character you have to type to start wildcard expansion in the
8924 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008925 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008926 The character is not recognized when used inside a macro. See
8927 'wildcharm' for that.
8928 Although 'wc' is a number option, you can set it to a special key: >
8929 :set wc=<Esc>
8930< NOTE: This option is set to the Vi default value when 'compatible' is
8931 set and to the Vim default value when 'compatible' is reset.
8932
8933 *'wildcharm'* *'wcm'*
8934'wildcharm' 'wcm' number (default: none (0))
8935 global
8936 {not in Vi}
8937 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008938 recognized when used inside a macro. You can find "spare" command-line
8939 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 you'll never actually type 'wildcharm', just use it in mappings that
8941 automatically invoke completion mode, e.g.: >
8942 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008943 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944< Then after typing :ss you can use CTRL-P & CTRL-N.
8945
8946 *'wildignore'* *'wig'*
8947'wildignore' 'wig' string (default "")
8948 global
8949 {not in Vi}
8950 {not available when compiled without the |+wildignore|
8951 feature}
8952 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008953 patterns is ignored when expanding |wildcards|, completing file or
8954 directory names, and influences the result of |expand()|, |glob()| and
8955 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8957 Also see 'suffixes'.
8958 Example: >
8959 :set wildignore=*.o,*.obj
8960< The use of |:set+=| and |:set-=| is preferred when adding or removing
8961 a pattern from the list. This avoids problems when a future version
8962 uses another default.
8963
Bram Moolenaar94950a92010-12-02 16:01:29 +01008964
Bram Moolenaar81af9252010-12-10 20:35:50 +01008965 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008966'wildignorecase' 'wic' boolean (default off)
8967 global
8968 {not in Vi}
8969 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008970 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008971 Does not apply when the shell is used to expand wildcards, which
8972 happens when there are special characters.
8973
8974
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008976'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 global
8978 {not in Vi}
8979 {not available if compiled without the |+wildmenu|
8980 feature}
8981 When 'wildmenu' is on, command-line completion operates in an enhanced
8982 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8983 the possible matches are shown just above the command line, with the
8984 first match highlighted (overwriting the status line, if there is
8985 one). Keys that show the previous/next match, such as <Tab> or
8986 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8987 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8988 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008989 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008990 If there are more matches than can fit in the line, a ">" is shown on
8991 the right and/or a "<" is shown on the left. The status line scrolls
8992 as needed.
8993 The "wildmenu" mode is abandoned when a key is hit that is not used
8994 for selecting a completion.
8995 While the "wildmenu" is active the following keys have special
8996 meanings:
8997
8998 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8999 <Down> - in filename/menu name completion: move into a
9000 subdirectory or submenu.
9001 <CR> - in menu completion, when the cursor is just after a
9002 dot: move into a submenu.
9003 <Up> - in filename/menu name completion: move up into
9004 parent directory or parent menu.
9005
9006 This makes the menus accessible from the console |console-menus|.
9007
9008 If you prefer the <Left> and <Right> keys to move the cursor instead
9009 of selecting a different match, use this: >
9010 :cnoremap <Left> <Space><BS><Left>
9011 :cnoremap <Right> <Space><BS><Right>
9012<
9013 The "WildMenu" highlighting is used for displaying the current match
9014 |hl-WildMenu|.
9015
9016 *'wildmode'* *'wim'*
9017'wildmode' 'wim' string (Vim default: "full")
9018 global
9019 {not in Vi}
9020 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009021 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00009022 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00009023 first part specifies the behavior for the first use of 'wildchar',
9024 The second part for the second use, etc.
9025 These are the possible values for each part:
9026 "" Complete only the first match.
9027 "full" Complete the next full match. After the last match,
9028 the original string is used and then the first match
9029 again.
9030 "longest" Complete till longest common string. If this doesn't
9031 result in a longer string, use the next part.
9032 "longest:full" Like "longest", but also start 'wildmenu' if it is
9033 enabled.
9034 "list" When more than one match, list all matches.
9035 "list:full" When more than one match, list all matches and
9036 complete first match.
9037 "list:longest" When more than one match, list all matches and
9038 complete till longest common string.
9039 When there is only a single match, it is fully completed in all cases.
9040
9041 Examples: >
9042 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00009043< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00009044 :set wildmode=longest,full
9045< Complete longest common string, then each full match >
9046 :set wildmode=list:full
9047< List all matches and complete each full match >
9048 :set wildmode=list,full
9049< List all matches without completing, then each full match >
9050 :set wildmode=longest,list
9051< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00009052 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009053
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009054 *'wildoptions'* *'wop'*
9055'wildoptions' 'wop' string (default "")
9056 global
9057 {not in Vi}
9058 {not available when compiled without the |+wildignore|
9059 feature}
9060 A list of words that change how command line completion is done.
9061 Currently only one word is allowed:
9062 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00009063 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00009064 is displayed per line. Often used tag kinds are:
9065 d #define
9066 f function
9067 Also see |cmdline-completion|.
9068
Bram Moolenaar071d4272004-06-13 20:20:40 +00009069 *'winaltkeys'* *'wak'*
9070'winaltkeys' 'wak' string (default "menu")
9071 global
9072 {not in Vi}
9073 {only used in Win32, Motif, GTK and Photon GUI}
9074 Some GUI versions allow the access to menu entries by using the ALT
9075 key in combination with a character that appears underlined in the
9076 menu. This conflicts with the use of the ALT key for mappings and
9077 entering special characters. This option tells what to do:
9078 no Don't use ALT keys for menus. ALT key combinations can be
9079 mapped, but there is no automatic handling. This can then be
9080 done with the |:simalt| command.
9081 yes ALT key handling is done by the windowing system. ALT key
9082 combinations cannot be mapped.
9083 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009084 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00009085 keys can be mapped.
9086 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
9087 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00009088 This option is not used for <F10>; on Win32 and with GTK <F10> will
9089 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009090
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009091 *'window'* *'wi'*
9092'window' 'wi' number (default screen height - 1)
9093 global
9094 Window height. Do not confuse this with the height of the Vim window,
9095 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00009096 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
9097 value is smaller than 'lines' minus one. The screen will scroll
9098 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00009099 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
9100 in a much smarter way, taking care of wrapping lines.
9101 When resizing the Vim window, the value is smaller than 1 or more than
9102 or equal to 'lines' it will be set to 'lines' minus 1.
9103 {Vi also uses the option to specify the number of displayed lines}
9104
Bram Moolenaar071d4272004-06-13 20:20:40 +00009105 *'winheight'* *'wh'* *E591*
9106'winheight' 'wh' number (default 1)
9107 global
9108 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009109 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009110 feature}
9111 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009112 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00009113 focus goes to a window that is smaller, its size is increased, at the
9114 cost of the height of other windows.
9115 Set 'winheight' to a small number for normal editing.
9116 Set it to 999 to make the current window fill most of the screen.
9117 Other windows will be only 'winminheight' high. This has the drawback
9118 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
9119 to create only two windows, set the option after startup is done,
9120 using the |VimEnter| event: >
9121 au VimEnter * set winheight=999
9122< Minimum value is 1.
9123 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009124 height of the current window.
9125 'winheight' applies to the current window. Use 'winminheight' to set
9126 the minimal height for other windows.
9127
9128 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
9129'winfixheight' 'wfh' boolean (default off)
9130 local to window
9131 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009132 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009133 feature}
9134 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009135 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
9136 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009137 The height may be changed anyway when running out of room.
9138
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009139 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
9140'winfixwidth' 'wfw' boolean (default off)
9141 local to window
9142 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009143 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009144 feature}
9145 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00009146 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00009147 The width may be changed anyway when running out of room.
9148
Bram Moolenaar071d4272004-06-13 20:20:40 +00009149 *'winminheight'* *'wmh'*
9150'winminheight' 'wmh' number (default 1)
9151 global
9152 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009153 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009154 feature}
9155 The minimal height of a window, when it's not the current window.
9156 This is a hard minimum, windows will never become smaller.
9157 When set to zero, windows may be "squashed" to zero lines (i.e. just a
9158 status bar) if necessary. They will return to at least one line when
9159 they become active (since the cursor has to have somewhere to go.)
9160 Use 'winheight' to set the minimal height of the current window.
9161 This option is only checked when making a window smaller. Don't use a
9162 large number, it will cause errors when opening more than a few
9163 windows. A value of 0 to 3 is reasonable.
9164
9165 *'winminwidth'* *'wmw'*
9166'winminwidth' 'wmw' number (default 1)
9167 global
9168 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009169 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009170 feature}
9171 The minimal width of a window, when it's not the current window.
9172 This is a hard minimum, windows will never become smaller.
9173 When set to zero, windows may be "squashed" to zero columns (i.e. just
9174 a vertical separator) if necessary. They will return to at least one
9175 line when they become active (since the cursor has to have somewhere
9176 to go.)
9177 Use 'winwidth' to set the minimal width of the current window.
9178 This option is only checked when making a window smaller. Don't use a
9179 large number, it will cause errors when opening more than a few
9180 windows. A value of 0 to 12 is reasonable.
9181
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009182 *'winptydll'*
9183'winptydll' string (default "winpty32.dll" or "winpty64.dll")
9184 global
9185 {not in Vi}
9186 {only available when compiled with the |terminal|
9187 feature on MS-Windows}
9188 Specifies the name of the winpty shared library, used for the
9189 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02009190 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02009191 a fallback.
9192 Environment variables are expanded |:set_env|.
9193 This option cannot be set from a |modeline| or in the |sandbox|, for
9194 security reasons.
9195
Bram Moolenaar071d4272004-06-13 20:20:40 +00009196 *'winwidth'* *'wiw'* *E592*
9197'winwidth' 'wiw' number (default 20)
9198 global
9199 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02009200 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00009201 feature}
9202 Minimal number of columns for the current window. This is not a hard
9203 minimum, Vim will use fewer columns if there is not enough room. If
9204 the current window is smaller, its size is increased, at the cost of
9205 the width of other windows. Set it to 999 to make the current window
9206 always fill the screen. Set it to a small number for normal editing.
9207 The width is not adjusted after one of the commands to change the
9208 width of the current window.
9209 'winwidth' applies to the current window. Use 'winminwidth' to set
9210 the minimal width for other windows.
9211
9212 *'wrap'* *'nowrap'*
9213'wrap' boolean (default on)
9214 local to window
9215 {not in Vi}
9216 This option changes how text is displayed. It doesn't change the text
9217 in the buffer, see 'textwidth' for that.
9218 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009219 displaying continues on the next line. When off lines will not wrap
9220 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00009221 moved to a part that is not shown, the screen will scroll
9222 horizontally.
9223 The line will be broken in the middle of a word if necessary. See
9224 'linebreak' to get the break at a word boundary.
9225 To make scrolling horizontally a bit more useful, try this: >
9226 :set sidescroll=5
9227 :set listchars+=precedes:<,extends:>
9228< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01009229 This option can't be set from a |modeline| when the 'diff' option is
9230 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009231
9232 *'wrapmargin'* *'wm'*
9233'wrapmargin' 'wm' number (default 0)
9234 local to buffer
9235 Number of characters from the right window border where wrapping
9236 starts. When typing text beyond this limit, an <EOL> will be inserted
9237 and inserting continues on the next line.
9238 Options that add a margin, such as 'number' and 'foldcolumn', cause
9239 the text width to be further reduced. This is Vi compatible.
9240 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02009241 This option is set to 0 when 'paste' is set and restored when 'paste'
9242 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009243 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
9244 and less usefully}
9245
9246 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
9247'wrapscan' 'ws' boolean (default on) *E384* *E385*
9248 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00009249 Searches wrap around the end of the file. Also applies to |]s| and
9250 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009251
9252 *'write'* *'nowrite'*
9253'write' boolean (default on)
9254 global
9255 {not in Vi}
9256 Allows writing files. When not set, writing a file is not allowed.
9257 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00009258 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00009259 argument. Filtering text is still possible, even though this requires
9260 writing a temporary file.
9261
9262 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9263'writeany' 'wa' boolean (default off)
9264 global
9265 Allows writing to any file with no need for "!" override.
9266
9267 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9268'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9269 otherwise)
9270 global
9271 {not in Vi}
9272 Make a backup before overwriting a file. The backup is removed after
9273 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009274 also on.
9275 WARNING: Switching this option off means that when Vim fails to write
9276 your buffer correctly and then, for whatever reason, Vim exits, you
9277 lose both the original file and what you were writing. Only reset
9278 this option if your file system is almost full and it makes the write
9279 fail (and make sure not to exit Vim until the write was successful).
9280 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009281 When the 'backupskip' pattern matches, a backup is not made anyway.
9282 NOTE: This option is set to the default value when 'compatible' is
9283 set.
9284
9285 *'writedelay'* *'wd'*
9286'writedelay' 'wd' number (default 0)
9287 global
9288 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009289 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009290 screen. When non-zero, characters are sent to the terminal one by
9291 one. For MS-DOS pcterm this does not work. For debugging purposes.
9292
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009293 vim:tw=78:ts=8:noet:ft=help:norl: