blob: bd6cc62d629461e7e3315dd6398a548f3ab8c4fe [file] [log] [blame]
Bram Moolenaar65e0d772020-06-14 17:29:55 +02001*options.txt* For Vim version 8.2. Last change: 2020 Jun 10
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*
Bram Moolenaar6b915c02020-01-18 15:53:19 +010025:se[t][!] Show all options that differ from their default value.
26 When [!] is present every option is on a separate
27 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000028
Bram Moolenaar6b915c02020-01-18 15:53:19 +010029:se[t][!] all Show all but terminal options.
30 When [!] is present every option is on a separate
31 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +000032
33:se[t] termcap Show all terminal options. Note that in the GUI the
34 key codes are not shown, because they are generated
35 internally and can't be changed. Changing the terminal
36 codes in the GUI is not useful either...
37
38 *E518* *E519*
39:se[t] {option}? Show value of {option}.
40
41:se[t] {option} Toggle option: set, switch it on.
42 Number option: show value.
43 String option: show value.
44
45:se[t] no{option} Toggle option: Reset, switch it off.
46
Bram Moolenaar00a927d2010-05-14 23:24:24 +020047 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000048:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000050
51 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
52:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020053 current value of 'compatible'.
54:se[t] {option}&vi Reset option to its Vi default value.
55:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010057:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020058 these options are not changed:
59 all terminal options, starting with t_
60 'columns'
61 'cryptmethod'
62 'encoding'
63 'key'
64 'lines'
65 'term'
66 'ttymouse'
67 'ttytype'
68 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000069
70 *:set-args* *E487* *E521*
71:se[t] {option}={value} or
72:se[t] {option}:{value}
73 Set string or number option to {value}.
74 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010075 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000076 The old value can be inserted by typing 'wildchar' (by
77 default this is a <Tab> or CTRL-E if 'compatible' is
78 set). See |cmdline-completion|.
79 White space between {option} and '=' is allowed and
80 will be ignored. White space between '=' and {value}
81 is not allowed.
82 See |option-backslash| for using white space and
83 backslashes in {value}.
84
85:se[t] {option}+={value} *:set+=*
86 Add the {value} to a number option, or append the
87 {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000091 are removed. When adding a flag that was already
92 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000093 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000094
95:se[t] {option}^={value} *:set^=*
96 Multiply the {value} to a number option, or prepend
97 the {value} to a string option. When the option is a
98 comma separated list, a comma is added, unless the
99 value was empty.
100 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
102:se[t] {option}-={value} *:set-=*
103 Subtract the {value} from a number option, or remove
104 the {value} from a string option, if it is there.
105 If the {value} is not found in a string option, there
106 is no error or warning. When the option is a comma
107 separated list, a comma is deleted, unless the option
108 becomes empty.
109 When the option is a list of flags, {value} must be
110 exactly as they appear in the option. Remove flags
111 one by one to avoid problems.
112 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000113
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 Moolenaar5666fcd2019-12-26 14:35:26 +0100203For Win32 backslashes in file names are mostly not removed. More precise: For
204options that expect a file name (those where environment variables are
205expanded) a backslash before a normal file name character is not removed. But
206a backslash before a special character (space, backslash, comma, etc.) is used
207like explained above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000208There 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*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100294:setl[ocal][!] ... Like ":set" but set only the value local to the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 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).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000309:setl[ocal] {option}< Set the local value of {option} to its global value by
310 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000311
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100312:se[t] {option}< For |global-local| options: Remove the local value of
313 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000314
315 *:setg* *:setglobal*
Bram Moolenaar6b915c02020-01-18 15:53:19 +0100316:setg[lobal][!] ... Like ":set" but set only the global value for a local
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 option without changing the local value.
318 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200319 With the "all" argument: display global values for all
320 local options.
321 Without argument: display global values for all local
322 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323
324For buffer-local and window-local options:
325 Command global value local value ~
326 :set option=value set set
327 :setlocal option=value - set
328:setglobal option=value set -
329 :set option? - display
330 :setlocal option? - display
331:setglobal option? display -
332
333
334Global options with a local value *global-local*
335
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000336Options are global when you mostly use one value for all buffers and windows.
337For some global options it's useful to sometimes have a different local value.
338You can set the local value with ":setlocal". That buffer or window will then
339use the local value, while other buffers and windows continue using the global
340value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000341
342For example, you have two windows, both on C source code. They use the global
343'makeprg' option. If you do this in one of the two windows: >
344 :set makeprg=gmake
345then the other window will switch to the same value. There is no need to set
346the 'makeprg' option in the other C source window too.
347However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000348another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000349files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000350 :setlocal makeprg=perlmake
351You can switch back to using the global value by making the local value empty: >
352 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100353This only works for a string option. For a number or boolean option you need
354to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000355 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100356Note that for non-boolean and non-number options using "<" copies the global
357value to the local value, it doesn't switch back to using the global value
358(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000359 :set path<
360This will make the local value of 'path' empty, so that the global value is
361used. Thus it does the same as: >
362 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000363Note: In the future more global options can be made global-local. Using
364":setlocal" on a global option might work differently then.
365
366
367Setting the filetype
368
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200369:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000370 Set the 'filetype' option to {filetype}, but only if
371 not done yet in a sequence of (nested) autocommands.
372 This is short for: >
373 :if !did_filetype()
374 : setlocal filetype={filetype}
375 :endif
376< This command is used in a filetype.vim file to avoid
377 setting the 'filetype' option twice, causing different
378 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200379
380 When the optional FALLBACK argument is present, a
381 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100382 'filetype'. This is to be used for filetype
383 detections that are just a guess. |did_filetype()|
384 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200385
Bram Moolenaard58e9292011-02-09 17:07:58 +0100386 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000387:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
388:opt[ions] Open a window for viewing and setting all options.
389 Options are grouped by function.
390 Offers short help for each option. Hit <CR> on the
391 short help to open a help window with more help for
392 the option.
393 Modify the value of the option and hit <CR> on the
394 "set" line to set the new value. For window and
395 buffer specific options, the last accessed window is
396 used to set the option value in, unless this is a help
397 window, in which case the window below help window is
398 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100399 {not available when compiled without the |+eval|
400 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000401
402 *$HOME*
403Using "~" is like using "$HOME", but it is only recognized at the start of an
404option and after a space or comma.
405
406On Unix systems "~user" can be used too. It is replaced by the home directory
407of user "user". Example: >
408 :set path=~mool/include,/usr/include,.
409
410On Unix systems the form "${HOME}" can be used too. The name between {} can
411contain non-id characters then. Note that if you want to use this for the
412"gf" command, you need to add the '{' and '}' characters to 'isfname'.
413
414NOTE: expanding environment variables and "~/" is only done with the ":set"
415command, not when assigning a value to an option with ":let".
416
Bram Moolenaarc572da52017-08-27 16:52:01 +0200417 *$HOME-windows*
418On MS-Windows, if $HOME is not defined as an environment variable, then
419at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200420If $HOMEDRIVE is not set then $USERPROFILE is used.
421
422This expanded value is not exported to the environment, this matters when
423running an external command: >
424 :echo system('set | findstr ^HOME=')
425and >
426 :echo luaeval('os.getenv("HOME")')
427should echo nothing (an empty string) despite exists('$HOME') being true.
428When setting $HOME to a non-empty string it will be exported to the
429subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431
432Note the maximum length of an expanded option is limited. How much depends on
433the system, mostly it is something like 256 or 1024 characters.
434
435 *:fix* *:fixdel*
436:fix[del] Set the value of 't_kD':
437 't_kb' is 't_kD' becomes ~
438 CTRL-? CTRL-H
439 not CTRL-? CTRL-?
440
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200441 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000442
443 If your delete key terminal code is wrong, but the
444 code for backspace is alright, you can put this in
445 your .vimrc: >
446 :fixdel
447< This works no matter what the actual code for
448 backspace is.
449
450 If the backspace key terminal code is wrong you can
451 use this: >
452 :if &term == "termname"
453 : set t_kb=^V<BS>
454 : fixdel
455 :endif
456< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000457 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000458 with your terminal name.
459
460 If your <Delete> key sends a strange key sequence (not
461 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
462 :if &term == "termname"
463 : set t_kD=^V<Delete>
464 :endif
465< Where "^V" is CTRL-V and "<Delete>" is the delete key
466 (don't type eight characters!). Replace "termname"
467 with your terminal name.
468
469 *Linux-backspace*
470 Note about Linux: By default the backspace key
471 produces CTRL-?, which is wrong. You can fix it by
472 putting this line in your rc.local: >
473 echo "keycode 14 = BackSpace" | loadkeys
474<
475 *NetBSD-backspace*
476 Note about NetBSD: If your backspace doesn't produce
477 the right code, try this: >
478 xmodmap -e "keycode 22 = BackSpace"
479< If this works, add this in your .Xmodmap file: >
480 keysym 22 = BackSpace
481< You need to restart for this to take effect.
482
483==============================================================================
4842. Automatically setting options *auto-setting*
485
486Besides changing options with the ":set" command, there are three alternatives
487to set options automatically for one or more files:
488
4891. When starting Vim initializations are read from various places. See
490 |initialization|. Most of them are performed for all editing sessions,
491 and some of them depend on the directory where Vim is started.
492 You can create an initialization file with |:mkvimrc|, |:mkview| and
493 |:mksession|.
4942. If you start editing a new file, the automatic commands are executed.
495 This can be used to set options for files matching a particular pattern and
496 many other things. See |autocommand|.
4973. If you start editing a new file, and the 'modeline' option is on, a
498 number of lines at the beginning and end of the file are checked for
499 modelines. This is explained here.
500
501 *modeline* *vim:* *vi:* *ex:* *E520*
502There are two forms of modelines. The first form:
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100503 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100505[text{white}] empty or any text followed by at least one blank
506 character (<Space> or <Tab>); "ex:" always requires at
507 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[white] optional white space
510{options} a list of option settings, separated with white space
511 or ':', where each part between ':' is the argument
512 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000515 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200516 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
518The second form (this is compatible with some versions of Vi):
519
Bram Moolenaarade0d392020-01-21 22:33:58 +0100520 [text{white}]{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
Bram Moolenaarade0d392020-01-21 22:33:58 +0100522[text{white}] empty or any text followed by at least one blank
523 character (<Space> or <Tab>); "ex:" always requires at
524 least one blank character
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
526[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527se[t] the string "set " or "se " (note the space); When
528 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200529{options} a list of options, separated with white space, which
530 is the argument for a ":set" command
531: a colon
532[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000533
Bram Moolenaar14b69452013-06-29 23:05:20 +0200534Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000535 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200536 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200538The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
539chance that a normal word like "lex:" is caught. There is one exception:
540"vi:" and "vim:" can also be at the start of the line (for compatibility with
541version 3.0). Using "ex:" at the start of the line will be ignored (this
542could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
544 *modeline-local*
545The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000546buffer and window that contain the file. Although it's possible to set global
547options from a modeline, this is unusual. If you have two windows open and
548the files in it set the same global option to a different value, the result
549depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000551When editing a file that was already loaded, only the window-local options
552from the modeline are used. Thus if you manually changed a buffer-local
553option after opening the file, it won't be changed if you edit the same buffer
554in another window. But window-local options will be set.
555
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556 *modeline-version*
557If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200558number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559 vim{vers}: version {vers} or later
560 vim<{vers}: version before {vers}
561 vim={vers}: version {vers}
562 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100563{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
564For example, to use a modeline only for Vim 7.0:
565 /* vim700: set foldmethod=marker */ ~
566To use a modeline for Vim after version 7.2:
567 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568There can be no blanks between "vim" and the ":".
569
570
571The number of lines that are checked can be set with the 'modelines' option.
572If 'modeline' is off or 'modelines' is 0 no lines are checked.
573
574Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000575like:
576 /* vi:ts=4: */ ~
577will give an error message for the trailing "*/". This line is OK:
578 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579
580If an error is detected the rest of the line is skipped.
581
582If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000583backslash in front of the ':' will be removed. Example:
Bram Moolenaar95a9dd12019-12-19 22:12:03 +0100584 /* vi:set fillchars=stl\:^,vert\:\|: */ ~
585This sets the 'fillchars' option to "stl:^,vert:\|". Only a single backslash
586before the ':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200587 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000589might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200590can be set. For some options a flag is set, so that when the value is used
591the |sandbox| is effective. Some options can only be set from the modeline
592when 'modelineexpr' is set (the default is off).
593
594Still, there is always a small risk that a modeline causes trouble. E.g.,
595when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
596So disable modelines before editing untrusted text. The mail ftplugin does
597this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599Hint: If you would like to do something else than setting an option, you could
600define an autocommand that checks the file for a specific string. For
601example: >
602 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
603And define a function SetVar() that does something with the line containing
604"VAR".
605
606==============================================================================
6073. Options summary *option-summary*
608
609In the list below all the options are mentioned with their full name and with
610an abbreviation if there is one. Both forms may be used.
611
612In this document when a boolean option is "set" that means that ":set option"
613is entered. When an option is "reset", ":set nooption" is used.
614
615For some options there are two default values: The "Vim default", which is
616used when 'compatible' is not set, and the "Vi default", which is used when
617'compatible' is set.
618
619Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000621different value in each window. For example the 'list' option can be set in
622one window and reset in another for the same text, giving both types of view
623at the same time. There are a few options that are specific to a certain
624file. These can have a different value for each file or buffer. For example
625the 'textwidth' option can be 78 for a normal text file and 0 for a C
626program.
627
628 global one option for all buffers and windows
629 local to window each window has its own copy of this option
630 local to buffer each buffer has its own copy of this option
631
632When creating a new window the option values from the currently active window
633are used as a default value for the window-specific options. For the
634buffer-specific options this depends on the 's' and 'S' flags in the
635'cpoptions' option. If 's' is included (which is the default) the values for
636buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000637first entered. If 'S' is present the options are copied each time the buffer
638is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639present, the options are copied from the currently active buffer when the
640buffer is created.
641
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000642Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000644Not all options are supported in all versions. This depends on the supported
645features and sometimes on the system. A remark about this is in curly braces
646below. When an option is not supported it may still be set without getting an
647error, this is called a hidden option. You can't get the value of a hidden
648option though, it is not stored.
649
650To test if option "foo" can be used with ":set" use something like this: >
651 if exists('&foo')
652This also returns true for a hidden option. To test if option "foo" is really
653supported use something like this: >
654 if exists('+foo')
655<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 *E355*
657A jump table for the options with a short description can be found at |Q_op|.
658
659 *'aleph'* *'al'* *aleph* *Aleph*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +0100660'aleph' 'al' number (default 128 for MS-Windows, 224 otherwise)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 {only available when compiled with the |+rightleft|
663 feature}
664 The ASCII code for the first letter of the Hebrew alphabet. The
665 routine that maps the keyboard in Hebrew mode, both in Insert mode
666 (when hkmap is set) and on the command-line (when hitting CTRL-_)
667 outputs the Hebrew characters in the range [aleph..aleph+26].
668 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
669 See |rileft.txt|.
670
671 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
672'allowrevins' 'ari' boolean (default off)
673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 {only available when compiled with the |+rightleft|
675 feature}
676 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
677 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
678 into reverse Insert mode, and don't know how to get out. See
679 'revins'.
680 NOTE: This option is reset when 'compatible' is set.
681
682 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
683'altkeymap' 'akm' boolean (default off)
684 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 {only available when compiled with the |+farsi|
686 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100687 This option was for using Farsi, which has been removed. See
688 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 *'ambiwidth'* *'ambw'*
691'ambiwidth' 'ambw' string (default: "single")
692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
694 Tells Vim what to do with characters with East Asian Width Class
695 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
696 letters, Cyrillic letters).
697
698 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000699 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700 expected by most users.
701 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200702 *E834* *E835*
703 The value "double" cannot be used if 'listchars' or 'fillchars'
704 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705
706 There are a number of CJK fonts for which the width of glyphs for
707 those characters are solely based on how many octets they take in
708 legacy/traditional CJK encodings. In those encodings, Euro,
709 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000710 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000712 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 Vim is running inside a terminal (emulators) that uses a CJK font
714 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
715 this option should be set to "double" to match the width perceived
716 by Vim with the width of glyphs in the font. Perhaps it also has
Bram Moolenaar8024f932020-01-14 19:29:13 +0100717 to be set to "double" under CJK MS-Windows when the system locale is
718 set to one of CJK locales. See Unicode Standard Annex #11
719 (http://www.unicode.org/reports/tr11).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100721 Vim may set this option automatically at startup time when Vim is
722 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200723 escape sequence to request cursor position report. The response can
724 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100725
Bram Moolenaar071d4272004-06-13 20:20:40 +0000726 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
727'antialias' 'anti' boolean (default: off)
728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000729 {only available when compiled with GUI enabled
730 on Mac OS X}
731 This option only has an effect in the GUI version of Vim on Mac OS X
732 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
733 which can be easier to read at certain sizes on certain displays.
734 Setting this option can sometimes cause problems if 'guifont' is set
735 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100736 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737
738 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
739'autochdir' 'acd' boolean (default off)
740 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200741 {only available when compiled with it, use
742 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000743 When on, Vim will change the current working directory whenever you
744 open a file, switch buffers, delete a buffer or open/close a window.
745 It will change to the directory containing the file which was opened
746 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000747 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748
749 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
750'arabic' 'arab' boolean (default off)
751 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 {only available when compiled with the |+arabic|
753 feature}
754 This option can be set to start editing Arabic text.
755 Setting this option will:
756 - Set the 'rightleft' option, unless 'termbidi' is set.
757 - Set the 'arabicshape' option, unless 'termbidi' is set.
758 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
759 between typing English and Arabic key mapping.
760 - Set the 'delcombine' option
761 Note that 'encoding' must be "utf-8" for working with Arabic text.
762
763 Resetting this option will:
764 - Reset the 'rightleft' option.
765 - Disable the use of 'keymap' (without changing its value).
766 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200767 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100768 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 Also see |arabic.txt|.
770
771 *'arabicshape'* *'arshape'*
772 *'noarabicshape'* *'noarshape'*
773'arabicshape' 'arshape' boolean (default on)
774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 {only available when compiled with the |+arabic|
776 feature}
777 When on and 'termbidi' is off, the required visual character
778 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200779 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 one which encompasses:
781 a) the changing/morphing of characters based on their location
782 within a word (initial, medial, final and stand-alone).
783 b) the enabling of the ability to compose characters
784 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100785 When disabled the display shows each character's true stand-alone
786 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 Arabic is a complex language which requires other settings, for
788 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100789 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000790
791 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
792'autoindent' 'ai' boolean (default off)
793 local to buffer
794 Copy indent from current line when starting a new line (typing <CR>
795 in Insert mode or when using the "o" or "O" command). If you do not
796 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000797 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
798 to another line has the same effect, unless the 'I' flag is included
799 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000800 When autoindent is on, formatting (with the "gq" command or when you
801 reach 'textwidth' in Insert mode) uses the indentation of the first
802 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 When 'smartindent' or 'cindent' is on the indent is changed in
804 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200805 The 'autoindent' option is reset when the 'paste' option is set and
806 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807
808 *'autoread'* *'ar'* *'noautoread'* *'noar'*
809'autoread' 'ar' boolean (default off)
810 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 When a file has been detected to have been changed outside of Vim and
812 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200813 When the file has been deleted this is not done, so you have the text
814 from before it was deleted. When it appears again then it is read.
815 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000816 If this option has a local value, use this command to switch back to
817 using the global value: >
818 :set autoread<
819<
820 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
821'autowrite' 'aw' boolean (default off)
822 global
823 Write the contents of the file, if it has been modified, on each
824 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000825 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
827 Note that for some commands the 'autowrite' option is not used, see
828 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200829 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200830 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831
832 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
833'autowriteall' 'awa' boolean (default off)
834 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000835 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
836 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
837 Setting this option also implies that Vim behaves like 'autowrite' has
838 been set.
839
840 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200841'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000843 When set to "dark", Vim will try to use colors that look good on a
844 dark background. When set to "light", Vim will try to use colors that
845 look good on a light background. Any other value is illegal.
846 Vim tries to set the default value according to the terminal used.
847 This will not always be correct.
848 Setting this option does not change the background color, it tells Vim
849 what the background color looks like. For changing the background
850 color, see |:hi-normal|.
851
852 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000853 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000854 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856 setting 'background' will cause the color scheme to be reloaded. If
857 the color scheme adjusts to the value of 'background' this will work.
858 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100859 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860
861 When setting 'background' to the default value with: >
862 :set background&
863< Vim will guess the value. In the GUI this should work correctly,
864 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200865 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200866 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200868 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200869 color from the terminal. If the returned RGB value is dark/light and
870 'background' is not dark/light, 'background' will be set and the
871 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200872 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100873 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200874
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 When starting the GUI, the default value for 'background' will be
876 "light". When the value is not set in the .gvimrc, and Vim detects
877 that the background is actually quite dark, 'background' is set to
878 "dark". But this happens only AFTER the .gvimrc file has been read
879 (because the window needs to be opened to find the actual background
880 color). To get around this, force the GUI window to be opened by
881 putting a ":gui" command in the .gvimrc file, before where the value
882 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200883
Bram Moolenaar6f345a12019-12-17 21:27:18 +0100884 For MS-Windows the default is "dark".
Bram Moolenaar446beb42011-05-10 17:18:44 +0200885 For other systems "dark" is used when 'term' is "linux",
886 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
887 background. Otherwise the default is "light".
888
Bram Moolenaarc572da52017-08-27 16:52:01 +0200889 The |:terminal| command and the |term_start()| function use the
890 'background' value to decide whether the terminal window will start
891 with a white or black background.
892
Bram Moolenaar071d4272004-06-13 20:20:40 +0000893 Normally this option would be set in the .vimrc file. Possibly
894 depending on the terminal name. Example: >
895 :if &term == "pcterm"
896 : set background=dark
897 :endif
898< When this option is set, the default settings for the highlight groups
899 will change. To use other settings, place ":highlight" commands AFTER
900 the setting of the 'background' option.
901 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
902 to select the colors for syntax highlighting. After changing this
903 option, you must load syntax.vim again to see the result. This can be
904 done with ":syntax on".
905
906 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200907'backspace' 'bs' string (default "", set to "indent,eol,start"
908 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000910 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
911 mode. This is a list of items, separated by commas. Each item allows
912 a way to backspace over something:
913 value effect ~
914 indent allow backspacing over autoindent
915 eol allow backspacing over line breaks (join lines)
916 start allow backspacing over the start of insert; CTRL-W and CTRL-U
917 stop once at the start of insert.
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200918 nostop like start, except CTRL-W and CTRL-U do not stop at the start of
919 insert.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920
921 When the value is empty, Vi compatible backspacing is used.
922
923 For backwards compatibility with version 5.4 and earlier:
924 value effect ~
925 0 same as ":set backspace=" (Vi compatible)
926 1 same as ":set backspace=indent,eol"
927 2 same as ":set backspace=indent,eol,start"
Bram Moolenaaraa0489e2020-04-17 19:41:21 +0200928 3 same as ":set backspace=indent,eol,nostop"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929
930 See |:fixdel| if your <BS> or <Del> key does not do what you want.
931 NOTE: This option is set to "" when 'compatible' is set.
932
933 *'backup'* *'bk'* *'nobackup'* *'nobk'*
934'backup' 'bk' boolean (default off)
935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 Make a backup before overwriting a file. Leave it around after the
937 file has been successfully written. If you do not want to keep the
938 backup file, but you do want a backup while the file is being
939 written, reset this option and set the 'writebackup' option (this is
940 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 |backup-table| for more explanations.
943 When the 'backupskip' pattern matches, a backup is not made anyway.
944 When 'patchmode' is set, the backup may be renamed to become the
945 oldest version of a file.
946 NOTE: This option is reset when 'compatible' is set.
947
948 *'backupcopy'* *'bkc'*
949'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200950 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 When writing a file and a backup is made, this option tells how it's
952 done. This is a comma separated list of words.
953
954 The main values are:
955 "yes" make a copy of the file and overwrite the original one
956 "no" rename the file and write a new one
957 "auto" one of the previous, what works best
958
959 Extra values that can be combined with the ones above are:
960 "breaksymlink" always break symlinks when writing
961 "breakhardlink" always break hardlinks when writing
962
963 Making a copy and overwriting the original file:
964 - Takes extra time to copy the file.
965 + When the file has special attributes, is a (hard/symbolic) link or
966 has a resource fork, all this is preserved.
967 - When the file is a link the backup will have the name of the link,
968 not of the real file.
969
970 Renaming the file and writing a new one:
971 + It's fast.
972 - Sometimes not all attributes of the file can be copied to the new
973 file.
974 - When the file is a link the new file will not be a link.
975
976 The "auto" value is the middle way: When Vim sees that renaming file
977 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000978 the file is not a link) that is used. When problems are expected, a
979 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000980
981 The "breaksymlink" and "breakhardlink" values can be used in
982 combination with any of "yes", "no" and "auto". When included, they
983 force Vim to always break either symbolic or hard links by doing
984 exactly what the "no" option does, renaming the original file to
985 become the backup and writing a new file in its place. This can be
986 useful for example in source trees where all the files are symbolic or
987 hard links and any changes should stay in the local source tree, not
988 be propagated back to the original source.
989 *crontab*
990 One situation where "no" and "auto" will cause problems: A program
991 that opens a file, invokes Vim to edit that file, and then tests if
992 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000993 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 example.
995
996 When a copy is made, the original file is truncated and then filled
997 with the new text. This means that protection bits, owner and
998 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000999 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 group of the backup is set to the group of the original file. If this
1001 fails, the protection bits for the group are made the same as for
1002 others.
1003
1004 When the file is renamed this is the other way around: The backup has
1005 the same attributes of the original file, and the newly written file
1006 is owned by the current user. When the file was a (hard/symbolic)
1007 link, the new file will not! That's why the "auto" value doesn't
1008 rename when the file is a link. The owner and group of the newly
1009 written file will be set to the same ones as the original file, but
1010 the system may refuse to do this. In that case the "auto" value will
1011 again not rename the file.
1012
Bram Moolenaar036986f2017-03-16 17:41:02 +01001013 NOTE: This option is set to the Vi default value when 'compatible' is
1014 set and to the Vim default value when 'compatible' is reset.
1015
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 *'backupdir'* *'bdir'*
1017'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01001018 for Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 for Unix: ".,~/tmp,~/")
1020 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 List of directories for the backup file, separated with commas.
1022 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001023 where this is possible. The directory must exist, Vim will not
1024 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001025 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 impossible!). Writing may fail because of this.
1027 - A directory "." means to put the backup file in the same directory
1028 as the edited file.
Bram Moolenaar8024f932020-01-14 19:29:13 +01001029 - A directory starting with "./" (or ".\" for MS-Windows) means to put
1030 the backup file relative to where the edited file is. The leading
1031 "." is replaced with the path name of the edited file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 ("." inside a directory name has no special meaning).
1033 - Spaces after the comma are ignored, other spaces are considered part
1034 of the directory name. To have a space at the start of a directory
1035 name, precede it with a backslash.
1036 - To include a comma in a directory name precede it with a backslash.
1037 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001038 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001039 the backup file name will be built from the complete path to the
1040 file with all path separators changed to percent '%' signs. This
1041 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001042 On Win32, it is also possible to end with "\\". However, When a
1043 separating comma is following, you must use "//", since "\\" will
1044 include the comma in the file name. Therefore it is recommended to
1045 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 - Environment variables are expanded |:set_env|.
1047 - Careful with '\' characters, type one before a space, type two to
1048 get one in the option (see |option-backslash|), for example: >
1049 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1050< - For backwards compatibility with Vim version 3.0 a '>' at the start
1051 of the option is removed.
1052 See also 'backup' and 'writebackup' options.
1053 If you want to hide your backup files on Unix, consider this value: >
1054 :set backupdir=./.backup,~/.backup,.,/tmp
1055< You must create a ".backup" directory in each directory and in your
1056 home directory for this to work properly.
1057 The use of |:set+=| and |:set-=| is preferred when adding or removing
1058 directories from the list. This avoids problems when a future version
1059 uses another default.
1060 This option cannot be set from a |modeline| or in the |sandbox|, for
1061 security reasons.
1062
1063 *'backupext'* *'bex'* *E589*
1064'backupext' 'bex' string (default "~", for VMS: "_")
1065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 String which is appended to a file name to make the name of the
1067 backup file. The default is quite unusual, because this avoids
1068 accidentally overwriting existing files with a backup file. You might
1069 prefer using ".bak", but make sure that you don't have files with
1070 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001071 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001073 If you like to keep a lot of backups, you could use a BufWritePre
1074 autocommand to change 'backupext' just before writing the file to
1075 include a timestamp. >
1076 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1077< Use 'backupdir' to put the backup in a different directory.
1078
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001080'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1081 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1082 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001084 {not available when compiled without the |+wildignore|
1085 feature}
1086 A list of file patterns. When one of the patterns matches with the
1087 name of the file which is written, no backup file is created. Both
1088 the specified file name and the full path name of the file are used.
1089 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1090 Watch out for special characters, see |option-backslash|.
1091 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001092 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001093
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001094 WARNING: Not having a backup file means that when Vim fails to write
1095 your buffer correctly and then, for whatever reason, Vim exits, you
1096 lose both the original file and what you were writing. Only disable
1097 backups if you don't care about losing the file.
1098
Bram Moolenaar02467872007-05-06 13:22:01 +00001099 Note that environment variables are not expanded. If you want to use
1100 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001101 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001102
1103< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001104 backup would be made by renaming the original file crontab won't see
1105 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106
1107 *'balloondelay'* *'bdlay'*
1108'balloondelay' 'bdlay' number (default: 600)
1109 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001110 {only available when compiled with the |+balloon_eval|
1111 feature}
1112 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1113
1114 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1115'ballooneval' 'beval' boolean (default off)
1116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001119 Switch on the |balloon-eval| functionality for the GUI.
1120
1121 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1122 *'nobevalterm'*
1123'balloonevalterm' 'bevalterm' boolean (default off)
1124 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001125 {only available when compiled with the
1126 |+balloon_eval_term| feature}
1127 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 *'balloonexpr'* *'bexpr'*
1130'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001131 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 {only available when compiled with the |+balloon_eval|
1133 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001134 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001135 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1136 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001137
1138 v:beval_bufnr number of the buffer in which balloon is going to show
1139 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001140 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 v:beval_lnum line number
1142 v:beval_col column number (byte index)
1143 v:beval_text word under or after the mouse pointer
1144
Bram Moolenaar54775062019-07-31 21:07:14 +02001145 Instead of showing a balloon, which is limited to plain text, consider
1146 using a popup window, see |popup_beval_example|. A popup window can
1147 use highlighting and show a border.
1148
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149 The evaluation of the expression must not have side effects!
1150 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001151 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001152 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 \', column ' . v:beval_col .
1154 \ ' of file ' . bufname(v:beval_bufnr) .
1155 \ ' on word "' . v:beval_text . '"'
1156 endfunction
1157 set bexpr=MyBalloonExpr()
1158 set ballooneval
1159<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001160 Also see |balloon_show()|, it can be used if the content of the balloon
1161 is to be fetched asynchronously. In that case evaluating
1162 'balloonexpr' should result in an empty string. If you get a balloon
1163 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001164
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001165 NOTE: The balloon is displayed only if the cursor is on a text
1166 character. If the result of evaluating 'balloonexpr' is not empty,
1167 Vim does not try to send a message to an external debugger (Netbeans
1168 or Sun Workshop).
1169
Bram Moolenaar30b65812012-07-12 22:01:11 +02001170 The expression will be evaluated in the |sandbox| when set from a
1171 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001172 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001173
1174 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001175 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001176
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001177 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001178 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001179< When they are supported "\n" characters will start a new line. If the
1180 expression evaluates to a |List| this is equal to using each List item
1181 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001182 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001183
Bram Moolenaar165bc692015-07-21 17:53:25 +02001184 *'belloff'* *'bo'*
1185'belloff' 'bo' string (default "")
1186 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001187 Specifies for which events the bell will not be rung. It is a comma
1188 separated list of items. For each item that is present, the bell
1189 will be silenced. This is most useful to specify specific events in
1190 insert mode to be silenced.
1191
1192 item meaning when present ~
1193 all All events.
1194 backspace When hitting <BS> or <Del> and deleting results in an
1195 error.
1196 cursor Fail to move around using the cursor keys or
1197 <PageUp>/<PageDown> in |Insert-mode|.
1198 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1199 |i_CTRL-X_CTRL-T|.
1200 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1201 |i_CTRL-E|.
1202 ctrlg Unknown Char after <C-G> in Insert mode.
1203 error Other Error occurred (e.g. try to join last line)
1204 (mostly used in |Normal-mode| or |Cmdline-mode|).
1205 esc hitting <Esc> in |Normal-mode|.
1206 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001207 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001208 insertmode Pressing <Esc> in 'insertmode'.
1209 lang Calling the beep module for Lua/Mzscheme/TCL.
1210 mess No output available for |g<|.
1211 showmatch Error occurred for 'showmatch' function.
1212 operator Empty region error |cpo-E|.
1213 register Unknown register after <C-R> in |Insert-mode|.
1214 shell Bell from shell output |:!|.
1215 spell Error happened on spell suggest.
1216 wildmode More matches in |cmdline-completion| available
1217 (depends on the 'wildmode' setting).
1218
Bram Moolenaar036986f2017-03-16 17:41:02 +01001219 This is most useful to fine tune when in Insert mode the bell should
1220 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001221 indicate that an error occurred. It can be silenced by adding the
1222 "error" keyword.
1223
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1225'binary' 'bin' boolean (default off)
1226 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227 This option should be set before editing a binary file. You can also
1228 use the |-b| Vim argument. When this option is switched on a few
1229 options will be changed (also when it already was on):
1230 'textwidth' will be set to 0
1231 'wrapmargin' will be set to 0
1232 'modeline' will be off
1233 'expandtab' will be off
1234 Also, 'fileformat' and 'fileformats' options will not be used, the
1235 file is read and written like 'fileformat' was "unix" (a single <NL>
1236 separates lines).
1237 The 'fileencoding' and 'fileencodings' options will not be used, the
1238 file is read without conversion.
1239 NOTE: When you start editing a(nother) file while the 'bin' option is
1240 on, settings from autocommands may change the settings again (e.g.,
1241 'textwidth'), causing trouble when editing. You might want to set
1242 'bin' again when the file has been loaded.
1243 The previous values of these options are remembered and restored when
1244 'bin' is switched from on to off. Each buffer has its own set of
1245 saved option values.
1246 To edit a file with 'binary' set you can use the |++bin| argument.
1247 This avoids you have to do ":set bin", which would have effect for all
1248 files you edit.
1249 When writing a file the <EOL> for the last line is only written if
1250 there was one in the original file (normally Vim appends an <EOL> to
1251 the last line if there is none; this would make the file longer). See
1252 the 'endofline' option.
1253
1254 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1255'bioskey' 'biosk' boolean (default on)
1256 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001257 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001258 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259
1260 *'bomb'* *'nobomb'*
1261'bomb' boolean (default off)
1262 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 When writing a file and the following conditions are met, a BOM (Byte
1264 Order Mark) is prepended to the file:
1265 - this option is on
1266 - the 'binary' option is off
1267 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1268 endian variants.
1269 Some applications use the BOM to recognize the encoding of the file.
1270 Often used for UCS-2 files on MS-Windows. For other applications it
1271 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001272 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1274 check for the presence of the BOM is done and 'bomb' set accordingly.
1275 Unless 'binary' is set, it is removed from the first line, so that you
1276 don't see it when editing. When you don't change the options, the BOM
1277 will be restored when writing the file.
1278
1279 *'breakat'* *'brk'*
1280'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1281 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001282 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 feature}
1284 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001285 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1286 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001288 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001289'breakindent' 'bri' boolean (default off)
1290 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001291 {not available when compiled without the |+linebreak|
1292 feature}
1293 Every wrapped line will continue visually indented (same amount of
1294 space as the beginning of that line), thus preserving horizontal blocks
1295 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001296 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297
1298 *'breakindentopt'* *'briopt'*
1299'breakindentopt' 'briopt' string (default empty)
1300 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001301 {not available when compiled without the |+linebreak|
1302 feature}
1303 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001304 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 min:{n} Minimum text width that will be kept after
1306 applying 'breakindent', even if the resulting
1307 text should normally be narrower. This prevents
1308 text indented almost to the right window border
1309 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001310 shift:{n} After applying 'breakindent', the wrapped line's
1311 beginning will be shifted by the given number of
1312 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001313 indentation (negative) or emphasizing the line
1314 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001315 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001316 additional indent.
1317 The default value for min is 20 and shift is 0.
1318
Bram Moolenaar071d4272004-06-13 20:20:40 +00001319 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001320'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001322 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001324 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001325 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 buffer Use the directory of the related buffer.
1327 current Use the current directory.
1328 {path} Use the specified directory
1329
1330 *'bufhidden'* *'bh'*
1331'bufhidden' 'bh' string (default: "")
1332 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 This option specifies what happens when a buffer is no longer
1334 displayed in a window:
1335 <empty> follow the global 'hidden' option
1336 hide hide the buffer (don't unload it), also when 'hidden'
1337 is not set
1338 unload unload the buffer, also when 'hidden' is set or using
1339 |:hide|
1340 delete delete the buffer from the buffer list, also when
1341 'hidden' is set or using |:hide|, like using
1342 |:bdelete|
1343 wipe wipe out the buffer from the buffer list, also when
1344 'hidden' is set or using |:hide|, like using
1345 |:bwipeout|
1346
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001347 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001348 are lost without a warning. Also, these values may break autocommands
1349 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 This option is used together with 'buftype' and 'swapfile' to specify
1351 special kinds of buffers. See |special-buffers|.
1352
1353 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1354'buflisted' 'bl' boolean (default: on)
1355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 When this option is set, the buffer shows up in the buffer list. If
1357 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1358 This option is reset by Vim for buffers that are only used to remember
1359 a file name or marks. Vim sets it when starting to edit a buffer.
1360 But not when moving to a buffer with ":buffer".
1361
1362 *'buftype'* *'bt'* *E382*
1363'buftype' 'bt' string (default: "")
1364 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 The value of this option specifies the type of a buffer:
1366 <empty> normal buffer
1367 nofile buffer which is not related to a file and will not be
1368 written
1369 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001370 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001371 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001373 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374 help help buffer (you are not supposed to set this
1375 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001376 terminal buffer for a |terminal| (you are not supposed to set
1377 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001378 prompt buffer where only the last line can be edited, meant
1379 to be used by a plugin, see |prompt-buffer|
1380 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001381 popup buffer used in a popup window, see |popup|.
1382 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383
1384 This option is used together with 'bufhidden' and 'swapfile' to
1385 specify special kinds of buffers. See |special-buffers|.
Bram Moolenaarebdf3c92020-02-15 21:41:42 +01001386 Also see |win_gettype()|, which returns the type of the window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387
1388 Be careful with changing this option, it can have many side effects!
1389
Bram Moolenaar280f1262006-01-30 00:14:18 +00001390 A "quickfix" buffer is only used for the error list and the location
1391 list. This value is set by the |:cwindow| and |:lwindow| commands and
1392 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393
1394 "nofile" and "nowrite" buffers are similar:
1395 both: The buffer is not to be written to disk, ":w" doesn't
1396 work (":w filename" does work though).
1397 both: The buffer is never considered to be |'modified'|.
1398 There is no warning when the changes will be lost, for
1399 example when you quit Vim.
1400 both: A swap file is only created when using too much memory
1401 (when 'swapfile' has been reset there is never a swap
1402 file).
1403 nofile only: The buffer name is fixed, it is not handled like a
1404 file name. It is not modified in response to a |:cd|
1405 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001406 both: When using ":e bufname" and already editing "bufname"
1407 the buffer is made empty and autocommands are
1408 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001409 *E676*
1410 "acwrite" implies that the buffer name is not related to a file, like
1411 "nofile", but it will be written. Thus, in contrast to "nofile" and
1412 "nowrite", ":w" does work and a modified buffer can't be abandoned
1413 without saving. For writing there must be matching |BufWriteCmd|,
1414 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
1416 *'casemap'* *'cmp'*
1417'casemap' 'cmp' string (default: "internal,keepascii")
1418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001419 Specifies details about changing the case of letters. It may contain
1420 these words, separated by a comma:
1421 internal Use internal case mapping functions, the current
1422 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001423 matters when 'encoding' is a Unicode encoding,
1424 "latin1" or "iso-8859-15". When "internal" is
1425 omitted, the towupper() and towlower() system library
1426 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1428 case mapping, the current locale is not effective.
1429 This probably only matters for Turkish.
1430
1431 *'cdpath'* *'cd'* *E344* *E346*
1432'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1433 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 {not available when compiled without the
1435 |+file_in_path| feature}
1436 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001437 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1438 searched for has a relative path, not an absolute part starting with
1439 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 The 'cdpath' option's value has the same form and semantics as
1441 |'path'|. Also see |file-searching|.
1442 The default value is taken from $CDPATH, with a "," prepended to look
1443 in the current directory first.
1444 If the default value taken from $CDPATH is not what you want, include
1445 a modified version of the following command in your vimrc file to
1446 override it: >
1447 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1448< This option cannot be set from a |modeline| or in the |sandbox|, for
1449 security reasons.
1450 (parts of 'cdpath' can be passed to the shell to expand file names).
1451
1452 *'cedit'*
1453'cedit' string (Vi default: "", Vim default: CTRL-F)
1454 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 The key used in Command-line Mode to open the command-line window.
1456 The default is CTRL-F when 'compatible' is off.
1457 Only non-printable keys are allowed.
1458 The key can be specified as a single character, but it is difficult to
1459 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001460 :exe "set cedit=\<C-Y>"
1461 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462< |Nvi| also has this option, but it only uses the first character.
1463 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001464 NOTE: This option is set to the Vim default value when 'compatible'
1465 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466
1467 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1468'charconvert' 'ccv' string (default "")
1469 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001470 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 An expression that is used for character encoding conversion. It is
1472 evaluated when a file that is to be read or has been written has a
1473 different encoding from what is desired.
1474 'charconvert' is not used when the internal iconv() function is
1475 supported and is able to do the conversion. Using iconv() is
1476 preferred, because it is much faster.
1477 'charconvert' is not used when reading stdin |--|, because there is no
1478 file to convert from. You will have to save the text in a file first.
1479 The expression must return zero or an empty string for success,
1480 non-zero for failure.
1481 The possible encoding names encountered are in 'encoding'.
1482 Additionally, names given in 'fileencodings' and 'fileencoding' are
1483 used.
1484 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1485 is done internally by Vim, 'charconvert' is not used for this.
1486 'charconvert' is also used to convert the viminfo file, if the 'c'
1487 flag is present in 'viminfo'. Also used for Unicode conversion.
1488 Example: >
1489 set charconvert=CharConvert()
1490 fun CharConvert()
1491 system("recode "
1492 \ . v:charconvert_from . ".." . v:charconvert_to
1493 \ . " <" . v:fname_in . " >" v:fname_out)
1494 return v:shell_error
1495 endfun
1496< The related Vim variables are:
1497 v:charconvert_from name of the current encoding
1498 v:charconvert_to name of the desired encoding
1499 v:fname_in name of the input file
1500 v:fname_out name of the output file
1501 Note that v:fname_in and v:fname_out will never be the same.
1502 Note that v:charconvert_from and v:charconvert_to may be different
1503 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1504 Encryption is not done by Vim when using 'charconvert'. If you want
1505 to encrypt the file after conversion, 'charconvert' should take care
1506 of this.
1507 This option cannot be set from a |modeline| or in the |sandbox|, for
1508 security reasons.
1509
1510 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1511'cindent' 'cin' boolean (default off)
1512 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 {not available when compiled without the |+cindent|
1514 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001515 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 that trigger reindenting in insert mode and 'cinoptions' to set your
1517 preferred indent style.
1518 If 'indentexpr' is not empty, it overrules 'cindent'.
1519 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1520 the "=" operator indents using this algorithm rather than calling an
1521 external program.
1522 See |C-indenting|.
1523 When you don't like the way 'cindent' works, try the 'smartindent'
1524 option or 'indentexpr'.
1525 This option is not used when 'paste' is set.
1526 NOTE: This option is reset when 'compatible' is set.
1527
1528 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001529'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531 {not available when compiled without the |+cindent|
1532 feature}
1533 A list of keys that, when typed in Insert mode, cause reindenting of
1534 the current line. Only used if 'cindent' is on and 'indentexpr' is
1535 empty.
1536 For the format of this option see |cinkeys-format|.
1537 See |C-indenting|.
1538
1539 *'cinoptions'* *'cino'*
1540'cinoptions' 'cino' string (default "")
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 {not available when compiled without the |+cindent|
1543 feature}
1544 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1545 program. See |cinoptions-values| for the values of this option, and
1546 |C-indenting| for info on C indenting in general.
1547
1548
1549 *'cinwords'* *'cinw'*
1550'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1551 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 {not available when compiled without both the
1553 |+cindent| and the |+smartindent| features}
1554 These keywords start an extra indent in the next line when
1555 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1556 an appropriate place (inside {}).
1557 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1558 matter, include the keyword both the uppercase and lowercase:
1559 "if,If,IF".
1560
1561 *'clipboard'* *'cb'*
1562'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1563 for X-windows, "" otherwise)
1564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 {only in GUI versions or when the |+xterm_clipboard|
1566 feature is included}
1567 This option is a list of comma separated names.
1568 These names are recognized:
1569
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001570 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 unnamed When included, Vim will use the clipboard register '*'
1572 for all yank, delete, change and put operations which
1573 would normally go to the unnamed register. When a
1574 register is explicitly specified, it will always be
1575 used regardless of whether "unnamed" is in 'clipboard'
1576 or not. The clipboard register can always be
1577 explicitly accessed using the "* notation. Also see
1578 |gui-clipboard|.
1579
Bram Moolenaar30b65812012-07-12 22:01:11 +02001580 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001581 unnamedplus A variant of the "unnamed" flag which uses the
1582 clipboard register '+' (|quoteplus|) instead of
1583 register '*' for all yank, delete, change and put
1584 operations which would normally go to the unnamed
1585 register. When "unnamed" is also included to the
1586 option, yank operations (but not delete, change or
1587 put) will additionally copy the text into register
1588 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001589 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001590 Availability can be checked with: >
1591 if has('unnamedplus')
1592<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001593 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 autoselect Works like the 'a' flag in 'guioptions': If present,
1595 then whenever Visual mode is started, or the Visual
1596 area extended, Vim tries to become the owner of the
1597 windowing system's global selection or put the
1598 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001599 register "*. See |'go-a'| and |quotestar| for details.
1600 When the GUI is active, the 'a' flag in 'guioptions'
1601 is used, when the GUI is not active, this "autoselect"
1602 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 Also applies to the modeless selection.
1604
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001605 *clipboard-autoselectplus*
1606 autoselectplus Like "autoselect" but using the + register instead of
1607 the * register. Compare to the 'P' flag in
1608 'guioptions'.
1609
1610 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 autoselectml Like "autoselect", but for the modeless selection
1612 only. Compare to the 'A' flag in 'guioptions'.
1613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001615 html When the clipboard contains HTML, use this when
1616 pasting. When putting text on the clipboard, mark it
1617 as HTML. This works to copy rendered HTML from
1618 Firefox, paste it as raw HTML in Vim, select the HTML
1619 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001620 You probably want to add this only temporarily,
1621 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001622 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001623
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001624 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 exclude:{pattern}
1626 Defines a pattern that is matched against the name of
1627 the terminal 'term'. If there is a match, no
1628 connection will be made to the X server. This is
1629 useful in this situation:
1630 - Running Vim in a console.
1631 - $DISPLAY is set to start applications on another
1632 display.
1633 - You do not want to connect to the X server in the
1634 console, but do want this in a terminal emulator.
1635 To never connect to the X server use: >
1636 exclude:.*
1637< This has the same effect as using the |-X| argument.
1638 Note that when there is no connection to the X server
1639 the window title won't be restored and the clipboard
1640 cannot be accessed.
1641 The value of 'magic' is ignored, {pattern} is
1642 interpreted as if 'magic' was on.
1643 The rest of the option value will be used for
1644 {pattern}, this must be the last entry.
1645
1646 *'cmdheight'* *'ch'*
1647'cmdheight' 'ch' number (default 1)
1648 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 Number of screen lines to use for the command-line. Helps avoiding
1650 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001651 The value of this option is stored with the tab page, so that each tab
1652 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653
1654 *'cmdwinheight'* *'cwh'*
1655'cmdwinheight' 'cwh' number (default 7)
1656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 Number of screen lines to use for the command-line window. |cmdwin|
1658
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001659 *'colorcolumn'* *'cc'*
1660'colorcolumn' 'cc' string (default "")
1661 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001662 {not available when compiled without the |+syntax|
1663 feature}
1664 'colorcolumn' is a comma separated list of screen columns that are
1665 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1666 text. Will make screen redrawing slower.
1667 The screen column can be an absolute number, or a number preceded with
1668 '+' or '-', which is added to or subtracted from 'textwidth'. >
1669
1670 :set cc=+1 " highlight column after 'textwidth'
1671 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1672 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1673<
1674 When 'textwidth' is zero then the items with '-' and '+' are not used.
1675 A maximum of 256 columns are highlighted.
1676
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 *'columns'* *'co'* *E594*
1678'columns' 'co' number (default 80 or terminal width)
1679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001681 initialization and does not have to be set by hand. Also see
1682 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683 When Vim is running in the GUI or in a resizable window, setting this
1684 option will cause the window size to be changed. When you only want
1685 to use the size for the GUI, put the command in your |gvimrc| file.
1686 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001687 number of columns of the display, the display may be messed up. For
1688 the GUI it is always possible and Vim limits the number of columns to
1689 what fits on the screen. You can use this command to get the widest
1690 window possible: >
1691 :set columns=9999
1692< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
1694 *'comments'* *'com'* *E524* *E525*
1695'comments' 'com' string (default
1696 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1697 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 A comma separated list of strings that can start a comment line. See
1699 |format-comments|. See |option-backslash| about using backslashes to
1700 insert a space.
1701
1702 *'commentstring'* *'cms'* *E537*
1703'commentstring' 'cms' string (default "/*%s*/")
1704 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 {not available when compiled without the |+folding|
1706 feature}
1707 A template for a comment. The "%s" in the value is replaced with the
1708 comment text. Currently only used to add markers for folding, see
1709 |fold-marker|.
1710
1711 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001712'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001713 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 This option has the effect of making Vim either more Vi-compatible, or
1716 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001717
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001719 other options are also changed as a side effect.
1720 NOTE: Setting or resetting this option can have a lot of unexpected
1721 effects: Mappings are interpreted in another way, undo behaves
1722 differently, etc. If you set this option in your vimrc file, you
1723 should probably put it at the very start.
1724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 By default this option is on and the Vi defaults are used for the
1726 options. This default was chosen for those people who want to use Vim
1727 just like Vi, and don't even (want to) know about the 'compatible'
1728 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001729 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001730 this option is switched off, and all options that have not been
1731 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001732 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001733 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001734 happen for the system-wide vimrc or gvimrc file, nor for a file given
1735 with the |-u| argument). Also see |compatible-default| and
1736 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 You can also set this option with the "-C" argument, and reset it with
1738 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001739 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740
Bram Moolenaar214641f2017-03-05 17:04:09 +01001741 When this option is set, numerous other options are set to make Vim as
1742 Vi-compatible as possible. When this option is unset, various options
1743 are set to make Vim more useful. The table below lists all the
1744 options affected.
1745 The {?} column indicates when the options are affected:
1746 + Means that the option is set to the value given in {set value} when
1747 'compatible' is set.
1748 & Means that the option is set to the value given in {set value} when
1749 'compatible' is set AND is set to its Vim default value when
1750 'compatible' is unset.
1751 - Means the option is NOT changed when setting 'compatible' but IS
1752 set to its Vim default when 'compatible' is unset.
1753 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754
Bram Moolenaar036986f2017-03-16 17:41:02 +01001755 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001756
1757 'allowrevins' + off no CTRL-_ command
1758 'antialias' + off don't use antialiased fonts
1759 'arabic' + off reset arabic-related options
1760 'arabicshape' + on correct character shapes
1761 'backspace' + "" normal backspace
1762 'backup' + off no backup file
1763 'backupcopy' & Unix: "yes" backup file is a copy
1764 else: "auto" copy or rename backup file
1765 'balloonexpr' + "" text to show in evaluation balloon
1766 'breakindent' + off don't indent when wrapping lines
1767 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1768 'cindent' + off no C code indentation
1769 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1770 'copyindent' + off don't copy indent structure
1771 'cpoptions' & (all flags) Vi-compatible flags
1772 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001773 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001774 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001775 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001776 'cscopeverbose' + off see |cscopeverbose|
1777 'delcombine' + off unicode: delete whole char combination
1778 'digraph' + off no digraphs
1779 'esckeys' & off no <Esc>-keys in Insert mode
1780 'expandtab' + off tabs not expanded to spaces
1781 'fileformats' & "" no automatic file format detection,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001782 "dos,unix" except for MS-Windows
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 'formatexpr' + "" use 'formatprg' for auto-formatting
1784 'formatoptions' & "vt" Vi compatible formatting
1785 'gdefault' + off no default 'g' flag for ":s"
1786 'history' & 0 no commandline history
1787 'hkmap' + off no Hebrew keyboard mapping
1788 'hkmapp' + off no phonetic Hebrew keyboard mapping
1789 'hlsearch' + off no highlighting of search matches
1790 'incsearch' + off no incremental searching
1791 'indentexpr' + "" no indenting by expression
1792 'insertmode' + off do not start in Insert mode
1793 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001795 'joinspaces' + on insert 2 spaces after period
1796 'modeline' & off no modelines
1797 'more' & off no pauses in listings
1798 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1799 'numberwidth' & 8 min number of columns for line number
1800 'preserveindent'+ off don't preserve current indent structure
1801 when changing it
1802 'revins' + off no reverse insert
1803 'ruler' + off no ruler
1804 'scrolljump' + 1 no jump scroll
1805 'scrolloff' + 0 no scroll offset
1806 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1807 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001808 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001809 'showcmd' & off command characters not shown
1810 'showmode' & off current mode not shown
1811 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1812 'smartcase' + off no automatic ignore case switch
1813 'smartindent' + off no smart indentation
1814 'smarttab' + off no smart tab size
1815 'softtabstop' + 0 tabs are always 'tabstop' positions
1816 'startofline' + on goto startofline with some commands
1817 'tagcase' & "followic" 'ignorecase' when searching tags file
1818 'tagrelative' & off tag file names are not relative
1819 'termguicolors' + off don't use highlight-(guifg|guibg)
1820 'textauto' & off no automatic textmode detection
1821 'textwidth' + 0 no automatic line wrap
1822 'tildeop' + off tilde is not an operator
1823 'ttimeout' + off no terminal timeout
1824 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001825 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001826 'virtualedit' + "" cursor can only be placed on characters
1827 'whichwrap' & "" left-right movements don't wrap
1828 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001830 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831
1832 *'complete'* *'cpt'* *E535*
1833'complete' 'cpt' string (default: ".,w,b,u,t,i")
1834 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 This option specifies how keyword completion |ins-completion| works
1836 when CTRL-P or CTRL-N are used. It is also used for whole-line
1837 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1838 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001839 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 w scan buffers from other windows
1841 b scan other loaded buffers that are in the buffer list
1842 u scan the unloaded buffers that are in the buffer list
1843 U scan the buffers that are not in the buffer list
1844 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001845 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 k{dict} scan the file {dict}. Several "k" flags can be given,
1847 patterns are valid too. For example: >
1848 :set cpt=k/usr/dict/*,k~/spanish
1849< s scan the files given with the 'thesaurus' option
1850 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1851 are valid too.
1852 i scan current and included files
1853 d scan current and included files for defined name or macro
1854 |i_CTRL-X_CTRL-D|
1855 ] tag completion
1856 t same as "]"
1857
1858 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1859 not executed, this may lead to unexpected completions from some files
1860 (gzipped files for example). Unloaded buffers are not scanned for
1861 whole-line completion.
1862
1863 The default is ".,w,b,u,t,i", which means to scan:
1864 1. the current buffer
1865 2. buffers in other windows
1866 3. other loaded buffers
1867 4. unloaded buffers
1868 5. tags
1869 6. included files
1870
1871 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001872 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1873 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001875 *'completefunc'* *'cfu'*
1876'completefunc' 'cfu' string (default: empty)
1877 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001878 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001879 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001880 This option specifies a function to be used for Insert mode completion
1881 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001882 See |complete-functions| for an explanation of how the function is
1883 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001884 This option cannot be set from a |modeline| or in the |sandbox|, for
1885 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001886
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001887 *'completeslash'* *'csl'*
1888'completeslash' 'csl' string (default: "")
1889 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001890 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001891 When this option is set it overrules 'shellslash' for completion:
1892 - When this option is set to "slash", a forward slash is used for path
1893 completion in insert mode. This is useful when editing HTML tag, or
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001894 Makefile with 'noshellslash' on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001895 - When this option is set to "backslash", backslash is used. This is
Bram Moolenaar6f345a12019-12-17 21:27:18 +01001896 useful when editing a batch file with 'shellslash' set on MS-Windows.
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001897 - When this option is empty, same character is used as for
1898 'shellslash'.
1899 For Insert mode completion the buffer-local value is used. For
1900 command line completion the global value is used.
1901
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001902 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001903'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001904 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001905 A comma separated list of options for Insert mode completion
1906 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001907
1908 menu Use a popup menu to show the possible completions. The
1909 menu is only shown when there is more than one match and
1910 sufficient colors are available. |ins-completion-menu|
1911
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001912 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001913 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001914 match, e.g., what file it comes from.
1915
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001916 longest Only insert the longest common text of the matches. If
1917 the menu is displayed you can use CTRL-L to add more
1918 characters. Whether case is ignored depends on the kind
1919 of completion. For buffer text the 'ignorecase' option is
1920 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001921
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001922 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001923 completion in the preview window. Only works in
1924 combination with "menu" or "menuone".
1925
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001926 popup Show extra information about the currently selected
1927 completion in a popup window. Only works in combination
1928 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001929 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001930 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001931
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001932 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001933 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001934 |CompleteChanged| autocommand to fetch the info and call
1935 |popup_show()| once the popup has been filled.
1936 See the example at |complete-popuphidden|.
1937 {only works when compiled with the |+textprop| feature}
1938
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001939 noinsert Do not insert any text for a match until the user selects
1940 a match from the menu. Only works in combination with
1941 "menu" or "menuone". No effect if "longest" is present.
1942
1943 noselect Do not select a match in the menu, force the user to
1944 select one from the menu. Only works in combination with
1945 "menu" or "menuone".
1946
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001947
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001948 *'completepopup'* *'cpp'*
1949'completepopup' 'cpp' string (default empty)
1950 global
1951 {not available when compiled without the |+textprop|
1952 or |+quickfix| feature}
1953 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001954 properties of the info popup when it is created. You can also use
1955 |popup_findinfo()| and then set properties for an existing info popup
1956 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001957
1958
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001959 *'concealcursor'* *'cocu'*
1960'concealcursor' 'cocu' string (default: "")
1961 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962 {not available when compiled without the |+conceal|
1963 feature}
1964 Sets the modes in which text in the cursor line can also be concealed.
1965 When the current mode is listed then concealing happens just like in
1966 other lines.
1967 n Normal mode
1968 v Visual mode
1969 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001970 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001971
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001972 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001973 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001974 are moving around text is concealed, but when starting to insert text
1975 or selecting a Visual area the concealed text is displayed, so that
1976 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001977 Keep in mind that the cursor position is not always where it's
1978 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979
1980
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001981 *'conceallevel'* *'cole'*
1982'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001983 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001984 {not available when compiled without the |+conceal|
1985 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001986 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1987 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001989 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001990 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001991 1 Each block of concealed text is replaced with one
1992 character. If the syntax item does not have a custom
1993 replacement character defined (see |:syn-cchar|) the
1994 character defined in 'listchars' is used (default is a
1995 space).
1996 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001997 2 Concealed text is completely hidden unless it has a
1998 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001999 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002000 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002001
Bram Moolenaara7781e02010-07-19 20:13:22 +02002002 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002003 edit and copy the text. This can be changed with the 'concealcursor'
2004 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002005
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2007'confirm' 'cf' boolean (default off)
2008 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 When 'confirm' is on, certain operations that would normally
2010 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2011 instead raise a |dialog| asking if you wish to save the current
2012 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2013 If 'confirm' is off you can still activate confirmation for one
2014 command only (this is most useful in mappings) with the |:confirm|
2015 command.
2016 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2017
2018 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2019'conskey' 'consk' boolean (default off)
2020 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002021 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022
2023 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2024'copyindent' 'ci' boolean (default off)
2025 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 Copy the structure of the existing lines indent when autoindenting a
2027 new line. Normally the new indent is reconstructed by a series of
2028 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2029 in which case only spaces are used). Enabling this option makes the
2030 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002031 existing line. 'expandtab' has no effect on these characters, a Tab
2032 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002034 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 Also see 'preserveindent'.
2036
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002037 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038'cpoptions' 'cpo' string (Vim default: "aABceFs",
2039 Vi default: all flags)
2040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002042 this indicates Vi-compatible behavior. This is used for things where
2043 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 'cpoptions' stands for "compatible-options".
2045 Commas can be added for readability.
2046 To avoid problems with flags that are added in the future, use the
2047 "+=" and "-=" feature of ":set" |add-option-flags|.
2048 NOTE: This option is set to the Vi default value when 'compatible' is
2049 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002050 NOTE: This option is set to the POSIX default value at startup when
2051 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002052 variable exists |posix|. This means Vim tries to behave like the
2053 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054
2055 contains behavior ~
2056 *cpo-a*
2057 a When included, a ":read" command with a file name
2058 argument will set the alternate file name for the
2059 current window.
2060 *cpo-A*
2061 A When included, a ":write" command with a file name
2062 argument will set the alternate file name for the
2063 current window.
2064 *cpo-b*
2065 b "\|" in a ":map" command is recognized as the end of
2066 the map command. The '\' is included in the mapping,
2067 the text after the '|' is interpreted as the next
2068 command. Use a CTRL-V instead of a backslash to
2069 include the '|' in the mapping. Applies to all
2070 mapping, abbreviation, menu and autocmd commands.
2071 See also |map_bar|.
2072 *cpo-B*
2073 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002074 abbreviations, user commands and the "to" part of the
2075 menu commands. Remove this flag to be able to use a
2076 backslash like a CTRL-V. For example, the command
2077 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 'B' included: "\^[" (^[ is a real <Esc>)
2079 'B' excluded: "<Esc>" (5 characters)
2080 ('<' excluded in both cases)
2081 *cpo-c*
2082 c Searching continues at the end of any match at the
2083 cursor position, but not further than the start of the
2084 next line. When not present searching continues
2085 one character from the cursor position. With 'c'
2086 "abababababab" only gets three matches when repeating
2087 "/abab", without 'c' there are five matches.
2088 *cpo-C*
2089 C Do not concatenate sourced lines that start with a
2090 backslash. See |line-continuation|.
2091 *cpo-d*
2092 d Using "./" in the 'tags' option doesn't mean to use
2093 the tags file relative to the current file, but the
2094 tags file in the current directory.
2095 *cpo-D*
2096 D Can't use CTRL-K to enter a digraph after Normal mode
2097 commands with a character argument, like |r|, |f| and
2098 |t|.
2099 *cpo-e*
2100 e When executing a register with ":@r", always add a
2101 <CR> to the last line, also when the register is not
2102 linewise. If this flag is not present, the register
2103 is not linewise and the last line does not end in a
2104 <CR>, then the last line is put on the command-line
2105 and can be edited before hitting <CR>.
2106 *cpo-E*
2107 E It is an error when using "y", "d", "c", "g~", "gu" or
2108 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002109 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 This makes "y0" fail in the first column.
2111 *cpo-f*
2112 f When included, a ":read" command with a file name
2113 argument will set the file name for the current buffer,
2114 if the current buffer doesn't have a file name yet.
2115 *cpo-F*
2116 F When included, a ":write" command with a file name
2117 argument will set the file name for the current
2118 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002119 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120 *cpo-g*
2121 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002122 *cpo-H*
2123 H When using "I" on a line with only blanks, insert
2124 before the last blank. Without this flag insert after
2125 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *cpo-i*
2127 i When included, interrupting the reading of a file will
2128 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002129 *cpo-I*
2130 I When moving the cursor up or down just after inserting
2131 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 *cpo-j*
2133 j When joining lines, only add two spaces after a '.',
2134 not after '!' or '?'. Also see 'joinspaces'.
2135 *cpo-J*
2136 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002137 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 white space.
2139 *cpo-k*
2140 k Disable the recognition of raw key codes in
2141 mappings, abbreviations, and the "to" part of menu
2142 commands. For example, if <Key> sends ^[OA (where ^[
2143 is <Esc>), the command ":map X ^[OA" results in X
2144 being mapped to:
2145 'k' included: "^[OA" (3 characters)
2146 'k' excluded: "<Key>" (one key code)
2147 Also see the '<' flag below.
2148 *cpo-K*
2149 K Don't wait for a key code to complete when it is
2150 halfway a mapping. This breaks mapping <F1><F1> when
2151 only part of the second <F1> has been read. It
2152 enables cancelling the mapping by typing <F1><Esc>.
2153 *cpo-l*
2154 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002155 literally, only "\]", "\^", "\-" and "\\" are special.
2156 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2158 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002159 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 *cpo-L*
2161 L When the 'list' option is set, 'wrapmargin',
2162 'textwidth', 'softtabstop' and Virtual Replace mode
2163 (see |gR|) count a <Tab> as two characters, instead of
2164 the normal behavior of a <Tab>.
2165 *cpo-m*
2166 m When included, a showmatch will always wait half a
2167 second. When not included, a showmatch will wait half
2168 a second or until a character is typed. |'showmatch'|
2169 *cpo-M*
2170 M When excluded, "%" matching will take backslashes into
2171 account. Thus in "( \( )" and "\( ( \)" the outer
2172 parenthesis match. When included "%" ignores
2173 backslashes, which is Vi compatible.
2174 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002175 n When included, the column used for 'number' and
2176 'relativenumber' will also be used for text of wrapped
2177 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *cpo-o*
2179 o Line offset to search command is not remembered for
2180 next search.
2181 *cpo-O*
2182 O Don't complain if a file is being overwritten, even
2183 when it didn't exist when editing it. This is a
2184 protection against a file unexpectedly created by
2185 someone else. Vi didn't complain about this.
2186 *cpo-p*
2187 p Vi compatible Lisp indenting. When not present, a
2188 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002189 *cpo-P*
2190 P When included, a ":write" command that appends to a
2191 file will set the file name for the current buffer, if
2192 the current buffer doesn't have a file name yet and
2193 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002194 *cpo-q*
2195 q When joining multiple lines leave the cursor at the
2196 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 *cpo-r*
2198 r Redo ("." command) uses "/" to repeat a search
2199 command, instead of the actually used search string.
2200 *cpo-R*
2201 R Remove marks from filtered lines. Without this flag
2202 marks are kept like |:keepmarks| was used.
2203 *cpo-s*
2204 s Set buffer options when entering the buffer for the
2205 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002206 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 set when the buffer is created.
2208 *cpo-S*
2209 S Set buffer options always when entering a buffer
2210 (except 'readonly', 'fileformat', 'filetype' and
2211 'syntax'). This is the (most) Vi compatible setting.
2212 The options are set to the values in the current
2213 buffer. When you change an option and go to another
2214 buffer, the value is copied. Effectively makes the
2215 buffer options global to all buffers.
2216
2217 's' 'S' copy buffer options
2218 no no when buffer created
2219 yes no when buffer first entered (default)
2220 X yes each time when buffer entered (vi comp.)
2221 *cpo-t*
2222 t Search pattern for the tag command is remembered for
2223 "n" command. Otherwise Vim only puts the pattern in
2224 the history for search pattern, but doesn't change the
2225 last used search pattern.
2226 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002227 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *cpo-v*
2229 v Backspaced characters remain visible on the screen in
2230 Insert mode. Without this flag the characters are
2231 erased from the screen right away. With this flag the
2232 screen newly typed text overwrites backspaced
2233 characters.
2234 *cpo-w*
2235 w When using "cw" on a blank character, only change one
2236 character and not all blanks until the start of the
2237 next word.
2238 *cpo-W*
2239 W Don't overwrite a readonly file. When omitted, ":w!"
2240 overwrites a readonly file, if possible.
2241 *cpo-x*
2242 x <Esc> on the command-line executes the command-line.
2243 The default in Vim is to abandon the command-line,
2244 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002245 *cpo-X*
2246 X When using a count with "R" the replaced text is
2247 deleted only once. Also when repeating "R" with "."
2248 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002249 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002250 y A yank command can be redone with ".". Think twice if
2251 you really want to use this, it may break some
2252 plugins, since most people expect "." to only repeat a
2253 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 *cpo-Z*
2255 Z When using "w!" while the 'readonly' option is set,
2256 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 *cpo-!*
2258 ! When redoing a filter command, use the last used
2259 external command, whatever it was. Otherwise the last
2260 used -filter- command is used.
2261 *cpo-$*
2262 $ When making a change to one line, don't redisplay the
2263 line, but put a '$' at the end of the changed text.
2264 The changed text will be overwritten when you type the
2265 new text. The line is redisplayed if you type any
2266 command that moves the cursor from the insertion
2267 point.
2268 *cpo-%*
2269 % Vi-compatible matching is done for the "%" command.
2270 Does not recognize "#if", "#endif", etc.
2271 Does not recognize "/*" and "*/".
2272 Parens inside single and double quotes are also
2273 counted, causing a string that contains a paren to
2274 disturb the matching. For example, in a line like
2275 "if (strcmp("foo(", s))" the first paren does not
2276 match the last one. When this flag is not included,
2277 parens inside single and double quotes are treated
2278 specially. When matching a paren outside of quotes,
2279 everything inside quotes is ignored. When matching a
2280 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002281 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002282 This flag is also used for other features, such as
2283 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002284 *cpo--*
2285 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002286 it would go above the first line or below the last
2287 line. Without it the cursor moves to the first or
2288 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002289 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002290 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002291 *cpo-+*
2292 + When included, a ":write file" command will reset the
2293 'modified' flag of the buffer, even though the buffer
2294 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002295 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 * Use ":*" in the same way as ":@". When not included,
2297 ":*" is an alias for ":'<,'>", select the Visual area.
2298 *cpo-<*
2299 < Disable the recognition of special key codes in |<>|
2300 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002301 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 ":map X <Tab>" results in X being mapped to:
2303 '<' included: "<Tab>" (5 characters)
2304 '<' excluded: "^I" (^I is a real <Tab>)
2305 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002306 *cpo->*
2307 > When appending to a register, put a line break before
2308 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002309 *cpo-;*
2310 ; When using |,| or |;| to repeat the last |t| search
2311 and the cursor is right in front of the searched
2312 character, the cursor won't move. When not included,
2313 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002314 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002315
2316 POSIX flags. These are not included in the Vi default value, except
2317 when $VIM_POSIX was set on startup. |posix|
2318
2319 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002320 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002321 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002322 *cpo-&*
2323 & When ":preserve" was used keep the swap file when
2324 exiting normally while this buffer is still loaded.
2325 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002326 *cpo-\*
2327 \ Backslash in a [] range in a search pattern is taken
2328 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002329 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2330 '\' excluded: "/[ \-]" finds <Space> and '-'
2331 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002332 *cpo-/*
2333 / When "%" is used as the replacement string in a |:s|
2334 command, use the previous replacement string. |:s%|
2335 *cpo-{*
2336 { The |{| and |}| commands also stop at a "{" character
2337 at the start of a line.
2338 *cpo-.*
2339 . The ":chdir" and ":cd" commands fail if the current
2340 buffer is modified, unless ! is used. Vim doesn't
2341 need this, since it remembers the full path of an
2342 opened file.
2343 *cpo-bar*
2344 | The value of the $LINES and $COLUMNS environment
2345 variables overrule the terminal size values obtained
2346 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002347
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002349 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002350'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002351 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002352 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002353 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002354 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002355 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002356 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002357 blowfish Blowfish method. Medium strong encryption but it has
2358 an implementation flaw. Requires Vim 7.3 or later,
2359 files can NOT be read by Vim 7.2 and older. This adds
2360 a "seed" to the file, every time you write the file
2361 the encrypted bytes will be different.
2362 *blowfish2*
2363 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002364 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002365 and older. This adds a "seed" to the file, every time
2366 you write the file the encrypted bytes will be
2367 different. The whole undo file is encrypted, not just
2368 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002369
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002370 You should use "blowfish2", also to re-encrypt older files.
2371
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002372 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373 to the detected method of the file being read. Thus if you write it
2374 without changing 'cryptmethod' the same method will be used.
2375 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002376 explicitly write it, you don't get a warning unless there are other
2377 modifications. Also see |:X|.
2378
2379 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002380 the value "blowfish2". When setting the local value to an empty
2381 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002382
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002383 When a new encryption method is added in a later version of Vim, and
2384 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002385 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002386
2387
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 *'cscopepathcomp'* *'cspc'*
2389'cscopepathcomp' 'cspc' number (default 0)
2390 global
2391 {not available when compiled without the |+cscope|
2392 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 Determines how many components of the path to show in a list of tags.
2394 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002395 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396
2397 *'cscopeprg'* *'csprg'*
2398'cscopeprg' 'csprg' string (default "cscope")
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 Specifies the command to execute cscope. See |cscopeprg|.
2403 This option cannot be set from a |modeline| or in the |sandbox|, for
2404 security reasons.
2405
2406 *'cscopequickfix'* *'csqf'*
2407'cscopequickfix' 'csqf' string (default "")
2408 global
2409 {not available when compiled without the |+cscope|
2410 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 Specifies whether to use quickfix window to show cscope results.
2412 See |cscopequickfix|.
2413
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002414 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002415'cscoperelative' 'csre' boolean (default off)
2416 global
2417 {not available when compiled without the |+cscope|
2418 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002419 In the absence of a prefix (-P) for cscope. setting this option enables
2420 to use the basename of cscope.out path as the prefix.
2421 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002422 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002423
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2425'cscopetag' 'cst' boolean (default off)
2426 global
2427 {not available when compiled without the |+cscope|
2428 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 Use cscope for tag commands. See |cscope-options|.
2430 NOTE: This option is reset when 'compatible' is set.
2431
2432 *'cscopetagorder'* *'csto'*
2433'cscopetagorder' 'csto' number (default 0)
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 Determines the order in which ":cstag" performs a search. See
2438 |cscopetagorder|.
2439 NOTE: This option is set to 0 when 'compatible' is set.
2440
2441 *'cscopeverbose'* *'csverb'*
2442 *'nocscopeverbose'* *'nocsverb'*
2443'cscopeverbose' 'csverb' boolean (default off)
2444 global
2445 {not available when compiled without the |+cscope|
2446 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 Give messages when adding a cscope database. See |cscopeverbose|.
2448 NOTE: This option is reset when 'compatible' is set.
2449
Bram Moolenaar860cae12010-06-05 23:22:07 +02002450 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2451'cursorbind' 'crb' boolean (default off)
2452 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002453 When this option is set, as the cursor in the current
2454 window moves other cursorbound windows (windows that also have
2455 this option set) move their cursors to the corresponding line and
2456 column. This option is useful for viewing the
2457 differences between two versions of a file (see 'diff'); in diff mode,
2458 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002459 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002460
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002461
2462 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2463'cursorcolumn' 'cuc' boolean (default off)
2464 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002465 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002466 feature}
2467 Highlight the screen column of the cursor with CursorColumn
2468 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2469 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002470 If you only want the highlighting in the current window you can use
2471 these autocommands: >
2472 au WinLeave * set nocursorline nocursorcolumn
2473 au WinEnter * set cursorline cursorcolumn
2474<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475
2476 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2477'cursorline' 'cul' boolean (default off)
2478 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002479 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002480 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002481 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2482 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002483 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002484 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002485
2486
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002487 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002488'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002489 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002490 {not available when compiled without the |+syntax|
2491 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002492 Comma separated list of settings for how 'cursorline' is displayed.
2493 Valid values:
2494 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002495 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002496 "screenline" Highlight only the screen line of the cursor with
2497 CursorLine |hl-CursorLine|.
2498 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002499 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002500
2501 Special value:
2502 "both" Alias for the values "line,number".
2503
2504 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002505
2506
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 *'debug'*
2508'debug' string (default "")
2509 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002510 These values can be used:
2511 msg Error messages that would otherwise be omitted will be given
2512 anyway.
2513 throw Error messages that would otherwise be omitted will be given
2514 anyway and also throw an exception and set |v:errmsg|.
2515 beep A message will be given when otherwise only a beep would be
2516 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002517 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002518 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2519 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520
2521 *'define'* *'def'*
2522'define' 'def' string (default "^\s*#\s*define")
2523 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 pattern, just like for the "/" command. This option is used for the
2526 commands like "[i" and "[d" |include-search|. The 'isident' option is
2527 used to recognize the defined name after the match:
2528 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2529 See |option-backslash| about inserting backslashes to include a space
2530 or backslash.
2531 The default value is for C programs. For C++ this value would be
2532 useful, to include const type declarations: >
2533 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002534< You can also use "\ze" just before the name and continue the pattern
2535 to check what is following. E.g. for Javascript, if a function is
2536 defined with "func_name = function(args)": >
2537 ^\s*\ze\i\+\s*=\s*function(
2538< If the function is defined with "func_name : function() {...": >
2539 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002541 To avoid that use `:let` with a single quote string: >
2542 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002543<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544
2545 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2546'delcombine' 'deco' boolean (default off)
2547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 If editing Unicode and this option is set, backspace and Normal mode
2549 "x" delete each combining character on its own. When it is off (the
2550 default) the character along with its combining characters are
2551 deleted.
2552 Note: When 'delcombine' is set "xx" may work different from "2x"!
2553
2554 This is useful for Arabic, Hebrew and many other languages where one
2555 may have combining characters overtop of base characters, and want
2556 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002557 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558
2559 *'dictionary'* *'dict'*
2560'dictionary' 'dict' string (default "")
2561 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 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
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 {not available when compiled without the |+diff|
2589 feature}
2590 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002591 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592
2593 *'dex'* *'diffexpr'*
2594'diffexpr' 'dex' string (default "")
2595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 {not available when compiled without the |+diff|
2597 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002598 Expression which is evaluated to obtain a diff file (either ed-style
2599 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 This option cannot be set from a |modeline| or in the |sandbox|, for
2601 security reasons.
2602
2603 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002604'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 {not available when compiled without the |+diff|
2607 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002608 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 All are optional. Items must be separated by a comma.
2610
2611 filler Show filler lines, to keep the text
2612 synchronized with a window that has inserted
2613 lines at the same position. Mostly useful
2614 when windows are side-by-side and 'scrollbind'
2615 is set.
2616
2617 context:{n} Use a context of {n} lines between a change
2618 and a fold that contains unchanged lines.
2619 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002620 When using zero the context is actually one,
2621 since folds require a line in between, also
2622 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 See |fold-diff|.
2624
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002625 iblank Ignore changes where lines are all blank. Adds
2626 the "-B" flag to the "diff" command if
2627 'diffexpr' is empty. Check the documentation
2628 of the "diff" command for what this does
2629 exactly.
2630 NOTE: the diff windows will get out of sync,
2631 because no differences between blank lines are
2632 taken into account.
2633
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 icase Ignore changes in case of text. "a" and "A"
2635 are considered the same. Adds the "-i" flag
2636 to the "diff" command if 'diffexpr' is empty.
2637
2638 iwhite Ignore changes in amount of white space. Adds
2639 the "-b" flag to the "diff" command if
2640 'diffexpr' is empty. Check the documentation
2641 of the "diff" command for what this does
2642 exactly. It should ignore adding trailing
2643 white space, but not leading white space.
2644
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002645 iwhiteall Ignore all white space changes. Adds
2646 the "-w" flag to the "diff" command if
2647 'diffexpr' is empty. Check the documentation
2648 of the "diff" command for what this does
2649 exactly.
2650
2651 iwhiteeol Ignore white space changes at end of line.
2652 Adds the "-Z" flag to the "diff" command if
2653 'diffexpr' is empty. Check the documentation
2654 of the "diff" command for what this does
2655 exactly.
2656
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002657 horizontal Start diff mode with horizontal splits (unless
2658 explicitly specified otherwise).
2659
2660 vertical Start diff mode with vertical splits (unless
2661 explicitly specified otherwise).
2662
Bram Moolenaarc8234772019-11-10 21:00:27 +01002663 closeoff When a window is closed where 'diff' is set
2664 and there is only one window remaining in the
2665 same tab page with 'diff' set, execute
2666 `:diffoff` in that window. This undoes a
2667 `:diffsplit` command.
2668
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002669 hiddenoff Do not use diff mode for a buffer when it
2670 becomes hidden.
2671
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002672 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2673 starting diff mode. Without this 2 is used.
2674
Bram Moolenaare828b762018-09-10 17:51:58 +02002675 internal Use the internal diff library. This is
2676 ignored when 'diffexpr' is set. *E960*
2677 When running out of memory when writing a
2678 buffer this item will be ignored for diffs
2679 involving that buffer. Set the 'verbose'
2680 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681
Bram Moolenaare828b762018-09-10 17:51:58 +02002682 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002683 Use the indent heuristic for the internal
2684 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002685
2686 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002687 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002688 algorithms are:
2689 myers the default algorithm
2690 minimal spend extra time to generate the
2691 smallest possible diff
2692 patience patience diff algorithm
2693 histogram histogram diff algorithm
2694
2695 Examples: >
2696 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002698 :set diffopt=internal,filler,foldcolumn:3
2699 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700<
2701 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2702'digraph' 'dg' boolean (default off)
2703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 {not available when compiled without the |+digraphs|
2705 feature}
2706 Enable the entering of digraphs in Insert mode with {char1} <BS>
2707 {char2}. See |digraphs|.
2708 NOTE: This option is reset when 'compatible' is set.
2709
2710 *'directory'* *'dir'*
2711'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002712 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 for Unix: ".,~/tmp,/var/tmp,/tmp")
2714 global
2715 List of directory names for the swap file, separated with commas.
2716 - The swap file will be created in the first directory where this is
2717 possible.
2718 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002719 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 - A directory "." means to put the swap file in the same directory as
2721 the edited file. On Unix, a dot is prepended to the file name, so
2722 it doesn't show in a directory listing. On MS-Windows the "hidden"
2723 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002724 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2725 the swap file relative to where the edited file is. The leading "."
2726 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002727 - For Unix and Win32, if a directory ends in two path separators "//",
2728 the swap file name will be built from the complete path to the file
2729 with all path separators substituted to percent '%' signs. This will
2730 ensure file name uniqueness in the preserve directory.
2731 On Win32, it is also possible to end with "\\". However, When a
2732 separating comma is following, you must use "//", since "\\" will
2733 include the comma in the file name. Therefore it is recommended to
2734 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 - Spaces after the comma are ignored, other spaces are considered part
2736 of the directory name. To have a space at the start of a directory
2737 name, precede it with a backslash.
2738 - To include a comma in a directory name precede it with a backslash.
2739 - A directory name may end in an ':' or '/'.
2740 - Environment variables are expanded |:set_env|.
2741 - Careful with '\' characters, type one before a space, type two to
2742 get one in the option (see |option-backslash|), for example: >
2743 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2744< - For backwards compatibility with Vim version 3.0 a '>' at the start
2745 of the option is removed.
2746 Using "." first in the list is recommended. This means that editing
2747 the same file twice will result in a warning. Using "/tmp" on Unix is
2748 discouraged: When the system crashes you lose the swap file.
2749 "/var/tmp" is often not cleared when rebooting, thus is a better
2750 choice than "/tmp". But it can contain a lot of files, your swap
2751 files get lost in the crowd. That is why a "tmp" directory in your
2752 home directory is tried first.
2753 The use of |:set+=| and |:set-=| is preferred when adding or removing
2754 directories from the list. This avoids problems when a future version
2755 uses another default.
2756 This option cannot be set from a |modeline| or in the |sandbox|, for
2757 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758
2759 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002760'display' 'dy' string (default "", set to "truncate" in
2761 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 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
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 Tells when the 'equalalways' option applies:
2781 ver vertically, width of windows is not affected
2782 hor horizontally, height of windows is not affected
2783 both width and height of windows is affected
2784
2785 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2786'edcompatible' 'ed' boolean (default off)
2787 global
2788 Makes the 'g' and 'c' flags of the ":substitute" command to be
2789 toggled each time the flag is given. See |complex-change|. See
2790 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002791 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792
Bram Moolenaar03413f42016-04-12 21:07:15 +02002793 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002794'emoji' 'emo' boolean (default: on)
2795 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002796 When on all Unicode emoji characters are considered to be full width.
2797
2798
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 *'encoding'* *'enc'* *E543*
2800'encoding' 'enc' string (default: "latin1" or value from $LANG)
2801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 Sets the character encoding used inside Vim. It applies to text in
2803 the buffers, registers, Strings in expressions, text stored in the
2804 viminfo file, etc. It sets the kind of characters which Vim can work
2805 with. See |encoding-names| for the possible values.
2806
2807 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002808 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002810 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811
Bram Moolenaar865242e2010-07-14 21:12:05 +02002812 This option cannot be set from a |modeline|. It would most likely
2813 corrupt the text.
2814
Bram Moolenaar3df01732017-02-17 22:47:16 +01002815 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2816 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 'encoding', "utf-8" is the natural choice for the environment and
2818 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002819 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 versions, and to avoid changing the encoding of newly created files
2821 without your knowledge (in case 'fileencodings' is empty).
2822
2823 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002824 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825 iconv() or as specified with 'charconvert'.
2826
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002827 If you need to know whether 'encoding' is a multi-byte encoding, you
2828 can use: >
2829 if has("multi_byte_encoding")
2830<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 Normally 'encoding' will be equal to your current locale. This will
2832 be the default if Vim recognizes your environment settings. If
2833 'encoding' is not set to the current locale, 'termencoding' must be
2834 set to convert typed and displayed text. See |encoding-table|.
2835
2836 When you set this option, it fires the |EncodingChanged| autocommand
2837 event so that you can set up fonts if necessary.
2838
2839 When the option is set, the value is converted to lowercase. Thus
2840 you can set it with uppercase values too. Underscores are translated
2841 to '-' signs.
2842 When the encoding is recognized, it is changed to the standard name.
2843 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2844 "iso-8859-2" and "utf8" becomes "utf-8".
2845
2846 Note: "latin1" is also used when the encoding could not be detected.
2847 This only works when editing files in the same encoding! When the
2848 actual character set is not latin1, make sure 'fileencoding' and
2849 'fileencodings' are empty. When conversion is needed, switch to using
2850 utf-8.
2851
2852 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2853 You don't notice this while editing, but it does matter for the
2854 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2855 setting 'encoding' to one of these values instead of utf-8 only has
2856 effect for encoding used for files when 'fileencoding' is empty.
2857
Bram Moolenaar661b1822005-07-28 22:36:45 +00002858 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2859 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860
2861 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2862'endofline' 'eol' boolean (default on)
2863 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002865 is on, or 'fixeol' option is off, no <EOL> will be written for the
2866 last line in the file. This option is automatically set or reset when
2867 starting to edit a new file, depending on whether file has an <EOL>
2868 for the last line in the file. Normally you don't have to set or
2869 reset this option.
2870 When 'binary' is off and 'fixeol' is on the value is not used when
2871 writing the file. When 'binary' is on or 'fixeol' is off it is used
2872 to remember the presence of a <EOL> for the last line in the file, so
2873 that when you write the file the situation from the original file can
2874 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875
2876 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2877'equalalways' 'ea' boolean (default on)
2878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002880 splitting or closing a window. This also happens the moment the
2881 option is switched on. When off, splitting a window will reduce the
2882 size of the current window and leave the other windows the same. When
2883 closing a window the extra lines are given to the window next to it
2884 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 When mixing vertically and horizontally split windows, a minimal size
2886 is computed and some windows may be larger if there is room. The
2887 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002888 Changing the height and width of a window can be avoided by setting
2889 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002890 If a window size is specified when creating a new window sizes are
2891 currently not equalized (it's complicated, but may be implemented in
2892 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893
2894 *'equalprg'* *'ep'*
2895'equalprg' 'ep' string (default "")
2896 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002898 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002899 or 'indentexpr'. When Vim was compiled without internal formatting,
2900 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 about including spaces and backslashes.
2903 This option cannot be set from a |modeline| or in the |sandbox|, for
2904 security reasons.
2905
2906 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2907'errorbells' 'eb' boolean (default off)
2908 global
2909 Ring the bell (beep or screen flash) for error messages. This only
2910 makes a difference for error messages, the bell will be used always
2911 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002912 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002913 screen flash or do nothing. See 'belloff' to finetune when to ring the
2914 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915
2916 *'errorfile'* *'ef'*
2917'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2918 others: "errors.err")
2919 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 {not available when compiled without the |+quickfix|
2921 feature}
2922 Name of the errorfile for the QuickFix mode (see |:cf|).
2923 When the "-q" command-line argument is used, 'errorfile' is set to the
2924 following argument. See |-q|.
2925 NOT used for the ":make" command. See 'makeef' for that.
2926 Environment variables are expanded |:set_env|.
2927 See |option-backslash| about including spaces and backslashes.
2928 This option cannot be set from a |modeline| or in the |sandbox|, for
2929 security reasons.
2930
2931 *'errorformat'* *'efm'*
2932'errorformat' 'efm' string (default is very long)
2933 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 {not available when compiled without the |+quickfix|
2935 feature}
2936 Scanf-like description of the format for the lines in the error file
2937 (see |errorformat|).
2938
2939 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2940'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2941 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 Function keys that start with an <Esc> are recognized in Insert
2943 mode. When this option is off, the cursor and function keys cannot be
2944 used in Insert mode if they start with an <Esc>. The advantage of
2945 this is that the single <Esc> is recognized immediately, instead of
2946 after one second. Instead of resetting this option, you might want to
2947 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2948 when 'esckeys' is off, you can still map anything, but the cursor keys
2949 won't work by default.
2950 NOTE: This option is set to the Vi default value when 'compatible' is
2951 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002952 NOTE: when this option is off then the |modifyOtherKeys| functionality
2953 is disabled while in Insert mode to avoid ending Insert mode with any
2954 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955
2956 *'eventignore'* *'ei'*
2957'eventignore' 'ei' string (default "")
2958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002960 When set to "all" or when "all" is one of the items, all autocommand
2961 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 Otherwise this is a comma separated list of event names. Example: >
2963 :set ei=WinEnter,WinLeave
2964<
2965 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2966'expandtab' 'et' boolean (default off)
2967 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002969 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2971 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002972 This option is reset when the 'paste' option is set and restored when
2973 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 NOTE: This option is reset when 'compatible' is set.
2975
2976 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2977'exrc' 'ex' boolean (default off)
2978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002980 directory.
2981
2982 Setting this option is a potential security leak. E.g., consider
2983 unpacking a package or fetching files from github, a .vimrc in there
2984 might be a trojan horse. BETTER NOT SET THIS OPTION!
2985 Instead, define an autocommand in your .vimrc to set options for a
2986 matching directory.
2987
2988 If you do switch this option on you should also consider setting the
2989 'secure' option (see |initialization|).
2990 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 This option cannot be set from a |modeline| or in the |sandbox|, for
2992 security reasons.
2993
2994 *'fileencoding'* *'fenc'* *E213*
2995'fileencoding' 'fenc' string (default: "")
2996 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002998
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003000 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 When 'fileencoding' is empty, the same value as 'encoding' will be
3002 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003003 No error will be given when the value is set, only when it is used,
3004 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003005 Conversion will also be done when 'encoding' and 'fileencoding' are
3006 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3007 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003009 'encoding' is "utf-8" or another Unicode encoding, conversion
3010 is most likely done in a way that the reverse conversion
3011 results in the same text. When 'encoding' is not "utf-8" some
3012 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003013
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 See 'encoding' for the possible values. Additionally, values may be
3015 specified that can be handled by the converter, see
3016 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003017
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 When reading a file 'fileencoding' will be set from 'fileencodings'.
3019 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003020 'fileencoding', use the |++enc| argument. One exception: when
3021 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003022 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3025 When the option is set, the value is converted to lowercase. Thus
3026 you can set it with uppercase values too. '_' characters are
3027 replaced with '-'. If a name is recognized from the list for
3028 'encoding', it is replaced by the standard name. For example
3029 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003030
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 When this option is set, after starting to edit a file, the 'modified'
3032 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003033
3034 Keep in mind that changing 'fenc' from a modeline happens
3035 AFTER the text has been read, thus it applies to when the file will be
3036 written. If you do set 'fenc' in a modeline, you might want to set
3037 'nomodified' to avoid not being able to ":q".
3038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 This option can not be changed when 'modifiable' is off.
3040
3041 *'fe'*
3042 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003043 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 old short name was 'fe', which is no longer used.
3045
3046 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003047'fileencodings' 'fencs' string (default: "ucs-bom",
3048 "ucs-bom,utf-8,default,latin1" when
3049 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 This is a list of character encodings considered when starting to edit
3052 an existing file. When a file is read, Vim tries to use the first
3053 mentioned character encoding. If an error is detected, the next one
3054 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003055 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 an empty string, which means the value of 'encoding' is used.
3057 WARNING: Conversion can cause loss of information! When
3058 'encoding' is "utf-8" (or one of the other Unicode variants)
3059 conversion is most likely done in a way that the reverse
3060 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003061 "utf-8" some non-ASCII characters may be lost! You can use
3062 the |++bad| argument to specify what is done with characters
3063 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 For an empty file or a file with only ASCII characters most encodings
3065 will work and the first entry of 'fileencodings' will be used (except
3066 "ucs-bom", which requires the BOM to be present). If you prefer
3067 another encoding use an BufReadPost autocommand event to test if your
3068 preferred encoding is to be used. Example: >
3069 au BufReadPost * if search('\S', 'w') == 0 |
3070 \ set fenc=iso-2022-jp | endif
3071< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3072 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003073 When the |++enc| argument is used then the value of 'fileencodings' is
3074 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003075 Note that 'fileencodings' is not used for a new file, the global value
3076 of 'fileencoding' is used instead. You can set it with: >
3077 :setglobal fenc=iso-8859-2
3078< This means that a non-existing file may get a different encoding than
3079 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 The special value "ucs-bom" can be used to check for a Unicode BOM
3081 (Byte Order Mark) at the start of the file. It must not be preceded
3082 by "utf-8" or another Unicode encoding for this to work properly.
3083 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3084 because Vim cannot detect an error, thus the encoding is always
3085 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003086 The special value "default" can be used for the encoding from the
3087 environment. This is the default value for 'encoding'. It is useful
3088 when 'encoding' is set to "utf-8" and your environment uses a
3089 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003090 When 'encoding' is "utf-8" and a file contains an illegal byte
3091 sequence it won't be recognized as UTF-8. You can use the |8g8|
3092 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 WRONG VALUES: WHAT'S WRONG:
3094 latin1,utf-8 "latin1" will always be used
3095 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3096 file
3097 cp1250,latin1 "cp1250" will always be used
3098 If 'fileencodings' is empty, 'fileencoding' is not modified.
3099 See 'fileencoding' for the possible values.
3100 Setting this option does not have an effect until the next time a file
3101 is read.
3102
3103 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003104'fileformat' 'ff' string (MS-Windows default: "dos",
3105 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 This gives the <EOL> of the current buffer, which is used for
3108 reading/writing the buffer from/to a file:
3109 dos <CR> <NL>
3110 unix <NL>
3111 mac <CR>
3112 When "dos" is used, CTRL-Z at the end of a file is ignored.
3113 See |file-formats| and |file-read|.
3114 For the character encoding of the file see 'fileencoding'.
3115 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003116 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 This option is set automatically when starting to edit a file and
3118 'fileformats' is not empty and 'binary' is off.
3119 When this option is set, after starting to edit a file, the 'modified'
3120 option is set, because the file would be different when written.
3121 This option can not be changed when 'modifiable' is off.
3122 For backwards compatibility: When this option is set to "dos",
3123 'textmode' is set, otherwise 'textmode' is reset.
3124
3125 *'fileformats'* *'ffs'*
3126'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003127 Vim+Vi MS-Windows: "dos,unix",
3128 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Vi Cygwin: "unix,dos",
3130 Vi others: "")
3131 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 This gives the end-of-line (<EOL>) formats that will be tried when
3133 starting to edit a new buffer and when reading a file into an existing
3134 buffer:
3135 - When empty, the format defined with 'fileformat' will be used
3136 always. It is not set automatically.
3137 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003138 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 'fileformats' name will be used when a file is read into an existing
3140 buffer, no matter what 'fileformat' for that buffer is set to.
3141 - When more than one name is present, separated by commas, automatic
3142 <EOL> detection will be done when reading a file. When starting to
3143 edit a file, a check is done for the <EOL>:
3144 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3145 'fileformat' is set to "dos".
3146 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003147 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003149 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3150 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003151 This means that "mac" is only chosen when:
3152 "unix" is not present or no <NL> is found in the file, and
3153 "dos" is not present or no <CR><NL> is found in the file.
3154 Except: if "unix" was chosen, but there is a <CR> before
3155 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003156 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 4. If 'fileformat' is still not set, the first name from
3158 'fileformats' is used.
3159 When reading a file into an existing buffer, the same is done, but
3160 this happens like 'fileformat' has been set appropriately for that
3161 file only, the option is not changed.
3162 When 'binary' is set, the value of 'fileformats' is not used.
3163
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003164 When Vim starts up with an empty buffer the first item is used. You
3165 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3168 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3169 done:
3170 - When 'fileformats' is empty, there is no automatic detection. Dos
3171 format will be used.
3172 - When 'fileformats' is set to one or more names, automatic detection
3173 is done. This is based on the first <NL> in the file: If there is a
3174 <CR> in front of it, Dos format is used, otherwise Unix format is
3175 used.
3176 Also see |file-formats|.
3177 For backwards compatibility: When this option is set to an empty
3178 string or one format (no comma is included), 'textauto' is reset,
3179 otherwise 'textauto' is set.
3180 NOTE: This option is set to the Vi default value when 'compatible' is
3181 set and to the Vim default value when 'compatible' is reset.
3182
Bram Moolenaarbf884932013-04-05 22:26:15 +02003183 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3184'fileignorecase' 'fic' boolean (default on for systems where case in file
3185 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003186 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003187 When set case is ignored when using file names and directories.
3188 See 'wildignorecase' for only ignoring case when doing completion.
3189
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 *'filetype'* *'ft'*
3191'filetype' 'ft' string (default: "")
3192 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 When this option is set, the FileType autocommand event is triggered.
3194 All autocommands that match with the value of this option will be
3195 executed. Thus the value of 'filetype' is used in place of the file
3196 name.
3197 Otherwise this option does not always reflect the current file type.
3198 This option is normally set when the file type is detected. To enable
3199 this use the ":filetype on" command. |:filetype|
3200 Setting this option to a different value is most useful in a modeline,
3201 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003202 Example, for in an IDL file:
3203 /* vim: set filetype=idl : */ ~
3204 |FileType| |filetypes|
3205 When a dot appears in the value then this separates two filetype
3206 names. Example:
3207 /* vim: set filetype=c.doxygen : */ ~
3208 This will use the "c" filetype first, then the "doxygen" filetype.
3209 This works both for filetype plugins and for syntax files. More than
3210 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 This option is not copied to another buffer, independent of the 's' or
3212 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003213 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214
3215 *'fillchars'* *'fcs'*
3216'fillchars' 'fcs' string (default "vert:|,fold:-")
3217 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003218 {not available when compiled without the |+folding|
3219 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 Characters to fill the statuslines and vertical separators.
3221 It is a comma separated list of items:
3222
3223 item default Used for ~
3224 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003225 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 vert:c '|' vertical separators |:vsplit|
3227 fold:c '-' filling 'foldtext'
3228 diff:c '-' deleted lines of the 'diff' option
3229
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003230 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003231 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 otherwise.
3233
3234 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003235 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236< This is similar to the default, except that these characters will also
3237 be used when there is highlighting.
3238
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003239 for "stl" and "stlnc" only single-byte values are supported.
3240
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 The highlighting used for these items:
3242 item highlight group ~
3243 stl:c StatusLine |hl-StatusLine|
3244 stlnc:c StatusLineNC |hl-StatusLineNC|
3245 vert:c VertSplit |hl-VertSplit|
3246 fold:c Folded |hl-Folded|
3247 diff:c DiffDelete |hl-DiffDelete|
3248
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003249 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3250'fixendofline' 'fixeol' boolean (default on)
3251 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003252 When writing a file and this option is on, <EOL> at the end of file
3253 will be restored if missing. Turn this option off if you want to
3254 preserve the situation from the original file.
3255 When the 'binary' option is set the value of this option doesn't
3256 matter.
3257 See the 'endofline' option.
3258
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3260'fkmap' 'fk' boolean (default off) *E198*
3261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 {only available when compiled with the |+rightleft|
3263 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003264 This option was for using Farsi, which has been removed. See
3265 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266
3267 *'foldclose'* *'fcl'*
3268'foldclose' 'fcl' string (default "")
3269 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {not available when compiled without the |+folding|
3271 feature}
3272 When set to "all", a fold is closed when the cursor isn't in it and
3273 its level is higher than 'foldlevel'. Useful if you want folds to
3274 automatically close when moving out of them.
3275
3276 *'foldcolumn'* *'fdc'*
3277'foldcolumn' 'fdc' number (default 0)
3278 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 {not available when compiled without the |+folding|
3280 feature}
3281 When non-zero, a column with the specified width is shown at the side
3282 of the window which indicates open and closed folds. The maximum
3283 value is 12.
3284 See |folding|.
3285
3286 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3287'foldenable' 'fen' boolean (default on)
3288 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 {not available when compiled without the |+folding|
3290 feature}
3291 When off, all folds are open. This option can be used to quickly
3292 switch between showing all text unfolded and viewing the text with
3293 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003294 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 'foldenable' is off.
3296 This option is set by commands that create a new fold or close a fold.
3297 See |folding|.
3298
3299 *'foldexpr'* *'fde'*
3300'foldexpr' 'fde' string (default: "0")
3301 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003303 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003305 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003306
Bram Moolenaar30b65812012-07-12 22:01:11 +02003307 The expression will be evaluated in the |sandbox| if set from a
3308 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003309 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003310 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003311
3312 It is not allowed to change text or jump to another window while
3313 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314
3315 *'foldignore'* *'fdi'*
3316'foldignore' 'fdi' string (default: "#")
3317 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 {not available when compiled without the |+folding|
3319 feature}
3320 Used only when 'foldmethod' is "indent". Lines starting with
3321 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003322 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 The default "#" works well for C programs. See |fold-indent|.
3324
3325 *'foldlevel'* *'fdl'*
3326'foldlevel' 'fdl' number (default: 0)
3327 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328 {not available when compiled without the |+folding|
3329 feature}
3330 Sets the fold level: Folds with a higher level will be closed.
3331 Setting this option to zero will close all folds. Higher numbers will
3332 close fewer folds.
3333 This option is set by commands like |zm|, |zM| and |zR|.
3334 See |fold-foldlevel|.
3335
3336 *'foldlevelstart'* *'fdls'*
3337'foldlevelstart' 'fdls' number (default: -1)
3338 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 {not available when compiled without the |+folding|
3340 feature}
3341 Sets 'foldlevel' when starting to edit another buffer in a window.
3342 Useful to always start editing with all folds closed (value zero),
3343 some folds closed (one) or no folds closed (99).
3344 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003345 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003346 ignores this option and closes all folds.
3347 It is also done before BufReadPre autocommands, to allow an autocmd to
3348 overrule the 'foldlevel' value for specific files.
3349 When the value is negative, it is not used.
3350
3351 *'foldmarker'* *'fmr'* *E536*
3352'foldmarker' 'fmr' string (default: "{{{,}}}")
3353 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 {not available when compiled without the |+folding|
3355 feature}
3356 The start and end marker used when 'foldmethod' is "marker". There
3357 must be one comma, which separates the start and end marker. The
3358 marker is a literal string (a regular expression would be too slow).
3359 See |fold-marker|.
3360
3361 *'foldmethod'* *'fdm'*
3362'foldmethod' 'fdm' string (default: "manual")
3363 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 {not available when compiled without the |+folding|
3365 feature}
3366 The kind of folding used for the current window. Possible values:
3367 |fold-manual| manual Folds are created manually.
3368 |fold-indent| indent Lines with equal indent form a fold.
3369 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3370 |fold-marker| marker Markers are used to specify folds.
3371 |fold-syntax| syntax Syntax highlighting items specify folds.
3372 |fold-diff| diff Fold text that is not changed.
3373
3374 *'foldminlines'* *'fml'*
3375'foldminlines' 'fml' number (default: 1)
3376 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 {not available when compiled without the |+folding|
3378 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003379 Sets the number of screen lines above which a fold can be displayed
3380 closed. Also for manually closed folds. With the default value of
3381 one a fold can only be closed if it takes up two or more screen lines.
3382 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003383 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 "zc" to close a fold, which is displayed open because it's smaller
3385 than 'foldminlines', a following "zc" may close a containing fold.
3386
3387 *'foldnestmax'* *'fdn'*
3388'foldnestmax' 'fdn' number (default: 20)
3389 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 {not available when compiled without the |+folding|
3391 feature}
3392 Sets the maximum nesting of folds for the "indent" and "syntax"
3393 methods. This avoids that too many folds will be created. Using more
3394 than 20 doesn't work, because the internal limit is 20.
3395
3396 *'foldopen'* *'fdo'*
3397'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3398 search,tag,undo")
3399 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 {not available when compiled without the |+folding|
3401 feature}
3402 Specifies for which type of commands folds will be opened, if the
3403 command moves the cursor into a closed fold. It is a comma separated
3404 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003405 NOTE: When the command is part of a mapping this option is not used.
3406 Add the |zv| command to the mapping to get the same effect.
3407 (rationale: the mapping may want to control opening folds itself)
3408
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 item commands ~
3410 all any
3411 block "(", "{", "[[", "[{", etc.
3412 hor horizontal movements: "l", "w", "fx", etc.
3413 insert any command in Insert mode
3414 jump far jumps: "G", "gg", etc.
3415 mark jumping to a mark: "'m", CTRL-O, etc.
3416 percent "%"
3417 quickfix ":cn", ":crew", ":make", etc.
3418 search search for a pattern: "/", "n", "*", "gd", etc.
3419 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003420 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 tag jumping to a tag: ":ta", CTRL-T, etc.
3422 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 When a movement command is used for an operator (e.g., "dl" or "y%")
3424 this option is not used. This means the operator will include the
3425 whole closed fold.
3426 Note that vertical movements are not here, because it would make it
3427 very difficult to move onto a closed fold.
3428 In insert mode the folds containing the cursor will always be open
3429 when text is inserted.
3430 To close folds you can re-apply 'foldlevel' with the |zx| command or
3431 set the 'foldclose' option to "all".
3432
3433 *'foldtext'* *'fdt'*
3434'foldtext' 'fdt' string (default: "foldtext()")
3435 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 {not available when compiled without the |+folding|
3437 feature}
3438 An expression which is used to specify the text displayed for a closed
3439 fold. See |fold-foldtext|.
3440
Bram Moolenaar30b65812012-07-12 22:01:11 +02003441 The expression will be evaluated in the |sandbox| if set from a
3442 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003443 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003444
3445 It is not allowed to change text or jump to another window while
3446 evaluating 'foldtext' |textlock|.
3447
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003448 *'formatexpr'* *'fex'*
3449'formatexpr' 'fex' string (default "")
3450 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003451 {not available when compiled without the |+eval|
3452 feature}
3453 Expression which is evaluated to format a range of lines for the |gq|
3454 operator or automatic formatting (see 'formatoptions'). When this
3455 option is empty 'formatprg' is used.
3456
3457 The |v:lnum| variable holds the first line to be formatted.
3458 The |v:count| variable holds the number of lines to be formatted.
3459 The |v:char| variable holds the character that is going to be
3460 inserted if the expression is being evaluated due to
3461 automatic formatting. This can be empty. Don't insert
3462 it yet!
3463
3464 Example: >
3465 :set formatexpr=mylang#Format()
3466< This will invoke the mylang#Format() function in the
3467 autoload/mylang.vim file in 'runtimepath'. |autoload|
3468
3469 The expression is also evaluated when 'textwidth' is set and adding
3470 text beyond that limit. This happens under the same conditions as
3471 when internal formatting is used. Make sure the cursor is kept in the
3472 same spot relative to the text then! The |mode()| function will
3473 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003474
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003475 When the expression evaluates to non-zero Vim will fall back to using
3476 the internal format mechanism.
3477
3478 The expression will be evaluated in the |sandbox| when set from a
3479 modeline, see |sandbox-option|. That stops the option from working,
3480 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003481 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003482 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003483
Bram Moolenaar86b68352004-12-27 21:59:20 +00003484 *'formatlistpat'* *'flp'*
3485'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3486 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003487 A pattern that is used to recognize a list header. This is used for
3488 the "n" flag in 'formatoptions'.
3489 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003490 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003491 while still checking more characters. There must be a character
3492 following the pattern, when it matches the whole line it is handled
3493 like there is no match.
3494 The default recognizes a number, followed by an optional punctuation
3495 character and white space.
3496
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003497 *'formatoptions'* *'fo'*
3498'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3499 local to buffer
3500 This is a sequence of letters which describes how automatic
3501 formatting is to be done. See |fo-table|. When the 'paste' option is
3502 on, no formatting is done (like 'formatoptions' is empty). Commas can
3503 be inserted for readability.
3504 To avoid problems with flags that are added in the future, use the
3505 "+=" and "-=" feature of ":set" |add-option-flags|.
3506 NOTE: This option is set to the Vi default value when 'compatible' is
3507 set and to the Vim default value when 'compatible' is reset.
3508
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 *'formatprg'* *'fp'*
3510'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003511 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003513 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003515 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003516 If the 'formatexpr' option is not empty it will be used instead.
3517 Otherwise, if 'formatprg' option is an empty string, the internal
3518 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003519 Environment variables are expanded |:set_env|. See |option-backslash|
3520 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003521 This option cannot be set from a |modeline| or in the |sandbox|, for
3522 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523
Bram Moolenaard94464e2015-11-02 15:28:18 +01003524 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003525'fsync' 'fs' boolean (default on)
3526 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003527 When on, the library function fsync() will be called after writing a
3528 file. This will flush a file to disk, ensuring that it is safely
3529 written even on filesystems which do metadata-only journaling. This
3530 will force the harddrive to spin up on Linux systems running in laptop
3531 mode, so it may be undesirable in some situations. Be warned that
3532 turning this off increases the chances of data loss after a crash. On
3533 systems without an fsync() implementation, this variable is always
3534 off.
3535 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003536 'fsync' also applies to |writefile()|, unless a flag is used to
3537 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003538 This option cannot be set from a |modeline| or in the |sandbox|, for
3539 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003540
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3542'gdefault' 'gd' boolean (default off)
3543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 When on, the ":substitute" flag 'g' is default on. This means that
3545 all matches in a line are substituted instead of one. When a 'g' flag
3546 is given to a ":substitute" command, this will toggle the substitution
3547 of all or one match. See |complex-change|.
3548
3549 command 'gdefault' on 'gdefault' off ~
3550 :s/// subst. all subst. one
3551 :s///g subst. one subst. all
3552 :s///gg subst. all subst. one
3553
3554 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003555 DEPRECATED: Setting this option may break plugins that are not aware
3556 of this option. Also, many users get confused that adding the /g flag
3557 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558
3559 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003560'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 Format to recognize for the ":grep" command output.
3563 This is a scanf-like string that uses the same format as the
3564 'errorformat' option: see |errorformat|.
3565
3566 *'grepprg'* *'gp'*
3567'grepprg' 'gp' string (default "grep -n ",
3568 Unix: "grep -n $* /dev/null",
3569 Win32: "findstr /n" or "grep -n",
3570 VMS: "SEARCH/NUMBERS ")
3571 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003572 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 and '#' characters, which are expanded like when used in a command-
3574 line. The placeholder "$*" is allowed to specify where the arguments
3575 will be included. Environment variables are expanded |:set_env|. See
3576 |option-backslash| about including spaces and backslashes.
3577 When your "grep" accepts the "-H" argument, use this to make ":grep"
3578 also work well with a single file: >
3579 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003580< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003581 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3582 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003583 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 apply equally to 'grepprg'.
3585 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3586 otherwise it's "grep -n".
3587 This option cannot be set from a |modeline| or in the |sandbox|, for
3588 security reasons.
3589
3590 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3591'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3592 ve:ver35-Cursor,
3593 o:hor50-Cursor,
3594 i-ci:ver25-Cursor/lCursor,
3595 r-cr:hor20-Cursor/lCursor,
3596 sm:block-Cursor
3597 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003598 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 "n-v-c:block,o:hor50,i-ci:hor15,
3600 r-cr:hor30,sm:block")
3601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003603 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003605 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003606 height of the cursor can be changed. This can be done by specifying a
3607 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003608 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3609 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003611 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 mode-list and an argument-list:
3613 mode-list:argument-list,mode-list:argument-list,..
3614 The mode-list is a dash separated list of these modes:
3615 n Normal mode
3616 v Visual mode
3617 ve Visual mode with 'selection' "exclusive" (same as 'v',
3618 if not specified)
3619 o Operator-pending mode
3620 i Insert mode
3621 r Replace mode
3622 c Command-line Normal (append) mode
3623 ci Command-line Insert mode
3624 cr Command-line Replace mode
3625 sm showmatch in Insert mode
3626 a all modes
3627 The argument-list is a dash separated list of these arguments:
3628 hor{N} horizontal bar, {N} percent of the character height
3629 ver{N} vertical bar, {N} percent of the character width
3630 block block cursor, fills the whole character
3631 [only one of the above three should be present]
3632 blinkwait{N} *cursor-blinking*
3633 blinkon{N}
3634 blinkoff{N}
3635 blink times for cursor: blinkwait is the delay before
3636 the cursor starts blinking, blinkon is the time that
3637 the cursor is shown and blinkoff is the time that the
3638 cursor is not shown. The times are in msec. When one
3639 of the numbers is zero, there is no blinking. The
3640 default is: "blinkwait700-blinkon400-blinkoff250".
3641 These numbers are used for a missing entry. This
3642 means that blinking is enabled by default. To switch
3643 blinking off you can use "blinkon0". The cursor only
3644 blinks when Vim is waiting for input, not while
3645 executing a command.
3646 To make the cursor blink in an xterm, see
3647 |xterm-blink|.
3648 {group-name}
3649 a highlight group name, that sets the color and font
3650 for the cursor
3651 {group-name}/{group-name}
3652 Two highlight group names, the first is used when
3653 no language mappings are used, the other when they
3654 are. |language-mapping|
3655
3656 Examples of parts:
3657 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3658 block cursor with colors from the "nCursor"
3659 highlight group
3660 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3661 In Insert and Command-line Insert mode, use a
3662 30% vertical bar cursor with colors from the
3663 "iCursor" highlight group. Blink a bit
3664 faster.
3665
3666 The 'a' mode is different. It will set the given argument-list for
3667 all modes. It does not reset anything to defaults. This can be used
3668 to do a common setting for all modes. For example, to switch off
3669 blinking: "a:blinkon0"
3670
3671 Examples of cursor highlighting: >
3672 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3673 :highlight Cursor gui=NONE guifg=bg guibg=fg
3674<
3675 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003676 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677'guifont' 'gfn' string (default "")
3678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 {only available when compiled with GUI enabled}
3680 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003681 In its simplest form the value is just one font name.
3682 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683
3684 *'guifontset'* *'gfs'*
3685 *E250* *E252* *E234* *E597* *E598*
3686'guifontset' 'gfs' string (default "")
3687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 {only available when compiled with GUI enabled and
3689 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003690 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 When not empty, specifies two (or more) fonts to be used. The first
3692 one for normal English, the second one for your special language. See
3693 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003694
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3696'guifontwide' 'gfw' string (default "")
3697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 {only available when compiled with GUI enabled}
3699 When not empty, specifies a comma-separated list of fonts to be used
3700 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003701 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003702
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 *'guiheadroom'* *'ghr'*
3704'guiheadroom' 'ghr' number (default 50)
3705 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003706 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 The number of pixels subtracted from the screen height when fitting
3708 the GUI window on the screen. Set this before the GUI is started,
3709 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003710 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 lines will be left for window decorations and other items on the
3712 screen. Set it to a negative value to allow windows taller than the
3713 screen.
3714
3715 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003716'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3717 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003718 "aegimrLtT" (GTK, Motif and Athena),
3719 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003722 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 sequence of letters which describes what components and options of the
3724 GUI should be used.
3725 To avoid problems with flags that are added in the future, use the
3726 "+=" and "-=" feature of ":set" |add-option-flags|.
3727
Bram Moolenaar13568252018-03-16 20:46:58 +01003728 Valid characters are as follows:
3729 *'go-!'*
3730 '!' External commands are executed in a terminal window. Without
3731 this flag the MS-Windows GUI will open a console window to
3732 execute the command. The Unix GUI will simulate a dumb
3733 terminal to list the command output.
3734 The terminal window will be positioned at the bottom, and grow
3735 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003736 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 'a' Autoselect: If present, then whenever VISUAL mode is started,
3738 or the Visual area extended, Vim tries to become the owner of
3739 the windowing system's global selection. This means that the
3740 Visually highlighted text is available for pasting into other
3741 applications as well as into Vim itself. When the Visual mode
3742 ends, possibly due to an operation on the text, or when an
3743 application wants to paste the selection, the highlighted text
3744 is automatically yanked into the "* selection register.
3745 Thus the selection is still available for pasting into other
3746 applications after the VISUAL mode has ended.
3747 If not present, then Vim won't become the owner of the
3748 windowing system's global selection unless explicitly told to
3749 by a yank or delete operation for the "* register.
3750 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003751 *'go-P'*
3752 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003753 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003754 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003755 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 applies to the modeless selection.
3757
3758 'guioptions' autoselect Visual autoselect modeless ~
3759 "" - -
3760 "a" yes yes
3761 "A" - yes
3762 "aA" yes yes
3763
Bram Moolenaar02467872007-05-06 13:22:01 +00003764 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 'c' Use console dialogs instead of popup dialogs for simple
3766 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003767 *'go-d'*
3768 'd' Use dark theme variant if available. Currently only works for
3769 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003770 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003771 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003772 'guitablabel' can be used to change the text in the labels.
3773 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003774 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003775 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003776 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 'f' Foreground: Don't use fork() to detach the GUI from the shell
3778 where it was started. Use this for programs that wait for the
3779 editor to finish (e.g., an e-mail program). Alternatively you
3780 can use "gvim -f" or ":gui -f" to start the GUI in the
3781 foreground. |gui-fork|
3782 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003783 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003784 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3786 corner of the window. It's black&white on non-GTK, because of
3787 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003788 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003790 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003791 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003793 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003795 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003796 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 'g' Grey menu items: Make menu items that are not active grey. If
3798 'g' is not included inactive menu items are not shown at all.
3799 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003800 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 't' Include tearoff menu items. Currently only works for Win32,
3802 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003803 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003804 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003805 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003806 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003808 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'R' Right-hand scrollbar is present when there is a vertically
3810 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003811 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'L' Left-hand scrollbar is present when there is a vertically
3815 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003816 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3818 the longest visible line, or on the cursor line if the 'h'
3819 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003820 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 'h' Limit horizontal scrollbar size to the length of the cursor
3822 line. Reduces computations. |gui-horiz-scroll|
3823
3824 And yes, you may even have scrollbars on the left AND the right if
3825 you really want to :-). See |gui-scrollbars| for more information.
3826
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003827 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 'v' Use a vertical button layout for dialogs. When not included,
3829 a horizontal layout is preferred, but when it doesn't fit a
3830 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003831 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 'p' Use Pointer callbacks for X11 GUI. This is required for some
3833 window managers. If the cursor is not blinking or hollow at
3834 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003835 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003837 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003838 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003839 *'go-k'*
3840 'k' Keep the GUI window size when adding/removing a scrollbar, or
3841 toolbar, tabline, etc. Instead, the behavior is similar to
3842 when the window is maximized and will adjust 'lines' and
3843 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003844 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003845 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003846
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 *'guipty'* *'noguipty'*
3848'guipty' boolean (default on)
3849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 {only available when compiled with GUI enabled}
3851 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3852 I/O to/from shell commands. See |gui-pty|.
3853
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003854 *'guitablabel'* *'gtl'*
3855'guitablabel' 'gtl' string (default empty)
3856 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003857 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003858 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003859 pages line. When empty and when the result is empty Vim will use a
3860 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003861
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003862 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003863 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003864 The expression will be evaluated in the |sandbox| when set from a
3865 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003866 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003867
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003868 Only used when the GUI tab pages line is displayed. 'e' must be
3869 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3870 used.
3871
Bram Moolenaar57657d82006-04-21 22:12:41 +00003872 *'guitabtooltip'* *'gtt'*
3873'guitabtooltip' 'gtt' string (default empty)
3874 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003875 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003876 When nonempty describes the text to use in a tooltip for the GUI tab
3877 pages line. When empty Vim will use a default tooltip.
3878 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003879 You can include a line break. Simplest method is to use |:let|: >
3880 :let &guitabtooltip = "line one\nline two"
3881<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003882
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003884'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 (others) "$VIMRUNTIME/doc/help.txt")
3886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 Name of the main help file. All distributed help files should be
3888 placed together in one directory. Additionally, all "doc" directories
3889 in 'runtimepath' will be used.
3890 Environment variables are expanded |:set_env|. For example:
3891 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003892 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 spaces and backslashes.
3894 This option cannot be set from a |modeline| or in the |sandbox|, for
3895 security reasons.
3896
3897 *'helpheight'* *'hh'*
3898'helpheight' 'hh' number (default 20)
3899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 Minimal initial height of the help window when it is opened with the
3901 ":help" command. The initial height of the help window is half of the
3902 current window, or (when the 'ea' option is on) the same as other
3903 windows. When the height is less than 'helpheight', the height is
3904 set to 'helpheight'. Set to zero to disable.
3905
3906 *'helplang'* *'hlg'*
3907'helplang' 'hlg' string (default: messages language or empty)
3908 global
3909 {only available when compiled with the |+multi_lang|
3910 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 Comma separated list of languages. Vim will use the first language
3912 for which the desired help can be found. The English help will always
3913 be used as a last resort. You can add "en" to prefer English over
3914 another language, but that will only find tags that exist in that
3915 language and not in the English help.
3916 Example: >
3917 :set helplang=de,it
3918< This will first search German, then Italian and finally English help
3919 files.
3920 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3921 try to find the tag in the current language before using this option.
3922 See |help-translated|.
3923
3924 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3925'hidden' 'hid' boolean (default off)
3926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 When off a buffer is unloaded when it is |abandon|ed. When on a
3928 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3929 displayed in another window, it does not become hidden, of course.
3930 The commands that move through the buffer list sometimes make a buffer
3931 hidden although the 'hidden' option is off: When the buffer is
3932 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003933 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003934 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 This option is set for one command with ":hide {command}" |:hide|.
3936 WARNING: It's easy to forget that you have changes in hidden buffers.
3937 Think twice when using ":q!" or ":qa!".
3938
3939 *'highlight'* *'hl'*
3940'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003941 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3942 d:Directory,e:ErrorMsg,i:IncSearch,
3943 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003944 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003945 N:CursorLineNr,r:Question,s:StatusLine,
3946 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003947 v:Visual,V:VisualNOS,w:WarningMsg,
3948 W:WildMenu,f:Folded,F:FoldColumn,
3949 A:DiffAdd,C:DiffChange,D:DiffDelete,
3950 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003951 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003952 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003953 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3954 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003955 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003956 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 This option can be used to set highlighting mode for various
3959 occasions. It is a comma separated list of character pairs. The
3960 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003961 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003963 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3964 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 characters from 'showbreak'
3966 |hl-Directory| d directories in CTRL-D listing and other special
3967 things in listings
3968 |hl-ErrorMsg| e error messages
3969 h (obsolete, ignored)
3970 |hl-IncSearch| i 'incsearch' highlighting
3971 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3972 |hl-MoreMsg| m |more-prompt|
3973 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003974 |hl-LineNr| n line number for ":number" and ":#" commands, and
3975 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003976 |hl-LineNrAbove| a line number above the cursor for when the
3977 'relativenumber' option is set.
3978 |hl-LineNrBelow| b line number below the cursor for when the
3979 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003980 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3981 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 |hl-Question| r |hit-enter| prompt and yes/no questions
3983 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003984 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3986 |hl-VertSplit| c column used to separate vertically split windows
3987 |hl-Visual| v Visual mode
3988 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3989 Selection" Only X11 Gui's |gui-x11| and
3990 |xterm-clipboard|.
3991 |hl-WarningMsg| w warning messages
3992 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3993 |hl-Folded| f line used for closed folds
3994 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003995 |hl-DiffAdd| A added line in diff mode
3996 |hl-DiffChange| C changed line in diff mode
3997 |hl-DiffDelete| D deleted line in diff mode
3998 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004000 |hl-Conceal| - the placeholders used for concealed characters
4001 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004002 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004003 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004004 |hl-SpellRare| R rare word |spell|
4005 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004006 |hl-Pmenu| + popup menu normal line
4007 |hl-PmenuSel| = popup menu selected line
4008 |hl-PmenuSbar| x popup menu scrollbar
4009 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010
4011 The display modes are:
4012 r reverse (termcap entry "mr" and "me")
4013 i italic (termcap entry "ZH" and "ZR")
4014 b bold (termcap entry "md" and "me")
4015 s standout (termcap entry "so" and "se")
4016 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004017 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004018 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 n no highlighting
4020 - no highlighting
4021 : use a highlight group
4022 The default is used for occasions that are not included.
4023 If you want to change what the display modes do, see |dos-colors|
4024 for an example.
4025 When using the ':' display mode, this must be followed by the name of
4026 a highlight group. A highlight group can be used to define any type
4027 of highlighting, including using color. See |:highlight| on how to
4028 define one. The default uses a different group for each occasion.
4029 See |highlight-default| for the default highlight groups.
4030
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004032'history' 'hi' number (Vim default: 50, Vi default: 0,
4033 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004036 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004038 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 NOTE: This option is set to the Vi default value when 'compatible' is
4040 set and to the Vim default value when 'compatible' is reset.
4041
4042 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4043'hkmap' 'hk' boolean (default off)
4044 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 {only available when compiled with the |+rightleft|
4046 feature}
4047 When on, the keyboard is mapped for the Hebrew character set.
4048 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4049 toggle this option. See |rileft.txt|.
4050 NOTE: This option is reset when 'compatible' is set.
4051
4052 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4053'hkmapp' 'hkp' boolean (default off)
4054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 {only available when compiled with the |+rightleft|
4056 feature}
4057 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4058 This is useful if you have a non-Hebrew keyboard.
4059 See |rileft.txt|.
4060 NOTE: This option is reset when 'compatible' is set.
4061
Bram Moolenaar036986f2017-03-16 17:41:02 +01004062 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4063'hlsearch' 'hls' boolean (default off)
4064 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004065 {not available when compiled without the
4066 |+extra_search| feature}
4067 When there is a previous search pattern, highlight all its matches.
4068 The type of highlighting used can be set with the 'l' occasion in the
4069 'highlight' option. This uses the "Search" highlight group by
4070 default. Note that only the matching text is highlighted, any offsets
4071 are not applied.
4072 See also: 'incsearch' and |:match|.
4073 When you get bored looking at the highlighted matches, you can turn it
4074 off with |:nohlsearch|. This does not change the option value, as
4075 soon as you use a search command, the highlighting comes back.
4076 'redrawtime' specifies the maximum time spent on finding matches.
4077 When the search pattern can match an end-of-line, Vim will try to
4078 highlight all of the matched text. However, this depends on where the
4079 search starts. This will be the first line in the window or the first
4080 line below a closed fold. A match in a previous line which is not
4081 drawn may not continue in a newly drawn line.
4082 You can specify whether the highlight status is restored on startup
4083 with the 'h' flag in 'viminfo' |viminfo-h|.
4084 NOTE: This option is reset when 'compatible' is set.
4085
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 *'icon'* *'noicon'*
4087'icon' boolean (default off, on when title can be restored)
4088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 {not available when compiled without the |+title|
4090 feature}
4091 When on, the icon text of the window will be set to the value of
4092 'iconstring' (if it is not empty), or to the name of the file
4093 currently being edited. Only the last part of the name is used.
4094 Overridden by the 'iconstring' option.
4095 Only works if the terminal supports setting window icons (currently
4096 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4097 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4098 builtin termcap).
4099 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004100 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004102 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103
4104 *'iconstring'*
4105'iconstring' string (default "")
4106 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 {not available when compiled without the |+title|
4108 feature}
4109 When this option is not empty, it will be used for the icon text of
4110 the window. This happens only when the 'icon' option is on.
4111 Only works if the terminal supports setting window icon text
4112 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4113 Does not work for MS Windows.
4114 When Vim was compiled with HAVE_X11 defined, the original icon will be
4115 restored if possible |X11|.
4116 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004119 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 {not available when compiled without the |+statusline| feature}
4121
4122 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4123'ignorecase' 'ic' boolean (default off)
4124 global
4125 Ignore case in search patterns. Also used when searching in the tags
4126 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004127 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 Can be overruled by using "\c" or "\C" in the pattern, see
4129 |/ignorecase|.
4130
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004131 *'imactivatefunc'* *'imaf'*
4132'imactivatefunc' 'imaf' string (default "")
4133 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004134 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004135 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004136 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004137 The expression will be evaluated in the |sandbox| when set from a
4138 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004139
4140 Example: >
4141 function ImActivateFunc(active)
4142 if a:active
4143 ... do something
4144 else
4145 ... do something
4146 endif
4147 " return value is not used
4148 endfunction
4149 set imactivatefunc=ImActivateFunc
4150<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 *'imactivatekey'* *'imak'*
4152'imactivatekey' 'imak' string (default "")
4153 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004155 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 Specifies the key that your Input Method in X-Windows uses for
4157 activation. When this is specified correctly, vim can fully control
4158 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4159 You can't use this option to change the activation key, the option
4160 tells Vim what the key is.
4161 Format:
4162 [MODIFIER_FLAG-]KEY_STRING
4163
4164 These characters can be used for MODIFIER_FLAG (case is ignored):
4165 S Shift key
4166 L Lock key
4167 C Control key
4168 1 Mod1 key
4169 2 Mod2 key
4170 3 Mod3 key
4171 4 Mod4 key
4172 5 Mod5 key
4173 Combinations are allowed, for example "S-C-space" or "SC-space" are
4174 both shift+ctrl+space.
4175 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4176
4177 Example: >
4178 :set imactivatekey=S-space
4179< "S-space" means shift+space. This is the activation key for kinput2 +
4180 canna (Japanese), and ami (Korean).
4181
4182 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4183'imcmdline' 'imc' boolean (default off)
4184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 When set the Input Method is always on when starting to edit a command
4186 line, unless entering a search pattern (see 'imsearch' for that).
4187 Setting this option is useful when your input method allows entering
4188 English characters directly, e.g., when it's used to type accented
4189 characters with dead keys.
4190
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004191 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4193 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 When set the Input Method is never used. This is useful to disable
4195 the IM when it doesn't work properly.
4196 Currently this option is on by default for SGI/IRIX machines. This
4197 may change in later releases.
4198
4199 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004200'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 Specifies whether :lmap or an Input Method (IM) is to be used in
4203 Insert mode. Valid values:
4204 0 :lmap is off and IM is off
4205 1 :lmap is ON and IM is off
4206 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 To always reset the option to zero when leaving Insert mode with <Esc>
4208 this can be used: >
4209 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4210< This makes :lmap and IM turn off automatically when leaving Insert
4211 mode.
4212 Note that this option changes when using CTRL-^ in Insert mode
4213 |i_CTRL-^|.
4214 The value is set to 1 when setting 'keymap' to a valid keymap name.
4215 It is also used for the argument of commands like "r" and "f".
4216 The value 0 may not work correctly with Athena and Motif with some XIM
4217 methods. Use 'imdisable' to disable XIM then.
4218
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004219 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004220 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004221 |+multi_byte_ime| or |global-ime|.
4222
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004224'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 Specifies whether :lmap or an Input Method (IM) is to be used when
4227 entering a search pattern. Valid values:
4228 -1 the value of 'iminsert' is used, makes it look like
4229 'iminsert' is also used when typing a search pattern
4230 0 :lmap is off and IM is off
4231 1 :lmap is ON and IM is off
4232 2 :lmap is off and IM is ON
4233 Note that this option changes when using CTRL-^ in Command-line mode
4234 |c_CTRL-^|.
4235 The value is set to 1 when it is not -1 and setting the 'keymap'
4236 option to a valid keymap name.
4237 The value 0 may not work correctly with Athena and Motif with some XIM
4238 methods. Use 'imdisable' to disable XIM then.
4239
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004240 *'imstatusfunc'* *'imsf'*
4241'imstatusfunc' 'imsf' string (default "")
4242 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004243 This option specifies a function that is called to obtain the status
4244 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004245 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004246
4247 Example: >
4248 function ImStatusFunc()
4249 let is_active = ...do something
4250 return is_active ? 1 : 0
4251 endfunction
4252 set imstatusfunc=ImStatusFunc
4253<
4254 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004255 The expression will be evaluated in the |sandbox| when set from a
4256 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004257
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004258 *'imstyle'* *'imst'*
4259'imstyle' 'imst' number (default 1)
4260 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004261 {only available when compiled with |+xim| and
4262 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004263 This option specifies the input style of Input Method:
4264 0 use on-the-spot style
4265 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004266 See: |xim-input-style|
4267
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004268 For a long time on-the-spot style had been used in the GTK version of
4269 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004270 |single-repeat|, etc. Therefore over-the-spot style becomes the
4271 default now. This should work fine for most people, however if you
4272 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004273 The expression will be evaluated in the |sandbox| when set from a
4274 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 *'include'* *'inc'*
4277'include' 'inc' string (default "^\s*#\s*include")
4278 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 {not available when compiled without the
4280 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004281 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 pattern, just like for the "/" command (See |pattern|). The default
4283 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004284 "]I", "[d", etc.
4285 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004286 comes after the matched pattern. But if "\zs" appears in the pattern
4287 then the text matched from "\zs" to the end, or until "\ze" if it
4288 appears, is used as the file name. Use this to include characters
4289 that are not in 'isfname', such as a space. You can then use
4290 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004291 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292
4293 *'includeexpr'* *'inex'*
4294'includeexpr' 'inex' string (default "")
4295 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004297 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004299 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 :set includeexpr=substitute(v:fname,'\\.','/','g')
4301< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004302
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004304 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 Also used for |<cfile>|.
4306
Bram Moolenaar30b65812012-07-12 22:01:11 +02004307 The expression will be evaluated in the |sandbox| when set from a
4308 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004309 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004310
4311 It is not allowed to change text or jump to another window while
4312 evaluating 'includeexpr' |textlock|.
4313
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004315'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4316 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004319 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004320 While typing a search command, show where the pattern, as it was typed
4321 so far, matches. The matched string is highlighted. If the pattern
4322 is invalid or not found, nothing is shown. The screen will be updated
4323 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004324 Also applies to the pattern in commands: >
4325 :global
4326 :lvimgrep
4327 :lvimgrepadd
4328 :smagic
4329 :snomagic
4330 :sort
4331 :substitute
4332 :vglobal
4333 :vimgrep
4334 :vimgrepadd
4335< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004336 original position when no match is found and when pressing <Esc>. You
4337 still need to finish the search command with <Enter> to move the
4338 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004339 You can use the CTRL-G and CTRL-T keys to move to the next and
4340 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004341 When compiled with the |+reltime| feature Vim only searches for about
4342 half a second. With a complicated pattern and/or a lot of text the
4343 match may not be found. This is to avoid that Vim hangs while you
4344 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004345 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004346 When 'hlsearch' is on, all matched strings are highlighted too while
4347 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004348 If you don't want to turn 'hlsearch' on, but want to highlight all
4349 matches while searching, you can turn on and off 'hlsearch' with
4350 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004351 augroup vimrc-incsearch-highlight
4352 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004353 autocmd CmdlineEnter /,\? :set hlsearch
4354 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004355 augroup END
4356<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004357 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004358 to the command line. If 'ignorecase' and 'smartcase' are set and the
4359 command line has no uppercase characters, the added character is
4360 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004361 CTRL-R CTRL-W can be used to add the word at the end of the current
4362 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 NOTE: This option is reset when 'compatible' is set.
4364
4365 *'indentexpr'* *'inde'*
4366'indentexpr' 'inde' string (default "")
4367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 {not available when compiled without the |+cindent|
4369 or |+eval| features}
4370 Expression which is evaluated to obtain the proper indent for a line.
4371 It is used when a new line is created, for the |=| operator and
4372 in Insert mode as specified with the 'indentkeys' option.
4373 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004374 'smartindent' indenting. When 'lisp' is set, this option is
4375 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 When 'paste' is set this option is not used for indenting.
4377 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004378 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 when the expression is evaluated (but it may be moved around).
4380 The expression must return the number of spaces worth of indent. It
4381 can return "-1" to keep the current indent (this means 'autoindent' is
4382 used for the indent).
4383 Functions useful for computing the indent are |indent()|, |cindent()|
4384 and |lispindent()|.
4385 The evaluation of the expression must not have side effects! It must
4386 not change the text, jump to another window, etc. Afterwards the
4387 cursor position is always restored, thus the cursor may be moved.
4388 Normally this option would be set to call a function: >
4389 :set indentexpr=GetMyIndent()
4390< Error messages will be suppressed, unless the 'debug' option contains
4391 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004392 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004393 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394
Bram Moolenaar30b65812012-07-12 22:01:11 +02004395 The expression will be evaluated in the |sandbox| when set from a
4396 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004397 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004398
4399 It is not allowed to change text or jump to another window while
4400 evaluating 'indentexpr' |textlock|.
4401
4402
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004404'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 {not available when compiled without the |+cindent|
4407 feature}
4408 A list of keys that, when typed in Insert mode, cause reindenting of
4409 the current line. Only happens if 'indentexpr' isn't empty.
4410 The format is identical to 'cinkeys', see |indentkeys-format|.
4411 See |C-indenting| and |indent-expression|.
4412
4413 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4414'infercase' 'inf' boolean (default off)
4415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004417 'ignorecase' is also on, the case of the match is adjusted depending
4418 on the typed text. If the typed text contains a lowercase letter
4419 where the match has an upper case letter, the completed part is made
4420 lowercase. If the typed text has no lowercase letters and the match
4421 has a lowercase letter where the typed text has an uppercase letter,
4422 and there is a letter before it, the completed part is made uppercase.
4423 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424
4425 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4426'insertmode' 'im' boolean (default off)
4427 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 Makes Vim work in a way that Insert mode is the default mode. Useful
4429 if you want to use Vim as a modeless editor. Used for |evim|.
4430 These Insert mode commands will be useful:
4431 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004432 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 this is a mapping, it is executed as if 'insertmode' was off.
4434 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004436 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4437 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438
4439 These items change when 'insertmode' is set:
4440 - when starting to edit of a file, Vim goes to Insert mode.
4441 - <Esc> in Insert mode is a no-op and beeps.
4442 - <Esc> in Normal mode makes Vim go to Insert mode.
4443 - CTRL-L in Insert mode is a command, it is not inserted.
4444 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4445 However, when <Esc> is used inside a mapping, it behaves like
4446 'insertmode' was not set. This was done to be able to use the same
4447 mappings with 'insertmode' set or not set.
4448 When executing commands with |:normal| 'insertmode' is not used.
4449
4450 NOTE: This option is reset when 'compatible' is set.
4451
4452 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004453'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4455 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4456 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4457 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4458 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4459 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 The characters specified by this option are included in file names and
4461 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004462 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 Multi-byte characters 256 and above are always included, only the
4464 characters up to 255 are specified with this option.
4465 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004466 Think twice before adding white space to this option. Although a
4467 space may appear inside a file name, the effect will be that Vim
4468 doesn't know where a file name starts or ends when doing completion.
4469 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470
4471 Note that on systems using a backslash as path separator, Vim tries to
4472 do its best to make it work as you would expect. That is a bit
4473 tricky, since Vi originally used the backslash to escape special
4474 characters. Vim will not remove a backslash in front of a normal file
4475 name character on these systems, but it will on Unix and alikes. The
4476 '&' and '^' are not included by default, because these are special for
4477 cmd.exe.
4478
4479 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004480 Each part can be a single character number or a range. A range is two
4481 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 decimal number between 0 and 255 or the ASCII character itself (does
4483 not work for digits). Example:
4484 "_,-,128-140,#-43" (include '_' and '-' and the range
4485 128 to 140 and '#' to 43)
4486 If a part starts with '^', the following character number or range
4487 will be excluded from the option. The option is interpreted from left
4488 to right. Put the excluded character after the range where it is
4489 included. To include '^' itself use it as the last character of the
4490 option or the end of a range. Example:
4491 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4492 If the character is '@', all characters where isalpha() returns TRUE
4493 are included. Normally these are the characters a to z and A to Z,
4494 plus accented characters. To include '@' itself use "@-@". Examples:
4495 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004496 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 "a-z,A-Z,@-@" All letters plus the '@' character.
4498 A comma can be included by using it where a character number is
4499 expected. Example:
4500 "48-57,,,_" Digits, comma and underscore.
4501 A comma can be excluded by prepending a '^'. Example:
4502 " -~,^,,9" All characters from space to '~', excluding
4503 comma, plus <Tab>.
4504 See |option-backslash| about including spaces and backslashes.
4505
4506 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004507'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 "@,48-57,_,128-167,224-235"
4509 otherwise: "@,48-57,_,192-255")
4510 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 The characters given by this option are included in identifiers.
4512 Identifiers are used in recognizing environment variables and after a
4513 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004514 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004515 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004517 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4519
4520 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004521'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 "@,48-57,_,128-167,224-235"
4523 otherwise: "@,48-57,_,192-255"
4524 Vi default: "@,48-57,_")
4525 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004527 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004528 'isfname' for a description of the format of this option. For '@'
4529 characters above 255 check the "word" character class.
4530 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 For a help file it is set to all non-blank printable characters except
4532 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4533 command).
4534 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004535 This option also influences syntax highlighting, unless the syntax
4536 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 NOTE: This option is set to the Vi default value when 'compatible' is
4538 set and to the Vim default value when 'compatible' is reset.
4539
4540 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004541'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 "@,~-255"; otherwise: "@,161-255")
4543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 The characters given by this option are displayed directly on the
4545 screen. It is also used for "\p" in a |pattern|. The characters from
4546 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4547 even when they are not included in 'isprint' or excluded. See
4548 'isfname' for a description of the format of this option.
4549
4550 Non-printable characters are displayed with two characters:
4551 0 - 31 "^@" - "^_"
4552 32 - 126 always single characters
4553 127 "^?"
4554 128 - 159 "~@" - "~_"
4555 160 - 254 "| " - "|~"
4556 255 "~?"
4557 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4558 displayed as <xx>, with the hexadecimal value of the byte.
4559 When 'display' contains "uhex" all unprintable characters are
4560 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004561 The SpecialKey highlighting will be used for unprintable characters.
4562 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563
4564 Multi-byte characters 256 and above are always included, only the
4565 characters up to 255 are specified with this option. When a character
4566 is printable but it is not available in the current font, a
4567 replacement character will be shown.
4568 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4569 There is no option to specify these characters.
4570
4571 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4572'joinspaces' 'js' boolean (default on)
4573 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 Insert two spaces after a '.', '?' and '!' with a join command.
4575 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4576 Otherwise only one space is inserted.
4577 NOTE: This option is set when 'compatible' is set.
4578
4579 *'key'*
4580'key' string (default "")
4581 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004582 {only available when compiled with the |+cryptv|
4583 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004585 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 Careful: Do not set the key value by hand, someone might see the typed
4587 key. Use the |:X| command. But you can make 'key' empty: >
4588 :set key=
4589< It is not possible to get the value of this option with ":set key" or
4590 "echo &key". This is to avoid showing it to someone who shouldn't
4591 know. It also means you cannot see it yourself once you have set it,
4592 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004593 You can use "&key" in an expression to detect whether encryption is
4594 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595
4596 *'keymap'* *'kmp'* *E544*
4597'keymap' 'kmp' string (default "")
4598 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 {only available when compiled with the |+keymap|
4600 feature}
4601 Name of a keyboard mapping. See |mbyte-keymap|.
4602 Setting this option to a valid keymap name has the side effect of
4603 setting 'iminsert' to one, so that the keymap becomes effective.
4604 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004605 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606
4607 *'keymodel'* *'km'*
4608'keymodel' 'km' string (default "")
4609 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 List of comma separated words, which enable special things that keys
4611 can do. These values can be used:
4612 startsel Using a shifted special key starts selection (either
4613 Select mode or Visual mode, depending on "key" being
4614 present in 'selectmode').
4615 stopsel Using a not-shifted special key stops selection.
4616 Special keys in this context are the cursor keys, <End>, <Home>,
4617 <PageUp> and <PageDown>.
4618 The 'keymodel' option is set by the |:behave| command.
4619
4620 *'keywordprg'* *'kp'*
4621'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004622 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 Program to use for the |K| command. Environment variables are
4625 expanded |:set_env|. ":help" may be used to access the Vim internal
4626 help. (Note that previously setting the global option to the empty
4627 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004628 When the first character is ":", the command is invoked as a Vim
4629 Ex command prefixed with [count].
4630 When "man", "man -s" or an Ex command is used, Vim will automatically
4631 translate a count for the "K" command and pass it as the first
4632 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 See |option-backslash| about including spaces and backslashes.
4634 Example: >
4635 :set keywordprg=man\ -s
4636< This option cannot be set from a |modeline| or in the |sandbox|, for
4637 security reasons.
4638
4639 *'langmap'* *'lmap'* *E357* *E358*
4640'langmap' 'lmap' string (default "")
4641 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 {only available when compiled with the |+langmap|
4643 feature}
4644 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004645 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004646 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 care of translating these special characters to the original meaning
4648 of the key. This means you don't have to change the keyboard mode to
4649 be able to execute Normal mode commands.
4650 This is the opposite of the 'keymap' option, where characters are
4651 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004652 Also consider setting 'langremap' to off, to prevent 'langmap' from
4653 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004654 This option cannot be set from a |modeline| or in the |sandbox|, for
4655 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004657 Example (for Greek, in UTF-8): *greek* >
4658 :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 +00004659< Example (exchanges meaning of z and y for commands): >
4660 :set langmap=zy,yz,ZY,YZ
4661<
4662 The 'langmap' option is a list of parts, separated with commas. Each
4663 part can be in one of two forms:
4664 1. A list of pairs. Each pair is a "from" character immediately
4665 followed by the "to" character. Examples: "aA", "aAbBcC".
4666 2. A list of "from" characters, a semi-colon and a list of "to"
4667 characters. Example: "abc;ABC"
4668 Example: "aA,fgh;FGH,cCdDeE"
4669 Special characters need to be preceded with a backslash. These are
4670 ";", ',' and backslash itself.
4671
4672 This will allow you to activate vim actions without having to switch
4673 back and forth between the languages. Your language characters will
4674 be understood as normal vim English characters (according to the
4675 langmap mappings) in the following cases:
4676 o Normal/Visual mode (commands, buffer/register names, user mappings)
4677 o Insert/Replace Mode: Register names after CTRL-R
4678 o Insert/Replace Mode: Mappings
4679 Characters entered in Command-line mode will NOT be affected by
4680 this option. Note that this option can be changed at any time
4681 allowing to switch between mappings for different languages/encodings.
4682 Use a mapping to avoid having to type it each time!
4683
4684 *'langmenu'* *'lm'*
4685'langmenu' 'lm' string (default "")
4686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 {only available when compiled with the |+menu| and
4688 |+multi_lang| features}
4689 Language to use for menu translation. Tells which file is loaded
4690 from the "lang" directory in 'runtimepath': >
4691 "lang/menu_" . &langmenu . ".vim"
4692< (without the spaces). For example, to always use the Dutch menus, no
4693 matter what $LANG is set to: >
4694 :set langmenu=nl_NL.ISO_8859-1
4695< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004696 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 If your $LANG is set to a non-English language but you do want to use
4698 the English menus: >
4699 :set langmenu=none
4700< This option must be set before loading menus, switching on filetype
4701 detection or syntax highlighting. Once the menus are defined setting
4702 this option has no effect. But you could do this: >
4703 :source $VIMRUNTIME/delmenu.vim
4704 :set langmenu=de_DE.ISO_8859-1
4705 :source $VIMRUNTIME/menu.vim
4706< Warning: This deletes all menus that you defined yourself!
4707
Bram Moolenaard94464e2015-11-02 15:28:18 +01004708 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004709'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004710 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004711 {only available when compiled with the |+langmap|
4712 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004713 This is just like 'langremap' but with the value inverted. It only
4714 exists for backwards compatibility. When setting 'langremap' then
4715 'langnoremap' is set to the inverted value, and the other way around.
4716
4717 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004718'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004719 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004720 {only available when compiled with the |+langmap|
4721 feature}
4722 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004723 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004724 'langmap' disables some of your mappings, try resetting this option.
4725 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004726 that works for you to avoid mappings to break.
4727
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 *'laststatus'* *'ls'*
4729'laststatus' 'ls' number (default 1)
4730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 The value of this option influences when the last window will have a
4732 status line:
4733 0: never
4734 1: only if there are at least two windows
4735 2: always
4736 The screen looks nicer with a status line if you have several
4737 windows, but it takes another screen line. |status-line|
4738
4739 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4740'lazyredraw' 'lz' boolean (default off)
4741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 When this option is set, the screen will not be redrawn while
4743 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004744 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 update use |:redraw|.
4746
4747 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4748'linebreak' 'lbr' boolean (default off)
4749 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004750 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004752 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 than at the last character that fits on the screen. Unlike
4754 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004755 it only affects the way the file is displayed, not its contents.
4756 If 'breakindent' is set, line is visually indented. Then, the value
4757 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004758 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 Note that <Tab> characters after an <EOL> are mostly not displayed
4760 with the right amount of white space.
4761
4762 *'lines'* *E593*
4763'lines' number (default 24 or terminal height)
4764 global
4765 Number of lines of the Vim window.
4766 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004767 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 When Vim is running in the GUI or in a resizable window, setting this
4769 option will cause the window size to be changed. When you only want
4770 to use the size for the GUI, put the command in your |gvimrc| file.
4771 Vim limits the number of lines to what fits on the screen. You can
4772 use this command to get the tallest window possible: >
4773 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004774< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004775 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 When you set this option and Vim is unable to change the physical
4777 number of lines of the display, the display may be messed up.
4778
4779 *'linespace'* *'lsp'*
4780'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 {only in the GUI}
4783 Number of pixel lines inserted between characters. Useful if the font
4784 uses the full character cell height, making lines touch each other.
4785 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004786 With some fonts there can be too much room between lines (to have
4787 space for ascents and descents). Then it makes sense to set
4788 'linespace' to a negative value. This may cause display problems
4789 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790
4791 *'lisp'* *'nolisp'*
4792'lisp' boolean (default off)
4793 local to buffer
4794 {not available when compiled without the |+lispindent|
4795 feature}
4796 Lisp mode: When <Enter> is typed in insert mode set the indent for
4797 the next line to Lisp standards (well, sort of). Also happens with
4798 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4799 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4800 better. Also see 'lispwords'.
4801 The '-' character is included in keyword characters. Redefines the
4802 "=" operator to use this same indentation algorithm rather than
4803 calling an external program if 'equalprg' is empty.
4804 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
4806 *'lispwords'* *'lw'*
4807'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004808 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 {not available when compiled without the |+lispindent|
4810 feature}
4811 Comma separated list of words that influence the Lisp indenting.
4812 |'lisp'|
4813
4814 *'list'* *'nolist'*
4815'list' boolean (default off)
4816 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004817 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4818 line. Useful to see the difference between tabs and spaces and for
4819 trailing blanks. Further changed by the 'listchars' option.
4820
4821 The cursor is displayed at the start of the space a Tab character
4822 occupies, not at the end as usual in Normal mode. To get this cursor
4823 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004824 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004825<
4826 Note that list mode will also affect formatting (set with 'textwidth'
4827 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 changing the way tabs are displayed.
4829
4830 *'listchars'* *'lcs'*
4831'listchars' 'lcs' string (default "eol:$")
4832 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004833 Strings to use in 'list' mode and for the |:list| command. It is a
4834 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004835 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 eol:c Character to show at the end of each line. When
4837 omitted, there is no extra character at the end of the
4838 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004839 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004840 tab:xy[z] Two or three characters to be used to show a tab.
4841 The third character is optional.
4842
4843 tab:xy The 'x' is always used, then 'y' as many times as will
4844 fit. Thus "tab:>-" displays:
4845 >
4846 >-
4847 >--
4848 etc.
4849
4850 tab:xyz The 'z' is always used, then 'x' is prepended, and
4851 then 'y' is used as many times as will fit. Thus
4852 "tab:<->" displays:
4853 >
4854 <>
4855 <->
4856 <-->
4857 etc.
4858
4859 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004860 *lcs-space*
4861 space:c Character to show for a space. When omitted, spaces
4862 are left blank.
4863 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004864 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004865 trailing spaces are blank. Overrides the "space"
4866 setting for trailing spaces.
4867 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 extends:c Character to show in the last column, when 'wrap' is
4869 off and the line continues beyond the right of the
4870 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004871 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004872 precedes:c Character to show in the first visible column of the
4873 physical line, when there is text preceding the
4874 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004875 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004876 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004877 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004878 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004879 nbsp:c Character to show for a non-breakable space character
4880 (0xA0 (160 decimal) and U+202F). Left blank when
4881 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004883 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004885 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886
4887 Examples: >
4888 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004889 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 :set lcs=extends:>,precedes:<
4891< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004892 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004893 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894
4895 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4896'loadplugins' 'lpl' boolean (default on)
4897 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 When on the plugin scripts are loaded when starting up |load-plugins|.
4899 This option can be reset in your |vimrc| file to disable the loading
4900 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004901 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4902 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
Bram Moolenaard94464e2015-11-02 15:28:18 +01004904 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004905'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004906 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004907 {only available when compiled with the |+lua/dyn|
4908 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004909 Specifies the name of the Lua shared library. The default is
4910 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004911 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004912 This option cannot be set from a |modeline| or in the |sandbox|, for
4913 security reasons.
4914
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004915 *'macatsui'* *'nomacatsui'*
4916'macatsui' boolean (default on)
4917 global
4918 {only available in Mac GUI version}
4919 This is a workaround for when drawing doesn't work properly. When set
4920 and compiled with multi-byte support ATSUI text drawing is used. When
4921 not set ATSUI text drawing is not used. Switch this option off when
4922 you experience drawing problems. In a future version the problems may
4923 be solved and this option becomes obsolete. Therefore use this method
4924 to unset it: >
4925 if exists('&macatsui')
4926 set nomacatsui
4927 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004928< Another option to check if you have drawing problems is
4929 'termencoding'.
4930
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 *'magic'* *'nomagic'*
4932'magic' boolean (default on)
4933 global
4934 Changes the special characters that can be used in search patterns.
4935 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004936 WARNING: Switching this option off most likely breaks plugins! That
4937 is because many patterns assume it's on and will fail when it's off.
4938 Only switch it off when working with old Vi scripts. In any other
4939 situation write patterns that work when 'magic' is on. Include "\M"
4940 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941
4942 *'makeef'* *'mef'*
4943'makeef' 'mef' string (default: "")
4944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 {not available when compiled without the |+quickfix|
4946 feature}
4947 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4948 and the |:grep| command.
4949 When it is empty, an internally generated temp file will be used.
4950 When "##" is included, it is replaced by a number to make the name
4951 unique. This makes sure that the ":make" command doesn't overwrite an
4952 existing file.
4953 NOT used for the ":cf" command. See 'errorfile' for that.
4954 Environment variables are expanded |:set_env|.
4955 See |option-backslash| about including spaces and backslashes.
4956 This option cannot be set from a |modeline| or in the |sandbox|, for
4957 security reasons.
4958
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004959 *'makeencoding'* *'menc'*
4960'makeencoding' 'menc' string (default "")
4961 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004962 Encoding used for reading the output of external commands. When empty,
4963 encoding is not converted.
4964 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4965 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4966 and `:laddfile`.
4967
4968 This would be mostly useful when you use MS-Windows and set 'encoding'
4969 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4970 'makeencoding' to "char" has the same effect as setting to the system
4971 locale encoding. Example: >
4972 :set encoding=utf-8
4973 :set makeencoding=char " system locale is used
4974<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 *'makeprg'* *'mp'*
4976'makeprg' 'mp' string (default "make", VMS: "MMS")
4977 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004978 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004979 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4980 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004981 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004982 Environment variables are expanded |:set_env|. See |option-backslash|
4983 about including spaces and backslashes.
4984 Note that a '|' must be escaped twice: once for ":set" and once for
4985 the interpretation of a command. When you use a filter called
4986 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 :set makeprg=gmake\ \\\|\ myfilter
4988< The placeholder "$*" can be given (even multiple times) to specify
4989 where the arguments will be included, for example: >
4990 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4991< This option cannot be set from a |modeline| or in the |sandbox|, for
4992 security reasons.
4993
4994 *'matchpairs'* *'mps'*
4995'matchpairs' 'mps' string (default "(:),{:},[:]")
4996 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004998 other.
4999 Only character pairs are allowed that are different, thus you cannot
5000 jump between two double quotes.
5001 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005002 The pairs must be separated by a comma. Example for including '<' and
5003 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 :set mps+=<:>
5005
5006< A more exotic example, to jump between the '=' and ';' in an
5007 assignment, useful for languages like C and Java: >
5008 :au FileType c,cpp,java set mps+==:;
5009
5010< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005011 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
5013 *'matchtime'* *'mat'*
5014'matchtime' 'mat' number (default 5)
5015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 Tenths of a second to show the matching paren, when 'showmatch' is
5017 set. Note that this is not in milliseconds, like other options that
5018 set a time. This is to be compatible with Nvi.
5019
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005020 *'maxcombine'* *'mco'*
5021'maxcombine' 'mco' number (default 2)
5022 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005023 The maximum number of combining characters supported for displaying.
5024 Only used when 'encoding' is "utf-8".
5025 The default is OK for most languages. Hebrew may require 4.
5026 Maximum value is 6.
5027 Even when this option is set to 2 you can still edit text with more
5028 combining characters, you just can't see them. Use |g8| or |ga|.
5029 See |mbyte-combining|.
5030
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 *'maxfuncdepth'* *'mfd'*
5032'maxfuncdepth' 'mfd' number (default 100)
5033 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005034 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005035 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 Maximum depth of function calls for user functions. This normally
5037 catches endless recursion. When using a recursive function with
5038 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5039 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005040 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005041 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 See also |:function|.
5043
5044 *'maxmapdepth'* *'mmd'* *E223*
5045'maxmapdepth' 'mmd' number (default 1000)
5046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 Maximum number of times a mapping is done without resulting in a
5048 character to be used. This normally catches endless mappings, like
5049 ":map x y" with ":map y x". It still does not catch ":map g wg",
5050 because the 'w' is used before the next mapping is done. See also
5051 |key-mapping|.
5052
5053 *'maxmem'* *'mm'*
5054'maxmem' 'mm' number (default between 256 to 5120 (system
5055 dependent) or half the amount of memory
5056 available)
5057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5059 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005060 other memory to be freed.
5061 The maximum usable value is about 2000000. Use this to work without a
5062 limit.
5063 The value is ignored when 'swapfile' is off.
5064 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005066 *'maxmempattern'* *'mmp'*
5067'maxmempattern' 'mmp' number (default 1000)
5068 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005069 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005070 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005071 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 When Vim runs into the limit it gives an error message and mostly
5073 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005074 Running into the limit often means that the pattern is very
5075 inefficient or too complex. This may already happen with the pattern
5076 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005077 Might also happen on redraw, when syntax rules try to match a complex
5078 text structure.
5079 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5080 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005081
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 *'maxmemtot'* *'mmt'*
5083'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5084 dependent) or half the amount of memory
5085 available)
5086 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005087 Maximum amount of memory in Kbyte to use for all buffers together.
5088 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005089 without a limit.
5090 On 64 bit machines higher values might work. But hey, do you really
5091 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005092 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005093 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005094 Buffers with 'swapfile' off still count to the total amount of memory
5095 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005096 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'menuitems'* *'mis'*
5099'menuitems' 'mis' number (default 25)
5100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 {not available when compiled without the |+menu|
5102 feature}
5103 Maximum number of items to use in a menu. Used for menus that are
5104 generated from a list of items, e.g., the Buffers menu. Changing this
5105 option has no direct effect, the menu must be refreshed first.
5106
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005107 *'mkspellmem'* *'msm'*
5108'mkspellmem' 'msm' string (default "460000,2000,500")
5109 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005110 {not available when compiled without the |+syntax|
5111 feature}
5112 Parameters for |:mkspell|. This tunes when to start compressing the
5113 word tree. Compression can be slow when there are many words, but
5114 it's needed to avoid running out of memory. The amount of memory used
5115 per word depends very much on how similar the words are, that's why
5116 this tuning is complicated.
5117
5118 There are three numbers, separated by commas:
5119 {start},{inc},{added}
5120
5121 For most languages the uncompressed word tree fits in memory. {start}
5122 gives the amount of memory in Kbyte that can be used before any
5123 compression is done. It should be a bit smaller than the amount of
5124 memory that is available to Vim.
5125
5126 When going over the {start} limit the {inc} number specifies the
5127 amount of memory in Kbyte that can be allocated before another
5128 compression is done. A low number means compression is done after
5129 less words are added, which is slow. A high number means more memory
5130 will be allocated.
5131
5132 After doing compression, {added} times 1024 words can be added before
5133 the {inc} limit is ignored and compression is done when any extra
5134 amount of memory is needed. A low number means there is a smaller
5135 chance of hitting the {inc} limit, less memory is used but it's
5136 slower.
5137
5138 The languages for which these numbers are important are Italian and
5139 Hungarian. The default works for when you have about 512 Mbyte. If
5140 you have 1 Gbyte you could use: >
5141 :set mkspellmem=900000,3000,800
5142< If you have less than 512 Mbyte |:mkspell| may fail for some
5143 languages, no matter what you set 'mkspellmem' to.
5144
Bram Moolenaar07607392019-05-26 19:20:43 +02005145 This option cannot be set from a |modeline| or in the |sandbox|.
5146
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005148'modeline' 'ml' boolean (Vim default: on (off for root),
5149 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005151 If 'modeline' is on 'modelines' gives the number of lines that is
5152 checked for set commands. If 'modeline' is off or 'modelines' is zero
5153 no lines are checked. See |modeline|.
5154
5155 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5156'modelineexpr' 'mle' boolean (default: off)
5157 global
5158 When on allow some options that are an expression to be set in the
5159 modeline. Check the option for whether it is affected by
5160 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005161 This option cannot be set from a |modeline| or in the |sandbox|, for
5162 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005163
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 *'modelines'* *'mls'*
5165'modelines' 'mls' number (default 5)
5166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 If 'modeline' is on 'modelines' gives the number of lines that is
5168 checked for set commands. If 'modeline' is off or 'modelines' is zero
5169 no lines are checked. See |modeline|.
5170 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5171 set and to the Vim default value when 'compatible' is reset.
5172
5173 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005174 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175'modifiable' 'ma' boolean (default on)
5176 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 When off the buffer contents cannot be changed. The 'fileformat' and
5178 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005179 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
5181 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5182'modified' 'mod' boolean (default off)
5183 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 When on, the buffer is considered to be modified. This option is set
5185 when:
5186 1. A change was made to the text since it was last written. Using the
5187 |undo| command to go back to the original text will reset the
5188 option. But undoing changes that were made before writing the
5189 buffer will set the option again, since the text is different from
5190 when it was written.
5191 2. 'fileformat' or 'fileencoding' is different from its original
5192 value. The original value is set when the buffer is read or
5193 written. A ":set nomodified" command also resets the original
5194 values to the current values and the 'modified' option will be
5195 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005196 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005197 This option is not set when a change is made to the buffer as the
5198 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5199 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5200 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5202 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005203 Note that the text may actually be the same, e.g. 'modified' is set
5204 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'more'* *'nomore'*
5207'more' boolean (Vim default: on, Vi default: off)
5208 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 When on, listings pause when the whole screen is filled. You will get
5210 the |more-prompt|. When this option is off there are no pauses, the
5211 listing continues until finished.
5212 NOTE: This option is set to the Vi default value when 'compatible' is
5213 set and to the Vim default value when 'compatible' is reset.
5214
5215 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005216'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005217 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005219 Enable the use of the mouse. Works for most terminals (xterm, Win32
5220 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5221 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5222 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005223 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 v Visual mode
5225 i Insert mode
5226 c Command-line mode
5227 h all previous modes when editing a help file
5228 a all previous modes
5229 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005230 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005232< If your terminal can't overrule the mouse events going to the
5233 application, use: >
5234 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005235< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005236 back to Vim using the mouse events.
5237 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5238 "xterm".
5239
5240 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 modeless selection. This doesn't move the text cursor.
5242
5243 See |mouse-using|. Also see |'clipboard'|.
5244
5245 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005246 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 the mouse buttons can still be used by keeping the shift key pressed.
5248 Also see the 'clipboard' option.
5249
5250 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5251'mousefocus' 'mousef' boolean (default off)
5252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 {only works in the GUI}
5254 The window that the mouse pointer is on is automatically activated.
5255 When changing the window layout or window focus in another way, the
5256 mouse pointer is moved to the window with keyboard focus. Off is the
5257 default because it makes using the pull down menus a little goofy, as
5258 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005259 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005260 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261
5262 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5263'mousehide' 'mh' boolean (default on)
5264 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 {only works in the GUI}
5266 When on, the mouse pointer is hidden when characters are typed.
5267 The mouse pointer is restored when the mouse is moved.
5268
5269 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005270'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 Sets the model to use for the mouse. The name mostly specifies what
5273 the right mouse button is used for:
5274 extend Right mouse button extends a selection. This works
5275 like in an xterm.
5276 popup Right mouse button pops up a menu. The shifted left
5277 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005278 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279 popup_setpos Like "popup", but the cursor will be moved to the
5280 position where the mouse was clicked, and thus the
5281 selected operation will act upon the clicked object.
5282 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005283 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 course, that right clicking outside a selection will
5285 end Visual mode.
5286 Overview of what button does what for each model:
5287 mouse extend popup(_setpos) ~
5288 left click place cursor place cursor
5289 left drag start selection start selection
5290 shift-left search word extend selection
5291 right click extend selection popup menu (place cursor)
5292 right drag extend selection -
5293 middle click paste paste
5294
5295 In the "popup" model the right mouse button produces a pop-up menu.
5296 You need to define this first, see |popup-menu|.
5297
5298 Note that you can further refine the meaning of buttons with mappings.
5299 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5300 selection (because that's handled in the GUI code directly).
5301
5302 The 'mousemodel' option is set by the |:behave| command.
5303
5304 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005305'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5306 vs:leftright,vd:lrsizing,m:no,
5307 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 {only available when compiled with the |+mouseshape|
5310 feature}
5311 This option tells Vim what the mouse pointer should look like in
5312 different modes. The option is a comma separated list of parts, much
5313 like used for 'guicursor'. Each part consist of a mode/location-list
5314 and an argument-list:
5315 mode-list:shape,mode-list:shape,..
5316 The mode-list is a dash separated list of these modes/locations:
5317 In a normal window: ~
5318 n Normal mode
5319 v Visual mode
5320 ve Visual mode with 'selection' "exclusive" (same as 'v',
5321 if not specified)
5322 o Operator-pending mode
5323 i Insert mode
5324 r Replace mode
5325
5326 Others: ~
5327 c appending to the command-line
5328 ci inserting in the command-line
5329 cr replacing in the command-line
5330 m at the 'Hit ENTER' or 'More' prompts
5331 ml idem, but cursor in the last line
5332 e any mode, pointer below last window
5333 s any mode, pointer on a status line
5334 sd any mode, while dragging a status line
5335 vs any mode, pointer on a vertical separator line
5336 vd any mode, while dragging a vertical separator line
5337 a everywhere
5338
5339 The shape is one of the following:
5340 avail name looks like ~
5341 w x arrow Normal mouse pointer
5342 w x blank no pointer at all (use with care!)
5343 w x beam I-beam
5344 w x updown up-down sizing arrows
5345 w x leftright left-right sizing arrows
5346 w x busy The system's usual busy pointer
5347 w x no The system's usual 'no input' pointer
5348 x udsizing indicates up-down resizing
5349 x lrsizing indicates left-right resizing
5350 x crosshair like a big thin +
5351 x hand1 black hand
5352 x hand2 white hand
5353 x pencil what you write with
5354 x question big ?
5355 x rightup-arrow arrow pointing right-up
5356 w x up-arrow arrow pointing up
5357 x <number> any X11 pointer number (see X11/cursorfont.h)
5358
5359 The "avail" column contains a 'w' if the shape is available for Win32,
5360 x for X11.
5361 Any modes not specified or shapes not available use the normal mouse
5362 pointer.
5363
5364 Example: >
5365 :set mouseshape=s:udsizing,m:no
5366< will make the mouse turn to a sizing arrow over the status lines and
5367 indicate no input when the hit-enter prompt is displayed (since
5368 clicking the mouse has no effect in this state.)
5369
5370 *'mousetime'* *'mouset'*
5371'mousetime' 'mouset' number (default 500)
5372 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005373 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374 time in msec between two mouse clicks for the second click to be
5375 recognized as a multi click.
5376
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005377 *'mzschemedll'*
5378'mzschemedll' string (default depends on the build)
5379 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005380 {only available when compiled with the |+mzscheme/dyn|
5381 feature}
5382 Specifies the name of the MzScheme shared library. The default is
5383 DYNAMIC_MZSCH_DLL which was specified at compile time.
5384 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005385 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005386 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005387 This option cannot be set from a |modeline| or in the |sandbox|, for
5388 security reasons.
5389
5390 *'mzschemegcdll'*
5391'mzschemegcdll' string (default depends on the build)
5392 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005393 {only available when compiled with the |+mzscheme/dyn|
5394 feature}
5395 Specifies the name of the MzScheme GC shared library. The default is
5396 DYNAMIC_MZGC_DLL which was specified at compile time.
5397 The value can be equal to 'mzschemedll' if it includes the GC code.
5398 Environment variables are expanded |:set_env|.
5399 This option cannot be set from a |modeline| or in the |sandbox|, for
5400 security reasons.
5401
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005402 *'mzquantum'* *'mzq'*
5403'mzquantum' 'mzq' number (default 100)
5404 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005405 {not available when compiled without the |+mzscheme|
5406 feature}
5407 The number of milliseconds between polls for MzScheme threads.
5408 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005409 NOTE: This option is set to the Vim default value when 'compatible'
5410 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005411
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005413'nrformats' 'nf' string (default "bin,octal,hex",
5414 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 This defines what bases Vim will consider for numbers when using the
5417 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5418 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005419 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005421 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005422 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005424 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 considered to be hexadecimal. Example: Using CTRL-X on
5426 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005427 bin If included, numbers starting with "0b" or "0B" will be
5428 considered to be binary. Example: Using CTRL-X on
5429 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005430 unsigned If included, numbers are recognized as unsigned. Thus a
5431 leading dash or negative sign won't be considered as part of
5432 the number. Examples:
5433 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5434 (without "unsigned" it would become "9-2021").
5435 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5436 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005437 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5438 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 Numbers which simply begin with a digit in the range 1-9 are always
5440 considered decimal. This also happens for numbers that are not
5441 recognized as octal or hex.
5442
5443 *'number'* *'nu'* *'nonumber'* *'nonu'*
5444'number' 'nu' boolean (default off)
5445 local to window
5446 Print the line number in front of each line. When the 'n' option is
5447 excluded from 'cpoptions' a wrapped line will not use the column of
5448 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005449 The 'numberwidth' option can be used to set the room used for the line
5450 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 When a long, wrapped line doesn't start with the first character, '-'
5452 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005453 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5454 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005455 *number_relativenumber*
5456 The 'relativenumber' option changes the displayed number to be
5457 relative to the cursor. Together with 'number' there are these
5458 four combinations (cursor in line 3):
5459
Bram Moolenaar3848e002016-03-19 18:42:29 +01005460 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005461 'nornu' 'nornu' 'rnu' 'rnu'
5462
5463 |apple | 1 apple | 2 apple | 2 apple
5464 |pear | 2 pear | 1 pear | 1 pear
5465 |nobody | 3 nobody | 0 nobody |3 nobody
5466 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005468 *'numberwidth'* *'nuw'*
5469'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5470 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005471 {only available when compiled with the |+linebreak|
5472 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005473 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005474 when the 'number' or 'relativenumber' option is set or printing lines
5475 with a line number. Since one space is always between the number and
5476 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005477 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005478 fit the highest line number in the buffer respectively the number of
5479 rows in the window, depending on whether 'number' or 'relativenumber'
5480 is set. Thus with the Vim default of 4 there is room for a line number
5481 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005482 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005483 NOTE: This option is set to the Vi default value when 'compatible' is
5484 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005485
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005486 *'omnifunc'* *'ofu'*
5487'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005488 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005489 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005490 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005491 This option specifies a function to be used for Insert mode omni
5492 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005493 See |complete-functions| for an explanation of how the function is
5494 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005495 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005496 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005497 This option cannot be set from a |modeline| or in the |sandbox|, for
5498 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005499
5500
Bram Moolenaar02467872007-05-06 13:22:01 +00005501 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005502'opendevice' 'odev' boolean (default off)
5503 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005504 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005505 Enable reading and writing from devices. This may get Vim stuck on a
5506 device that can be opened but doesn't actually do the I/O. Therefore
5507 it is off by default.
5508 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5509 result in editing a device.
5510
5511
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005512 *'operatorfunc'* *'opfunc'*
5513'operatorfunc' 'opfunc' string (default: empty)
5514 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005515 This option specifies a function to be called by the |g@| operator.
5516 See |:map-operator| for more info and an example.
5517
5518 This option cannot be set from a |modeline| or in the |sandbox|, for
5519 security reasons.
5520
5521
Bram Moolenaar251e1912011-06-19 05:09:16 +02005522 *'osfiletype'* *'oft'*
5523'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005525 This option was supported on RISC OS, which has been removed.
5526
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005528 *'packpath'* *'pp'*
5529'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005530 Directories used to find packages. See |packages|.
5531
5532
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005534'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 global
5536 Specifies the nroff macros that separate paragraphs. These are pairs
5537 of two letters (see |object-motions|).
5538
5539 *'paste'* *'nopaste'*
5540'paste' boolean (default off)
5541 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005542 Put Vim in Paste mode. This is useful if you want to cut or copy
5543 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 unexpected effects.
5545 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005546 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 knows about pasting and will mostly do the right thing without 'paste'
5548 being set. The same is true for a terminal where Vim handles the
5549 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005550 This option is reset when starting the GUI. Thus if you set it in
5551 your .vimrc it will work in a terminal, but not in the GUI. Setting
5552 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5553 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 When the 'paste' option is switched on (also when it was already on):
5555 - mapping in Insert mode and Command-line mode is disabled
5556 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005558 - 'expandtab' is reset
5559 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 - 'revins' is reset
5561 - 'ruler' is reset
5562 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005563 - 'smartindent' is reset
5564 - 'smarttab' is reset
5565 - 'softtabstop' is set to 0
5566 - 'textwidth' is set to 0
5567 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005570 - 'indentexpr'
5571 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 NOTE: When you start editing another file while the 'paste' option is
5573 on, settings from the modelines or autocommands may change the
5574 settings again, causing trouble when pasting text. You might want to
5575 set the 'paste' option again.
5576 When the 'paste' option is reset the mentioned options are restored to
5577 the value before the moment 'paste' was switched from off to on.
5578 Resetting 'paste' before ever setting it does not have any effect.
5579 Since mapping doesn't work while 'paste' is active, you need to use
5580 the 'pastetoggle' option to toggle the 'paste' option with some key.
5581
5582 *'pastetoggle'* *'pt'*
5583'pastetoggle' 'pt' string (default "")
5584 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 When non-empty, specifies the key sequence that toggles the 'paste'
5586 option. This is like specifying a mapping: >
5587 :map {keys} :set invpaste<CR>
5588< Where {keys} is the value of 'pastetoggle'.
5589 The difference is that it will work even when 'paste' is set.
5590 'pastetoggle' works in Insert mode and Normal mode, but not in
5591 Command-line mode.
5592 Mappings are checked first, thus overrule 'pastetoggle'. However,
5593 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5594 this: >
5595 :map <F10> :set paste<CR>
5596 :map <F11> :set nopaste<CR>
5597 :imap <F10> <C-O>:set paste<CR>
5598 :imap <F11> <nop>
5599 :set pastetoggle=<F11>
5600< This will make <F10> start paste mode and <F11> stop paste mode.
5601 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5602 mode everything is inserted literally, except the 'pastetoggle' key
5603 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005604 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605
5606 *'pex'* *'patchexpr'*
5607'patchexpr' 'pex' string (default "")
5608 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 {not available when compiled without the |+diff|
5610 feature}
5611 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
Bram Moolenaardbc28022014-07-26 13:40:44 +02005614 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615'patchmode' 'pm' string (default "")
5616 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 When non-empty the oldest version of a file is kept. This can be used
5618 to keep the original version of a file if you are changing files in a
5619 source distribution. Only the first time that a file is written a
5620 copy of the original file will be kept. The name of the copy is the
5621 name of the original file with the string in the 'patchmode' option
5622 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005623 ".orig" or ".org". 'backupdir' must not be empty for this to work
5624 (Detail: The backup file is renamed to the patchmode file after the
5625 new file has been successfully written, that's why it must be possible
5626 to write a backup file). If there was no file to be backed up, an
5627 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 When the 'backupskip' pattern matches, a patchmode file is not made.
5629 Using 'patchmode' for compressed files appends the extension at the
5630 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5631 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005632 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005634 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 other systems: ".,,")
5637 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005639 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5640 provided that the file being searched for has a relative path (not
5641 starting with "/", "./" or "../"). The directories in the 'path'
5642 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 - Use commas to separate directory names: >
5644 :set path=.,/usr/local/include,/usr/include
5645< - Spaces can also be used to separate directory names (for backwards
5646 compatibility with version 3.0). To have a space in a directory
5647 name, precede it with an extra backslash, and escape the space: >
5648 :set path=.,/dir/with\\\ space
5649< - To include a comma in a directory name precede it with an extra
5650 backslash: >
5651 :set path=.,/dir/with\\,comma
5652< - To search relative to the directory of the current file, use: >
5653 :set path=.
5654< - To search in the current directory use an empty string between two
5655 commas: >
5656 :set path=,,
5657< - A directory name may end in a ':' or '/'.
5658 - Environment variables are expanded |:set_env|.
5659 - When using |netrw.vim| URLs can be used. For example, adding
5660 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005661 - Search upwards and downwards in a directory tree using "*", "**" and
5662 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 {not available when compiled without the |+path_extra| feature}
5664 - Careful with '\' characters, type two to get one in the option: >
5665 :set path=.,c:\\include
5666< Or just use '/' instead: >
5667 :set path=.,c:/include
5668< Don't forget "." or files won't even be found in the same directory as
5669 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005670 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 it is something like 256 or 1024 characters.
5672 You can check if all the include files are found, using the value of
5673 'path', see |:checkpath|.
5674 The use of |:set+=| and |:set-=| is preferred when adding or removing
5675 directories from the list. This avoids problems when a future version
5676 uses another default. To remove the current directory use: >
5677 :set path-=
5678< To add the current directory use: >
5679 :set path+=
5680< To use an environment variable, you probably need to replace the
5681 separator. Here is an example to append $INCL, in which directory
5682 names are separated with a semi-colon: >
5683 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5684< Replace the ';' with a ':' or whatever separator is used. Note that
5685 this doesn't work when $INCL contains a comma or white space.
5686
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005687 *'perldll'*
5688'perldll' string (default depends on the build)
5689 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005690 {only available when compiled with the |+perl/dyn|
5691 feature}
5692 Specifies the name of the Perl shared library. The default is
5693 DYNAMIC_PERL_DLL, which was specified at compile time.
5694 Environment variables are expanded |:set_env|.
5695 This option cannot be set from a |modeline| or in the |sandbox|, for
5696 security reasons.
5697
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5699'preserveindent' 'pi' boolean (default off)
5700 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 When changing the indent of the current line, preserve as much of the
5702 indent structure as possible. Normally the indent is replaced by a
5703 series of tabs followed by spaces as required (unless |'expandtab'| is
5704 enabled, in which case only spaces are used). Enabling this option
5705 means the indent will preserve as many existing characters as possible
5706 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005707 'expandtab' does not apply to the preserved white space, a Tab remains
5708 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 NOTE: When using ">>" multiple times the resulting indent is a mix of
5710 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005711 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 Also see 'copyindent'.
5713 Use |:retab| to clean up white space.
5714
5715 *'previewheight'* *'pvh'*
5716'previewheight' 'pvh' number (default 12)
5717 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005718 {not available when compiled without the |+quickfix|
5719 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005721 commands. Used for |CTRL-W_}| when no count is given. Not used when
5722 'previewpopup' is set.
5723
5724 *'previewpopup'* *'pvp'*
5725'previewpopup' 'pvp' string (default empty)
5726 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005727 {not available when compiled without the |+textprop|
5728 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005729 When not empty a popup window is used for commands that would open a
5730 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005731 Not used for the insert completion info, add "popup" to
5732 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733
5734 *'previewwindow'* *'nopreviewwindow'*
5735 *'pvw'* *'nopvw'* *E590*
5736'previewwindow' 'pvw' boolean (default off)
5737 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005738 {not available when compiled without the |+quickfix|
5739 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005740 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 set. It's normally not set directly, but by using one of the commands
5742 |:ptag|, |:pedit|, etc.
5743
5744 *'printdevice'* *'pdev'*
5745'printdevice' 'pdev' string (default empty)
5746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 {only available when compiled with the |+printer|
5748 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005749 The name of the printer to be used for |:hardcopy|.
5750 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005751 This option cannot be set from a |modeline| or in the |sandbox|, for
5752 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
Bram Moolenaar8299df92004-07-10 09:47:34 +00005754 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005755'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757 {only available when compiled with the |+printer|
5758 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005759 Sets the character encoding used when printing.
5760 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
5762 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005763'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005765 {only available when compiled with the |+printer|
5766 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005767 Expression used to print the PostScript produced with |:hardcopy|.
5768 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005769 This option cannot be set from a |modeline| or in the |sandbox|, for
5770 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771
Bram Moolenaar8299df92004-07-10 09:47:34 +00005772 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773'printfont' 'pfn' string (default "courier")
5774 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 {only available when compiled with the |+printer|
5776 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005777 The name of the font that will be used for |:hardcopy|.
5778 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005779
5780 *'printheader'* *'pheader'*
5781'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5782 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {only available when compiled with the |+printer|
5784 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 The format of the header produced in |:hardcopy| output.
5786 See |pheader-option|.
5787
5788 *'printmbcharset'* *'pmbcs'*
5789'printmbcharset' 'pmbcs' string (default "")
5790 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005791 {only available when compiled with the |+printer|
5792 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005793 The CJK character set to be used for CJK output from |:hardcopy|.
5794 See |pmbcs-option|.
5795
5796 *'printmbfont'* *'pmbfn'*
5797'printmbfont' 'pmbfn' string (default "")
5798 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005799 {only available when compiled with the |+printer|
5800 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005801 List of font names to be used for CJK output from |:hardcopy|.
5802 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803
5804 *'printoptions'* *'popt'*
5805'printoptions' 'popt' string (default "")
5806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005808 List of items that control the format of the output of |:hardcopy|.
5809 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005811 *'prompt'* *'noprompt'*
5812'prompt' boolean (default on)
5813 global
5814 When on a ":" prompt is used in Ex mode.
5815
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005816 *'pumheight'* *'ph'*
5817'pumheight' 'ph' number (default 0)
5818 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005819 Determines the maximum number of items to show in the popup menu for
5820 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005821 |ins-completion-menu|.
5822
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005823 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005824'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005825 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005826 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005827 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005828
Bram Moolenaard94464e2015-11-02 15:28:18 +01005829 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005830'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005831 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005832 {only available when compiled with the |+python/dyn|
5833 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005834 Specifies the name of the Python 2.x shared library. The default is
5835 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005836 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005837 This option cannot be set from a |modeline| or in the |sandbox|, for
5838 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005839
Bram Moolenaar94073162018-01-31 21:49:05 +01005840 *'pythonhome'*
5841'pythonhome' string (default "")
5842 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005843 {only available when compiled with the |+python/dyn|
5844 feature}
5845 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5846 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5847 which was specified at compile time, will be used for the Python 2.x
5848 home directory.
5849 Environment variables are expanded |:set_env|.
5850 This option cannot be set from a |modeline| or in the |sandbox|, for
5851 security reasons.
5852
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005853 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005854'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005855 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005856 {only available when compiled with the |+python3/dyn|
5857 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005858 Specifies the name of the Python 3 shared library. The default is
5859 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005860 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005861 This option cannot be set from a |modeline| or in the |sandbox|, for
5862 security reasons.
5863
Bram Moolenaar94073162018-01-31 21:49:05 +01005864 *'pythonthreehome'*
5865'pythonthreehome' string (default "")
5866 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005867 {only available when compiled with the |+python3/dyn|
5868 feature}
5869 Specifies the name of the Python 3 home directory. When
5870 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5871 PYTHON3_HOME, which was specified at compile time, will be used for
5872 the Python 3 home directory.
5873 Environment variables are expanded |:set_env|.
5874 This option cannot be set from a |modeline| or in the |sandbox|, for
5875 security reasons.
5876
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005877 *'pyxversion'* *'pyx'*
5878'pyxversion' 'pyx' number (default depends on the build)
5879 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005880 {only available when compiled with the |+python| or
5881 the |+python3| feature}
5882 Specifies the python version used for pyx* functions and commands
5883 |python_x|. The default value is as follows:
5884
5885 Compiled with Default ~
5886 |+python| and |+python3| 0
5887 only |+python| 2
5888 only |+python3| 3
5889
5890 Available values are 0, 2 and 3.
5891 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5892 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5893 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5894 to 2 if Python 2 is available.
5895 See also: |has-pythonx|
5896
5897 If Vim is compiled with only |+python| or |+python3| setting
5898 'pyxversion' has no effect. The pyx* functions and commands are
5899 always the same as the compiled version.
5900
5901 This option cannot be set from a |modeline| or in the |sandbox|, for
5902 security reasons.
5903
Bram Moolenaar858ba062020-05-31 23:11:59 +02005904 *'quickfixtextfunc'* *'qftf'*
5905'quickfixtextfunc' 'qftf' string (default "")
5906 global
5907 {only available when compiled with the |+quickfix|
5908 feature}
5909 This option specifies a function to be used to get the text to display
5910 in the quickfix and location list windows. This can be used to
5911 customize the information displayed in the quickfix or location window
5912 for each entry in the corresponding quickfix or location list. See
5913 |quickfix-window-function| for an explanation of how to write the
5914 function and an example.
5915
5916 This option cannot be set from a |modeline| or in the |sandbox|, for
5917 security reasons.
5918
Bram Moolenaar677ee682005-01-27 14:41:15 +00005919 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005920'quoteescape' 'qe' string (default "\")
5921 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005922 The characters that are used to escape quotes in a string. Used for
5923 objects like a', a" and a` |a'|.
5924 When one of the characters in this option is found inside a string,
5925 the following character will be skipped. The default value makes the
5926 text "foo\"bar\\" considered to be one string.
5927
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5929'readonly' 'ro' boolean (default off)
5930 local to buffer
5931 If on, writes fail unless you use a '!'. Protects you from
5932 accidentally overwriting a file. Default on when Vim is started
5933 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005934 When using ":w!" the 'readonly' option is reset for the current
5935 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005936 When using the ":view" command the 'readonly' option is set for the
5937 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005938 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005940 *'redrawtime'* *'rdt'*
5941'redrawtime' 'rdt' number (default 2000)
5942 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005943 {only available when compiled with the |+reltime|
5944 feature}
5945 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005946 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005947 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005948 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005949 matches will be highlighted.
5950 For syntax highlighting the time applies per window. When over the
5951 limit syntax highlighting is disabled until |CTRL-L| is used.
5952 This is used to avoid that Vim hangs when using a very complicated
5953 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005954
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005955 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005956'regexpengine' 're' number (default 0)
5957 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005958 This selects the default regexp engine. |two-engines|
5959 The possible values are:
5960 0 automatic selection
5961 1 old engine
5962 2 NFA engine
5963 Note that when using the NFA engine and the pattern contains something
5964 that is not supported the pattern will not match. This is only useful
5965 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005966 Using automatic selection enables Vim to switch the engine, if the
5967 default engine becomes too costly. E.g., when the NFA engine uses too
5968 many states. This should prevent Vim from hanging on a combination of
5969 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005970
Bram Moolenaar64486672010-05-16 15:46:46 +02005971 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5972'relativenumber' 'rnu' boolean (default off)
5973 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005974 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005975 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005976 precede some vertical motion commands (e.g. j k + -) with, without
5977 having to calculate it yourself. Especially useful in combination with
5978 other commands (e.g. y d c < > gq gw =).
5979 When the 'n' option is excluded from 'cpoptions' a wrapped
5980 line will not use the column of line numbers (this is the default when
5981 'compatible' isn't set).
5982 The 'numberwidth' option can be used to set the room used for the line
5983 number.
5984 When a long, wrapped line doesn't start with the first character, '-'
5985 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005986 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5987 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005988
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005989 The number in front of the cursor line also depends on the value of
5990 'number', see |number_relativenumber| for all combinations of the two
5991 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005992
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 *'remap'* *'noremap'*
5994'remap' boolean (default on)
5995 global
5996 Allows for mappings to work recursively. If you do not want this for
5997 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005998 NOTE: To avoid portability problems with Vim scripts, always keep
5999 this option at the default "on". Only switch it off when working with
6000 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006002 *'renderoptions'* *'rop'*
6003'renderoptions' 'rop' string (default: empty)
6004 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006005 {only available when compiled with GUI and DIRECTX on
6006 MS-Windows}
6007 Select a text renderer and set its options. The options depend on the
6008 renderer.
6009
6010 Syntax: >
6011 set rop=type:{renderer}(,{name}:{value})*
6012<
6013 Currently, only one optional renderer is available.
6014
6015 render behavior ~
6016 directx Vim will draw text using DirectX (DirectWrite). It makes
6017 drawn glyphs more beautiful than default GDI.
6018 It requires 'encoding' is "utf-8", and only works on
6019 MS-Windows Vista or newer version.
6020
6021 Options:
6022 name meaning type value ~
6023 gamma gamma float 1.0 - 2.2 (maybe)
6024 contrast enhancedContrast float (unknown)
6025 level clearTypeLevel float (unknown)
6026 geom pixelGeometry int 0 - 2 (see below)
6027 renmode renderingMode int 0 - 6 (see below)
6028 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006029 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006030
Bram Moolenaar92467d32017-12-05 13:22:16 +01006031 See this URL for detail (except for scrlines):
6032 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006033
6034 For geom: structure of a device pixel.
6035 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6036 1 - DWRITE_PIXEL_GEOMETRY_RGB
6037 2 - DWRITE_PIXEL_GEOMETRY_BGR
6038
6039 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006040 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006041
6042 For renmode: method of rendering glyphs.
6043 0 - DWRITE_RENDERING_MODE_DEFAULT
6044 1 - DWRITE_RENDERING_MODE_ALIASED
6045 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6046 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6047 4 - DWRITE_RENDERING_MODE_NATURAL
6048 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6049 6 - DWRITE_RENDERING_MODE_OUTLINE
6050
6051 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006052 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006053
6054 For taamode: antialiasing mode used for drawing text.
6055 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6056 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6057 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6058 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6059
6060 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006061 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6062
Bram Moolenaara338adc2018-01-31 20:51:47 +01006063 For scrlines:
6064 This was used for optimizing scrolling behavior, however this
6065 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006066
6067 Example: >
6068 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006069 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006070 set rop=type:directx
6071<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006072 If select a raster font (Courier, Terminal or FixedSys which
6073 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006074 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006075
6076 NOTE: It is known that some fonts and options combination
6077 causes trouble on drawing glyphs.
6078
Bram Moolenaar92467d32017-12-05 13:22:16 +01006079 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006080 special made fonts (True-Type fonts which includes only
6081 bitmap glyphs).
6082 - 'taamode:3' will not work with some vector fonts.
6083
6084 NOTE: With this option, you can display colored emoji
6085 (emoticon) in Windows 8.1 or later. To display colored emoji,
6086 there are some conditions which you should notice.
6087
6088 - If your font includes non-colored emoji already, it will
6089 be used.
6090 - If your font doesn't have emoji, the system chooses an
6091 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6092 will be used.
6093 - When this alternative font didn't have fixed width glyph,
6094 emoji might be rendered beyond the bounding box of drawing
6095 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006096
6097 Other render types are currently not supported.
6098
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 *'report'*
6100'report' number (default 2)
6101 global
6102 Threshold for reporting number of lines changed. When the number of
6103 changed lines is more than 'report' a message will be given for most
6104 ":" commands. If you want it always, set 'report' to 0.
6105 For the ":substitute" command the number of substitutions is used
6106 instead of the number of lines.
6107
6108 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6109'restorescreen' 'rs' boolean (default on)
6110 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006111 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 When set, the screen contents is restored when exiting Vim. This also
6113 happens when executing external commands.
6114
6115 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6116 options in your .vimrc. To disable restoring:
6117 set t_ti= t_te=
6118 To enable restoring (for an xterm):
6119 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6120 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6121
6122 *'revins'* *'ri'* *'norevins'* *'nori'*
6123'revins' 'ri' boolean (default off)
6124 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 {only available when compiled with the |+rightleft|
6126 feature}
6127 Inserting characters in Insert mode will work backwards. See "typing
6128 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6129 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006130 NOTE: This option is reset when 'compatible' is set.
6131 This option is reset when 'paste' is set and restored when 'paste' is
6132 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133
6134 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6135'rightleft' 'rl' boolean (default off)
6136 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 {only available when compiled with the |+rightleft|
6138 feature}
6139 When on, display orientation becomes right-to-left, i.e., characters
6140 that are stored in the file appear from the right to the left.
6141 Using this option, it is possible to edit files for languages that
6142 are written from the right to the left such as Hebrew and Arabic.
6143 This option is per window, so it is possible to edit mixed files
6144 simultaneously, or to view the same file in both ways (this is
6145 useful whenever you have a mixed text file with both right-to-left
6146 and left-to-right strings so that both sets are displayed properly
6147 in different windows). Also see |rileft.txt|.
6148
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006149 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150'rightleftcmd' 'rlc' string (default "search")
6151 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 {only available when compiled with the |+rightleft|
6153 feature}
6154 Each word in this option enables the command line editing to work in
6155 right-to-left mode for a group of commands:
6156
6157 search "/" and "?" commands
6158
6159 This is useful for languages such as Hebrew, Arabic and Farsi.
6160 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6161
Bram Moolenaard94464e2015-11-02 15:28:18 +01006162 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006163'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006164 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006165 {only available when compiled with the |+ruby/dyn|
6166 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006167 Specifies the name of the Ruby shared library. The default is
6168 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006169 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006170 This option cannot be set from a |modeline| or in the |sandbox|, for
6171 security reasons.
6172
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006174'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 {not available when compiled without the
6177 |+cmdline_info| feature}
6178 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006179 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 text in the file is shown on the far right:
6181 Top first line is visible
6182 Bot last line is visible
6183 All first and last line are visible
6184 45% relative position in the file
6185 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006186 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006188 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 this option takes precedence over 'ruler' and 'rulerformat'
6190 If the number of characters displayed is different from the number of
6191 bytes in the text (e.g., for a TAB or a multi-byte character), both
6192 the text column (byte number) and the screen column are shown,
6193 separated with a dash.
6194 For an empty line "0-1" is shown.
6195 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006196 This option is reset when 'paste' is set and restored when 'paste' is
6197 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 If you don't want to see the ruler all the time but want to know where
6199 you are, use "g CTRL-G" |g_CTRL-G|.
6200 NOTE: This option is reset when 'compatible' is set.
6201
6202 *'rulerformat'* *'ruf'*
6203'rulerformat' 'ruf' string (default empty)
6204 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 {not available when compiled without the |+statusline|
6206 feature}
6207 When this option is not empty, it determines the content of the ruler
6208 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006209 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006210 This option cannot be set in a modeline when 'modelineexpr' is off.
6211
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 The default ruler width is 17 characters. To make the ruler 15
6213 characters wide, put "%15(" at the start and "%)" at the end.
6214 Example: >
6215 :set rulerformat=%15(%c%V\ %p%%%)
6216<
6217 *'runtimepath'* *'rtp'* *vimfiles*
6218'runtimepath' 'rtp' string (default:
6219 Unix: "$HOME/.vim,
6220 $VIM/vimfiles,
6221 $VIMRUNTIME,
6222 $VIM/vimfiles/after,
6223 $HOME/.vim/after"
6224 Amiga: "home:vimfiles,
6225 $VIM/vimfiles,
6226 $VIMRUNTIME,
6227 $VIM/vimfiles/after,
6228 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006229 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 $VIM/vimfiles,
6231 $VIMRUNTIME,
6232 $VIM/vimfiles/after,
6233 $HOME/vimfiles/after"
6234 Macintosh: "$VIM:vimfiles,
6235 $VIMRUNTIME,
6236 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006237 Haiku: "$BE_USER_SETTINGS/vim,
6238 $VIM/vimfiles,
6239 $VIMRUNTIME,
6240 $VIM/vimfiles/after,
6241 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 VMS: "sys$login:vimfiles,
6243 $VIM/vimfiles,
6244 $VIMRUNTIME,
6245 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006246 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 This is a list of directories which will be searched for runtime
6249 files:
6250 filetype.vim filetypes by file name |new-filetype|
6251 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006252 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 colors/ color scheme files |:colorscheme|
6254 compiler/ compiler files |:compiler|
6255 doc/ documentation |write-local-help|
6256 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006257 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 indent/ indent scripts |indent-expression|
6259 keymap/ key mapping files |mbyte-keymap|
6260 lang/ menu translations |:menutrans|
6261 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006262 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 plugin/ plugin scripts |write-plugin|
6264 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006265 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 syntax/ syntax files |mysyntaxfile|
6267 tutor/ files for vimtutor |tutor|
6268
6269 And any other file searched for with the |:runtime| command.
6270
6271 The defaults for most systems are setup to search five locations:
6272 1. In your home directory, for your personal preferences.
6273 2. In a system-wide Vim directory, for preferences from the system
6274 administrator.
6275 3. In $VIMRUNTIME, for files distributed with Vim.
6276 *after-directory*
6277 4. In the "after" directory in the system-wide Vim directory. This is
6278 for the system administrator to overrule or add to the distributed
6279 defaults (rarely needed)
6280 5. In the "after" directory in your home directory. This is for
6281 personal preferences to overrule or add to the distributed defaults
6282 or system-wide settings (rarely needed).
6283
Bram Moolenaard0796902016-09-16 20:02:31 +02006284 More entries are added when using |packages|. If it gets very long
6285 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6286 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006287
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6289 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006290 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 wildcards.
6292 See |:runtime|.
6293 Example: >
6294 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6295< This will use the directory "~/vimruntime" first (containing your
6296 personal Vim runtime files), then "/mygroup/vim" (shared between a
6297 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6298 files).
6299 You probably should always include $VIMRUNTIME somewhere, to use the
6300 distributed runtime files. You can put a directory before $VIMRUNTIME
6301 to find files which replace a distributed runtime files. You can put
6302 a directory after $VIMRUNTIME to find files which add to distributed
6303 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006304 When Vim is started with |--clean| the home directory entries are not
6305 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 This option cannot be set from a |modeline| or in the |sandbox|, for
6307 security reasons.
6308
6309 *'scroll'* *'scr'*
6310'scroll' 'scr' number (default: half the window height)
6311 local to window
6312 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6313 set to half the number of lines in the window when the window size
6314 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006315 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006316 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317
6318 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6319'scrollbind' 'scb' boolean (default off)
6320 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006321 See also |scroll-binding|. When this option is set, the current
6322 window scrolls as other scrollbind windows (windows that also have
6323 this option set) scroll. This option is useful for viewing the
6324 differences between two versions of a file, see 'diff'.
6325 See |'scrollopt'| for options that determine how this option should be
6326 interpreted.
6327 This option is mostly reset when splitting a window to edit another
6328 file. This means that ":split | edit file" results in two windows
6329 with scroll-binding, but ":split file" does not.
6330
Bram Moolenaarae20f342019-11-05 21:09:23 +01006331 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6332'scrollfocus' 'scf' boolean (default off)
6333 global
6334 {only for MS-Windows GUI}
6335 When using the scroll wheel and this option is set, the window under
6336 the mouse pointer is scrolled. With this option off the current
6337 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006338 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006339
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 *'scrolljump'* *'sj'*
6341'scrolljump' 'sj' number (default 1)
6342 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 Minimal number of lines to scroll when the cursor gets off the
6344 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6345 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006346 When set to a negative number from -1 to -100 this is used as the
6347 percentage of the window height. Thus -50 scrolls half the window
6348 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 NOTE: This option is set to 1 when 'compatible' is set.
6350
6351 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006352'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006353 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 Minimal number of screen lines to keep above and below the cursor.
6355 This will make some context visible around where you are working. If
6356 you set it to a very large value (999) the cursor line will always be
6357 in the middle of the window (except at the start or end of the file or
6358 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006359 After using the local value, go back the global value with one of
6360 these two: >
6361 setlocal scrolloff<
6362 setlocal scrolloff=-1
6363< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 NOTE: This option is set to 0 when 'compatible' is set.
6365
6366 *'scrollopt'* *'sbo'*
6367'scrollopt' 'sbo' string (default "ver,jump")
6368 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006370 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6371 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 The following words are available:
6373 ver Bind vertical scrolling for 'scrollbind' windows
6374 hor Bind horizontal scrolling for 'scrollbind' windows
6375 jump Applies to the offset between two windows for vertical
6376 scrolling. This offset is the difference in the first
6377 displayed line of the bound windows. When moving
6378 around in a window, another 'scrollbind' window may
6379 reach a position before the start or after the end of
6380 the buffer. The offset is not changed though, when
6381 moving back the 'scrollbind' window will try to scroll
6382 to the desired position when possible.
6383 When now making that window the current one, two
6384 things can be done with the relative offset:
6385 1. When "jump" is not included, the relative offset is
6386 adjusted for the scroll position in the new current
6387 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006388 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006389 2. When "jump" is included, the other windows are
6390 scrolled to keep the same relative offset. When
6391 going back to the other window, it still uses the
6392 same relative offset.
6393 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006394 When 'diff' mode is active there always is vertical scroll binding,
6395 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396
6397 *'sections'* *'sect'*
6398'sections' 'sect' string (default "SHNHH HUnhsh")
6399 global
6400 Specifies the nroff macros that separate sections. These are pairs of
6401 two letters (See |object-motions|). The default makes a section start
6402 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6403
6404 *'secure'* *'nosecure'* *E523*
6405'secure' boolean (default off)
6406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 When on, ":autocmd", shell and write commands are not allowed in
6408 ".vimrc" and ".exrc" in the current directory and map commands are
6409 displayed. Switch it off only if you know that you will not run into
6410 problems, or when the 'exrc' option is off. On Unix this option is
6411 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006412 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 'secure' at the end of your ~/.vimrc then.
6414 This option cannot be set from a |modeline| or in the |sandbox|, for
6415 security reasons.
6416
6417 *'selection'* *'sel'*
6418'selection' 'sel' string (default "inclusive")
6419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 This option defines the behavior of the selection. It is only used
6421 in Visual and Select mode.
6422 Possible values:
6423 value past line inclusive ~
6424 old no yes
6425 inclusive yes yes
6426 exclusive yes no
6427 "past line" means that the cursor is allowed to be positioned one
6428 character past the line.
6429 "inclusive" means that the last character of the selection is included
6430 in an operation. For example, when "x" is used to delete the
6431 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006432 When "old" is used and 'virtualedit' allows the cursor to move past
6433 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 Note that when "exclusive" is used and selecting from the end
6435 backwards, you cannot include the last character of a line, when
6436 starting in Normal mode and 'virtualedit' empty.
6437
6438 The 'selection' option is set by the |:behave| command.
6439
6440 *'selectmode'* *'slm'*
6441'selectmode' 'slm' string (default "")
6442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006443 This is a comma separated list of words, which specifies when to start
6444 Select mode instead of Visual mode, when a selection is started.
6445 Possible values:
6446 mouse when using the mouse
6447 key when using shifted special keys
6448 cmd when using "v", "V" or CTRL-V
6449 See |Select-mode|.
6450 The 'selectmode' option is set by the |:behave| command.
6451
6452 *'sessionoptions'* *'ssop'*
6453'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006454 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006456 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 feature}
6458 Changes the effect of the |:mksession| command. It is a comma
6459 separated list of words. Each word enables saving and restoring
6460 something:
6461 word save and restore ~
6462 blank empty windows
6463 buffers hidden and unloaded buffers, not just those in windows
6464 curdir the current directory
6465 folds manually created folds, opened/closed folds and local
6466 fold options
6467 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006468 and contain at least one lowercase letter. Only
6469 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 help the help window
6471 localoptions options and mappings local to a window or buffer (not
6472 global values for local options)
6473 options all options and mappings (also global values for local
6474 options)
6475 resize size of the Vim window: 'lines' and 'columns'
6476 sesdir the directory in which the session file is located
6477 will become the current directory (useful with
6478 projects accessed over a network from different
6479 systems)
6480 slash backslashes in file names replaced with forward
6481 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006482 tabpages all tab pages; without this only the current tab page
6483 is restored, so that you can make a session for each
6484 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006485 terminal include terminal windows where the command can be
6486 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 unix with Unix end-of-line format (single <NL>), even when
6488 on Windows or DOS
6489 winpos position of the whole Vim window
6490 winsize window sizes
6491
6492 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006493 When neither "curdir" nor "sesdir" is included, file names are stored
6494 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 "slash" and "unix" are useful on Windows when sharing session files
6496 with Unix. The Unix version of Vim cannot source dos format scripts,
6497 but the Windows version of Vim can source unix format scripts.
6498
6499 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006500'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 global
6502 Name of the shell to use for ! and :! commands. When changing the
6503 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6504 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006505 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 See |option-backslash| about including spaces and backslashes.
6507 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006508
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006509 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006510 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6512< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006513 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006515 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006517 Example with escaped space (Vim will do this when initializing the
6518 option from $SHELL): >
6519 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006520< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006521 backslashes are consumed by `:set`.
6522
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 Under MS-Windows, when the executable ends in ".com" it must be
6524 included. Thus setting the shell to "command.com" or "4dos.com"
6525 works, but "command" and "4dos" do not work for all commands (e.g.,
6526 filtering).
6527 For unknown reasons, when using "4dos.com" the current directory is
6528 changed to "C:\". To avoid this set 'shell' like this: >
6529 :set shell=command.com\ /c\ 4dos
6530< This option cannot be set from a |modeline| or in the |sandbox|, for
6531 security reasons.
6532
6533 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006534'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006535 Win32, when 'shell' does not contain "sh"
6536 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006539 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6540 set according to the value of 'shell', to reduce the need to set this
6541 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006542 On Unix it can have more than one flag. Each white space separated
6543 part is passed as an argument to the shell command.
6544 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006545 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 This option cannot be set from a |modeline| or in the |sandbox|, for
6547 security reasons.
6548
6549 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006550'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6551 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 {not available when compiled without the |+quickfix|
6554 feature}
6555 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006556 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 including spaces and backslashes.
6558 The name of the temporary file can be represented by "%s" if necessary
6559 (the file name is appended automatically if no %s appears in the value
6560 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006561 For the Amiga the default is ">". For MS-Windows the default is
6562 ">%s 2>&1". The output is directly saved in a file and not echoed to
6563 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 For Unix the default it "| tee". The stdout of the compiler is saved
6565 in a file and echoed to the screen. If the 'shell' option is "csh" or
6566 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006567 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6568 "bash" or "fish" the default becomes "2>&1| tee". This means that
6569 stderr is also included. Before using the 'shell' option a path is
6570 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 The initialization of this option is done after reading the ".vimrc"
6572 and the other initializations, so that when the 'shell' option is set
6573 there, the 'shellpipe' option changes automatically, unless it was
6574 explicitly set before.
6575 When 'shellpipe' is set to an empty string, no redirection of the
6576 ":make" output will be done. This is useful if you use a 'makeprg'
6577 that writes to 'makeef' by itself. If you want no piping, but do
6578 want to include the 'makeef', set 'shellpipe' to a single space.
6579 Don't forget to precede the space with a backslash: ":set sp=\ ".
6580 In the future pipes may be used for filtering and this option will
6581 become obsolete (at least for Unix).
6582 This option cannot be set from a |modeline| or in the |sandbox|, for
6583 security reasons.
6584
6585 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006586'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 contains "sh" somewhere: "\"")
6588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 Quoting character(s), put around the command passed to the shell, for
6590 the "!" and ":!" commands. The redirection is kept outside of the
6591 quoting. See 'shellxquote' to include the redirection. It's
6592 probably not useful to set both options.
6593 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006594 third-party shells on MS-Windows-like systems, such as the MKS Korn
6595 Shell or bash, where it should be "\"". The default is adjusted
6596 according the value of 'shell', to reduce the need to set this option
6597 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 This option cannot be set from a |modeline| or in the |sandbox|, for
6599 security reasons.
6600
6601 *'shellredir'* *'srr'*
6602'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 String to be used to put the output of a filter command in a temporary
6605 file. See also |:!|. See |option-backslash| about including spaces
6606 and backslashes.
6607 The name of the temporary file can be represented by "%s" if necessary
6608 (the file name is appended automatically if no %s appears in the value
6609 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006610 The default is ">". For Unix, if the 'shell' option is "csh" or
6611 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006612 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6613 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6614 stderr is also included. For Win32, the Unix checks are done and
6615 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6616 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 The initialization of this option is done after reading the ".vimrc"
6618 and the other initializations, so that when the 'shell' option is set
6619 there, the 'shellredir' option changes automatically unless it was
6620 explicitly set before.
6621 In the future pipes may be used for filtering and this option will
6622 become obsolete (at least for Unix).
6623 This option cannot be set from a |modeline| or in the |sandbox|, for
6624 security reasons.
6625
6626 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6627'shellslash' 'ssl' boolean (default off)
6628 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006629 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006631 useful when a Unix-like shell is used instead of cmd.exe. Backward
6632 slashes can still be typed, but they are changed to forward slashes by
6633 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 Note that setting or resetting this option has no effect for some
6635 existing file names, thus this option needs to be set before opening
6636 any file for best results. This might change in the future.
6637 'shellslash' only works when a backslash can be used as a path
6638 separator. To test if this is so use: >
6639 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006640< Also see 'completeslash'.
6641
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006642 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6643'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6644 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006645 When on, use temp files for shell commands. When off use a pipe.
6646 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006647 Currently a pipe is only supported on Unix and MS-Windows 2K and
6648 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006649 :if has("filterpipe")
6650< The advantage of using a pipe is that nobody can read the temp file
6651 and the 'shell' command does not need to support redirection.
6652 The advantage of using a temp file is that the file type and encoding
6653 can be detected.
6654 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6655 |FilterWritePost| autocommands event are not triggered when
6656 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006657 The `system()` function does not respect this option and always uses
6658 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006659 NOTE: This option is set to the Vim default value when 'compatible'
6660 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006661
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 *'shelltype'* *'st'*
6663'shelltype' 'st' number (default 0)
6664 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006665 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 On the Amiga this option influences the way how the commands work
6667 which use a shell.
6668 0 and 1: always use the shell
6669 2 and 3: use the shell only to filter lines
6670 4 and 5: use shell only for ':sh' command
6671 When not using the shell, the command is executed directly.
6672
6673 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6674 1 and 3: use "shell cmd" to start external commands
6675
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006676 *'shellxescape'* *'sxe'*
6677'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006678 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006679 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006680 When 'shellxquote' is set to "(" then the characters listed in this
6681 option will be escaped with a '^' character. This makes it possible
6682 to execute most external commands with cmd.exe.
6683
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 *'shellxquote'* *'sxq'*
6685'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006686 for Win32, when 'shell' is cmd.exe: "("
6687 for Win32, when 'shell' contains "sh"
6688 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 for Unix, when using system(): "\"")
6690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 Quoting character(s), put around the command passed to the shell, for
6692 the "!" and ":!" commands. Includes the redirection. See
6693 'shellquote' to exclude the redirection. It's probably not useful
6694 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006695 When the value is '(' then ')' is appended. When the value is '"('
6696 then ')"' is appended.
6697 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006698 This is an empty string by default on most systems, but is known to be
6699 useful for on Win32 version, either for cmd.exe which automatically
6700 strips off the first and last quote on a command, or 3rd-party shells
6701 such as the MKS Korn Shell or bash, where it should be "\"". The
6702 default is adjusted according the value of 'shell', to reduce the need
6703 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 This option cannot be set from a |modeline| or in the |sandbox|, for
6705 security reasons.
6706
6707 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6708'shiftround' 'sr' boolean (default off)
6709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 Round indent to multiple of 'shiftwidth'. Applies to > and <
6711 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6712 a multiple of 'shiftwidth' (this is Vi compatible).
6713 NOTE: This option is reset when 'compatible' is set.
6714
6715 *'shiftwidth'* *'sw'*
6716'shiftwidth' 'sw' number (default 8)
6717 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006718 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006720 When zero the 'ts' value will be used. Use the |shiftwidth()|
6721 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722
6723 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006724'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6725 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 This option helps to avoid all the |hit-enter| prompts caused by file
6728 messages, for example with CTRL-G, and to avoid some other messages.
6729 It is a list of flags:
6730 flag meaning when present ~
6731 f use "(3 of 5)" instead of "(file 3 of 5)"
6732 i use "[noeol]" instead of "[Incomplete last line]"
6733 l use "999L, 888C" instead of "999 lines, 888 characters"
6734 m use "[+]" instead of "[Modified]"
6735 n use "[New]" instead of "[New File]"
6736 r use "[RO]" instead of "[readonly]"
6737 w use "[w]" instead of "written" for file write message
6738 and "[a]" instead of "appended" for ':w >> file' command
6739 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6740 "[unix format]" and "[mac]" instead of "[mac format]".
6741 a all of the above abbreviations
6742
6743 o overwrite message for writing a file with subsequent message
6744 for reading a file (useful for ":wn" or when 'autowrite' on)
6745 O message for reading a file overwrites any previous message.
6746 Also for quickfix message (e.g., ":cn").
6747 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006748 hit TOP, continuing at BOTTOM" messages; when using the search
6749 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 t truncate file message at the start if it is too long to fit
6751 on the command-line, "<" will appear in the left most column.
6752 Ignored in Ex mode.
6753 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006754 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 Ignored in Ex mode.
6756 W don't give "written" or "[w]" when writing a file
6757 A don't give the "ATTENTION" message when an existing swap file
6758 is found.
6759 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006760 c don't give |ins-completion-menu| messages. For example,
6761 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6762 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006763 q use "recording" instead of "recording @a"
6764 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006765 was used for the command; note that this also affects messages
6766 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006767 S do not show search count message when searching, e.g.
6768 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006769
6770 This gives you the opportunity to avoid that a change between buffers
6771 requires you to hit <Enter>, but still gives as useful a message as
6772 possible for the space available. To get the whole message that you
6773 would have got with 'shm' empty, use ":file!"
6774 Useful values:
6775 shm= No abbreviation of message.
6776 shm=a Abbreviation, but no loss of information.
6777 shm=at Abbreviation, and truncate message when necessary.
6778
6779 NOTE: This option is set to the Vi default value when 'compatible' is
6780 set and to the Vim default value when 'compatible' is reset.
6781
6782 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6783'shortname' 'sn' boolean (default off)
6784 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 Filenames are assumed to be 8 characters plus one extension of 3
6786 characters. Multiple dots in file names are not allowed. When this
6787 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006788 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006790 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791
6792 *'showbreak'* *'sbr'* *E595*
6793'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006794 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006795 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 feature}
6797 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006798 values are "> " or "+++ ": >
6799 :set showbreak=>\
6800< Note the backslash to escape the trailing space. It's easier like
6801 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006802 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006803< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 comma (in a future version the comma might be used to separate the
6805 part that is shown at the end and at the start of a line).
6806 The characters are highlighted according to the '@' flag in
6807 'highlight'.
6808 Note that tabs after the showbreak will be displayed differently.
6809 If you want the 'showbreak' to appear in between line numbers, add the
6810 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006811 A window-local value overrules a global value. If the global value is
6812 set and you want no value in the current window use NONE: >
6813 :setlocal showbreak=NONE
6814<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006816'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6817 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 {not available when compiled without the
6820 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006821 Show (partial) command in the last line of the screen. Set this
6822 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 In Visual mode the size of the selected area is shown:
6824 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006825 If the number of bytes is different it is also displayed: "2-6"
6826 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006828 - When selecting a block, the size in screen characters:
6829 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 NOTE: This option is set to the Vi default value when 'compatible' is
6831 set and to the Vim default value when 'compatible' is reset.
6832
6833 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6834'showfulltag' 'sft' boolean (default off)
6835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 When completing a word in insert mode (see |ins-completion|) from the
6837 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006838 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 matched a C function, you can see a template for what arguments are
6840 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006841 Note that this doesn't work well together with having "longest" in
6842 'completeopt', because the completion from the search pattern may not
6843 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844
6845 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6846'showmatch' 'sm' boolean (default off)
6847 global
6848 When a bracket is inserted, briefly jump to the matching one. The
6849 jump is only done if the match can be seen on the screen. The time to
6850 show the match can be set with 'matchtime'.
6851 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006852 seen or not).
6853 This option is reset when 'paste' is set and restored when 'paste' is
6854 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 When the 'm' flag is not included in 'cpoptions', typing a character
6856 will immediately move the cursor back to where it belongs.
6857 See the "sm" field in 'guicursor' for setting the cursor shape and
6858 blinking when showing the match.
6859 The 'matchpairs' option can be used to specify the characters to show
6860 matches for. 'rightleft' and 'revins' are used to look for opposite
6861 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006862 Also see the matchparen plugin for highlighting the match when moving
6863 around |pi_paren.txt|.
6864 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865
6866 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6867'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6868 global
6869 If in Insert, Replace or Visual mode put a message on the last line.
6870 Use the 'M' flag in 'highlight' to set the type of highlighting for
6871 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006872 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 doesn't mean XIM is really active, especially when 'imactivatekey' is
6874 not set.
6875 NOTE: This option is set to the Vi default value when 'compatible' is
6876 set and to the Vim default value when 'compatible' is reset.
6877
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006878 *'showtabline'* *'stal'*
6879'showtabline' 'stal' number (default 1)
6880 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006881 The value of this option specifies when the line with tab page labels
6882 will be displayed:
6883 0: never
6884 1: only if there are at least two tab pages
6885 2: always
6886 This is both for the GUI and non-GUI implementation of the tab pages
6887 line.
6888 See |tab-page| for more information about tab pages.
6889
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 *'sidescroll'* *'ss'*
6891'sidescroll' 'ss' number (default 0)
6892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 The minimal number of columns to scroll horizontally. Used only when
6894 the 'wrap' option is off and the cursor is moved off of the screen.
6895 When it is zero the cursor will be put in the middle of the screen.
6896 When using a slow terminal set it to a large number or 0. When using
6897 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6898 commands.
6899
6900 *'sidescrolloff'* *'siso'*
6901'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006902 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006904 right of the cursor if 'nowrap' is set. Setting this option to a
6905 value greater than 0 while having |'sidescroll'| also at a non-zero
6906 value makes some context visible in the line you are scrolling in
6907 horizontally (except at beginning of the line). Setting this option
6908 to a large value (like 999) has the effect of keeping the cursor
6909 horizontally centered in the window, as long as one does not come too
6910 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006911 After using the local value, go back the global value with one of
6912 these two: >
6913 setlocal sidescrolloff<
6914 setlocal sidescrolloff=-1
6915< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916
6917 Example: Try this together with 'sidescroll' and 'listchars' as
6918 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006919 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920
6921 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6922 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006923<
6924 *'signcolumn'* *'scl'*
6925'signcolumn' 'scl' string (default "auto")
6926 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006927 {not available when compiled without the |+signs|
6928 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006929 Whether or not to draw the signcolumn. Valid values are:
6930 "auto" only when there is a sign to display
6931 "no" never
6932 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006933 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006934 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935
6936
6937 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6938'smartcase' 'scs' boolean (default off)
6939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 Override the 'ignorecase' option if the search pattern contains upper
6941 case characters. Only used when the search pattern is typed and
6942 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006943 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006944 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6945 recalling the search pattern from history and hitting <Enter>.
6946 NOTE: This option is reset when 'compatible' is set.
6947
6948 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6949'smartindent' 'si' boolean (default off)
6950 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 {not available when compiled without the
6952 |+smartindent| feature}
6953 Do smart autoindenting when starting a new line. Works for C-like
6954 programs, but can also be used for other languages. 'cindent' does
6955 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006956 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006957 setting 'si' has no effect. 'indentexpr' is a more advanced
6958 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 Normally 'autoindent' should also be on when using 'smartindent'.
6960 An indent is automatically inserted:
6961 - After a line ending in '{'.
6962 - After a line starting with a keyword from 'cinwords'.
6963 - Before a line starting with '}' (only with the "O" command).
6964 When typing '}' as the first character in a new line, that line is
6965 given the same indent as the matching '{'.
6966 When typing '#' as the first character in a new line, the indent for
6967 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006968 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6970 When using the ">>" command, lines starting with '#' are not shifted
6971 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006972 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006973 This option is reset when 'paste' is set and restored when 'paste' is
6974 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975
6976 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6977'smarttab' 'sta' boolean (default off)
6978 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006980 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6981 <BS> will delete a 'shiftwidth' worth of space at the start of the
6982 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006983 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006984 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6985 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006986 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006988 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006989 This option is reset when 'paste' is set and restored when 'paste' is
6990 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 NOTE: This option is reset when 'compatible' is set.
6992
6993 *'softtabstop'* *'sts'*
6994'softtabstop' 'sts' number (default 0)
6995 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 Number of spaces that a <Tab> counts for while performing editing
6997 operations, like inserting a <Tab> or using <BS>. It "feels" like
6998 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6999 used. This is useful to keep the 'ts' setting at its standard value
7000 of 8, while being able to edit like it is set to 'sts'. However,
7001 commands like "x" still work on the actual characters.
7002 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007003 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007004 'softtabstop' is set to 0 when the 'paste' option is set and restored
7005 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7007 spaces is minimized by using <Tab>s.
7008 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7009 set.
7010 NOTE: This option is set to 0 when 'compatible' is set.
7011
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007012 If Vim is compiled with the |+vartabs| feature then the value of
7013 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7014 anything other than an empty string.
7015
Bram Moolenaar217ad922005-03-20 22:37:15 +00007016 *'spell'* *'nospell'*
7017'spell' boolean (default off)
7018 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007019 {not available when compiled without the |+syntax|
7020 feature}
7021 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007022 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007023
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007024 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007025'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007026 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007027 {not available when compiled without the |+syntax|
7028 feature}
7029 Pattern to locate the end of a sentence. The following word will be
7030 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007031 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007032 When this check is not wanted make this option empty.
7033 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007034 Be careful with special characters, see |option-backslash| about
7035 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007036 To set this option automatically depending on the language, see
7037 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007038
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007039 *'spellfile'* *'spf'*
7040'spellfile' 'spf' string (default empty)
7041 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007042 {not available when compiled without the |+syntax|
7043 feature}
7044 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007045 commands. It must end in ".{encoding}.add". You need to include the
7046 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007047 *E765*
7048 It may also be a comma separated list of names. A count before the
7049 |zg| and |zw| commands can be used to access each. This allows using
7050 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007051 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007052 you: Using the first directory in 'runtimepath' that is writable. If
7053 there is no "spell" directory yet it will be created. For the file
7054 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007055 ignoring the region.
7056 The resulting ".spl" file will be used for spell checking, it does not
7057 have to appear in 'spelllang'.
7058 Normally one file is used for all regions, but you can add the region
7059 name if you want to. However, it will then only be used when
7060 'spellfile' is set to it, for entries in 'spelllang' only files
7061 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007062 This option cannot be set from a |modeline| or in the |sandbox|, for
7063 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007064
Bram Moolenaar217ad922005-03-20 22:37:15 +00007065 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007066'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007067 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007068 {not available when compiled without the |+syntax|
7069 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007070 A comma separated list of word list names. When the 'spell' option is
7071 on spellchecking will be done for these languages. Example: >
7072 set spelllang=en_us,nl,medical
7073< This means US English, Dutch and medical words are recognized. Words
7074 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007075 The word list name must consist of alphanumeric characters, a dash or
7076 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007077 recommended to separate the two letter language name from a
7078 specification. Thus "en-rare" is used for rare English words.
7079 A region name must come last and have the form "_xx", where "xx" is
7080 the two-letter, lower case region name. You can use more than one
7081 region by listing them: "en_us,en_ca" supports both US and Canadian
7082 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007083 Britain. (Note: currently en_au and en_nz dictionaries are older than
7084 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007085 If the name "cjk" is included East Asian characters are excluded from
7086 spell checking. This is useful when editing text that also has Asian
7087 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007088 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007089 As a special case the name of a .spl file can be given as-is. The
7090 first "_xx" in the name is removed and used as the region name
7091 (_xx is an underscore, two letters and followed by a non-letter).
7092 This is mainly for testing purposes. You must make sure the correct
7093 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007094 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007095 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7096 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007097 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007098
Bram Moolenaar98692072006-02-04 00:57:42 +00007099 If the |spellfile.vim| plugin is active and you use a language name
7100 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7101 will ask you if you want to download the file.
7102
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007103 After this option has been set successfully, Vim will source the files
7104 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007105 up to the first character that is not an ASCII letter or number and
7106 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007107
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007108 *'spelloptions'* *'spo'*
7109'spelloptions' 'spo' string (default "")
7110 local to buffer
7111 {not available when compiled without the |+syntax|
7112 feature}
7113 A comma separated list of options for spell checking:
7114 camel When a word is CamelCased, assume "Cased" is a
7115 separate word: every upper-case character in a word
7116 that comes after a lower case character indicates the
7117 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007118
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007119 *'spellsuggest'* *'sps'*
7120'spellsuggest' 'sps' string (default "best")
7121 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007122 {not available when compiled without the |+syntax|
7123 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007124 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007125 the |spellsuggest()| function. This is a comma-separated list of
7126 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007127
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007128 best Internal method that works best for English. Finds
7129 changes like "fast" and uses a bit of sound-a-like
7130 scoring to improve the ordering.
7131
7132 double Internal method that uses two methods and mixes the
7133 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007134 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007135 word. That only works when the language specifies
7136 sound folding. Can be slow and doesn't always give
7137 better results.
7138
7139 fast Internal method that only checks for simple changes:
7140 character inserts/deletes/swaps. Works well for
7141 simple typing mistakes.
7142
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007143 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007144 Not used for |spellsuggest()|. The number of
7145 suggestions is never more than the value of 'lines'
7146 minus two.
7147
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007148 file:{filename} Read file {filename}, which must have two columns,
7149 separated by a slash. The first column contains the
7150 bad word, the second column the suggested good word.
7151 Example:
7152 theribal/terrible ~
7153 Use this for common mistakes that do not appear at the
7154 top of the suggestion list with the internal methods.
7155 Lines without a slash are ignored, use this for
7156 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007157 The word in the second column must be correct,
7158 otherwise it will not be used. Add the word to an
7159 ".add" file if it is currently flagged as a spelling
7160 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007161 The file is used for all languages.
7162
7163 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7164 trouble with spaces. |v:val| holds the badly spelled
7165 word. The expression must evaluate to a List of
7166 Lists, each with a suggestion and a score.
7167 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007168 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007169 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007170 internal methods use. A lower score is better.
7171 This may invoke |spellsuggest()| if you temporarily
7172 set 'spellsuggest' to exclude the "expr:" part.
7173 Errors are silently ignored, unless you set the
7174 'verbose' option to a non-zero value.
7175
7176 Only one of "best", "double" or "fast" may be used. The others may
7177 appear several times in any order. Example: >
7178 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7179<
7180 This option cannot be set from a |modeline| or in the |sandbox|, for
7181 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007182
7183
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7185'splitbelow' 'sb' boolean (default off)
7186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 When on, splitting a window will put the new window below the current
7188 one. |:split|
7189
7190 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7191'splitright' 'spr' boolean (default off)
7192 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 When on, splitting a window will put the new window right of the
7194 current one. |:vsplit|
7195
7196 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7197'startofline' 'sol' boolean (default on)
7198 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007199 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007200 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007201 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007202 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 with a linewise operator, with "%" with a count and to buffer changing
7204 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7205 only has a line number, e.g., ":25" or ":+".
7206 In case of buffer changing commands the cursor is placed at the column
7207 where it was the last time the buffer was edited.
7208 NOTE: This option is set when 'compatible' is set.
7209
Bram Moolenaar00654022011-02-25 14:42:19 +01007210 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007211'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007212 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 {not available when compiled without the |+statusline|
7214 feature}
7215 When nonempty, this option determines the content of the status line.
7216 Also see |status-line|.
7217
7218 The option consists of printf style '%' items interspersed with
7219 normal text. Each status line item is of the form:
7220 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007221 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007222 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223
Bram Moolenaar238a5642006-02-21 22:12:05 +00007224 When the option starts with "%!" then it is used as an expression,
7225 evaluated and the result is used as the option value. Example: >
7226 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007227< The *g:statusline_winid* variable will be set to the |window-ID| of the
7228 window that the status line belongs to.
7229 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007230 Note that the "%!" expression is evaluated in the context of the
7231 current window and buffer, while %{} items are evaluated in the
7232 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007233
7234 When there is error while evaluating the option then it will be made
7235 empty to avoid further errors. Otherwise screen updating would loop.
7236
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 Note that the only effect of 'ruler' when this option is set (and
7238 'laststatus' is 2) is controlling the output of |CTRL-G|.
7239
7240 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007241 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007243 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 minwid Minimum width of the item, padding as set by '-' & '0'.
7245 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 on the left for text items. Numeric items will be
7248 shifted down to maxwid-2 digits followed by '>'number
7249 where number is the amount of missing digits, much like
7250 an exponential notation.
7251 item A one letter code as described below.
7252
7253 Following is a description of the possible statusline items. The
7254 second character in "item" is the type:
7255 N for number
7256 S for string
7257 F for flags as described below
7258 - not applicable
7259
7260 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007261 f S Path to the file in the buffer, as typed or relative to current
7262 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 F S Full path to the file in the buffer.
7264 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007265 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007267 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007269 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007271 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007273 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007275 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7277 being used: "<keymap>"
7278 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007279 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 B N As above, in hexadecimal.
7281 o N Byte number in file of byte under cursor, first byte is 1.
7282 Mnemonic: Offset from start of file (with one added)
7283 {not available when compiled without |+byte_offset| feature}
7284 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007285 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 l N Line number.
7287 L N Number of lines in buffer.
7288 c N Column number.
7289 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007290 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 p N Percentage through file in lines as in |CTRL-G|.
7292 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007293 percentage described for 'ruler'. Always 3 in length, unless
7294 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007295 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007297 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007298 Note that there is no '%' before the closing '}'. The
7299 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007300 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 ( - Start of item group. Can be used for setting the width and
7302 alignment of a section. Must be followed by %) somewhere.
7303 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007304 T N For 'tabline': start of tab page N label. Use %T after the last
7305 label. This information is used for mouse clicks.
7306 X N For 'tabline': start of close tab N label. Use %X after the
7307 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7308 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 < - Where to truncate line if too long. Default is at the start.
7310 No width fields allowed.
7311 = - Separation point between left and right aligned items.
7312 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007313 # - Set highlight group. The name must follow and then a # again.
7314 Thus use %#HLname# for highlight group HLname. The same
7315 highlighting is used, also for the statusline of non-current
7316 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007318 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 The difference between User{N} and StatusLine will be applied
7320 to StatusLineNC for the statusline of non-current windows.
7321 The number N must be between 1 and 9. See |hl-User1..9|
7322
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007323 When displaying a flag, Vim removes the leading comma, if any, when
7324 that flag comes right after plaintext. This will make a nice display
7325 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326
Bram Moolenaar582fd852005-03-28 20:58:01 +00007327 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 not set) and a minwid is not set for the group, the whole group will
7329 become empty. This will make a group like the following disappear
7330 completely from the statusline when none of the flags are set. >
7331 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007332< Beware that an expression is evaluated each and every time the status
7333 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007334 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007335 While evaluating %{} the current buffer and current window will be set
7336 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007337 currently being drawn. The expression will evaluate in this context.
7338 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7339 real current buffer and "g:actual_curwin" to the |window-ID| of the
7340 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007341
Bram Moolenaar30b65812012-07-12 22:01:11 +02007342 The 'statusline' option will be evaluated in the |sandbox| if set from
7343 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007344 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007345
7346 It is not allowed to change text or jump to another window while
7347 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007348
7349 If the statusline is not updated when you want it (e.g., after setting
7350 a variable that's used in an expression), you can force an update by
7351 setting an option without changing its value. Example: >
7352 :let &ro = &ro
7353
7354< A result of all digits is regarded a number for display purposes.
7355 Otherwise the result is taken as flag text and applied to the rules
7356 described above.
7357
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007358 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007360 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361
7362 Examples:
7363 Emulate standard status line with 'ruler' set >
7364 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7365< Similar, but add ASCII value of char under the cursor (like "ga") >
7366 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7367< Display byte count and byte value, modified flag in red. >
7368 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7369 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7370< Display a ,GZ flag if a compressed file is loaded >
7371 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7372< In the |:autocmd|'s: >
7373 :let b:gzflag = 1
7374< And: >
7375 :unlet b:gzflag
7376< And define this function: >
7377 :function VarExists(var, val)
7378 : if exists(a:var) | return a:val | else | return '' | endif
7379 :endfunction
7380<
7381 *'suffixes'* *'su'*
7382'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7383 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 Files with these suffixes get a lower priority when multiple files
7385 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 suffixes. Spaces after the comma are ignored. A dot is also seen as
7387 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 separator, precede it with a backslash (see |option-backslash| about
7389 including spaces and backslashes).
7390 See 'wildignore' for completely ignoring files.
7391 The use of |:set+=| and |:set-=| is preferred when adding or removing
7392 suffixes from the list. This avoids problems when a future version
7393 uses another default.
7394
7395 *'suffixesadd'* *'sua'*
7396'suffixesadd' 'sua' string (default "")
7397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 {not available when compiled without the
7399 |+file_in_path| feature}
7400 Comma separated list of suffixes, which are used when searching for a
7401 file for the "gf", "[I", etc. commands. Example: >
7402 :set suffixesadd=.java
7403<
7404 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7405'swapfile' 'swf' boolean (default on)
7406 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007407 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 swapfile is not wanted for a specific buffer. For example, with
7409 confidential information that even root must not be able to access.
7410 Careful: All text will be in memory:
7411 - Don't use this for big files.
7412 - Recovery will be impossible!
7413 A swapfile will only be present when |'updatecount'| is non-zero and
7414 'swapfile' is set.
7415 When 'swapfile' is reset, the swap file for the current buffer is
7416 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7417 non-zero, a swap file is immediately created.
7418 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007419 If you want to open a new buffer without creating a swap file for it,
7420 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007421 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422
7423 This option is used together with 'bufhidden' and 'buftype' to
7424 specify special kinds of buffers. See |special-buffers|.
7425
7426 *'swapsync'* *'sws'*
7427'swapsync' 'sws' string (default "fsync")
7428 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007429 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007430 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 When this option is empty parts of the swap file may be in memory and
7432 not written to disk. When the system crashes you may lose more work.
7433 On Unix the system does a sync now and then without Vim asking for it,
7434 so the disadvantage of setting this option off is small. On some
7435 systems the swap file will not be written at all. For a unix system
7436 setting it to "sync" will use the sync() call instead of the default
7437 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007438 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439
7440 *'switchbuf'* *'swb'*
7441'switchbuf' 'swb' string (default "")
7442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443 This option controls the behavior when switching between buffers.
7444 Possible values (comma separated list):
7445 useopen If included, jump to the first open window that
7446 contains the specified buffer (if there is one).
7447 Otherwise: Do not examine other windows.
7448 This setting is checked with |quickfix| commands, when
7449 jumping to errors (":cc", ":cn", "cp", etc.). It is
7450 also used in all buffer related split commands, for
7451 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007452 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007453 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007455 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007456 Otherwise: do not split, use current window (when used
7457 in the quickfix window: the previously used window or
7458 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007459 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007460 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007461 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007462 uselast If included, jump to the previously used window when
7463 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007465 *'synmaxcol'* *'smc'*
7466'synmaxcol' 'smc' number (default 3000)
7467 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007468 {not available when compiled without the |+syntax|
7469 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007470 Maximum column in which to search for syntax items. In long lines the
7471 text after this column is not highlighted and following lines may not
7472 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007473 This helps to avoid very slow redrawing for an XML file that is one
7474 long line.
7475 Set to zero to remove the limit.
7476
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 *'syntax'* *'syn'*
7478'syntax' 'syn' string (default empty)
7479 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 {not available when compiled without the |+syntax|
7481 feature}
7482 When this option is set, the syntax with this name is loaded, unless
7483 syntax highlighting has been switched off with ":syntax off".
7484 Otherwise this option does not always reflect the current syntax (the
7485 b:current_syntax variable does).
7486 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007487 not automatically recognized. Example, in an IDL file:
7488 /* vim: set syntax=idl : */ ~
7489 When a dot appears in the value then this separates two filetype
7490 names. Example:
7491 /* vim: set syntax=c.doxygen : */ ~
7492 This will use the "c" syntax first, then the "doxygen" syntax.
7493 Note that the second one must be prepared to be loaded as an addition,
7494 otherwise it will be skipped. More than one dot may appear.
7495 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 :set syntax=OFF
7497< To switch syntax highlighting on according to the current value of the
7498 'filetype' option: >
7499 :set syntax=ON
7500< What actually happens when setting the 'syntax' option is that the
7501 Syntax autocommand event is triggered with the value as argument.
7502 This option is not copied to another buffer, independent of the 's' or
7503 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007504 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007506 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007507'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007508 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007509 When nonempty, this option determines the content of the tab pages
7510 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007511 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007512
7513 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007514 option and only when there is no GUI tab line. When 'e' is in
7515 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007516 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007517
7518 The value is evaluated like with 'statusline'. You can use
7519 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007520 the text to be displayed. Use "%1T" for the first label, "%2T" for
7521 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007522
Bram Moolenaare12bab32019-01-08 22:02:56 +01007523 When changing something that is used in 'tabline' that does not
7524 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007525 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007526
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007527 Keep in mind that only one of the tab pages is the current one, others
7528 are invisible and you can't jump to their windows.
7529
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007530
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007531 *'tabpagemax'* *'tpm'*
7532'tabpagemax' 'tpm' number (default 10)
7533 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007534 Maximum number of tab pages to be opened by the |-p| command line
7535 argument or the ":tab all" command. |tabpage|
7536
7537
7538 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539'tabstop' 'ts' number (default 8)
7540 local to buffer
7541 Number of spaces that a <Tab> in the file counts for. Also see
7542 |:retab| command, and 'softtabstop' option.
7543
7544 Note: Setting 'tabstop' to any other value than 8 can make your file
7545 appear wrong in many places (e.g., when printing it).
7546
7547 There are four main ways to use tabs in Vim:
7548 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7549 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007550 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 behave like a tab appears every 4 (or 3) characters.
7552 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7553 'expandtab'. This way you will always insert spaces. The
7554 formatting will never be messed up when 'tabstop' is changed.
7555 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007556 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 works when using Vim to edit the file.
7558 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7559 'noexpandtab'. This should then work (for initial indents only)
7560 for any tabstop setting that people use. It might be nice to have
7561 tabs after the first non-blank inserted as spaces if you do this
7562 though. Otherwise aligned comments will be wrong when 'tabstop' is
7563 changed.
7564
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007565 If Vim is compiled with the |+vartabs| feature then the value of
7566 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7567 than an empty string.
7568
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7570'tagbsearch' 'tbs' boolean (default on)
7571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007573 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 searching makes searching for a tag a LOT faster, but a linear search
7575 will find more tags if the tags file wasn't properly sorted.
7576 Vim normally assumes that your tags files are sorted, or indicate that
7577 they are not sorted. Only when this is not the case does the
7578 'tagbsearch' option need to be switched off.
7579
7580 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007581 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 certain files, or retry all files with a linear search. When
7583 'tagbsearch' is off, only a linear search is done.
7584
7585 Linear searching is done anyway, for one file, when Vim finds a line
7586 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007587 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588< [The whitespace before and after the '0' must be a single <Tab>]
7589
7590 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007591 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 instead of a normal tag name, a retry is done with a linear search.
7593 Tags in unsorted tags files, and matches with different case will only
7594 be found in the retry.
7595
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007596 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007597 linear search can be avoided when case is ignored. Use a value of '2'
7598 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7599 sorted with the -f switch to "sort" in most unices, as in the command:
7600 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7601 (at least 5.5) the --sort=foldcase switch can be used for this as
7602 well. Note that case must be folded to uppercase for this to work.
7603
7604 By default, tag searches are case-sensitive. Case is ignored when
7605 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7606 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007607 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7608 'tagcase' is "smart", and the pattern contains only lowercase
7609 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610
7611 When 'tagbsearch' is off, tags searching is slower when a full match
7612 exists, but faster when no full match exists. Tags in unsorted tags
7613 files may only be found with 'tagbsearch' off.
7614 When the tags file is not sorted, or sorted in a wrong way (not on
7615 ASCII byte value), 'tagbsearch' should be off, or the line given above
7616 must be included in the tags file.
7617 This option doesn't affect commands that find all matching tags (e.g.,
7618 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007619
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007620 *'tagcase'* *'tc'*
7621'tagcase' 'tc' string (default "followic")
7622 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007623 This option specifies how case is handled when searching the tags
7624 file:
7625 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007626 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007627 ignore Ignore case
7628 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007629 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007630 NOTE: This option is set to the Vi default value when 'compatible' is
7631 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007632
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007633 *'tagfunc'* *'tfu'*
7634'tagfunc' 'tfu' string (default: empty)
7635 local to buffer
7636 {not available when compiled without the |+eval|
7637 feature}
7638 This option specifies a function to be used to perform tag searches.
7639 The function gets the tag pattern and should return a List of matching
7640 tags. See |tag-function| for an explanation of how to write the
7641 function and an example.
7642
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 *'taglength'* *'tl'*
7644'taglength' 'tl' number (default 0)
7645 global
7646 If non-zero, tags are significant up to this number of characters.
7647
7648 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7649'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7650 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007651 If on and using a tags file in another directory, file names in that
7652 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 NOTE: This option is set to the Vi default value when 'compatible' is
7654 set and to the Vim default value when 'compatible' is reset.
7655
7656 *'tags'* *'tag'* *E433*
7657'tags' 'tag' string (default "./tags,tags", when compiled with
7658 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7659 global or local to buffer |global-local|
7660 Filenames for the tag command, separated by spaces or commas. To
7661 include a space or comma in a file name, precede it with a backslash
7662 (see |option-backslash| about including spaces and backslashes).
7663 When a file name starts with "./", the '.' is replaced with the path
7664 of the current file. But only when the 'd' flag is not included in
7665 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7666 |tags-option|.
7667 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007668 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7669 find all files named "tags" below "/lib". The filename itself cannot
7670 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7671 files called "tags?". {not available when compiled without the
7672 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007673 The |tagfiles()| function can be used to get a list of the file names
7674 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7676 files are also supported. They are automatically recognized. The
7677 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7678 differences are ignored (MS-Windows). |emacs-tags|
7679 The use of |:set+=| and |:set-=| is preferred when adding or removing
7680 file names from the list. This avoids problems when a future version
7681 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682
7683 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7684'tagstack' 'tgst' boolean (default on)
7685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 When on, the |tagstack| is used normally. When off, a ":tag" or
7687 ":tselect" command with an argument will not push the tag onto the
7688 tagstack. A following ":tag" without an argument, a ":pop" command or
7689 any other command that uses the tagstack will use the unmodified
7690 tagstack, but does change the pointer to the active entry.
7691 Resetting this option is useful when using a ":tag" command in a
7692 mapping which should not change the tagstack.
7693
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007694 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007695'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007696 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007697 {only available when compiled with the |+tcl/dyn|
7698 feature}
7699 Specifies the name of the Tcl shared library. The default is
7700 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007701 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007702 This option cannot be set from a |modeline| or in the |sandbox|, for
7703 security reasons.
7704
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 *'term'* *E529* *E530* *E531*
7706'term' string (default is $TERM, if that fails:
7707 in the GUI: "builtin_gui"
7708 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007709 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 on Mac: "mac-ansi"
7711 on MiNT: "vt52"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 on Unix: "ansi"
7713 on VMS: "ansi"
7714 on Win 32: "win32")
7715 global
7716 Name of the terminal. Used for choosing the terminal control
7717 characters. Environment variables are expanded |:set_env|.
7718 For example: >
7719 :set term=$TERM
7720< See |termcap|.
7721
7722 *'termbidi'* *'tbidi'*
7723 *'notermbidi'* *'notbidi'*
7724'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7725 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 {only available when compiled with the |+arabic|
7727 feature}
7728 The terminal is in charge of Bi-directionality of text (as specified
7729 by Unicode). The terminal is also expected to do the required shaping
7730 that some languages (such as Arabic) require.
7731 Setting this option implies that 'rightleft' will not be set when
7732 'arabic' is set and the value of 'arabicshape' will be ignored.
7733 Note that setting 'termbidi' has the immediate effect that
7734 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7735 This option is reset when the GUI is started.
7736 For further details see |arabic.txt|.
7737
7738 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007739'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 Macintosh GUI: "macroman")
7741 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 Encoding used for the terminal. This specifies what character
7743 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007744 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007745 display). Except for the Mac when 'macatsui' is off, then
7746 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007747 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007748 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007749 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7750 Any attempts to set a different value will be rejected, and an error
7751 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007752 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 because the Win32 system always passes Unicode characters.
7754 When empty, the same encoding is used as for the 'encoding' option.
7755 This is the normal value.
7756 Not all combinations for 'termencoding' and 'encoding' are valid. See
7757 |encoding-table|.
7758 The value for this option must be supported by internal conversions or
7759 iconv(). When this is not possible no conversion will be done and you
7760 will probably experience problems with non-ASCII characters.
7761 Example: You are working with the locale set to euc-jp (Japanese) and
7762 want to edit a UTF-8 file: >
7763 :let &termencoding = &encoding
7764 :set encoding=utf-8
7765< You need to do this when your system has no locale support for UTF-8.
7766
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007767 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007768'termguicolors' 'tgc' boolean (default off)
7769 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007770 {not available when compiled without the
7771 |+termguicolors| feature}
7772 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007773 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007774
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007775 Requires a ISO-8613-3 compatible terminal. If setting this option
7776 does not work (produces a colorless UI) reading |xterm-true-color|
7777 might help.
7778
7779 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7780 is required. Use this check to find out: >
7781 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007782< This requires Vim to be built with the |+vtp| feature.
7783
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007784 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007785 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007786
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007787 *'termwinkey'* *'twk'*
7788'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007789 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007790 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007791 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007792 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007793 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007794< The string must be one key stroke but can be multiple bytes.
7795 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007796 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007797 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007798
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007799 *'termwinscroll'* *'twsl'*
7800'termwinscroll' 'twsl' number (default 10000)
7801 local to buffer
7802 {not available when compiled without the
7803 |+terminal| feature}
7804 Number of scrollback lines to keep. When going over this limit the
7805 first 10% of the scrollback lines are deleted. This is just to reduce
7806 the memory usage. See |Terminal-Normal|.
7807
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007808 *'termwinsize'* *'tws'*
7809'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007810 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007811 Size of the |terminal| window. Format: {rows}x{columns} or
7812 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007813 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007814 - When set with a "x" (e.g., "24x80") the terminal size is not
7815 adjusted to the window size. If the window is smaller only the
7816 top-left part is displayed.
7817 - When set with a "*" (e.g., "10*50") the terminal size follows the
7818 window size, but will not be smaller than the specified rows and/or
7819 columns.
7820 - When rows is zero then use the height of the window.
7821 - When columns is zero then use the width of the window.
7822 - Using "0x0" or "0*0" is the same as empty.
7823
7824 Examples:
7825 "30x0" uses 30 rows and the current window width.
7826 "20*0" uses at least 20 rows and the current window width.
7827 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007828 Note that the command running in the terminal window may still change
7829 the size of the terminal. In that case the Vim window will be
7830 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007831
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007832 *'termwintype'* *'twt'*
7833'termwintype' 'twt' string (default "")
7834 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007835 {only available when compiled with the |terminal|
7836 feature on MS-Windows}
7837 Specify the virtual console (pty) used when opening the terminal
7838 window.
7839
7840 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007841 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007842 "winpty" use winpty, fail if not supported
7843 "conpty" use |ConPTY|, fail if not supported
7844
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007845 |ConPTY| support depends on the platform. Windows 10 October 2018
7846 Update is the first version that supports ConPTY, however it is still
7847 considered unstable. ConPTY might become stable in the next release
7848 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007849 supported then you cannot open a terminal window.
7850
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851 *'terse'* *'noterse'*
7852'terse' boolean (default off)
7853 global
7854 When set: Add 's' flag to 'shortmess' option (this makes the message
7855 for a search that hits the start or end of the file not being
7856 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7857 shortens a lot of messages}
7858
7859 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7860'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7861 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 This option is obsolete. Use 'fileformats'.
7863 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7864 set to the default value for the current system. When 'textauto' is
7865 reset, 'fileformats' is made empty.
7866 NOTE: This option is set to the Vi default value when 'compatible' is
7867 set and to the Vim default value when 'compatible' is reset.
7868
7869 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007870'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 others: default off)
7872 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 This option is obsolete. Use 'fileformat'.
7874 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7875 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7876 "unix".
7877
7878 *'textwidth'* *'tw'*
7879'textwidth' 'tw' number (default 0)
7880 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007881 Maximum width of text that is being inserted. A longer line will be
7882 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007883 this.
7884 'textwidth' is set to 0 when the 'paste' option is set and restored
7885 when 'paste' is reset.
7886 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007888 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 NOTE: This option is set to 0 when 'compatible' is set.
7890
7891 *'thesaurus'* *'tsr'*
7892'thesaurus' 'tsr' string (default "")
7893 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007895 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7896
7897 Each line in the file should contain words with similar meaning,
7898 separated by non-keyword characters (white space is preferred).
7899 Maximum line length is 510 bytes.
7900
Bram Moolenaard47d5222018-12-09 20:43:55 +01007901 An English word list was added to this github issue:
7902 https://github.com/vim/vim/issues/629#issuecomment-443293282
7903 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7904 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7905 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007906
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007907 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 after a comma are ignored, otherwise spaces are included in the file
7909 name. See |option-backslash| about using backslashes.
7910 The use of |:set+=| and |:set-=| is preferred when adding or removing
7911 directories from the list. This avoids problems when a future version
7912 uses another default.
7913 Backticks cannot be used in this option for security reasons.
7914
7915 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7916'tildeop' 'top' boolean (default off)
7917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 When on: The tilde command "~" behaves like an operator.
7919 NOTE: This option is reset when 'compatible' is set.
7920
7921 *'timeout'* *'to'* *'notimeout'* *'noto'*
7922'timeout' 'to' boolean (default on)
7923 global
7924 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007925'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 These two options together determine the behavior when part of a
7928 mapped key sequence or keyboard code has been received:
7929
7930 'timeout' 'ttimeout' action ~
7931 off off do not time out
7932 on on or off time out on :mappings and key codes
7933 off on time out on key codes
7934
7935 If both options are off, Vim will wait until either the complete
7936 mapping or key sequence has been received, or it is clear that there
7937 is no mapping or key sequence for the received characters. For
7938 example: if you have mapped "vl" and Vim has received 'v', the next
7939 character is needed to see if the 'v' is followed by an 'l'.
7940 When one of the options is on, Vim will wait for about 1 second for
7941 the next character to arrive. After that the already received
7942 characters are interpreted as single characters. The waiting time can
7943 be changed with the 'timeoutlen' option.
7944 On slow terminals or very busy systems timing out may cause
7945 malfunctioning cursor keys. If both options are off, Vim waits
7946 forever after an entered <Esc> if there are key codes that start
7947 with <Esc>. You will have to type <Esc> twice. If you do not have
7948 problems with key codes, but would like to have :mapped key
7949 sequences not timing out in 1 second, set the 'ttimeout' option and
7950 reset the 'timeout' option.
7951
7952 NOTE: 'ttimeout' is reset when 'compatible' is set.
7953
7954 *'timeoutlen'* *'tm'*
7955'timeoutlen' 'tm' number (default 1000)
7956 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007957
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007959'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 The time in milliseconds that is waited for a key code or mapped key
7962 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7963 when part of a command has been typed.
7964 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7965 different timeout value for key codes is desired set 'ttimeoutlen' to
7966 a non-negative number.
7967
7968 ttimeoutlen mapping delay key code delay ~
7969 < 0 'timeoutlen' 'timeoutlen'
7970 >= 0 'timeoutlen' 'ttimeoutlen'
7971
7972 The timeout only happens when the 'timeout' and 'ttimeout' options
7973 tell so. A useful setting would be >
7974 :set timeout timeoutlen=3000 ttimeoutlen=100
7975< (time out on mapping after three seconds, time out on key codes after
7976 a tenth of a second).
7977
7978 *'title'* *'notitle'*
7979'title' boolean (default off, on when title can be restored)
7980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 {not available when compiled without the |+title|
7982 feature}
7983 When on, the title of the window will be set to the value of
7984 'titlestring' (if it is not empty), or to:
7985 filename [+=-] (path) - VIM
7986 Where:
7987 filename the name of the file being edited
7988 - indicates the file cannot be modified, 'ma' off
7989 + indicates the file was modified
7990 = indicates the file is read-only
7991 =+ indicates the file is read-only and modified
7992 (path) is the path of the file being edited
7993 - VIM the server name |v:servername| or "VIM"
7994 Only works if the terminal supports setting window titles
7995 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02007996 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7998 *X11*
7999 When Vim was compiled with HAVE_X11 defined, the original title will
8000 be restored if possible. The output of ":version" will include "+X11"
8001 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8002 works for the icon name |'icon'|.
8003 But: When Vim was started with the |-X| argument, restoring the title
8004 will not work (except in the GUI).
8005 If the title cannot be restored, it is set to the value of 'titleold'.
8006 You might want to restore the title outside of Vim then.
8007 When using an xterm from a remote machine you can use this command:
8008 rsh machine_name xterm -display $DISPLAY &
8009 then the WINDOWID environment variable should be inherited and the
8010 title of the window should change back to what it should be after
8011 exiting Vim.
8012
8013 *'titlelen'*
8014'titlelen' number (default 85)
8015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 {not available when compiled without the |+title|
8017 feature}
8018 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008019 title. When the title is longer, only the end of the path name is
8020 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021 Using a percentage makes this adapt to the width of the window. But
8022 it won't work perfectly, because the actual number of characters
8023 available also depends on the font used and other things in the title
8024 bar. When 'titlelen' is zero the full path is used. Otherwise,
8025 values from 1 to 30000 percent can be used.
8026 'titlelen' is also used for the 'titlestring' option.
8027
8028 *'titleold'*
8029'titleold' string (default "Thanks for flying Vim")
8030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 {only available when compiled with the |+title|
8032 feature}
8033 This option will be used for the window title when exiting Vim if the
8034 original title cannot be restored. Only happens if 'title' is on or
8035 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008036 This option cannot be set from a |modeline| or in the |sandbox|, for
8037 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 *'titlestring'*
8039'titlestring' string (default "")
8040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 {not available when compiled without the |+title|
8042 feature}
8043 When this option is not empty, it will be used for the title of the
8044 window. This happens only when the 'title' option is on.
8045 Only works if the terminal supports setting window titles (currently
8046 Amiga console, Win32 console, all GUI versions and terminals with a
8047 non-empty 't_ts' option).
8048 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008049 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008050
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 When this option contains printf-style '%' items, they will be
8052 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008053 This option cannot be set in a modeline when 'modelineexpr' is off.
8054
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 Example: >
8056 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8057 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8058< The value of 'titlelen' is used to align items in the middle or right
8059 of the available space.
8060 Some people prefer to have the file name first: >
8061 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8062< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008063 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 separating space only when needed.
8065 NOTE: Use of special characters in 'titlestring' may cause the display
8066 to be garbled (e.g., when it contains a CR or NL character).
8067 {not available when compiled without the |+statusline| feature}
8068
8069 *'toolbar'* *'tb'*
8070'toolbar' 'tb' string (default "icons,tooltips")
8071 global
8072 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8073 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008074 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 possible values are:
8076 icons Toolbar buttons are shown with icons.
8077 text Toolbar buttons shown with text.
8078 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008079 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 tooltips Tooltips are active for toolbar buttons.
8081 Tooltips refer to the popup help text which appears after the mouse
8082 cursor is placed over a toolbar button for a brief moment.
8083
8084 If you want the toolbar to be shown with icons as well as text, do the
8085 following: >
8086 :set tb=icons,text
8087< Motif and Athena cannot display icons and text at the same time. They
8088 will show icons if both are requested.
8089
8090 If none of the strings specified in 'toolbar' are valid or if
8091 'toolbar' is empty, this option is ignored. If you want to disable
8092 the toolbar, you need to set the 'guioptions' option. For example: >
8093 :set guioptions-=T
8094< Also see |gui-toolbar|.
8095
8096 *'toolbariconsize'* *'tbis'*
8097'toolbariconsize' 'tbis' string (default "small")
8098 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008099 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008101 tiny Use tiny icons.
8102 small Use small icons (default).
8103 medium Use medium-sized icons.
8104 large Use large icons.
8105 huge Use even larger icons.
8106 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008108 the current theme. Common dimensions are giant=48x48, huge=32x32,
8109 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110
8111 If 'toolbariconsize' is empty, the global default size as determined
8112 by user preferences or the current theme is used.
8113
8114 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8115'ttybuiltin' 'tbi' boolean (default on)
8116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117 When on, the builtin termcaps are searched before the external ones.
8118 When off the builtin termcaps are searched after the external ones.
8119 When this option is changed, you should set the 'term' option next for
8120 the change to take effect, for example: >
8121 :set notbi term=$TERM
8122< See also |termcap|.
8123 Rationale: The default for this option is "on", because the builtin
8124 termcap entries are generally better (many systems contain faulty
8125 xterm entries...).
8126
8127 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8128'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8129 sun-cmd, screen, rxvt, dtterm or
8130 iris-ansi; also on when running Vim in
8131 a DOS console)
8132 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 Indicates a fast terminal connection. More characters will be sent to
8134 the screen for redrawing, instead of using insert/delete line
8135 commands. Improves smoothness of redrawing when there are multiple
8136 windows and the terminal does not support a scrolling region.
8137 Also enables the extra writing of characters at the end of each screen
8138 line for lines that wrap. This helps when using copy/paste with the
8139 mouse in an xterm and other terminals.
8140
8141 *'ttymouse'* *'ttym'*
8142'ttymouse' 'ttym' string (default depends on 'term')
8143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 {only in Unix and VMS, doesn't work in the GUI; not
8145 available when compiled without |+mouse|}
8146 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008147 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 *xterm-mouse*
8149 xterm xterm-like mouse handling. The mouse generates
8150 "<Esc>[Mscr", where "scr" is three bytes:
8151 "s" = button state
8152 "c" = column plus 33
8153 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008154 This only works up to 223 columns! See "dec",
8155 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 xterm2 Works like "xterm", but with the xterm reporting the
8157 mouse position while the mouse is dragged. This works
8158 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008159 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 work. See below for how Vim detects this
8161 automatically.
8162 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008163 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008165 for the row and column. No other mouse events are
8166 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 *dec-mouse*
8168 dec DEC terminal mouse handling. The mouse generates a
8169 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008170 This is also available for an Xterm, if it was
8171 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 *jsbterm-mouse*
8173 jsbterm JSB term mouse handling.
8174 *pterm-mouse*
8175 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008176 *urxvt-mouse*
8177 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008178 The mouse works only if the terminal supports this
8179 encoding style, but it does not have 223 columns limit
8180 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008181 *sgr-mouse*
8182 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008183 mouse reporting. The mouse works even in columns
8184 beyond 223. This option is backward compatible with
8185 "xterm2" because it can also decode "xterm2" style
8186 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187
8188 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008189 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8190 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8192 recognized, if enabled at compile time. DEC terminal mouse codes
8193 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008194 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8195 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008197 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8198 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8199 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008200 Additionally, if vim is compiled with the |+termresponse| feature and
8201 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008202 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008204 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8205 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8206 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008207 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8208 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 :set t_RV=
8210<
8211 *'ttyscroll'* *'tsl'*
8212'ttyscroll' 'tsl' number (default 999)
8213 global
8214 Maximum number of lines to scroll the screen. If there are more lines
8215 to scroll the window is redrawn. For terminals where scrolling is
8216 very slow and redrawing is not slow this can be set to a small number,
8217 e.g., 3, to speed up displaying.
8218
8219 *'ttytype'* *'tty'*
8220'ttytype' 'tty' string (default from $TERM)
8221 global
8222 Alias for 'term', see above.
8223
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008224 *'undodir'* *'udir'*
8225'undodir' 'udir' string (default ".")
8226 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008227 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008228 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008229 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008230 "." means using the directory of the file. The undo file name for
8231 "file.txt" is ".file.txt.un~".
8232 For other directories the file name is the full path of the edited
8233 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008234 When writing: The first directory that exists is used. "." always
8235 works, no directories after "." will be used for writing.
8236 When reading all entries are tried to find an undo file. The first
8237 undo file that exists is used. When it cannot be read an error is
8238 given, no further entry is used.
8239 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008240 This option cannot be set from a |modeline| or in the |sandbox|, for
8241 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008242
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008243 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008244'undofile' 'udf' boolean (default off)
8245 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008246 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008247 When on, Vim automatically saves undo history to an undo file when
8248 writing a buffer to a file, and restores undo history from the same
8249 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008250 The directory where the undo file is stored is specified by 'undodir'.
8251 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008252 The undo file is not read when 'undoreload' causes the buffer from
8253 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008254 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008255 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008256
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008258'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008259 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008261 is kept in memory, higher numbers will cause more memory to be used.
8262 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8264 itself: >
8265 set ul=0
8266< But you can also get Vi compatibility by including the 'u' flag in
8267 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008268 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008269 Set to -1 for no undo at all. You might want to do this only for the
8270 current buffer: >
8271 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008272< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008273
8274 The local value is set to -123456 when the global value is to be used.
8275
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008276 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008278 *'undoreload'* *'ur'*
8279'undoreload' 'ur' number (default 10000)
8280 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008281 Save the whole buffer for undo when reloading it. This applies to the
8282 ":e!" command and reloading for when the buffer changed outside of
8283 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008284 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008285 of lines is smaller than the value of this option.
8286 Set this option to zero to disable undo for a reload.
8287
8288 When saving undo for a reload, any undo file is not read.
8289
8290 Note that this causes the whole buffer to be stored in memory. Set
8291 this option to a lower value if you run out of memory.
8292
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 *'updatecount'* *'uc'*
8294'updatecount' 'uc' number (default: 200)
8295 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 After typing this many characters the swap file will be written to
8297 disk. When zero, no swap file will be created at all (see chapter on
8298 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8299 Vim with the "-n" option, see |startup|. When editing in readonly
8300 mode this option will be initialized to 10000.
8301 The swapfile can be disabled per buffer with |'swapfile'|.
8302 When 'updatecount' is set from zero to non-zero, swap files are
8303 created for all buffers that have 'swapfile' set. When 'updatecount'
8304 is set to zero, existing swap files are not deleted.
8305 Also see |'swapsync'|.
8306 This option has no meaning in buffers where |'buftype'| is "nofile"
8307 or "nowrite".
8308
8309 *'updatetime'* *'ut'*
8310'updatetime' 'ut' number (default 4000)
8311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 If this many milliseconds nothing is typed the swap file will be
8313 written to disk (see |crash-recovery|). Also used for the
8314 |CursorHold| autocommand event.
8315
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008316 *'varsofttabstop'* *'vsts'*
8317'varsofttabstop' 'vsts' string (default "")
8318 local to buffer
8319 {only available when compiled with the |+vartabs|
8320 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008321 A list of the number of spaces that a <Tab> counts for while editing,
8322 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8323 width <Tab>s are being inserted, while in fact a mixture of spaces
8324 and <Tab>s is used. Tab widths are separated with commas, with the
8325 final value applying to all subsequent tabs.
8326
8327 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008328 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008329 to use the following: >
8330 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008331< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8332 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008333
8334 Note that the value of |'softtabstop'| will be ignored while
8335 'varsofttabstop' is set.
8336
8337 *'vartabstop'* *'vts'*
8338'vartabstop' 'vts' string (default "")
8339 local to buffer
8340 {only available when compiled with the |+vartabs|
8341 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008342 A list of the number of spaces that a <Tab> in the file counts for,
8343 separated by commas. Each value corresponds to one tab, with the
8344 final value applying to all subsequent tabs. For example: >
8345 :set vartabstop=4,20,10,8
8346< This will make the first tab 4 spaces wide, the second 20 spaces,
8347 the third 10 spaces, and all following tabs 8 spaces.
8348
8349 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8350 is set.
8351
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 *'verbose'* *'vbs'*
8353'verbose' 'vbs' number (default 0)
8354 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 When bigger than zero, Vim will give messages about what it is doing.
8356 Currently, these messages are given:
8357 >= 1 When the viminfo file is read or written.
8358 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008359 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008360 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 >= 8 Files for which a group of autocommands is executed.
8362 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008363 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 >= 12 Every executed function.
8365 >= 13 When an exception is thrown, caught, finished, or discarded.
8366 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008367 >= 15 Every executed Ex command from a script (truncated at 200
8368 characters).
8369 >= 16 Every executed Ex command
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370
8371 This option can also be set with the "-V" argument. See |-V|.
8372 This option is also set by the |:verbose| command.
8373
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008374 When the 'verbosefile' option is set then the verbose messages are not
8375 displayed.
8376
8377 *'verbosefile'* *'vfile'*
8378'verbosefile' 'vfile' string (default empty)
8379 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008380 When not empty all messages are written in a file with this name.
8381 When the file exists messages are appended.
8382 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008383 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008384 Setting 'verbosefile' to a new value is like making it empty first.
8385 The difference with |:redir| is that verbose messages are not
8386 displayed when 'verbosefile' is set.
8387
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008389'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 "$VIM/vimfiles/view",
8391 for Unix: "~/.vim/view",
8392 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008393 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008394 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008395 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 feature}
8397 Name of the directory where to store files for |:mkview|.
8398 This option cannot be set from a |modeline| or in the |sandbox|, for
8399 security reasons.
8400
8401 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008402'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008404 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 feature}
8406 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008407 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 word save and restore ~
8409 cursor cursor position in file and in window
8410 folds manually created folds, opened/closed folds and local
8411 fold options
8412 options options and mappings local to a window or buffer (not
8413 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008414 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 slash backslashes in file names replaced with forward
8416 slashes
8417 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008418 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008419 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008421 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008423 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008424
8425 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008426'viminfo' 'vi' string (Vi default: "", Vim default for
8427 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008428 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8429 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008431 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 feature}
8433 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008434 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8435 "NONE".
8436 The string should be a comma separated list of parameters, each
8437 consisting of a single character identifying the particular parameter,
8438 followed by a number or string which specifies the value of that
8439 parameter. If a particular character is left out, then the default
8440 value is used for that parameter. The following is a list of the
8441 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008443 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444 ! When included, save and restore global variables that start
8445 with an uppercase letter, and don't contain a lowercase
8446 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008447 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008448 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008449 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 " Maximum number of lines saved for each register. Old name of
8451 the '<' item, with the disadvantage that you need to put a
8452 backslash before the ", otherwise it will be recognized as the
8453 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008454 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008455 % When included, save and restore the buffer list. If Vim is
8456 started with a file name argument, the buffer list is not
8457 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008458 buffer list is restored from the viminfo file. Quickfix
8459 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8460 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008461 When followed by a number, the number specifies the maximum
8462 number of buffers that are stored. Without a number all
8463 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008464 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 ' Maximum number of previously edited files for which the marks
8466 are remembered. This parameter must always be included when
8467 'viminfo' is non-empty.
8468 Including this item also means that the |jumplist| and the
8469 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008470 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008472 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 patterns are also saved. When not included, the value of
8474 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008475 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008477 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008478 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 < Maximum number of lines saved for each register. If zero then
8480 registers are not saved. When not included, all lines are
8481 saved. '"' is the old name for this item.
8482 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008483 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008484 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008485 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008486 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 c When included, convert the text in the viminfo file from the
8488 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008489 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008490 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008491 f Whether file marks need to be stored. If zero, file marks ('0
8492 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008493 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008495 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 h Disable the effect of 'hlsearch' when loading the viminfo
8497 file. When not included, it depends on whether ":nohlsearch"
8498 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008499 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008500 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008501 the 'n'. Must be at the end of the option! If the
8502 'viminfofile' option is set, that file name overrides the one
8503 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008504 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008505 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 r Removable media. The argument is a string (up to the next
8507 ','). This parameter can be given several times. Each
8508 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008509 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8511 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8512 ignored. Maximum length of each 'r' argument is 50
8513 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008514 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 s Maximum size of an item in Kbyte. If zero then registers are
8516 not saved. Currently only applies to registers. The default
8517 "s10" will exclude registers with more than 10 Kbyte of text.
8518 Also see the '<' item above: line count limit.
8519
8520 Example: >
8521 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8522<
8523 '50 Marks will be remembered for the last 50 files you
8524 edited.
8525 <1000 Contents of registers (up to 1000 lines each) will be
8526 remembered.
8527 s100 Registers with more than 100 Kbyte text are skipped.
8528 :0 Command-line history will not be saved.
8529 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8530 no / Since '/' is not specified, the default will be used,
8531 that is, save all of the search history, and also the
8532 previous search and substitute patterns.
8533 no % The buffer list will not be saved nor read back.
8534 no h 'hlsearch' highlighting will be restored.
8535
8536 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8537 load the contents of the file, this is not done automatically.
8538
8539 This option cannot be set from a |modeline| or in the |sandbox|, for
8540 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008541 NOTE: This option is set to the Vim default value when 'compatible'
8542 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008543
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008544 *'viminfofile'* *'vif'*
8545'viminfofile' 'vif' string (default: "")
8546 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008547 {not available when compiled without the |+viminfo|
8548 feature}
8549 When non-empty, overrides the file name used for viminfo.
8550 When equal to "NONE" no viminfo file will be read or written.
8551 This option can be set with the |-i| command line flag. The |--clean|
8552 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008553 This option cannot be set from a |modeline| or in the |sandbox|, for
8554 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008555
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 *'virtualedit'* *'ve'*
8557'virtualedit' 've' string (default "")
8558 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 A comma separated list of these words:
8560 block Allow virtual editing in Visual block mode.
8561 insert Allow virtual editing in Insert mode.
8562 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008563 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008564
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008566 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 of the line. Useful for selecting a rectangle in Visual mode and
8568 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008569 "onemore" is not the same, it will only allow moving the cursor just
8570 after the last character of the line. This makes some commands more
8571 consistent. Previously the cursor was always past the end of the line
8572 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008573 break some plugins or Vim scripts. For example because |l| can move
8574 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008575 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008576 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008577 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008578 It doesn't make sense to combine "all" with "onemore", but you will
8579 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008580 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008581
8582 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8583'visualbell' 'vb' boolean (default off)
8584 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008585 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008587 use: >
8588 :set vb t_vb=
8589< If you want a short flash, you can use this on many terminals: >
8590 :set vb t_vb=[?5h$<100>[?5l
8591< Here $<100> specifies the time, you can use a smaller or bigger value
8592 to get a shorter or longer flash.
8593
8594 Note: Vim will limit the bell to once per half a second. This avoids
8595 having to wait for the flashing to finish when there are lots of
8596 bells, e.g. on key repeat. This also happens without 'visualbell'
8597 set.
8598
Bram Moolenaar071d4272004-06-13 20:20:40 +00008599 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8600 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8601 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008602
8603 Note: When the GUI starts, 't_vb' is reset to its default value. You
8604 might want to set it again in your |gvimrc|.
8605
Bram Moolenaar071d4272004-06-13 20:20:40 +00008606 Does not work on the Amiga, you always get a screen flash.
8607 Also see 'errorbells'.
8608
8609 *'warn'* *'nowarn'*
8610'warn' boolean (default on)
8611 global
8612 Give a warning message when a shell command is used while the buffer
8613 has been changed.
8614
8615 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8616'weirdinvert' 'wiv' boolean (default off)
8617 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008618 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 It is provided for backwards compatibility with version 4.x.
8620 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8621 vice versa. Has no effect when the GUI is running.
8622
8623 *'whichwrap'* *'ww'*
8624'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8625 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008626 Allow specified keys that move the cursor left/right to move to the
8627 previous/next line when the cursor is on the first/last character in
8628 the line. Concatenate characters to allow this for these keys:
8629 char key mode ~
8630 b <BS> Normal and Visual
8631 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008632 h "h" Normal and Visual (not recommended)
8633 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 < <Left> Normal and Visual
8635 > <Right> Normal and Visual
8636 ~ "~" Normal
8637 [ <Left> Insert and Replace
8638 ] <Right> Insert and Replace
8639 For example: >
8640 :set ww=<,>,[,]
8641< allows wrap only when cursor keys are used.
8642 When the movement keys are used in combination with a delete or change
8643 operator, the <EOL> also counts for a character. This makes "3h"
8644 different from "3dh" when the cursor crosses the end of a line. This
8645 is also true for "x" and "X", because they do the same as "dl" and
8646 "dh". If you use this, you may also want to use the mapping
8647 ":map <BS> X" to make backspace delete the character in front of the
8648 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008649 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008650 line (not an empty line) then it will not move to the next line. This
8651 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008652 NOTE: This option is set to the Vi default value when 'compatible' is
8653 set and to the Vim default value when 'compatible' is reset.
8654
8655 *'wildchar'* *'wc'*
8656'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8657 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 Character you have to type to start wildcard expansion in the
8659 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008660 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 The character is not recognized when used inside a macro. See
8662 'wildcharm' for that.
8663 Although 'wc' is a number option, you can set it to a special key: >
8664 :set wc=<Esc>
8665< NOTE: This option is set to the Vi default value when 'compatible' is
8666 set and to the Vim default value when 'compatible' is reset.
8667
8668 *'wildcharm'* *'wcm'*
8669'wildcharm' 'wcm' number (default: none (0))
8670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008672 recognized when used inside a macro. You can find "spare" command-line
8673 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 you'll never actually type 'wildcharm', just use it in mappings that
8675 automatically invoke completion mode, e.g.: >
8676 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008677 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008678< Then after typing :ss you can use CTRL-P & CTRL-N.
8679
8680 *'wildignore'* *'wig'*
8681'wildignore' 'wig' string (default "")
8682 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 {not available when compiled without the |+wildignore|
8684 feature}
8685 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008686 patterns is ignored when expanding |wildcards|, completing file or
8687 directory names, and influences the result of |expand()|, |glob()| and
8688 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8690 Also see 'suffixes'.
8691 Example: >
8692 :set wildignore=*.o,*.obj
8693< The use of |:set+=| and |:set-=| is preferred when adding or removing
8694 a pattern from the list. This avoids problems when a future version
8695 uses another default.
8696
Bram Moolenaar94950a92010-12-02 16:01:29 +01008697
Bram Moolenaar81af9252010-12-10 20:35:50 +01008698 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008699'wildignorecase' 'wic' boolean (default off)
8700 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008701 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008702 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008703 Does not apply when the shell is used to expand wildcards, which
8704 happens when there are special characters.
8705
8706
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008708'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 {not available if compiled without the |+wildmenu|
8711 feature}
8712 When 'wildmenu' is on, command-line completion operates in an enhanced
8713 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8714 the possible matches are shown just above the command line, with the
8715 first match highlighted (overwriting the status line, if there is
8716 one). Keys that show the previous/next match, such as <Tab> or
8717 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8718 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8719 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008720 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 If there are more matches than can fit in the line, a ">" is shown on
8722 the right and/or a "<" is shown on the left. The status line scrolls
8723 as needed.
8724 The "wildmenu" mode is abandoned when a key is hit that is not used
8725 for selecting a completion.
8726 While the "wildmenu" is active the following keys have special
8727 meanings:
8728
8729 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8730 <Down> - in filename/menu name completion: move into a
8731 subdirectory or submenu.
8732 <CR> - in menu completion, when the cursor is just after a
8733 dot: move into a submenu.
8734 <Up> - in filename/menu name completion: move up into
8735 parent directory or parent menu.
8736
8737 This makes the menus accessible from the console |console-menus|.
8738
8739 If you prefer the <Left> and <Right> keys to move the cursor instead
8740 of selecting a different match, use this: >
8741 :cnoremap <Left> <Space><BS><Left>
8742 :cnoremap <Right> <Space><BS><Right>
8743<
8744 The "WildMenu" highlighting is used for displaying the current match
8745 |hl-WildMenu|.
8746
8747 *'wildmode'* *'wim'*
8748'wildmode' 'wim' string (Vim default: "full")
8749 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008750 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008751 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008752 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 first part specifies the behavior for the first use of 'wildchar',
8754 The second part for the second use, etc.
8755 These are the possible values for each part:
8756 "" Complete only the first match.
8757 "full" Complete the next full match. After the last match,
8758 the original string is used and then the first match
8759 again.
8760 "longest" Complete till longest common string. If this doesn't
8761 result in a longer string, use the next part.
8762 "longest:full" Like "longest", but also start 'wildmenu' if it is
8763 enabled.
8764 "list" When more than one match, list all matches.
8765 "list:full" When more than one match, list all matches and
8766 complete first match.
8767 "list:longest" When more than one match, list all matches and
8768 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008769 "list:lastused" When more than one buffer matches, sort buffers
8770 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 When there is only a single match, it is fully completed in all cases.
8772
8773 Examples: >
8774 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008775< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 :set wildmode=longest,full
8777< Complete longest common string, then each full match >
8778 :set wildmode=list:full
8779< List all matches and complete each full match >
8780 :set wildmode=list,full
8781< List all matches without completing, then each full match >
8782 :set wildmode=longest,list
8783< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008784 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008785
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008786 *'wildoptions'* *'wop'*
8787'wildoptions' 'wop' string (default "")
8788 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008789 {not available when compiled without the |+wildignore|
8790 feature}
8791 A list of words that change how command line completion is done.
8792 Currently only one word is allowed:
8793 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008794 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008795 is displayed per line. Often used tag kinds are:
8796 d #define
8797 f function
8798 Also see |cmdline-completion|.
8799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 *'winaltkeys'* *'wak'*
8801'winaltkeys' 'wak' string (default "menu")
8802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 {only used in Win32, Motif, GTK and Photon GUI}
8804 Some GUI versions allow the access to menu entries by using the ALT
8805 key in combination with a character that appears underlined in the
8806 menu. This conflicts with the use of the ALT key for mappings and
8807 entering special characters. This option tells what to do:
8808 no Don't use ALT keys for menus. ALT key combinations can be
8809 mapped, but there is no automatic handling. This can then be
8810 done with the |:simalt| command.
8811 yes ALT key handling is done by the windowing system. ALT key
8812 combinations cannot be mapped.
8813 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008814 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008815 keys can be mapped.
8816 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8817 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008818 This option is not used for <F10>; on Win32 and with GTK <F10> will
8819 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008821 *'wincolor'* *'wcr'*
8822'wincolor' 'wcr' string (default empty)
8823 local to window
8824 Highlight group name to use for this window instead of the Normal
8825 color |hl-Normal|.
8826
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008827 *'window'* *'wi'*
8828'window' 'wi' number (default screen height - 1)
8829 global
8830 Window height. Do not confuse this with the height of the Vim window,
8831 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008832 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8833 value is smaller than 'lines' minus one. The screen will scroll
8834 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008835 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8836 in a much smarter way, taking care of wrapping lines.
8837 When resizing the Vim window, the value is smaller than 1 or more than
8838 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008839
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 *'winheight'* *'wh'* *E591*
8841'winheight' 'wh' number (default 1)
8842 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008844 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008845 focus goes to a window that is smaller, its size is increased, at the
8846 cost of the height of other windows.
8847 Set 'winheight' to a small number for normal editing.
8848 Set it to 999 to make the current window fill most of the screen.
8849 Other windows will be only 'winminheight' high. This has the drawback
8850 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8851 to create only two windows, set the option after startup is done,
8852 using the |VimEnter| event: >
8853 au VimEnter * set winheight=999
8854< Minimum value is 1.
8855 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 height of the current window.
8857 'winheight' applies to the current window. Use 'winminheight' to set
8858 the minimal height for other windows.
8859
8860 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8861'winfixheight' 'wfh' boolean (default off)
8862 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008864 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8865 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 The height may be changed anyway when running out of room.
8867
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008868 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8869'winfixwidth' 'wfw' boolean (default off)
8870 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008871 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008872 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008873 The width may be changed anyway when running out of room.
8874
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 *'winminheight'* *'wmh'*
8876'winminheight' 'wmh' number (default 1)
8877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 The minimal height of a window, when it's not the current window.
8879 This is a hard minimum, windows will never become smaller.
8880 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8881 status bar) if necessary. They will return to at least one line when
8882 they become active (since the cursor has to have somewhere to go.)
8883 Use 'winheight' to set the minimal height of the current window.
8884 This option is only checked when making a window smaller. Don't use a
8885 large number, it will cause errors when opening more than a few
8886 windows. A value of 0 to 3 is reasonable.
8887
8888 *'winminwidth'* *'wmw'*
8889'winminwidth' 'wmw' number (default 1)
8890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 The minimal width of a window, when it's not the current window.
8892 This is a hard minimum, windows will never become smaller.
8893 When set to zero, windows may be "squashed" to zero columns (i.e. just
8894 a vertical separator) if necessary. They will return to at least one
8895 line when they become active (since the cursor has to have somewhere
8896 to go.)
8897 Use 'winwidth' to set the minimal width of the current window.
8898 This option is only checked when making a window smaller. Don't use a
8899 large number, it will cause errors when opening more than a few
8900 windows. A value of 0 to 12 is reasonable.
8901
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008902 *'winptydll'*
8903'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8904 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008905 {only available when compiled with the |terminal|
8906 feature on MS-Windows}
8907 Specifies the name of the winpty shared library, used for the
8908 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008909 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008910 a fallback.
8911 Environment variables are expanded |:set_env|.
8912 This option cannot be set from a |modeline| or in the |sandbox|, for
8913 security reasons.
8914
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915 *'winwidth'* *'wiw'* *E592*
8916'winwidth' 'wiw' number (default 20)
8917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 Minimal number of columns for the current window. This is not a hard
8919 minimum, Vim will use fewer columns if there is not enough room. If
8920 the current window is smaller, its size is increased, at the cost of
8921 the width of other windows. Set it to 999 to make the current window
8922 always fill the screen. Set it to a small number for normal editing.
8923 The width is not adjusted after one of the commands to change the
8924 width of the current window.
8925 'winwidth' applies to the current window. Use 'winminwidth' to set
8926 the minimal width for other windows.
8927
8928 *'wrap'* *'nowrap'*
8929'wrap' boolean (default on)
8930 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008931 This option changes how text is displayed. It doesn't change the text
8932 in the buffer, see 'textwidth' for that.
8933 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008934 displaying continues on the next line. When off lines will not wrap
8935 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 moved to a part that is not shown, the screen will scroll
8937 horizontally.
8938 The line will be broken in the middle of a word if necessary. See
8939 'linebreak' to get the break at a word boundary.
8940 To make scrolling horizontally a bit more useful, try this: >
8941 :set sidescroll=5
8942 :set listchars+=precedes:<,extends:>
8943< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008944 This option can't be set from a |modeline| when the 'diff' option is
8945 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946
8947 *'wrapmargin'* *'wm'*
8948'wrapmargin' 'wm' number (default 0)
8949 local to buffer
8950 Number of characters from the right window border where wrapping
8951 starts. When typing text beyond this limit, an <EOL> will be inserted
8952 and inserting continues on the next line.
8953 Options that add a margin, such as 'number' and 'foldcolumn', cause
8954 the text width to be further reduced. This is Vi compatible.
8955 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008956 This option is set to 0 when 'paste' is set and restored when 'paste'
8957 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008958 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008959
8960 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8961'wrapscan' 'ws' boolean (default on) *E384* *E385*
8962 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008963 Searches wrap around the end of the file. Also applies to |]s| and
8964 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008965
8966 *'write'* *'nowrite'*
8967'write' boolean (default on)
8968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008969 Allows writing files. When not set, writing a file is not allowed.
8970 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008971 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 argument. Filtering text is still possible, even though this requires
8973 writing a temporary file.
8974
8975 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8976'writeany' 'wa' boolean (default off)
8977 global
8978 Allows writing to any file with no need for "!" override.
8979
8980 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8981'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8982 otherwise)
8983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008984 Make a backup before overwriting a file. The backup is removed after
8985 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008986 also on.
8987 WARNING: Switching this option off means that when Vim fails to write
8988 your buffer correctly and then, for whatever reason, Vim exits, you
8989 lose both the original file and what you were writing. Only reset
8990 this option if your file system is almost full and it makes the write
8991 fail (and make sure not to exit Vim until the write was successful).
8992 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008993 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008994 Depending on 'backupcopy' the backup is a new file or the original
8995 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 NOTE: This option is set to the default value when 'compatible' is
8997 set.
8998
8999 *'writedelay'* *'wd'*
9000'writedelay' 'wd' number (default 0)
9001 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009002 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009003 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009004 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009005
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009006 vim:tw=78:ts=8:noet:ft=help:norl: