blob: 6a9e2ed0e88aa1051f67d70aea5564a71577ee2b [file] [log] [blame]
Bram Moolenaar7ff78462020-07-10 22:00:53 +02001*options.txt* For Vim version 8.2. Last change: 2020 Jul 05
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 Moolenaar447bfba2020-07-18 16:07:16 +02001954 properties of the info popup when it is created. If an info popup
1955 window already exists it is closed, so that the option value is
1956 applied when it is created again.
1957 You can also use |popup_findinfo()| and then set properties for an
1958 existing info popup with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001959
1960
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001961 *'concealcursor'* *'cocu'*
1962'concealcursor' 'cocu' string (default: "")
1963 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 {not available when compiled without the |+conceal|
1965 feature}
1966 Sets the modes in which text in the cursor line can also be concealed.
1967 When the current mode is listed then concealing happens just like in
1968 other lines.
1969 n Normal mode
1970 v Visual mode
1971 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001972 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001973
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001974 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001975 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976 are moving around text is concealed, but when starting to insert text
1977 or selecting a Visual area the concealed text is displayed, so that
1978 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001979 Keep in mind that the cursor position is not always where it's
1980 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001981
1982
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001983 *'conceallevel'* *'cole'*
1984'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986 {not available when compiled without the |+conceal|
1987 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001988 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1989 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001990
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001991 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001993 1 Each block of concealed text is replaced with one
1994 character. If the syntax item does not have a custom
1995 replacement character defined (see |:syn-cchar|) the
1996 character defined in 'listchars' is used (default is a
1997 space).
1998 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001999 2 Concealed text is completely hidden unless it has a
2000 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002001 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002002 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002003
Bram Moolenaara7781e02010-07-19 20:13:22 +02002004 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002005 edit and copy the text. This can be changed with the 'concealcursor'
2006 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2009'confirm' 'cf' boolean (default off)
2010 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 When 'confirm' is on, certain operations that would normally
2012 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2013 instead raise a |dialog| asking if you wish to save the current
2014 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2015 If 'confirm' is off you can still activate confirmation for one
2016 command only (this is most useful in mappings) with the |:confirm|
2017 command.
2018 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2019
2020 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2021'conskey' 'consk' boolean (default off)
2022 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002023 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024
2025 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2026'copyindent' 'ci' boolean (default off)
2027 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 Copy the structure of the existing lines indent when autoindenting a
2029 new line. Normally the new indent is reconstructed by a series of
2030 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2031 in which case only spaces are used). Enabling this option makes the
2032 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002033 existing line. 'expandtab' has no effect on these characters, a Tab
2034 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002036 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 Also see 'preserveindent'.
2038
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002039 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040'cpoptions' 'cpo' string (Vim default: "aABceFs",
2041 Vi default: all flags)
2042 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002044 this indicates Vi-compatible behavior. This is used for things where
2045 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 'cpoptions' stands for "compatible-options".
2047 Commas can be added for readability.
2048 To avoid problems with flags that are added in the future, use the
2049 "+=" and "-=" feature of ":set" |add-option-flags|.
2050 NOTE: This option is set to the Vi default value when 'compatible' is
2051 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002052 NOTE: This option is set to the POSIX default value at startup when
2053 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002054 variable exists |posix|. This means Vim tries to behave like the
2055 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056
2057 contains behavior ~
2058 *cpo-a*
2059 a When included, a ":read" command with a file name
2060 argument will set the alternate file name for the
2061 current window.
2062 *cpo-A*
2063 A When included, a ":write" command with a file name
2064 argument will set the alternate file name for the
2065 current window.
2066 *cpo-b*
2067 b "\|" in a ":map" command is recognized as the end of
2068 the map command. The '\' is included in the mapping,
2069 the text after the '|' is interpreted as the next
2070 command. Use a CTRL-V instead of a backslash to
2071 include the '|' in the mapping. Applies to all
2072 mapping, abbreviation, menu and autocmd commands.
2073 See also |map_bar|.
2074 *cpo-B*
2075 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002076 abbreviations, user commands and the "to" part of the
2077 menu commands. Remove this flag to be able to use a
2078 backslash like a CTRL-V. For example, the command
2079 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 'B' included: "\^[" (^[ is a real <Esc>)
2081 'B' excluded: "<Esc>" (5 characters)
2082 ('<' excluded in both cases)
2083 *cpo-c*
2084 c Searching continues at the end of any match at the
2085 cursor position, but not further than the start of the
2086 next line. When not present searching continues
2087 one character from the cursor position. With 'c'
2088 "abababababab" only gets three matches when repeating
2089 "/abab", without 'c' there are five matches.
2090 *cpo-C*
2091 C Do not concatenate sourced lines that start with a
2092 backslash. See |line-continuation|.
2093 *cpo-d*
2094 d Using "./" in the 'tags' option doesn't mean to use
2095 the tags file relative to the current file, but the
2096 tags file in the current directory.
2097 *cpo-D*
2098 D Can't use CTRL-K to enter a digraph after Normal mode
2099 commands with a character argument, like |r|, |f| and
2100 |t|.
2101 *cpo-e*
2102 e When executing a register with ":@r", always add a
2103 <CR> to the last line, also when the register is not
2104 linewise. If this flag is not present, the register
2105 is not linewise and the last line does not end in a
2106 <CR>, then the last line is put on the command-line
2107 and can be edited before hitting <CR>.
2108 *cpo-E*
2109 E It is an error when using "y", "d", "c", "g~", "gu" or
2110 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002111 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 This makes "y0" fail in the first column.
2113 *cpo-f*
2114 f When included, a ":read" command with a file name
2115 argument will set the file name for the current buffer,
2116 if the current buffer doesn't have a file name yet.
2117 *cpo-F*
2118 F When included, a ":write" command with a file name
2119 argument will set the file name for the current
2120 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002121 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-g*
2123 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002124 *cpo-H*
2125 H When using "I" on a line with only blanks, insert
2126 before the last blank. Without this flag insert after
2127 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 *cpo-i*
2129 i When included, interrupting the reading of a file will
2130 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002131 *cpo-I*
2132 I When moving the cursor up or down just after inserting
2133 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 *cpo-j*
2135 j When joining lines, only add two spaces after a '.',
2136 not after '!' or '?'. Also see 'joinspaces'.
2137 *cpo-J*
2138 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002139 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 white space.
2141 *cpo-k*
2142 k Disable the recognition of raw key codes in
2143 mappings, abbreviations, and the "to" part of menu
2144 commands. For example, if <Key> sends ^[OA (where ^[
2145 is <Esc>), the command ":map X ^[OA" results in X
2146 being mapped to:
2147 'k' included: "^[OA" (3 characters)
2148 'k' excluded: "<Key>" (one key code)
2149 Also see the '<' flag below.
2150 *cpo-K*
2151 K Don't wait for a key code to complete when it is
2152 halfway a mapping. This breaks mapping <F1><F1> when
2153 only part of the second <F1> has been read. It
2154 enables cancelling the mapping by typing <F1><Esc>.
2155 *cpo-l*
2156 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002157 literally, only "\]", "\^", "\-" and "\\" are special.
2158 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2160 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002161 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 *cpo-L*
2163 L When the 'list' option is set, 'wrapmargin',
2164 'textwidth', 'softtabstop' and Virtual Replace mode
2165 (see |gR|) count a <Tab> as two characters, instead of
2166 the normal behavior of a <Tab>.
2167 *cpo-m*
2168 m When included, a showmatch will always wait half a
2169 second. When not included, a showmatch will wait half
2170 a second or until a character is typed. |'showmatch'|
2171 *cpo-M*
2172 M When excluded, "%" matching will take backslashes into
2173 account. Thus in "( \( )" and "\( ( \)" the outer
2174 parenthesis match. When included "%" ignores
2175 backslashes, which is Vi compatible.
2176 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002177 n When included, the column used for 'number' and
2178 'relativenumber' will also be used for text of wrapped
2179 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 *cpo-o*
2181 o Line offset to search command is not remembered for
2182 next search.
2183 *cpo-O*
2184 O Don't complain if a file is being overwritten, even
2185 when it didn't exist when editing it. This is a
2186 protection against a file unexpectedly created by
2187 someone else. Vi didn't complain about this.
2188 *cpo-p*
2189 p Vi compatible Lisp indenting. When not present, a
2190 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002191 *cpo-P*
2192 P When included, a ":write" command that appends to a
2193 file will set the file name for the current buffer, if
2194 the current buffer doesn't have a file name yet and
2195 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002196 *cpo-q*
2197 q When joining multiple lines leave the cursor at the
2198 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 *cpo-r*
2200 r Redo ("." command) uses "/" to repeat a search
2201 command, instead of the actually used search string.
2202 *cpo-R*
2203 R Remove marks from filtered lines. Without this flag
2204 marks are kept like |:keepmarks| was used.
2205 *cpo-s*
2206 s Set buffer options when entering the buffer for the
2207 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002208 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 set when the buffer is created.
2210 *cpo-S*
2211 S Set buffer options always when entering a buffer
2212 (except 'readonly', 'fileformat', 'filetype' and
2213 'syntax'). This is the (most) Vi compatible setting.
2214 The options are set to the values in the current
2215 buffer. When you change an option and go to another
2216 buffer, the value is copied. Effectively makes the
2217 buffer options global to all buffers.
2218
2219 's' 'S' copy buffer options
2220 no no when buffer created
2221 yes no when buffer first entered (default)
2222 X yes each time when buffer entered (vi comp.)
2223 *cpo-t*
2224 t Search pattern for the tag command is remembered for
2225 "n" command. Otherwise Vim only puts the pattern in
2226 the history for search pattern, but doesn't change the
2227 last used search pattern.
2228 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002229 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 *cpo-v*
2231 v Backspaced characters remain visible on the screen in
2232 Insert mode. Without this flag the characters are
2233 erased from the screen right away. With this flag the
2234 screen newly typed text overwrites backspaced
2235 characters.
2236 *cpo-w*
2237 w When using "cw" on a blank character, only change one
2238 character and not all blanks until the start of the
2239 next word.
2240 *cpo-W*
2241 W Don't overwrite a readonly file. When omitted, ":w!"
2242 overwrites a readonly file, if possible.
2243 *cpo-x*
2244 x <Esc> on the command-line executes the command-line.
2245 The default in Vim is to abandon the command-line,
2246 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247 *cpo-X*
2248 X When using a count with "R" the replaced text is
2249 deleted only once. Also when repeating "R" with "."
2250 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002252 y A yank command can be redone with ".". Think twice if
2253 you really want to use this, it may break some
2254 plugins, since most people expect "." to only repeat a
2255 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002256 *cpo-Z*
2257 Z When using "w!" while the 'readonly' option is set,
2258 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *cpo-!*
2260 ! When redoing a filter command, use the last used
2261 external command, whatever it was. Otherwise the last
2262 used -filter- command is used.
2263 *cpo-$*
2264 $ When making a change to one line, don't redisplay the
2265 line, but put a '$' at the end of the changed text.
2266 The changed text will be overwritten when you type the
2267 new text. The line is redisplayed if you type any
2268 command that moves the cursor from the insertion
2269 point.
2270 *cpo-%*
2271 % Vi-compatible matching is done for the "%" command.
2272 Does not recognize "#if", "#endif", etc.
2273 Does not recognize "/*" and "*/".
2274 Parens inside single and double quotes are also
2275 counted, causing a string that contains a paren to
2276 disturb the matching. For example, in a line like
2277 "if (strcmp("foo(", s))" the first paren does not
2278 match the last one. When this flag is not included,
2279 parens inside single and double quotes are treated
2280 specially. When matching a paren outside of quotes,
2281 everything inside quotes is ignored. When matching a
2282 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002283 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002284 This flag is also used for other features, such as
2285 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002286 *cpo--*
2287 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002288 it would go above the first line or below the last
2289 line. Without it the cursor moves to the first or
2290 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002291 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002292 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002293 *cpo-+*
2294 + When included, a ":write file" command will reset the
2295 'modified' flag of the buffer, even though the buffer
2296 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002297 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 * Use ":*" in the same way as ":@". When not included,
2299 ":*" is an alias for ":'<,'>", select the Visual area.
2300 *cpo-<*
2301 < Disable the recognition of special key codes in |<>|
2302 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002303 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002304 ":map X <Tab>" results in X being mapped to:
2305 '<' included: "<Tab>" (5 characters)
2306 '<' excluded: "^I" (^I is a real <Tab>)
2307 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002308 *cpo->*
2309 > When appending to a register, put a line break before
2310 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002311 *cpo-;*
2312 ; When using |,| or |;| to repeat the last |t| search
2313 and the cursor is right in front of the searched
2314 character, the cursor won't move. When not included,
2315 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002316 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002317
2318 POSIX flags. These are not included in the Vi default value, except
2319 when $VIM_POSIX was set on startup. |posix|
2320
2321 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002322 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002323 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002324 *cpo-&*
2325 & When ":preserve" was used keep the swap file when
2326 exiting normally while this buffer is still loaded.
2327 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002328 *cpo-\*
2329 \ Backslash in a [] range in a search pattern is taken
2330 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002331 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2332 '\' excluded: "/[ \-]" finds <Space> and '-'
2333 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002334 *cpo-/*
2335 / When "%" is used as the replacement string in a |:s|
2336 command, use the previous replacement string. |:s%|
2337 *cpo-{*
2338 { The |{| and |}| commands also stop at a "{" character
2339 at the start of a line.
2340 *cpo-.*
2341 . The ":chdir" and ":cd" commands fail if the current
2342 buffer is modified, unless ! is used. Vim doesn't
2343 need this, since it remembers the full path of an
2344 opened file.
2345 *cpo-bar*
2346 | The value of the $LINES and $COLUMNS environment
2347 variables overrule the terminal size values obtained
2348 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002349
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002351 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002352'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002353 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002354 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002355 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002356 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002357 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002358 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002359 blowfish Blowfish method. Medium strong encryption but it has
2360 an implementation flaw. Requires Vim 7.3 or later,
2361 files can NOT be read by Vim 7.2 and older. This adds
2362 a "seed" to the file, every time you write the file
2363 the encrypted bytes will be different.
2364 *blowfish2*
2365 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002366 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002367 and older. This adds a "seed" to the file, every time
2368 you write the file the encrypted bytes will be
2369 different. The whole undo file is encrypted, not just
2370 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002371
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002372 You should use "blowfish2", also to re-encrypt older files.
2373
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002374 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002375 to the detected method of the file being read. Thus if you write it
2376 without changing 'cryptmethod' the same method will be used.
2377 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002378 explicitly write it, you don't get a warning unless there are other
2379 modifications. Also see |:X|.
2380
2381 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002382 the value "blowfish2". When setting the local value to an empty
2383 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002384
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002385 When a new encryption method is added in a later version of Vim, and
2386 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002387 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002388
2389
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 *'cscopepathcomp'* *'cspc'*
2391'cscopepathcomp' 'cspc' number (default 0)
2392 global
2393 {not available when compiled without the |+cscope|
2394 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 Determines how many components of the path to show in a list of tags.
2396 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002397 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398
2399 *'cscopeprg'* *'csprg'*
2400'cscopeprg' 'csprg' string (default "cscope")
2401 global
2402 {not available when compiled without the |+cscope|
2403 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404 Specifies the command to execute cscope. See |cscopeprg|.
2405 This option cannot be set from a |modeline| or in the |sandbox|, for
2406 security reasons.
2407
2408 *'cscopequickfix'* *'csqf'*
2409'cscopequickfix' 'csqf' string (default "")
2410 global
2411 {not available when compiled without the |+cscope|
2412 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 Specifies whether to use quickfix window to show cscope results.
2414 See |cscopequickfix|.
2415
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002416 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002417'cscoperelative' 'csre' boolean (default off)
2418 global
2419 {not available when compiled without the |+cscope|
2420 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002421 In the absence of a prefix (-P) for cscope. setting this option enables
2422 to use the basename of cscope.out path as the prefix.
2423 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002424 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002425
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2427'cscopetag' 'cst' boolean (default off)
2428 global
2429 {not available when compiled without the |+cscope|
2430 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 Use cscope for tag commands. See |cscope-options|.
2432 NOTE: This option is reset when 'compatible' is set.
2433
2434 *'cscopetagorder'* *'csto'*
2435'cscopetagorder' 'csto' number (default 0)
2436 global
2437 {not available when compiled without the |+cscope|
2438 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 Determines the order in which ":cstag" performs a search. See
2440 |cscopetagorder|.
2441 NOTE: This option is set to 0 when 'compatible' is set.
2442
2443 *'cscopeverbose'* *'csverb'*
2444 *'nocscopeverbose'* *'nocsverb'*
2445'cscopeverbose' 'csverb' boolean (default off)
2446 global
2447 {not available when compiled without the |+cscope|
2448 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 Give messages when adding a cscope database. See |cscopeverbose|.
2450 NOTE: This option is reset when 'compatible' is set.
2451
Bram Moolenaar860cae12010-06-05 23:22:07 +02002452 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2453'cursorbind' 'crb' boolean (default off)
2454 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002455 When this option is set, as the cursor in the current
2456 window moves other cursorbound windows (windows that also have
2457 this option set) move their cursors to the corresponding line and
2458 column. This option is useful for viewing the
2459 differences between two versions of a file (see 'diff'); in diff mode,
2460 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002461 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002462
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463
2464 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2465'cursorcolumn' 'cuc' boolean (default off)
2466 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002467 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002468 feature}
2469 Highlight the screen column of the cursor with CursorColumn
2470 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2471 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002472 If you only want the highlighting in the current window you can use
2473 these autocommands: >
2474 au WinLeave * set nocursorline nocursorcolumn
2475 au WinEnter * set cursorline cursorcolumn
2476<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002477
2478 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2479'cursorline' 'cul' boolean (default off)
2480 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002481 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002482 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002483 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2484 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002485 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002486 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002487
2488
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002489 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002490'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002491 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002492 {not available when compiled without the |+syntax|
2493 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002494 Comma separated list of settings for how 'cursorline' is displayed.
2495 Valid values:
2496 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002497 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002498 "screenline" Highlight only the screen line of the cursor with
2499 CursorLine |hl-CursorLine|.
2500 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002501 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002502
2503 Special value:
2504 "both" Alias for the values "line,number".
2505
2506 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002507
2508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 *'debug'*
2510'debug' string (default "")
2511 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002512 These values can be used:
2513 msg Error messages that would otherwise be omitted will be given
2514 anyway.
2515 throw Error messages that would otherwise be omitted will be given
2516 anyway and also throw an exception and set |v:errmsg|.
2517 beep A message will be given when otherwise only a beep would be
2518 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002519 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002520 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2521 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522
2523 *'define'* *'def'*
2524'define' 'def' string (default "^\s*#\s*define")
2525 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 pattern, just like for the "/" command. This option is used for the
2528 commands like "[i" and "[d" |include-search|. The 'isident' option is
2529 used to recognize the defined name after the match:
2530 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2531 See |option-backslash| about inserting backslashes to include a space
2532 or backslash.
2533 The default value is for C programs. For C++ this value would be
2534 useful, to include const type declarations: >
2535 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002536< You can also use "\ze" just before the name and continue the pattern
2537 to check what is following. E.g. for Javascript, if a function is
2538 defined with "func_name = function(args)": >
2539 ^\s*\ze\i\+\s*=\s*function(
2540< If the function is defined with "func_name : function() {...": >
2541 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002543 To avoid that use `:let` with a single quote string: >
2544 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002545<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2548'delcombine' 'deco' boolean (default off)
2549 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 If editing Unicode and this option is set, backspace and Normal mode
2551 "x" delete each combining character on its own. When it is off (the
2552 default) the character along with its combining characters are
2553 deleted.
2554 Note: When 'delcombine' is set "xx" may work different from "2x"!
2555
2556 This is useful for Arabic, Hebrew and many other languages where one
2557 may have combining characters overtop of base characters, and want
2558 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002559 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
2561 *'dictionary'* *'dict'*
2562'dictionary' 'dict' string (default "")
2563 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 List of file names, separated by commas, that are used to lookup words
2565 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2566 contain a list of words. This can be one word per line, or several
2567 words per line, separated by non-keyword characters (white space is
2568 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002569
2570 When this option is empty or an entry "spell" is present, and spell
2571 checking is enabled, words in the word lists for the currently active
2572 'spelllang' are used. See |spell|.
2573
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002574 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 after a comma are ignored, otherwise spaces are included in the file
2576 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002577 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Where to find a list of words?
2579 - On FreeBSD, there is the file "/usr/share/dict/words".
2580 - In the Simtel archive, look in the "msdos/linguist" directory.
2581 - In "miscfiles" of the GNU collection.
2582 The use of |:set+=| and |:set-=| is preferred when adding or removing
2583 directories from the list. This avoids problems when a future version
2584 uses another default.
2585 Backticks cannot be used in this option for security reasons.
2586
2587 *'diff'* *'nodiff'*
2588'diff' boolean (default off)
2589 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 {not available when compiled without the |+diff|
2591 feature}
2592 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002593 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594
2595 *'dex'* *'diffexpr'*
2596'diffexpr' 'dex' string (default "")
2597 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 {not available when compiled without the |+diff|
2599 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002600 Expression which is evaluated to obtain a diff file (either ed-style
2601 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 This option cannot be set from a |modeline| or in the |sandbox|, for
2603 security reasons.
2604
2605 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002606'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 {not available when compiled without the |+diff|
2609 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 All are optional. Items must be separated by a comma.
2612
2613 filler Show filler lines, to keep the text
2614 synchronized with a window that has inserted
2615 lines at the same position. Mostly useful
2616 when windows are side-by-side and 'scrollbind'
2617 is set.
2618
2619 context:{n} Use a context of {n} lines between a change
2620 and a fold that contains unchanged lines.
2621 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002622 When using zero the context is actually one,
2623 since folds require a line in between, also
2624 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 See |fold-diff|.
2626
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002627 iblank Ignore changes where lines are all blank. Adds
2628 the "-B" flag to the "diff" command if
2629 'diffexpr' is empty. Check the documentation
2630 of the "diff" command for what this does
2631 exactly.
2632 NOTE: the diff windows will get out of sync,
2633 because no differences between blank lines are
2634 taken into account.
2635
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 icase Ignore changes in case of text. "a" and "A"
2637 are considered the same. Adds the "-i" flag
2638 to the "diff" command if 'diffexpr' is empty.
2639
2640 iwhite Ignore changes in amount of white space. Adds
2641 the "-b" flag to the "diff" command if
2642 'diffexpr' is empty. Check the documentation
2643 of the "diff" command for what this does
2644 exactly. It should ignore adding trailing
2645 white space, but not leading white space.
2646
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002647 iwhiteall Ignore all white space changes. Adds
2648 the "-w" flag to the "diff" command if
2649 'diffexpr' is empty. Check the documentation
2650 of the "diff" command for what this does
2651 exactly.
2652
2653 iwhiteeol Ignore white space changes at end of line.
2654 Adds the "-Z" flag to the "diff" command if
2655 'diffexpr' is empty. Check the documentation
2656 of the "diff" command for what this does
2657 exactly.
2658
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002659 horizontal Start diff mode with horizontal splits (unless
2660 explicitly specified otherwise).
2661
2662 vertical Start diff mode with vertical splits (unless
2663 explicitly specified otherwise).
2664
Bram Moolenaarc8234772019-11-10 21:00:27 +01002665 closeoff When a window is closed where 'diff' is set
2666 and there is only one window remaining in the
2667 same tab page with 'diff' set, execute
2668 `:diffoff` in that window. This undoes a
2669 `:diffsplit` command.
2670
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002671 hiddenoff Do not use diff mode for a buffer when it
2672 becomes hidden.
2673
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002674 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2675 starting diff mode. Without this 2 is used.
2676
Bram Moolenaare828b762018-09-10 17:51:58 +02002677 internal Use the internal diff library. This is
2678 ignored when 'diffexpr' is set. *E960*
2679 When running out of memory when writing a
2680 buffer this item will be ignored for diffs
2681 involving that buffer. Set the 'verbose'
2682 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683
Bram Moolenaare828b762018-09-10 17:51:58 +02002684 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002685 Use the indent heuristic for the internal
2686 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002687
2688 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002689 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002690 algorithms are:
2691 myers the default algorithm
2692 minimal spend extra time to generate the
2693 smallest possible diff
2694 patience patience diff algorithm
2695 histogram histogram diff algorithm
2696
2697 Examples: >
2698 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002700 :set diffopt=internal,filler,foldcolumn:3
2701 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702<
2703 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2704'digraph' 'dg' boolean (default off)
2705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 {not available when compiled without the |+digraphs|
2707 feature}
2708 Enable the entering of digraphs in Insert mode with {char1} <BS>
2709 {char2}. See |digraphs|.
2710 NOTE: This option is reset when 'compatible' is set.
2711
2712 *'directory'* *'dir'*
2713'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01002714 for Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 for Unix: ".,~/tmp,/var/tmp,/tmp")
2716 global
2717 List of directory names for the swap file, separated with commas.
2718 - The swap file will be created in the first directory where this is
2719 possible.
2720 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002721 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 - A directory "." means to put the swap file in the same directory as
2723 the edited file. On Unix, a dot is prepended to the file name, so
2724 it doesn't show in a directory listing. On MS-Windows the "hidden"
2725 attribute is set and a dot prepended if possible.
Bram Moolenaar8024f932020-01-14 19:29:13 +01002726 - A directory starting with "./" (or ".\" for MS-Windows) means to put
2727 the swap file relative to where the edited file is. The leading "."
2728 is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002729 - For Unix and Win32, if a directory ends in two path separators "//",
2730 the swap file name will be built from the complete path to the file
2731 with all path separators substituted to percent '%' signs. This will
2732 ensure file name uniqueness in the preserve directory.
2733 On Win32, it is also possible to end with "\\". However, When a
2734 separating comma is following, you must use "//", since "\\" will
2735 include the comma in the file name. Therefore it is recommended to
2736 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 - Spaces after the comma are ignored, other spaces are considered part
2738 of the directory name. To have a space at the start of a directory
2739 name, precede it with a backslash.
2740 - To include a comma in a directory name precede it with a backslash.
2741 - A directory name may end in an ':' or '/'.
2742 - Environment variables are expanded |:set_env|.
2743 - Careful with '\' characters, type one before a space, type two to
2744 get one in the option (see |option-backslash|), for example: >
2745 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2746< - For backwards compatibility with Vim version 3.0 a '>' at the start
2747 of the option is removed.
2748 Using "." first in the list is recommended. This means that editing
2749 the same file twice will result in a warning. Using "/tmp" on Unix is
2750 discouraged: When the system crashes you lose the swap file.
2751 "/var/tmp" is often not cleared when rebooting, thus is a better
2752 choice than "/tmp". But it can contain a lot of files, your swap
2753 files get lost in the crowd. That is why a "tmp" directory in your
2754 home directory is tried first.
2755 The use of |:set+=| and |:set-=| is preferred when adding or removing
2756 directories from the list. This avoids problems when a future version
2757 uses another default.
2758 This option cannot be set from a |modeline| or in the |sandbox|, for
2759 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760
2761 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002762'display' 'dy' string (default "", set to "truncate" in
2763 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 Change the way text is displayed. This is comma separated list of
2766 flags:
2767 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002768 in a window will be displayed. "@@@" is put in the
2769 last columns of the last screen line to indicate the
2770 rest of the line is not displayed.
2771 truncate Like "lastline", but "@@@" is displayed in the first
2772 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 uhex Show unprintable characters hexadecimal as <xx>
2774 instead of using ^C and ~C.
2775
Bram Moolenaard0796902016-09-16 20:02:31 +02002776 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002777 doesn't fit is replaced with "@" lines.
2778
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 *'eadirection'* *'ead'*
2780'eadirection' 'ead' string (default "both")
2781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 Tells when the 'equalalways' option applies:
2783 ver vertically, width of windows is not affected
2784 hor horizontally, height of windows is not affected
2785 both width and height of windows is affected
2786
2787 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2788'edcompatible' 'ed' boolean (default off)
2789 global
2790 Makes the 'g' and 'c' flags of the ":substitute" command to be
2791 toggled each time the flag is given. See |complex-change|. See
2792 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002793 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794
Bram Moolenaar03413f42016-04-12 21:07:15 +02002795 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002796'emoji' 'emo' boolean (default: on)
2797 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002798 When on all Unicode emoji characters are considered to be full width.
2799
2800
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 *'encoding'* *'enc'* *E543*
2802'encoding' 'enc' string (default: "latin1" or value from $LANG)
2803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 Sets the character encoding used inside Vim. It applies to text in
2805 the buffers, registers, Strings in expressions, text stored in the
2806 viminfo file, etc. It sets the kind of characters which Vim can work
2807 with. See |encoding-names| for the possible values.
2808
2809 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002810 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002812 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813
Bram Moolenaar865242e2010-07-14 21:12:05 +02002814 This option cannot be set from a |modeline|. It would most likely
2815 corrupt the text.
2816
Bram Moolenaar3df01732017-02-17 22:47:16 +01002817 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2818 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 'encoding', "utf-8" is the natural choice for the environment and
2820 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002821 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 versions, and to avoid changing the encoding of newly created files
2823 without your knowledge (in case 'fileencodings' is empty).
2824
2825 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002826 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 iconv() or as specified with 'charconvert'.
2828
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002829 If you need to know whether 'encoding' is a multi-byte encoding, you
2830 can use: >
2831 if has("multi_byte_encoding")
2832<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 Normally 'encoding' will be equal to your current locale. This will
2834 be the default if Vim recognizes your environment settings. If
2835 'encoding' is not set to the current locale, 'termencoding' must be
2836 set to convert typed and displayed text. See |encoding-table|.
2837
2838 When you set this option, it fires the |EncodingChanged| autocommand
2839 event so that you can set up fonts if necessary.
2840
2841 When the option is set, the value is converted to lowercase. Thus
2842 you can set it with uppercase values too. Underscores are translated
2843 to '-' signs.
2844 When the encoding is recognized, it is changed to the standard name.
2845 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2846 "iso-8859-2" and "utf8" becomes "utf-8".
2847
2848 Note: "latin1" is also used when the encoding could not be detected.
2849 This only works when editing files in the same encoding! When the
2850 actual character set is not latin1, make sure 'fileencoding' and
2851 'fileencodings' are empty. When conversion is needed, switch to using
2852 utf-8.
2853
2854 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2855 You don't notice this while editing, but it does matter for the
2856 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2857 setting 'encoding' to one of these values instead of utf-8 only has
2858 effect for encoding used for files when 'fileencoding' is empty.
2859
Bram Moolenaar661b1822005-07-28 22:36:45 +00002860 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2861 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862
2863 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2864'endofline' 'eol' boolean (default on)
2865 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002867 is on, or 'fixeol' option is off, no <EOL> will be written for the
2868 last line in the file. This option is automatically set or reset when
2869 starting to edit a new file, depending on whether file has an <EOL>
2870 for the last line in the file. Normally you don't have to set or
2871 reset this option.
2872 When 'binary' is off and 'fixeol' is on the value is not used when
2873 writing the file. When 'binary' is on or 'fixeol' is off it is used
2874 to remember the presence of a <EOL> for the last line in the file, so
2875 that when you write the file the situation from the original file can
2876 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877
2878 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2879'equalalways' 'ea' boolean (default on)
2880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002882 splitting or closing a window. This also happens the moment the
2883 option is switched on. When off, splitting a window will reduce the
2884 size of the current window and leave the other windows the same. When
2885 closing a window the extra lines are given to the window next to it
2886 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 When mixing vertically and horizontally split windows, a minimal size
2888 is computed and some windows may be larger if there is room. The
2889 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002890 Changing the height and width of a window can be avoided by setting
2891 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002892 If a window size is specified when creating a new window sizes are
2893 currently not equalized (it's complicated, but may be implemented in
2894 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
2896 *'equalprg'* *'ep'*
2897'equalprg' 'ep' string (default "")
2898 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002900 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002901 or 'indentexpr'. When Vim was compiled without internal formatting,
2902 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002903 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 about including spaces and backslashes.
2905 This option cannot be set from a |modeline| or in the |sandbox|, for
2906 security reasons.
2907
2908 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2909'errorbells' 'eb' boolean (default off)
2910 global
2911 Ring the bell (beep or screen flash) for error messages. This only
2912 makes a difference for error messages, the bell will be used always
2913 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002914 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002915 screen flash or do nothing. See 'belloff' to finetune when to ring the
2916 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918 *'errorfile'* *'ef'*
2919'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2920 others: "errors.err")
2921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 {not available when compiled without the |+quickfix|
2923 feature}
2924 Name of the errorfile for the QuickFix mode (see |:cf|).
2925 When the "-q" command-line argument is used, 'errorfile' is set to the
2926 following argument. See |-q|.
2927 NOT used for the ":make" command. See 'makeef' for that.
2928 Environment variables are expanded |:set_env|.
2929 See |option-backslash| about including spaces and backslashes.
2930 This option cannot be set from a |modeline| or in the |sandbox|, for
2931 security reasons.
2932
2933 *'errorformat'* *'efm'*
2934'errorformat' 'efm' string (default is very long)
2935 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 {not available when compiled without the |+quickfix|
2937 feature}
2938 Scanf-like description of the format for the lines in the error file
2939 (see |errorformat|).
2940
2941 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2942'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 Function keys that start with an <Esc> are recognized in Insert
2945 mode. When this option is off, the cursor and function keys cannot be
2946 used in Insert mode if they start with an <Esc>. The advantage of
2947 this is that the single <Esc> is recognized immediately, instead of
2948 after one second. Instead of resetting this option, you might want to
2949 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2950 when 'esckeys' is off, you can still map anything, but the cursor keys
2951 won't work by default.
2952 NOTE: This option is set to the Vi default value when 'compatible' is
2953 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002954 NOTE: when this option is off then the |modifyOtherKeys| functionality
2955 is disabled while in Insert mode to avoid ending Insert mode with any
2956 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957
2958 *'eventignore'* *'ei'*
2959'eventignore' 'ei' string (default "")
2960 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002962 When set to "all" or when "all" is one of the items, all autocommand
2963 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 Otherwise this is a comma separated list of event names. Example: >
2965 :set ei=WinEnter,WinLeave
2966<
2967 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2968'expandtab' 'et' boolean (default off)
2969 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002971 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2973 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002974 This option is reset when the 'paste' option is set and restored when
2975 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 NOTE: This option is reset when 'compatible' is set.
2977
2978 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2979'exrc' 'ex' boolean (default off)
2980 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002982 directory.
2983
2984 Setting this option is a potential security leak. E.g., consider
2985 unpacking a package or fetching files from github, a .vimrc in there
2986 might be a trojan horse. BETTER NOT SET THIS OPTION!
2987 Instead, define an autocommand in your .vimrc to set options for a
2988 matching directory.
2989
2990 If you do switch this option on you should also consider setting the
2991 'secure' option (see |initialization|).
2992 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 This option cannot be set from a |modeline| or in the |sandbox|, for
2994 security reasons.
2995
2996 *'fileencoding'* *'fenc'* *E213*
2997'fileencoding' 'fenc' string (default: "")
2998 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003000
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003002 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 When 'fileencoding' is empty, the same value as 'encoding' will be
3004 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01003005 No error will be given when the value is set, only when it is used,
3006 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003007 Conversion will also be done when 'encoding' and 'fileencoding' are
3008 both a Unicode encoding and 'fileencoding' is not utf-8. That's
3009 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003011 'encoding' is "utf-8" or another Unicode encoding, conversion
3012 is most likely done in a way that the reverse conversion
3013 results in the same text. When 'encoding' is not "utf-8" some
3014 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003015
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 See 'encoding' for the possible values. Additionally, values may be
3017 specified that can be handled by the converter, see
3018 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003019
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 When reading a file 'fileencoding' will be set from 'fileencodings'.
3021 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003022 'fileencoding', use the |++enc| argument. One exception: when
3023 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003024 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003025
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3027 When the option is set, the value is converted to lowercase. Thus
3028 you can set it with uppercase values too. '_' characters are
3029 replaced with '-'. If a name is recognized from the list for
3030 'encoding', it is replaced by the standard name. For example
3031 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003032
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 When this option is set, after starting to edit a file, the 'modified'
3034 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003035
3036 Keep in mind that changing 'fenc' from a modeline happens
3037 AFTER the text has been read, thus it applies to when the file will be
3038 written. If you do set 'fenc' in a modeline, you might want to set
3039 'nomodified' to avoid not being able to ":q".
3040
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 This option can not be changed when 'modifiable' is off.
3042
3043 *'fe'*
3044 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003045 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 old short name was 'fe', which is no longer used.
3047
3048 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003049'fileencodings' 'fencs' string (default: "ucs-bom",
3050 "ucs-bom,utf-8,default,latin1" when
3051 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 This is a list of character encodings considered when starting to edit
3054 an existing file. When a file is read, Vim tries to use the first
3055 mentioned character encoding. If an error is detected, the next one
3056 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003057 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 an empty string, which means the value of 'encoding' is used.
3059 WARNING: Conversion can cause loss of information! When
3060 'encoding' is "utf-8" (or one of the other Unicode variants)
3061 conversion is most likely done in a way that the reverse
3062 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003063 "utf-8" some non-ASCII characters may be lost! You can use
3064 the |++bad| argument to specify what is done with characters
3065 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 For an empty file or a file with only ASCII characters most encodings
3067 will work and the first entry of 'fileencodings' will be used (except
3068 "ucs-bom", which requires the BOM to be present). If you prefer
3069 another encoding use an BufReadPost autocommand event to test if your
3070 preferred encoding is to be used. Example: >
3071 au BufReadPost * if search('\S', 'w') == 0 |
3072 \ set fenc=iso-2022-jp | endif
3073< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3074 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003075 When the |++enc| argument is used then the value of 'fileencodings' is
3076 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003077 Note that 'fileencodings' is not used for a new file, the global value
3078 of 'fileencoding' is used instead. You can set it with: >
3079 :setglobal fenc=iso-8859-2
3080< This means that a non-existing file may get a different encoding than
3081 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082 The special value "ucs-bom" can be used to check for a Unicode BOM
3083 (Byte Order Mark) at the start of the file. It must not be preceded
3084 by "utf-8" or another Unicode encoding for this to work properly.
3085 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3086 because Vim cannot detect an error, thus the encoding is always
3087 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003088 The special value "default" can be used for the encoding from the
3089 environment. This is the default value for 'encoding'. It is useful
3090 when 'encoding' is set to "utf-8" and your environment uses a
3091 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003092 When 'encoding' is "utf-8" and a file contains an illegal byte
3093 sequence it won't be recognized as UTF-8. You can use the |8g8|
3094 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 WRONG VALUES: WHAT'S WRONG:
3096 latin1,utf-8 "latin1" will always be used
3097 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3098 file
3099 cp1250,latin1 "cp1250" will always be used
3100 If 'fileencodings' is empty, 'fileencoding' is not modified.
3101 See 'fileencoding' for the possible values.
3102 Setting this option does not have an effect until the next time a file
3103 is read.
3104
3105 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003106'fileformat' 'ff' string (MS-Windows default: "dos",
3107 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 This gives the <EOL> of the current buffer, which is used for
3110 reading/writing the buffer from/to a file:
3111 dos <CR> <NL>
3112 unix <NL>
3113 mac <CR>
3114 When "dos" is used, CTRL-Z at the end of a file is ignored.
3115 See |file-formats| and |file-read|.
3116 For the character encoding of the file see 'fileencoding'.
3117 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003118 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 This option is set automatically when starting to edit a file and
3120 'fileformats' is not empty and 'binary' is off.
3121 When this option is set, after starting to edit a file, the 'modified'
3122 option is set, because the file would be different when written.
3123 This option can not be changed when 'modifiable' is off.
3124 For backwards compatibility: When this option is set to "dos",
3125 'textmode' is set, otherwise 'textmode' is reset.
3126
3127 *'fileformats'* *'ffs'*
3128'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003129 Vim+Vi MS-Windows: "dos,unix",
3130 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 Vi Cygwin: "unix,dos",
3132 Vi others: "")
3133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 This gives the end-of-line (<EOL>) formats that will be tried when
3135 starting to edit a new buffer and when reading a file into an existing
3136 buffer:
3137 - When empty, the format defined with 'fileformat' will be used
3138 always. It is not set automatically.
3139 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003140 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 'fileformats' name will be used when a file is read into an existing
3142 buffer, no matter what 'fileformat' for that buffer is set to.
3143 - When more than one name is present, separated by commas, automatic
3144 <EOL> detection will be done when reading a file. When starting to
3145 edit a file, a check is done for the <EOL>:
3146 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3147 'fileformat' is set to "dos".
3148 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003149 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003151 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3152 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003153 This means that "mac" is only chosen when:
3154 "unix" is not present or no <NL> is found in the file, and
3155 "dos" is not present or no <CR><NL> is found in the file.
3156 Except: if "unix" was chosen, but there is a <CR> before
3157 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003158 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 4. If 'fileformat' is still not set, the first name from
3160 'fileformats' is used.
3161 When reading a file into an existing buffer, the same is done, but
3162 this happens like 'fileformat' has been set appropriately for that
3163 file only, the option is not changed.
3164 When 'binary' is set, the value of 'fileformats' is not used.
3165
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003166 When Vim starts up with an empty buffer the first item is used. You
3167 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003168
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3170 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3171 done:
3172 - When 'fileformats' is empty, there is no automatic detection. Dos
3173 format will be used.
3174 - When 'fileformats' is set to one or more names, automatic detection
3175 is done. This is based on the first <NL> in the file: If there is a
3176 <CR> in front of it, Dos format is used, otherwise Unix format is
3177 used.
3178 Also see |file-formats|.
3179 For backwards compatibility: When this option is set to an empty
3180 string or one format (no comma is included), 'textauto' is reset,
3181 otherwise 'textauto' is set.
3182 NOTE: This option is set to the Vi default value when 'compatible' is
3183 set and to the Vim default value when 'compatible' is reset.
3184
Bram Moolenaarbf884932013-04-05 22:26:15 +02003185 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3186'fileignorecase' 'fic' boolean (default on for systems where case in file
3187 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003188 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003189 When set case is ignored when using file names and directories.
3190 See 'wildignorecase' for only ignoring case when doing completion.
3191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 *'filetype'* *'ft'*
3193'filetype' 'ft' string (default: "")
3194 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 When this option is set, the FileType autocommand event is triggered.
3196 All autocommands that match with the value of this option will be
3197 executed. Thus the value of 'filetype' is used in place of the file
3198 name.
3199 Otherwise this option does not always reflect the current file type.
3200 This option is normally set when the file type is detected. To enable
3201 this use the ":filetype on" command. |:filetype|
3202 Setting this option to a different value is most useful in a modeline,
3203 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003204 Example, for in an IDL file:
3205 /* vim: set filetype=idl : */ ~
3206 |FileType| |filetypes|
3207 When a dot appears in the value then this separates two filetype
3208 names. Example:
3209 /* vim: set filetype=c.doxygen : */ ~
3210 This will use the "c" filetype first, then the "doxygen" filetype.
3211 This works both for filetype plugins and for syntax files. More than
3212 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 This option is not copied to another buffer, independent of the 's' or
3214 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003215 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216
3217 *'fillchars'* *'fcs'*
3218'fillchars' 'fcs' string (default "vert:|,fold:-")
3219 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003220 {not available when compiled without the |+folding|
3221 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 Characters to fill the statuslines and vertical separators.
3223 It is a comma separated list of items:
3224
3225 item default Used for ~
3226 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003227 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 vert:c '|' vertical separators |:vsplit|
3229 fold:c '-' filling 'foldtext'
3230 diff:c '-' deleted lines of the 'diff' option
3231
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003232 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003233 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 otherwise.
3235
3236 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003237 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238< This is similar to the default, except that these characters will also
3239 be used when there is highlighting.
3240
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003241 for "stl" and "stlnc" only single-byte values are supported.
3242
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 The highlighting used for these items:
3244 item highlight group ~
3245 stl:c StatusLine |hl-StatusLine|
3246 stlnc:c StatusLineNC |hl-StatusLineNC|
3247 vert:c VertSplit |hl-VertSplit|
3248 fold:c Folded |hl-Folded|
3249 diff:c DiffDelete |hl-DiffDelete|
3250
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003251 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3252'fixendofline' 'fixeol' boolean (default on)
3253 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003254 When writing a file and this option is on, <EOL> at the end of file
3255 will be restored if missing. Turn this option off if you want to
3256 preserve the situation from the original file.
3257 When the 'binary' option is set the value of this option doesn't
3258 matter.
3259 See the 'endofline' option.
3260
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3262'fkmap' 'fk' boolean (default off) *E198*
3263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 {only available when compiled with the |+rightleft|
3265 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003266 This option was for using Farsi, which has been removed. See
3267 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268
3269 *'foldclose'* *'fcl'*
3270'foldclose' 'fcl' string (default "")
3271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 {not available when compiled without the |+folding|
3273 feature}
3274 When set to "all", a fold is closed when the cursor isn't in it and
3275 its level is higher than 'foldlevel'. Useful if you want folds to
3276 automatically close when moving out of them.
3277
3278 *'foldcolumn'* *'fdc'*
3279'foldcolumn' 'fdc' number (default 0)
3280 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 {not available when compiled without the |+folding|
3282 feature}
3283 When non-zero, a column with the specified width is shown at the side
3284 of the window which indicates open and closed folds. The maximum
3285 value is 12.
3286 See |folding|.
3287
3288 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3289'foldenable' 'fen' boolean (default on)
3290 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 {not available when compiled without the |+folding|
3292 feature}
3293 When off, all folds are open. This option can be used to quickly
3294 switch between showing all text unfolded and viewing the text with
3295 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003296 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 'foldenable' is off.
3298 This option is set by commands that create a new fold or close a fold.
3299 See |folding|.
3300
3301 *'foldexpr'* *'fde'*
3302'foldexpr' 'fde' string (default: "0")
3303 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003305 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003307 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003308
Bram Moolenaar30b65812012-07-12 22:01:11 +02003309 The expression will be evaluated in the |sandbox| if set from a
3310 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003311 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003312 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003313
3314 It is not allowed to change text or jump to another window while
3315 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316
3317 *'foldignore'* *'fdi'*
3318'foldignore' 'fdi' string (default: "#")
3319 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 {not available when compiled without the |+folding|
3321 feature}
3322 Used only when 'foldmethod' is "indent". Lines starting with
3323 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003324 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 The default "#" works well for C programs. See |fold-indent|.
3326
3327 *'foldlevel'* *'fdl'*
3328'foldlevel' 'fdl' number (default: 0)
3329 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 {not available when compiled without the |+folding|
3331 feature}
3332 Sets the fold level: Folds with a higher level will be closed.
3333 Setting this option to zero will close all folds. Higher numbers will
3334 close fewer folds.
3335 This option is set by commands like |zm|, |zM| and |zR|.
3336 See |fold-foldlevel|.
3337
3338 *'foldlevelstart'* *'fdls'*
3339'foldlevelstart' 'fdls' number (default: -1)
3340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 {not available when compiled without the |+folding|
3342 feature}
3343 Sets 'foldlevel' when starting to edit another buffer in a window.
3344 Useful to always start editing with all folds closed (value zero),
3345 some folds closed (one) or no folds closed (99).
3346 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003347 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 ignores this option and closes all folds.
3349 It is also done before BufReadPre autocommands, to allow an autocmd to
3350 overrule the 'foldlevel' value for specific files.
3351 When the value is negative, it is not used.
3352
3353 *'foldmarker'* *'fmr'* *E536*
3354'foldmarker' 'fmr' string (default: "{{{,}}}")
3355 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 {not available when compiled without the |+folding|
3357 feature}
3358 The start and end marker used when 'foldmethod' is "marker". There
3359 must be one comma, which separates the start and end marker. The
3360 marker is a literal string (a regular expression would be too slow).
3361 See |fold-marker|.
3362
3363 *'foldmethod'* *'fdm'*
3364'foldmethod' 'fdm' string (default: "manual")
3365 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 {not available when compiled without the |+folding|
3367 feature}
3368 The kind of folding used for the current window. Possible values:
3369 |fold-manual| manual Folds are created manually.
3370 |fold-indent| indent Lines with equal indent form a fold.
3371 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3372 |fold-marker| marker Markers are used to specify folds.
3373 |fold-syntax| syntax Syntax highlighting items specify folds.
3374 |fold-diff| diff Fold text that is not changed.
3375
3376 *'foldminlines'* *'fml'*
3377'foldminlines' 'fml' number (default: 1)
3378 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 {not available when compiled without the |+folding|
3380 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003381 Sets the number of screen lines above which a fold can be displayed
3382 closed. Also for manually closed folds. With the default value of
3383 one a fold can only be closed if it takes up two or more screen lines.
3384 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003385 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 "zc" to close a fold, which is displayed open because it's smaller
3387 than 'foldminlines', a following "zc" may close a containing fold.
3388
3389 *'foldnestmax'* *'fdn'*
3390'foldnestmax' 'fdn' number (default: 20)
3391 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 {not available when compiled without the |+folding|
3393 feature}
3394 Sets the maximum nesting of folds for the "indent" and "syntax"
3395 methods. This avoids that too many folds will be created. Using more
3396 than 20 doesn't work, because the internal limit is 20.
3397
3398 *'foldopen'* *'fdo'*
3399'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3400 search,tag,undo")
3401 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 {not available when compiled without the |+folding|
3403 feature}
3404 Specifies for which type of commands folds will be opened, if the
3405 command moves the cursor into a closed fold. It is a comma separated
3406 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003407 NOTE: When the command is part of a mapping this option is not used.
3408 Add the |zv| command to the mapping to get the same effect.
3409 (rationale: the mapping may want to control opening folds itself)
3410
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 item commands ~
3412 all any
3413 block "(", "{", "[[", "[{", etc.
3414 hor horizontal movements: "l", "w", "fx", etc.
3415 insert any command in Insert mode
3416 jump far jumps: "G", "gg", etc.
3417 mark jumping to a mark: "'m", CTRL-O, etc.
3418 percent "%"
3419 quickfix ":cn", ":crew", ":make", etc.
3420 search search for a pattern: "/", "n", "*", "gd", etc.
3421 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003422 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 tag jumping to a tag: ":ta", CTRL-T, etc.
3424 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 When a movement command is used for an operator (e.g., "dl" or "y%")
3426 this option is not used. This means the operator will include the
3427 whole closed fold.
3428 Note that vertical movements are not here, because it would make it
3429 very difficult to move onto a closed fold.
3430 In insert mode the folds containing the cursor will always be open
3431 when text is inserted.
3432 To close folds you can re-apply 'foldlevel' with the |zx| command or
3433 set the 'foldclose' option to "all".
3434
3435 *'foldtext'* *'fdt'*
3436'foldtext' 'fdt' string (default: "foldtext()")
3437 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 {not available when compiled without the |+folding|
3439 feature}
3440 An expression which is used to specify the text displayed for a closed
3441 fold. See |fold-foldtext|.
3442
Bram Moolenaar30b65812012-07-12 22:01:11 +02003443 The expression will be evaluated in the |sandbox| if set from a
3444 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003445 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003446
3447 It is not allowed to change text or jump to another window while
3448 evaluating 'foldtext' |textlock|.
3449
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003450 *'formatexpr'* *'fex'*
3451'formatexpr' 'fex' string (default "")
3452 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003453 {not available when compiled without the |+eval|
3454 feature}
3455 Expression which is evaluated to format a range of lines for the |gq|
3456 operator or automatic formatting (see 'formatoptions'). When this
3457 option is empty 'formatprg' is used.
3458
3459 The |v:lnum| variable holds the first line to be formatted.
3460 The |v:count| variable holds the number of lines to be formatted.
3461 The |v:char| variable holds the character that is going to be
3462 inserted if the expression is being evaluated due to
3463 automatic formatting. This can be empty. Don't insert
3464 it yet!
3465
3466 Example: >
3467 :set formatexpr=mylang#Format()
3468< This will invoke the mylang#Format() function in the
3469 autoload/mylang.vim file in 'runtimepath'. |autoload|
3470
3471 The expression is also evaluated when 'textwidth' is set and adding
3472 text beyond that limit. This happens under the same conditions as
3473 when internal formatting is used. Make sure the cursor is kept in the
3474 same spot relative to the text then! The |mode()| function will
3475 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003476
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003477 When the expression evaluates to non-zero Vim will fall back to using
3478 the internal format mechanism.
3479
3480 The expression will be evaluated in the |sandbox| when set from a
3481 modeline, see |sandbox-option|. That stops the option from working,
3482 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003483 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003484 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003485
Bram Moolenaar86b68352004-12-27 21:59:20 +00003486 *'formatlistpat'* *'flp'*
3487'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3488 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003489 A pattern that is used to recognize a list header. This is used for
3490 the "n" flag in 'formatoptions'.
3491 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003492 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003493 while still checking more characters. There must be a character
3494 following the pattern, when it matches the whole line it is handled
3495 like there is no match.
3496 The default recognizes a number, followed by an optional punctuation
3497 character and white space.
3498
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003499 *'formatoptions'* *'fo'*
3500'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3501 local to buffer
3502 This is a sequence of letters which describes how automatic
3503 formatting is to be done. See |fo-table|. When the 'paste' option is
3504 on, no formatting is done (like 'formatoptions' is empty). Commas can
3505 be inserted for readability.
3506 To avoid problems with flags that are added in the future, use the
3507 "+=" and "-=" feature of ":set" |add-option-flags|.
3508 NOTE: This option is set to the Vi default value when 'compatible' is
3509 set and to the Vim default value when 'compatible' is reset.
3510
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 *'formatprg'* *'fp'*
3512'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003513 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003515 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003517 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003518 If the 'formatexpr' option is not empty it will be used instead.
3519 Otherwise, if 'formatprg' option is an empty string, the internal
3520 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003521 Environment variables are expanded |:set_env|. See |option-backslash|
3522 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003523 This option cannot be set from a |modeline| or in the |sandbox|, for
3524 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525
Bram Moolenaard94464e2015-11-02 15:28:18 +01003526 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003527'fsync' 'fs' boolean (default on)
3528 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003529 When on, the library function fsync() will be called after writing a
3530 file. This will flush a file to disk, ensuring that it is safely
3531 written even on filesystems which do metadata-only journaling. This
3532 will force the harddrive to spin up on Linux systems running in laptop
3533 mode, so it may be undesirable in some situations. Be warned that
3534 turning this off increases the chances of data loss after a crash. On
3535 systems without an fsync() implementation, this variable is always
3536 off.
3537 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003538 'fsync' also applies to |writefile()|, unless a flag is used to
3539 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003540 This option cannot be set from a |modeline| or in the |sandbox|, for
3541 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003542
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3544'gdefault' 'gd' boolean (default off)
3545 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 When on, the ":substitute" flag 'g' is default on. This means that
3547 all matches in a line are substituted instead of one. When a 'g' flag
3548 is given to a ":substitute" command, this will toggle the substitution
3549 of all or one match. See |complex-change|.
3550
3551 command 'gdefault' on 'gdefault' off ~
3552 :s/// subst. all subst. one
3553 :s///g subst. one subst. all
3554 :s///gg subst. all subst. one
3555
3556 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003557 DEPRECATED: Setting this option may break plugins that are not aware
3558 of this option. Also, many users get confused that adding the /g flag
3559 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003562'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 Format to recognize for the ":grep" command output.
3565 This is a scanf-like string that uses the same format as the
3566 'errorformat' option: see |errorformat|.
3567
3568 *'grepprg'* *'gp'*
3569'grepprg' 'gp' string (default "grep -n ",
3570 Unix: "grep -n $* /dev/null",
3571 Win32: "findstr /n" or "grep -n",
3572 VMS: "SEARCH/NUMBERS ")
3573 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003574 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 and '#' characters, which are expanded like when used in a command-
3576 line. The placeholder "$*" is allowed to specify where the arguments
3577 will be included. Environment variables are expanded |:set_env|. See
3578 |option-backslash| about including spaces and backslashes.
3579 When your "grep" accepts the "-H" argument, use this to make ":grep"
3580 also work well with a single file: >
3581 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003582< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003583 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3584 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003585 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 apply equally to 'grepprg'.
3587 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3588 otherwise it's "grep -n".
3589 This option cannot be set from a |modeline| or in the |sandbox|, for
3590 security reasons.
3591
3592 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3593'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3594 ve:ver35-Cursor,
3595 o:hor50-Cursor,
3596 i-ci:ver25-Cursor/lCursor,
3597 r-cr:hor20-Cursor/lCursor,
3598 sm:block-Cursor
3599 -blinkwait175-blinkoff150-blinkon175",
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003600 for Win32 console:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 "n-v-c:block,o:hor50,i-ci:hor15,
3602 r-cr:hor30,sm:block")
3603 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 {only available when compiled with GUI enabled, and
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003605 for Win32 console}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 This option tells Vim what the cursor should look like in different
Bram Moolenaar8024f932020-01-14 19:29:13 +01003607 modes. It fully works in the GUI. In a Win32 console, only the
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003608 height of the cursor can be changed. This can be done by specifying a
3609 block cursor, or a percentage for a vertical or horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003610 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3611 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003613 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 mode-list and an argument-list:
3615 mode-list:argument-list,mode-list:argument-list,..
3616 The mode-list is a dash separated list of these modes:
3617 n Normal mode
3618 v Visual mode
3619 ve Visual mode with 'selection' "exclusive" (same as 'v',
3620 if not specified)
3621 o Operator-pending mode
3622 i Insert mode
3623 r Replace mode
3624 c Command-line Normal (append) mode
3625 ci Command-line Insert mode
3626 cr Command-line Replace mode
3627 sm showmatch in Insert mode
3628 a all modes
3629 The argument-list is a dash separated list of these arguments:
3630 hor{N} horizontal bar, {N} percent of the character height
3631 ver{N} vertical bar, {N} percent of the character width
3632 block block cursor, fills the whole character
3633 [only one of the above three should be present]
3634 blinkwait{N} *cursor-blinking*
3635 blinkon{N}
3636 blinkoff{N}
3637 blink times for cursor: blinkwait is the delay before
3638 the cursor starts blinking, blinkon is the time that
3639 the cursor is shown and blinkoff is the time that the
3640 cursor is not shown. The times are in msec. When one
3641 of the numbers is zero, there is no blinking. The
3642 default is: "blinkwait700-blinkon400-blinkoff250".
3643 These numbers are used for a missing entry. This
3644 means that blinking is enabled by default. To switch
3645 blinking off you can use "blinkon0". The cursor only
3646 blinks when Vim is waiting for input, not while
3647 executing a command.
3648 To make the cursor blink in an xterm, see
3649 |xterm-blink|.
3650 {group-name}
3651 a highlight group name, that sets the color and font
3652 for the cursor
3653 {group-name}/{group-name}
3654 Two highlight group names, the first is used when
3655 no language mappings are used, the other when they
3656 are. |language-mapping|
3657
3658 Examples of parts:
3659 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3660 block cursor with colors from the "nCursor"
3661 highlight group
3662 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3663 In Insert and Command-line Insert mode, use a
3664 30% vertical bar cursor with colors from the
3665 "iCursor" highlight group. Blink a bit
3666 faster.
3667
3668 The 'a' mode is different. It will set the given argument-list for
3669 all modes. It does not reset anything to defaults. This can be used
3670 to do a common setting for all modes. For example, to switch off
3671 blinking: "a:blinkon0"
3672
3673 Examples of cursor highlighting: >
3674 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3675 :highlight Cursor gui=NONE guifg=bg guibg=fg
3676<
3677 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003678 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679'guifont' 'gfn' string (default "")
3680 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 {only available when compiled with GUI enabled}
3682 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003683 In its simplest form the value is just one font name.
3684 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685
3686 *'guifontset'* *'gfs'*
3687 *E250* *E252* *E234* *E597* *E598*
3688'guifontset' 'gfs' string (default "")
3689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 {only available when compiled with GUI enabled and
3691 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003692 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 When not empty, specifies two (or more) fonts to be used. The first
3694 one for normal English, the second one for your special language. See
3695 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003696
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3698'guifontwide' 'gfw' string (default "")
3699 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 {only available when compiled with GUI enabled}
3701 When not empty, specifies a comma-separated list of fonts to be used
3702 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003703 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003704
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 *'guiheadroom'* *'ghr'*
3706'guiheadroom' 'ghr' number (default 50)
3707 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003708 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 The number of pixels subtracted from the screen height when fitting
3710 the GUI window on the screen. Set this before the GUI is started,
3711 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 lines will be left for window decorations and other items on the
3714 screen. Set it to a negative value to allow windows taller than the
3715 screen.
3716
3717 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003718'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3719 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003720 "aegimrLtT" (GTK, Motif and Athena),
3721 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003724 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 sequence of letters which describes what components and options of the
3726 GUI should be used.
3727 To avoid problems with flags that are added in the future, use the
3728 "+=" and "-=" feature of ":set" |add-option-flags|.
3729
Bram Moolenaar13568252018-03-16 20:46:58 +01003730 Valid characters are as follows:
3731 *'go-!'*
3732 '!' External commands are executed in a terminal window. Without
3733 this flag the MS-Windows GUI will open a console window to
3734 execute the command. The Unix GUI will simulate a dumb
3735 terminal to list the command output.
3736 The terminal window will be positioned at the bottom, and grow
3737 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003738 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 'a' Autoselect: If present, then whenever VISUAL mode is started,
3740 or the Visual area extended, Vim tries to become the owner of
3741 the windowing system's global selection. This means that the
3742 Visually highlighted text is available for pasting into other
3743 applications as well as into Vim itself. When the Visual mode
3744 ends, possibly due to an operation on the text, or when an
3745 application wants to paste the selection, the highlighted text
3746 is automatically yanked into the "* selection register.
3747 Thus the selection is still available for pasting into other
3748 applications after the VISUAL mode has ended.
3749 If not present, then Vim won't become the owner of the
3750 windowing system's global selection unless explicitly told to
3751 by a yank or delete operation for the "* register.
3752 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003753 *'go-P'*
3754 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003755 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003756 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003757 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 applies to the modeless selection.
3759
3760 'guioptions' autoselect Visual autoselect modeless ~
3761 "" - -
3762 "a" yes yes
3763 "A" - yes
3764 "aA" yes yes
3765
Bram Moolenaar02467872007-05-06 13:22:01 +00003766 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 'c' Use console dialogs instead of popup dialogs for simple
3768 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003769 *'go-d'*
3770 'd' Use dark theme variant if available. Currently only works for
3771 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003773 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003774 'guitablabel' can be used to change the text in the labels.
3775 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003776 The GUI tabs are only supported on some systems, currently
Bram Moolenaarb3f74062020-02-26 16:16:53 +01003777 GTK, Motif, Mac OS/X, Haiku, and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 'f' Foreground: Don't use fork() to detach the GUI from the shell
3780 where it was started. Use this for programs that wait for the
3781 editor to finish (e.g., an e-mail program). Alternatively you
3782 can use "gvim -f" or ":gui -f" to start the GUI in the
3783 foreground. |gui-fork|
3784 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003785 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003786 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3788 corner of the window. It's black&white on non-GTK, because of
3789 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003790 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003792 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003793 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003795 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003797 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003798 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'g' Grey menu items: Make menu items that are not active grey. If
3800 'g' is not included inactive menu items are not shown at all.
3801 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003802 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 't' Include tearoff menu items. Currently only works for Win32,
3804 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003805 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003806 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003807 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003808 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003810 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 'R' Right-hand scrollbar is present when there is a vertically
3812 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003815 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 'L' Left-hand scrollbar is present when there is a vertically
3817 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003818 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3820 the longest visible line, or on the cursor line if the 'h'
3821 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003822 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'h' Limit horizontal scrollbar size to the length of the cursor
3824 line. Reduces computations. |gui-horiz-scroll|
3825
3826 And yes, you may even have scrollbars on the left AND the right if
3827 you really want to :-). See |gui-scrollbars| for more information.
3828
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003829 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 'v' Use a vertical button layout for dialogs. When not included,
3831 a horizontal layout is preferred, but when it doesn't fit a
3832 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003833 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 'p' Use Pointer callbacks for X11 GUI. This is required for some
3835 window managers. If the cursor is not blinking or hollow at
3836 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003837 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003839 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003840 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003841 *'go-k'*
3842 'k' Keep the GUI window size when adding/removing a scrollbar, or
3843 toolbar, tabline, etc. Instead, the behavior is similar to
3844 when the window is maximized and will adjust 'lines' and
3845 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003846 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003847 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003848
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 *'guipty'* *'noguipty'*
3850'guipty' boolean (default on)
3851 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 {only available when compiled with GUI enabled}
3853 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3854 I/O to/from shell commands. See |gui-pty|.
3855
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003856 *'guitablabel'* *'gtl'*
3857'guitablabel' 'gtl' string (default empty)
3858 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003859 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003860 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003861 pages line. When empty and when the result is empty Vim will use a
3862 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003863
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003864 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003865 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003866 The expression will be evaluated in the |sandbox| when set from a
3867 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003868 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003869
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003870 Only used when the GUI tab pages line is displayed. 'e' must be
3871 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3872 used.
3873
Bram Moolenaar57657d82006-04-21 22:12:41 +00003874 *'guitabtooltip'* *'gtt'*
3875'guitabtooltip' 'gtt' string (default empty)
3876 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003877 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003878 When nonempty describes the text to use in a tooltip for the GUI tab
3879 pages line. When empty Vim will use a default tooltip.
3880 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003881 You can include a line break. Simplest method is to use |:let|: >
3882 :let &guitabtooltip = "line one\nline two"
3883<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 *'helpfile'* *'hf'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01003886'helpfile' 'hf' string (default (MS-Windows) "$VIMRUNTIME\doc\help.txt"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 (others) "$VIMRUNTIME/doc/help.txt")
3888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 Name of the main help file. All distributed help files should be
3890 placed together in one directory. Additionally, all "doc" directories
3891 in 'runtimepath' will be used.
3892 Environment variables are expanded |:set_env|. For example:
3893 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003894 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 spaces and backslashes.
3896 This option cannot be set from a |modeline| or in the |sandbox|, for
3897 security reasons.
3898
3899 *'helpheight'* *'hh'*
3900'helpheight' 'hh' number (default 20)
3901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 Minimal initial height of the help window when it is opened with the
3903 ":help" command. The initial height of the help window is half of the
3904 current window, or (when the 'ea' option is on) the same as other
3905 windows. When the height is less than 'helpheight', the height is
3906 set to 'helpheight'. Set to zero to disable.
3907
3908 *'helplang'* *'hlg'*
3909'helplang' 'hlg' string (default: messages language or empty)
3910 global
3911 {only available when compiled with the |+multi_lang|
3912 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 Comma separated list of languages. Vim will use the first language
3914 for which the desired help can be found. The English help will always
3915 be used as a last resort. You can add "en" to prefer English over
3916 another language, but that will only find tags that exist in that
3917 language and not in the English help.
3918 Example: >
3919 :set helplang=de,it
3920< This will first search German, then Italian and finally English help
3921 files.
3922 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3923 try to find the tag in the current language before using this option.
3924 See |help-translated|.
3925
3926 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3927'hidden' 'hid' boolean (default off)
3928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 When off a buffer is unloaded when it is |abandon|ed. When on a
3930 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3931 displayed in another window, it does not become hidden, of course.
3932 The commands that move through the buffer list sometimes make a buffer
3933 hidden although the 'hidden' option is off: When the buffer is
3934 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003936 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 This option is set for one command with ":hide {command}" |:hide|.
3938 WARNING: It's easy to forget that you have changes in hidden buffers.
3939 Think twice when using ":q!" or ":qa!".
3940
3941 *'highlight'* *'hl'*
3942'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003943 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3944 d:Directory,e:ErrorMsg,i:IncSearch,
3945 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003946 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003947 N:CursorLineNr,r:Question,s:StatusLine,
3948 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003949 v:Visual,V:VisualNOS,w:WarningMsg,
3950 W:WildMenu,f:Folded,F:FoldColumn,
3951 A:DiffAdd,C:DiffChange,D:DiffDelete,
3952 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003953 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003954 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003955 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3956 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003957 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003958 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 This option can be used to set highlighting mode for various
3961 occasions. It is a comma separated list of character pairs. The
3962 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003965 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3966 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 characters from 'showbreak'
3968 |hl-Directory| d directories in CTRL-D listing and other special
3969 things in listings
3970 |hl-ErrorMsg| e error messages
3971 h (obsolete, ignored)
3972 |hl-IncSearch| i 'incsearch' highlighting
3973 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3974 |hl-MoreMsg| m |more-prompt|
3975 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003976 |hl-LineNr| n line number for ":number" and ":#" commands, and
3977 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003978 |hl-LineNrAbove| a line number above the cursor for when the
3979 'relativenumber' option is set.
3980 |hl-LineNrBelow| b line number below the cursor for when the
3981 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003982 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3983 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 |hl-Question| r |hit-enter| prompt and yes/no questions
3985 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003986 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3988 |hl-VertSplit| c column used to separate vertically split windows
3989 |hl-Visual| v Visual mode
3990 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3991 Selection" Only X11 Gui's |gui-x11| and
3992 |xterm-clipboard|.
3993 |hl-WarningMsg| w warning messages
3994 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3995 |hl-Folded| f line used for closed folds
3996 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003997 |hl-DiffAdd| A added line in diff mode
3998 |hl-DiffChange| C changed line in diff mode
3999 |hl-DiffDelete| D deleted line in diff mode
4000 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004002 |hl-Conceal| - the placeholders used for concealed characters
4003 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00004004 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004005 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004006 |hl-SpellRare| R rare word |spell|
4007 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01004008 |hl-Pmenu| + popup menu normal line
4009 |hl-PmenuSel| = popup menu selected line
4010 |hl-PmenuSbar| x popup menu scrollbar
4011 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012
4013 The display modes are:
4014 r reverse (termcap entry "mr" and "me")
4015 i italic (termcap entry "ZH" and "ZR")
4016 b bold (termcap entry "md" and "me")
4017 s standout (termcap entry "so" and "se")
4018 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004019 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004020 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 n no highlighting
4022 - no highlighting
4023 : use a highlight group
4024 The default is used for occasions that are not included.
4025 If you want to change what the display modes do, see |dos-colors|
4026 for an example.
4027 When using the ':' display mode, this must be followed by the name of
4028 a highlight group. A highlight group can be used to define any type
4029 of highlighting, including using color. See |:highlight| on how to
4030 define one. The default uses a different group for each occasion.
4031 See |highlight-default| for the default highlight groups.
4032
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004034'history' 'hi' number (Vim default: 50, Vi default: 0,
4035 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004038 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004040 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 NOTE: This option is set to the Vi default value when 'compatible' is
4042 set and to the Vim default value when 'compatible' is reset.
4043
4044 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4045'hkmap' 'hk' boolean (default off)
4046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 {only available when compiled with the |+rightleft|
4048 feature}
4049 When on, the keyboard is mapped for the Hebrew character set.
4050 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4051 toggle this option. See |rileft.txt|.
4052 NOTE: This option is reset when 'compatible' is set.
4053
4054 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4055'hkmapp' 'hkp' boolean (default off)
4056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 {only available when compiled with the |+rightleft|
4058 feature}
4059 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4060 This is useful if you have a non-Hebrew keyboard.
4061 See |rileft.txt|.
4062 NOTE: This option is reset when 'compatible' is set.
4063
Bram Moolenaar036986f2017-03-16 17:41:02 +01004064 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4065'hlsearch' 'hls' boolean (default off)
4066 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004067 {not available when compiled without the
4068 |+extra_search| feature}
4069 When there is a previous search pattern, highlight all its matches.
4070 The type of highlighting used can be set with the 'l' occasion in the
4071 'highlight' option. This uses the "Search" highlight group by
4072 default. Note that only the matching text is highlighted, any offsets
4073 are not applied.
4074 See also: 'incsearch' and |:match|.
4075 When you get bored looking at the highlighted matches, you can turn it
4076 off with |:nohlsearch|. This does not change the option value, as
4077 soon as you use a search command, the highlighting comes back.
4078 'redrawtime' specifies the maximum time spent on finding matches.
4079 When the search pattern can match an end-of-line, Vim will try to
4080 highlight all of the matched text. However, this depends on where the
4081 search starts. This will be the first line in the window or the first
4082 line below a closed fold. A match in a previous line which is not
4083 drawn may not continue in a newly drawn line.
4084 You can specify whether the highlight status is restored on startup
4085 with the 'h' flag in 'viminfo' |viminfo-h|.
4086 NOTE: This option is reset when 'compatible' is set.
4087
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 *'icon'* *'noicon'*
4089'icon' boolean (default off, on when title can be restored)
4090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 {not available when compiled without the |+title|
4092 feature}
4093 When on, the icon text of the window will be set to the value of
4094 'iconstring' (if it is not empty), or to the name of the file
4095 currently being edited. Only the last part of the name is used.
4096 Overridden by the 'iconstring' option.
4097 Only works if the terminal supports setting window icons (currently
4098 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4099 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4100 builtin termcap).
4101 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004102 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004104 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105
4106 *'iconstring'*
4107'iconstring' string (default "")
4108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 {not available when compiled without the |+title|
4110 feature}
4111 When this option is not empty, it will be used for the icon text of
4112 the window. This happens only when the 'icon' option is on.
4113 Only works if the terminal supports setting window icon text
4114 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4115 Does not work for MS Windows.
4116 When Vim was compiled with HAVE_X11 defined, the original icon will be
4117 restored if possible |X11|.
4118 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004119 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004121 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 {not available when compiled without the |+statusline| feature}
4123
4124 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4125'ignorecase' 'ic' boolean (default off)
4126 global
4127 Ignore case in search patterns. Also used when searching in the tags
4128 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004129 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 Can be overruled by using "\c" or "\C" in the pattern, see
4131 |/ignorecase|.
4132
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004133 *'imactivatefunc'* *'imaf'*
4134'imactivatefunc' 'imaf' string (default "")
4135 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004136 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004137 activate or deactivate the Input Method.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004138 It is not used in the MS-Windows GUI version.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004139 The expression will be evaluated in the |sandbox| when set from a
4140 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004141
4142 Example: >
4143 function ImActivateFunc(active)
4144 if a:active
4145 ... do something
4146 else
4147 ... do something
4148 endif
4149 " return value is not used
4150 endfunction
4151 set imactivatefunc=ImActivateFunc
4152<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 *'imactivatekey'* *'imak'*
4154'imactivatekey' 'imak' string (default "")
4155 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004157 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 Specifies the key that your Input Method in X-Windows uses for
4159 activation. When this is specified correctly, vim can fully control
4160 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4161 You can't use this option to change the activation key, the option
4162 tells Vim what the key is.
4163 Format:
4164 [MODIFIER_FLAG-]KEY_STRING
4165
4166 These characters can be used for MODIFIER_FLAG (case is ignored):
4167 S Shift key
4168 L Lock key
4169 C Control key
4170 1 Mod1 key
4171 2 Mod2 key
4172 3 Mod3 key
4173 4 Mod4 key
4174 5 Mod5 key
4175 Combinations are allowed, for example "S-C-space" or "SC-space" are
4176 both shift+ctrl+space.
4177 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4178
4179 Example: >
4180 :set imactivatekey=S-space
4181< "S-space" means shift+space. This is the activation key for kinput2 +
4182 canna (Japanese), and ami (Korean).
4183
4184 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4185'imcmdline' 'imc' boolean (default off)
4186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 When set the Input Method is always on when starting to edit a command
4188 line, unless entering a search pattern (see 'imsearch' for that).
4189 Setting this option is useful when your input method allows entering
4190 English characters directly, e.g., when it's used to type accented
4191 characters with dead keys.
4192
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004193 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 When set the Input Method is never used. This is useful to disable
4197 the IM when it doesn't work properly.
4198 Currently this option is on by default for SGI/IRIX machines. This
4199 may change in later releases.
4200
4201 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004202'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 Specifies whether :lmap or an Input Method (IM) is to be used in
4205 Insert mode. Valid values:
4206 0 :lmap is off and IM is off
4207 1 :lmap is ON and IM is off
4208 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 To always reset the option to zero when leaving Insert mode with <Esc>
4210 this can be used: >
4211 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4212< This makes :lmap and IM turn off automatically when leaving Insert
4213 mode.
4214 Note that this option changes when using CTRL-^ in Insert mode
4215 |i_CTRL-^|.
4216 The value is set to 1 when setting 'keymap' to a valid keymap name.
4217 It is also used for the argument of commands like "r" and "f".
4218 The value 0 may not work correctly with Athena and Motif with some XIM
4219 methods. Use 'imdisable' to disable XIM then.
4220
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004221 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004222 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004223 |+multi_byte_ime| or |global-ime|.
4224
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004226'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228 Specifies whether :lmap or an Input Method (IM) is to be used when
4229 entering a search pattern. Valid values:
4230 -1 the value of 'iminsert' is used, makes it look like
4231 'iminsert' is also used when typing a search pattern
4232 0 :lmap is off and IM is off
4233 1 :lmap is ON and IM is off
4234 2 :lmap is off and IM is ON
4235 Note that this option changes when using CTRL-^ in Command-line mode
4236 |c_CTRL-^|.
4237 The value is set to 1 when it is not -1 and setting the 'keymap'
4238 option to a valid keymap name.
4239 The value 0 may not work correctly with Athena and Motif with some XIM
4240 methods. Use 'imdisable' to disable XIM then.
4241
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004242 *'imstatusfunc'* *'imsf'*
4243'imstatusfunc' 'imsf' string (default "")
4244 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004245 This option specifies a function that is called to obtain the status
4246 of Input Method. It must return a positive number when IME is active.
Bram Moolenaaref8c6172020-07-01 15:12:44 +02004247 It is not used in the MS-Windows GUI version.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004248
4249 Example: >
4250 function ImStatusFunc()
4251 let is_active = ...do something
4252 return is_active ? 1 : 0
4253 endfunction
4254 set imstatusfunc=ImStatusFunc
4255<
4256 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004257 The expression will be evaluated in the |sandbox| when set from a
4258 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004259
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004260 *'imstyle'* *'imst'*
4261'imstyle' 'imst' number (default 1)
4262 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004263 {only available when compiled with |+xim| and
4264 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004265 This option specifies the input style of Input Method:
4266 0 use on-the-spot style
4267 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004268 See: |xim-input-style|
4269
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004270 For a long time on-the-spot style had been used in the GTK version of
4271 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004272 |single-repeat|, etc. Therefore over-the-spot style becomes the
4273 default now. This should work fine for most people, however if you
4274 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004275 The expression will be evaluated in the |sandbox| when set from a
4276 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004277
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 *'include'* *'inc'*
4279'include' 'inc' string (default "^\s*#\s*include")
4280 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 {not available when compiled without the
4282 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004283 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 pattern, just like for the "/" command (See |pattern|). The default
4285 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004286 "]I", "[d", etc.
4287 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004288 comes after the matched pattern. But if "\zs" appears in the pattern
4289 then the text matched from "\zs" to the end, or until "\ze" if it
4290 appears, is used as the file name. Use this to include characters
4291 that are not in 'isfname', such as a space. You can then use
4292 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004293 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294
4295 *'includeexpr'* *'inex'*
4296'includeexpr' 'inex' string (default "")
4297 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004299 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004301 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 :set includeexpr=substitute(v:fname,'\\.','/','g')
4303< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004304
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004306 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 Also used for |<cfile>|.
4308
Bram Moolenaar30b65812012-07-12 22:01:11 +02004309 The expression will be evaluated in the |sandbox| when set from a
4310 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004311 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004312
4313 It is not allowed to change text or jump to another window while
4314 evaluating 'includeexpr' |textlock|.
4315
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004317'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4318 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004321 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004322 While typing a search command, show where the pattern, as it was typed
4323 so far, matches. The matched string is highlighted. If the pattern
4324 is invalid or not found, nothing is shown. The screen will be updated
4325 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004326 Also applies to the pattern in commands: >
4327 :global
4328 :lvimgrep
4329 :lvimgrepadd
4330 :smagic
4331 :snomagic
4332 :sort
4333 :substitute
4334 :vglobal
4335 :vimgrep
4336 :vimgrepadd
4337< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004338 original position when no match is found and when pressing <Esc>. You
4339 still need to finish the search command with <Enter> to move the
4340 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004341 You can use the CTRL-G and CTRL-T keys to move to the next and
4342 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004343 When compiled with the |+reltime| feature Vim only searches for about
4344 half a second. With a complicated pattern and/or a lot of text the
4345 match may not be found. This is to avoid that Vim hangs while you
4346 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004347 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004348 When 'hlsearch' is on, all matched strings are highlighted too while
4349 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004350 If you don't want to turn 'hlsearch' on, but want to highlight all
4351 matches while searching, you can turn on and off 'hlsearch' with
4352 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004353 augroup vimrc-incsearch-highlight
4354 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004355 autocmd CmdlineEnter /,\? :set hlsearch
4356 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004357 augroup END
4358<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004359 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004360 to the command line. If 'ignorecase' and 'smartcase' are set and the
4361 command line has no uppercase characters, the added character is
4362 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004363 CTRL-R CTRL-W can be used to add the word at the end of the current
4364 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 NOTE: This option is reset when 'compatible' is set.
4366
4367 *'indentexpr'* *'inde'*
4368'indentexpr' 'inde' string (default "")
4369 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 {not available when compiled without the |+cindent|
4371 or |+eval| features}
4372 Expression which is evaluated to obtain the proper indent for a line.
4373 It is used when a new line is created, for the |=| operator and
4374 in Insert mode as specified with the 'indentkeys' option.
4375 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004376 'smartindent' indenting. When 'lisp' is set, this option is
4377 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 When 'paste' is set this option is not used for indenting.
4379 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004380 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 when the expression is evaluated (but it may be moved around).
4382 The expression must return the number of spaces worth of indent. It
4383 can return "-1" to keep the current indent (this means 'autoindent' is
4384 used for the indent).
4385 Functions useful for computing the indent are |indent()|, |cindent()|
4386 and |lispindent()|.
4387 The evaluation of the expression must not have side effects! It must
4388 not change the text, jump to another window, etc. Afterwards the
4389 cursor position is always restored, thus the cursor may be moved.
4390 Normally this option would be set to call a function: >
4391 :set indentexpr=GetMyIndent()
4392< Error messages will be suppressed, unless the 'debug' option contains
4393 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004394 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004395 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396
Bram Moolenaar30b65812012-07-12 22:01:11 +02004397 The expression will be evaluated in the |sandbox| when set from a
4398 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004399 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004400
4401 It is not allowed to change text or jump to another window while
4402 evaluating 'indentexpr' |textlock|.
4403
4404
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004406'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 {not available when compiled without the |+cindent|
4409 feature}
4410 A list of keys that, when typed in Insert mode, cause reindenting of
4411 the current line. Only happens if 'indentexpr' isn't empty.
4412 The format is identical to 'cinkeys', see |indentkeys-format|.
4413 See |C-indenting| and |indent-expression|.
4414
4415 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4416'infercase' 'inf' boolean (default off)
4417 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004419 'ignorecase' is also on, the case of the match is adjusted depending
4420 on the typed text. If the typed text contains a lowercase letter
4421 where the match has an upper case letter, the completed part is made
4422 lowercase. If the typed text has no lowercase letters and the match
4423 has a lowercase letter where the typed text has an uppercase letter,
4424 and there is a letter before it, the completed part is made uppercase.
4425 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426
4427 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4428'insertmode' 'im' boolean (default off)
4429 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 Makes Vim work in a way that Insert mode is the default mode. Useful
4431 if you want to use Vim as a modeless editor. Used for |evim|.
4432 These Insert mode commands will be useful:
4433 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004434 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 this is a mapping, it is executed as if 'insertmode' was off.
4436 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004438 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4439 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
4441 These items change when 'insertmode' is set:
4442 - when starting to edit of a file, Vim goes to Insert mode.
4443 - <Esc> in Insert mode is a no-op and beeps.
4444 - <Esc> in Normal mode makes Vim go to Insert mode.
4445 - CTRL-L in Insert mode is a command, it is not inserted.
4446 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4447 However, when <Esc> is used inside a mapping, it behaves like
4448 'insertmode' was not set. This was done to be able to use the same
4449 mappings with 'insertmode' set or not set.
4450 When executing commands with |:normal| 'insertmode' is not used.
4451
4452 NOTE: This option is reset when 'compatible' is set.
4453
4454 *'isfname'* *'isf'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004455'isfname' 'isf' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4457 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4458 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4459 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4460 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4461 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 The characters specified by this option are included in file names and
4463 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004464 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 Multi-byte characters 256 and above are always included, only the
4466 characters up to 255 are specified with this option.
4467 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004468 Think twice before adding white space to this option. Although a
4469 space may appear inside a file name, the effect will be that Vim
4470 doesn't know where a file name starts or ends when doing completion.
4471 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472
4473 Note that on systems using a backslash as path separator, Vim tries to
4474 do its best to make it work as you would expect. That is a bit
4475 tricky, since Vi originally used the backslash to escape special
4476 characters. Vim will not remove a backslash in front of a normal file
4477 name character on these systems, but it will on Unix and alikes. The
4478 '&' and '^' are not included by default, because these are special for
4479 cmd.exe.
4480
4481 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004482 Each part can be a single character number or a range. A range is two
4483 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 decimal number between 0 and 255 or the ASCII character itself (does
4485 not work for digits). Example:
4486 "_,-,128-140,#-43" (include '_' and '-' and the range
4487 128 to 140 and '#' to 43)
4488 If a part starts with '^', the following character number or range
4489 will be excluded from the option. The option is interpreted from left
4490 to right. Put the excluded character after the range where it is
4491 included. To include '^' itself use it as the last character of the
4492 option or the end of a range. Example:
4493 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4494 If the character is '@', all characters where isalpha() returns TRUE
4495 are included. Normally these are the characters a to z and A to Z,
4496 plus accented characters. To include '@' itself use "@-@". Examples:
4497 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004498 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 "a-z,A-Z,@-@" All letters plus the '@' character.
4500 A comma can be included by using it where a character number is
4501 expected. Example:
4502 "48-57,,,_" Digits, comma and underscore.
4503 A comma can be excluded by prepending a '^'. Example:
4504 " -~,^,,9" All characters from space to '~', excluding
4505 comma, plus <Tab>.
4506 See |option-backslash| about including spaces and backslashes.
4507
4508 *'isident'* *'isi'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004509'isident' 'isi' string (default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 "@,48-57,_,128-167,224-235"
4511 otherwise: "@,48-57,_,192-255")
4512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 The characters given by this option are included in identifiers.
4514 Identifiers are used in recognizing environment variables and after a
4515 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004516 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004517 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4521
4522 *'iskeyword'* *'isk'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004523'iskeyword' 'isk' string (Vim default for Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 "@,48-57,_,128-167,224-235"
4525 otherwise: "@,48-57,_,192-255"
4526 Vi default: "@,48-57,_")
4527 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004529 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004530 'isfname' for a description of the format of this option. For '@'
4531 characters above 255 check the "word" character class.
4532 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 For a help file it is set to all non-blank printable characters except
4534 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4535 command).
4536 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004537 This option also influences syntax highlighting, unless the syntax
4538 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 NOTE: This option is set to the Vi default value when 'compatible' is
4540 set and to the Vim default value when 'compatible' is reset.
4541
4542 *'isprint'* *'isp'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01004543'isprint' 'isp' string (default for Win32 and Macintosh:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 "@,~-255"; otherwise: "@,161-255")
4545 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 The characters given by this option are displayed directly on the
4547 screen. It is also used for "\p" in a |pattern|. The characters from
4548 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4549 even when they are not included in 'isprint' or excluded. See
4550 'isfname' for a description of the format of this option.
4551
4552 Non-printable characters are displayed with two characters:
4553 0 - 31 "^@" - "^_"
4554 32 - 126 always single characters
4555 127 "^?"
4556 128 - 159 "~@" - "~_"
4557 160 - 254 "| " - "|~"
4558 255 "~?"
4559 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4560 displayed as <xx>, with the hexadecimal value of the byte.
4561 When 'display' contains "uhex" all unprintable characters are
4562 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004563 The SpecialKey highlighting will be used for unprintable characters.
4564 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565
4566 Multi-byte characters 256 and above are always included, only the
4567 characters up to 255 are specified with this option. When a character
4568 is printable but it is not available in the current font, a
4569 replacement character will be shown.
4570 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4571 There is no option to specify these characters.
4572
4573 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4574'joinspaces' 'js' boolean (default on)
4575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 Insert two spaces after a '.', '?' and '!' with a join command.
4577 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4578 Otherwise only one space is inserted.
4579 NOTE: This option is set when 'compatible' is set.
4580
4581 *'key'*
4582'key' string (default "")
4583 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004584 {only available when compiled with the |+cryptv|
4585 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004587 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 Careful: Do not set the key value by hand, someone might see the typed
4589 key. Use the |:X| command. But you can make 'key' empty: >
4590 :set key=
4591< It is not possible to get the value of this option with ":set key" or
4592 "echo &key". This is to avoid showing it to someone who shouldn't
4593 know. It also means you cannot see it yourself once you have set it,
4594 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004595 You can use "&key" in an expression to detect whether encryption is
4596 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
4598 *'keymap'* *'kmp'* *E544*
4599'keymap' 'kmp' string (default "")
4600 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 {only available when compiled with the |+keymap|
4602 feature}
4603 Name of a keyboard mapping. See |mbyte-keymap|.
4604 Setting this option to a valid keymap name has the side effect of
4605 setting 'iminsert' to one, so that the keymap becomes effective.
4606 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004607 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608
4609 *'keymodel'* *'km'*
4610'keymodel' 'km' string (default "")
4611 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 List of comma separated words, which enable special things that keys
4613 can do. These values can be used:
4614 startsel Using a shifted special key starts selection (either
4615 Select mode or Visual mode, depending on "key" being
4616 present in 'selectmode').
4617 stopsel Using a not-shifted special key stops selection.
4618 Special keys in this context are the cursor keys, <End>, <Home>,
4619 <PageUp> and <PageDown>.
4620 The 'keymodel' option is set by the |:behave| command.
4621
4622 *'keywordprg'* *'kp'*
4623'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004624 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 Program to use for the |K| command. Environment variables are
4627 expanded |:set_env|. ":help" may be used to access the Vim internal
4628 help. (Note that previously setting the global option to the empty
4629 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004630 When the first character is ":", the command is invoked as a Vim
4631 Ex command prefixed with [count].
4632 When "man", "man -s" or an Ex command is used, Vim will automatically
4633 translate a count for the "K" command and pass it as the first
4634 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 See |option-backslash| about including spaces and backslashes.
4636 Example: >
4637 :set keywordprg=man\ -s
4638< This option cannot be set from a |modeline| or in the |sandbox|, for
4639 security reasons.
4640
4641 *'langmap'* *'lmap'* *E357* *E358*
4642'langmap' 'lmap' string (default "")
4643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 {only available when compiled with the |+langmap|
4645 feature}
4646 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004647 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004648 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 care of translating these special characters to the original meaning
4650 of the key. This means you don't have to change the keyboard mode to
4651 be able to execute Normal mode commands.
4652 This is the opposite of the 'keymap' option, where characters are
4653 mapped in Insert mode.
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004654 Also consider setting 'langremap' to off, to prevent 'langmap' from
4655 applying to characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004656 This option cannot be set from a |modeline| or in the |sandbox|, for
4657 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004659 Example (for Greek, in UTF-8): *greek* >
4660 :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 +00004661< Example (exchanges meaning of z and y for commands): >
4662 :set langmap=zy,yz,ZY,YZ
4663<
4664 The 'langmap' option is a list of parts, separated with commas. Each
4665 part can be in one of two forms:
4666 1. A list of pairs. Each pair is a "from" character immediately
4667 followed by the "to" character. Examples: "aA", "aAbBcC".
4668 2. A list of "from" characters, a semi-colon and a list of "to"
4669 characters. Example: "abc;ABC"
4670 Example: "aA,fgh;FGH,cCdDeE"
4671 Special characters need to be preceded with a backslash. These are
4672 ";", ',' and backslash itself.
4673
4674 This will allow you to activate vim actions without having to switch
4675 back and forth between the languages. Your language characters will
4676 be understood as normal vim English characters (according to the
4677 langmap mappings) in the following cases:
4678 o Normal/Visual mode (commands, buffer/register names, user mappings)
4679 o Insert/Replace Mode: Register names after CTRL-R
4680 o Insert/Replace Mode: Mappings
4681 Characters entered in Command-line mode will NOT be affected by
4682 this option. Note that this option can be changed at any time
4683 allowing to switch between mappings for different languages/encodings.
4684 Use a mapping to avoid having to type it each time!
4685
4686 *'langmenu'* *'lm'*
4687'langmenu' 'lm' string (default "")
4688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 {only available when compiled with the |+menu| and
4690 |+multi_lang| features}
4691 Language to use for menu translation. Tells which file is loaded
4692 from the "lang" directory in 'runtimepath': >
4693 "lang/menu_" . &langmenu . ".vim"
4694< (without the spaces). For example, to always use the Dutch menus, no
4695 matter what $LANG is set to: >
4696 :set langmenu=nl_NL.ISO_8859-1
4697< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004698 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 If your $LANG is set to a non-English language but you do want to use
4700 the English menus: >
4701 :set langmenu=none
4702< This option must be set before loading menus, switching on filetype
4703 detection or syntax highlighting. Once the menus are defined setting
4704 this option has no effect. But you could do this: >
4705 :source $VIMRUNTIME/delmenu.vim
4706 :set langmenu=de_DE.ISO_8859-1
4707 :source $VIMRUNTIME/menu.vim
4708< Warning: This deletes all menus that you defined yourself!
4709
Bram Moolenaard94464e2015-11-02 15:28:18 +01004710 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004711'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004712 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004713 {only available when compiled with the |+langmap|
4714 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004715 This is just like 'langremap' but with the value inverted. It only
4716 exists for backwards compatibility. When setting 'langremap' then
4717 'langnoremap' is set to the inverted value, and the other way around.
4718
4719 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
Bram Moolenaarb17893a2020-03-14 08:19:51 +01004720'langremap' 'lrm' boolean (default on, set to off in |defaults.vim|)
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004721 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004722 {only available when compiled with the |+langmap|
4723 feature}
4724 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004725 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004726 'langmap' disables some of your mappings, try resetting this option.
4727 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004728 that works for you to avoid mappings to break.
4729
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 *'laststatus'* *'ls'*
4731'laststatus' 'ls' number (default 1)
4732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 The value of this option influences when the last window will have a
4734 status line:
4735 0: never
4736 1: only if there are at least two windows
4737 2: always
4738 The screen looks nicer with a status line if you have several
4739 windows, but it takes another screen line. |status-line|
4740
4741 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4742'lazyredraw' 'lz' boolean (default off)
4743 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 When this option is set, the screen will not be redrawn while
4745 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004746 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 update use |:redraw|.
4748
4749 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4750'linebreak' 'lbr' boolean (default off)
4751 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004752 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004754 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 than at the last character that fits on the screen. Unlike
4756 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004757 it only affects the way the file is displayed, not its contents.
4758 If 'breakindent' is set, line is visually indented. Then, the value
4759 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004760 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 Note that <Tab> characters after an <EOL> are mostly not displayed
4762 with the right amount of white space.
4763
4764 *'lines'* *E593*
4765'lines' number (default 24 or terminal height)
4766 global
4767 Number of lines of the Vim window.
4768 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004769 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 When Vim is running in the GUI or in a resizable window, setting this
4771 option will cause the window size to be changed. When you only want
4772 to use the size for the GUI, put the command in your |gvimrc| file.
4773 Vim limits the number of lines to what fits on the screen. You can
4774 use this command to get the tallest window possible: >
4775 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004776< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004777 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 When you set this option and Vim is unable to change the physical
4779 number of lines of the display, the display may be messed up.
4780
4781 *'linespace'* *'lsp'*
4782'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 {only in the GUI}
4785 Number of pixel lines inserted between characters. Useful if the font
4786 uses the full character cell height, making lines touch each other.
4787 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004788 With some fonts there can be too much room between lines (to have
4789 space for ascents and descents). Then it makes sense to set
4790 'linespace' to a negative value. This may cause display problems
4791 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 *'lisp'* *'nolisp'*
4794'lisp' boolean (default off)
4795 local to buffer
4796 {not available when compiled without the |+lispindent|
4797 feature}
4798 Lisp mode: When <Enter> is typed in insert mode set the indent for
4799 the next line to Lisp standards (well, sort of). Also happens with
4800 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4801 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4802 better. Also see 'lispwords'.
4803 The '-' character is included in keyword characters. Redefines the
4804 "=" operator to use this same indentation algorithm rather than
4805 calling an external program if 'equalprg' is empty.
4806 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
4808 *'lispwords'* *'lw'*
4809'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004810 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 {not available when compiled without the |+lispindent|
4812 feature}
4813 Comma separated list of words that influence the Lisp indenting.
4814 |'lisp'|
4815
4816 *'list'* *'nolist'*
4817'list' boolean (default off)
4818 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004819 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4820 line. Useful to see the difference between tabs and spaces and for
4821 trailing blanks. Further changed by the 'listchars' option.
4822
4823 The cursor is displayed at the start of the space a Tab character
4824 occupies, not at the end as usual in Normal mode. To get this cursor
4825 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004826 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004827<
4828 Note that list mode will also affect formatting (set with 'textwidth'
4829 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 changing the way tabs are displayed.
4831
4832 *'listchars'* *'lcs'*
4833'listchars' 'lcs' string (default "eol:$")
4834 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004835 Strings to use in 'list' mode and for the |:list| command. It is a
4836 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004837 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 eol:c Character to show at the end of each line. When
4839 omitted, there is no extra character at the end of the
4840 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004841 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004842 tab:xy[z] Two or three characters to be used to show a tab.
4843 The third character is optional.
4844
4845 tab:xy The 'x' is always used, then 'y' as many times as will
4846 fit. Thus "tab:>-" displays:
4847 >
4848 >-
4849 >--
4850 etc.
4851
4852 tab:xyz The 'z' is always used, then 'x' is prepended, and
4853 then 'y' is used as many times as will fit. Thus
4854 "tab:<->" displays:
4855 >
4856 <>
4857 <->
4858 <-->
4859 etc.
4860
4861 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004862 *lcs-space*
4863 space:c Character to show for a space. When omitted, spaces
4864 are left blank.
4865 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004867 trailing spaces are blank. Overrides the "space"
4868 setting for trailing spaces.
4869 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 extends:c Character to show in the last column, when 'wrap' is
4871 off and the line continues beyond the right of the
4872 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004873 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004874 precedes:c Character to show in the first visible column of the
4875 physical line, when there is text preceding the
4876 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004877 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004878 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004879 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004880 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004881 nbsp:c Character to show for a non-breakable space character
4882 (0xA0 (160 decimal) and U+202F). Left blank when
4883 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004885 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004887 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888
4889 Examples: >
4890 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004891 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 :set lcs=extends:>,precedes:<
4893< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004894 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004895 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896
4897 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4898'loadplugins' 'lpl' boolean (default on)
4899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 When on the plugin scripts are loaded when starting up |load-plugins|.
4901 This option can be reset in your |vimrc| file to disable the loading
4902 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004903 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4904 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905
Bram Moolenaard94464e2015-11-02 15:28:18 +01004906 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004907'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004908 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004909 {only available when compiled with the |+lua/dyn|
4910 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004911 Specifies the name of the Lua shared library. The default is
4912 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004913 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004914 This option cannot be set from a |modeline| or in the |sandbox|, for
4915 security reasons.
4916
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004917 *'macatsui'* *'nomacatsui'*
4918'macatsui' boolean (default on)
4919 global
4920 {only available in Mac GUI version}
4921 This is a workaround for when drawing doesn't work properly. When set
4922 and compiled with multi-byte support ATSUI text drawing is used. When
4923 not set ATSUI text drawing is not used. Switch this option off when
4924 you experience drawing problems. In a future version the problems may
4925 be solved and this option becomes obsolete. Therefore use this method
4926 to unset it: >
4927 if exists('&macatsui')
4928 set nomacatsui
4929 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004930< Another option to check if you have drawing problems is
4931 'termencoding'.
4932
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 *'magic'* *'nomagic'*
4934'magic' boolean (default on)
4935 global
4936 Changes the special characters that can be used in search patterns.
4937 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004938 WARNING: Switching this option off most likely breaks plugins! That
4939 is because many patterns assume it's on and will fail when it's off.
4940 Only switch it off when working with old Vi scripts. In any other
4941 situation write patterns that work when 'magic' is on. Include "\M"
4942 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943
4944 *'makeef'* *'mef'*
4945'makeef' 'mef' string (default: "")
4946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 {not available when compiled without the |+quickfix|
4948 feature}
4949 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4950 and the |:grep| command.
4951 When it is empty, an internally generated temp file will be used.
4952 When "##" is included, it is replaced by a number to make the name
4953 unique. This makes sure that the ":make" command doesn't overwrite an
4954 existing file.
4955 NOT used for the ":cf" command. See 'errorfile' for that.
4956 Environment variables are expanded |:set_env|.
4957 See |option-backslash| about including spaces and backslashes.
4958 This option cannot be set from a |modeline| or in the |sandbox|, for
4959 security reasons.
4960
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004961 *'makeencoding'* *'menc'*
4962'makeencoding' 'menc' string (default "")
4963 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004964 Encoding used for reading the output of external commands. When empty,
4965 encoding is not converted.
4966 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4967 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4968 and `:laddfile`.
4969
4970 This would be mostly useful when you use MS-Windows and set 'encoding'
4971 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4972 'makeencoding' to "char" has the same effect as setting to the system
4973 locale encoding. Example: >
4974 :set encoding=utf-8
4975 :set makeencoding=char " system locale is used
4976<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 *'makeprg'* *'mp'*
4978'makeprg' 'mp' string (default "make", VMS: "MMS")
4979 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004980 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004981 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4982 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004983 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004984 Environment variables are expanded |:set_env|. See |option-backslash|
4985 about including spaces and backslashes.
4986 Note that a '|' must be escaped twice: once for ":set" and once for
4987 the interpretation of a command. When you use a filter called
4988 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 :set makeprg=gmake\ \\\|\ myfilter
4990< The placeholder "$*" can be given (even multiple times) to specify
4991 where the arguments will be included, for example: >
4992 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4993< This option cannot be set from a |modeline| or in the |sandbox|, for
4994 security reasons.
4995
4996 *'matchpairs'* *'mps'*
4997'matchpairs' 'mps' string (default "(:),{:},[:]")
4998 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005000 other.
5001 Only character pairs are allowed that are different, thus you cannot
5002 jump between two double quotes.
5003 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005004 The pairs must be separated by a comma. Example for including '<' and
5005 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 :set mps+=<:>
5007
5008< A more exotic example, to jump between the '=' and ';' in an
5009 assignment, useful for languages like C and Java: >
5010 :au FileType c,cpp,java set mps+==:;
5011
5012< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005013 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014
5015 *'matchtime'* *'mat'*
5016'matchtime' 'mat' number (default 5)
5017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 Tenths of a second to show the matching paren, when 'showmatch' is
5019 set. Note that this is not in milliseconds, like other options that
5020 set a time. This is to be compatible with Nvi.
5021
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005022 *'maxcombine'* *'mco'*
5023'maxcombine' 'mco' number (default 2)
5024 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005025 The maximum number of combining characters supported for displaying.
5026 Only used when 'encoding' is "utf-8".
5027 The default is OK for most languages. Hebrew may require 4.
5028 Maximum value is 6.
5029 Even when this option is set to 2 you can still edit text with more
5030 combining characters, you just can't see them. Use |g8| or |ga|.
5031 See |mbyte-combining|.
5032
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 *'maxfuncdepth'* *'mfd'*
5034'maxfuncdepth' 'mfd' number (default 100)
5035 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005036 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005037 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 Maximum depth of function calls for user functions. This normally
5039 catches endless recursion. When using a recursive function with
5040 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5041 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005042 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005043 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 See also |:function|.
5045
5046 *'maxmapdepth'* *'mmd'* *E223*
5047'maxmapdepth' 'mmd' number (default 1000)
5048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 Maximum number of times a mapping is done without resulting in a
5050 character to be used. This normally catches endless mappings, like
5051 ":map x y" with ":map y x". It still does not catch ":map g wg",
5052 because the 'w' is used before the next mapping is done. See also
5053 |key-mapping|.
5054
5055 *'maxmem'* *'mm'*
5056'maxmem' 'mm' number (default between 256 to 5120 (system
5057 dependent) or half the amount of memory
5058 available)
5059 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5061 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005062 other memory to be freed.
5063 The maximum usable value is about 2000000. Use this to work without a
5064 limit.
5065 The value is ignored when 'swapfile' is off.
5066 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005068 *'maxmempattern'* *'mmp'*
5069'maxmempattern' 'mmp' number (default 1000)
5070 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005071 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005072 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005073 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005074 When Vim runs into the limit it gives an error message and mostly
5075 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005076 Running into the limit often means that the pattern is very
5077 inefficient or too complex. This may already happen with the pattern
5078 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005079 Might also happen on redraw, when syntax rules try to match a complex
5080 text structure.
5081 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5082 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005083
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 *'maxmemtot'* *'mmt'*
5085'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5086 dependent) or half the amount of memory
5087 available)
5088 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005089 Maximum amount of memory in Kbyte to use for all buffers together.
5090 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005091 without a limit.
5092 On 64 bit machines higher values might work. But hey, do you really
5093 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005094 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005095 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005096 Buffers with 'swapfile' off still count to the total amount of memory
5097 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005098 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099
5100 *'menuitems'* *'mis'*
5101'menuitems' 'mis' number (default 25)
5102 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 {not available when compiled without the |+menu|
5104 feature}
5105 Maximum number of items to use in a menu. Used for menus that are
5106 generated from a list of items, e.g., the Buffers menu. Changing this
5107 option has no direct effect, the menu must be refreshed first.
5108
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005109 *'mkspellmem'* *'msm'*
5110'mkspellmem' 'msm' string (default "460000,2000,500")
5111 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005112 {not available when compiled without the |+syntax|
5113 feature}
5114 Parameters for |:mkspell|. This tunes when to start compressing the
5115 word tree. Compression can be slow when there are many words, but
5116 it's needed to avoid running out of memory. The amount of memory used
5117 per word depends very much on how similar the words are, that's why
5118 this tuning is complicated.
5119
5120 There are three numbers, separated by commas:
5121 {start},{inc},{added}
5122
5123 For most languages the uncompressed word tree fits in memory. {start}
5124 gives the amount of memory in Kbyte that can be used before any
5125 compression is done. It should be a bit smaller than the amount of
5126 memory that is available to Vim.
5127
5128 When going over the {start} limit the {inc} number specifies the
5129 amount of memory in Kbyte that can be allocated before another
5130 compression is done. A low number means compression is done after
5131 less words are added, which is slow. A high number means more memory
5132 will be allocated.
5133
5134 After doing compression, {added} times 1024 words can be added before
5135 the {inc} limit is ignored and compression is done when any extra
5136 amount of memory is needed. A low number means there is a smaller
5137 chance of hitting the {inc} limit, less memory is used but it's
5138 slower.
5139
5140 The languages for which these numbers are important are Italian and
5141 Hungarian. The default works for when you have about 512 Mbyte. If
5142 you have 1 Gbyte you could use: >
5143 :set mkspellmem=900000,3000,800
5144< If you have less than 512 Mbyte |:mkspell| may fail for some
5145 languages, no matter what you set 'mkspellmem' to.
5146
Bram Moolenaar07607392019-05-26 19:20:43 +02005147 This option cannot be set from a |modeline| or in the |sandbox|.
5148
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005150'modeline' 'ml' boolean (Vim default: on (off for root),
5151 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005153 If 'modeline' is on 'modelines' gives the number of lines that is
5154 checked for set commands. If 'modeline' is off or 'modelines' is zero
5155 no lines are checked. See |modeline|.
5156
5157 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5158'modelineexpr' 'mle' boolean (default: off)
5159 global
5160 When on allow some options that are an expression to be set in the
5161 modeline. Check the option for whether it is affected by
5162 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005163 This option cannot be set from a |modeline| or in the |sandbox|, for
5164 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005165
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 *'modelines'* *'mls'*
5167'modelines' 'mls' number (default 5)
5168 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 If 'modeline' is on 'modelines' gives the number of lines that is
5170 checked for set commands. If 'modeline' is off or 'modelines' is zero
5171 no lines are checked. See |modeline|.
5172 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5173 set and to the Vim default value when 'compatible' is reset.
5174
5175 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005176 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177'modifiable' 'ma' boolean (default on)
5178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 When off the buffer contents cannot be changed. The 'fileformat' and
5180 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005181 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5184'modified' 'mod' boolean (default off)
5185 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 When on, the buffer is considered to be modified. This option is set
5187 when:
5188 1. A change was made to the text since it was last written. Using the
5189 |undo| command to go back to the original text will reset the
5190 option. But undoing changes that were made before writing the
5191 buffer will set the option again, since the text is different from
5192 when it was written.
5193 2. 'fileformat' or 'fileencoding' is different from its original
5194 value. The original value is set when the buffer is read or
5195 written. A ":set nomodified" command also resets the original
5196 values to the current values and the 'modified' option will be
5197 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005198 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005199 This option is not set when a change is made to the buffer as the
5200 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5201 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5202 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5204 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005205 Note that the text may actually be the same, e.g. 'modified' is set
5206 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
5208 *'more'* *'nomore'*
5209'more' boolean (Vim default: on, Vi default: off)
5210 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 When on, listings pause when the whole screen is filled. You will get
5212 the |more-prompt|. When this option is off there are no pauses, the
5213 listing continues until finished.
5214 NOTE: This option is set to the Vi default value when 'compatible' is
5215 set and to the Vim default value when 'compatible' is reset.
5216
5217 *'mouse'* *E538*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005218'mouse' string (default "", "a" for GUI and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005219 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005220 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005221 Enable the use of the mouse. Works for most terminals (xterm, Win32
5222 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux console
5223 with gpm). For using the mouse in the GUI, see |gui-mouse|. The
5224 mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005225 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 v Visual mode
5227 i Insert mode
5228 c Command-line mode
5229 h all previous modes when editing a help file
5230 a all previous modes
5231 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005232 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005234< If your terminal can't overrule the mouse events going to the
5235 application, use: >
5236 :set mouse=nvi
Bram Moolenaar65e0d772020-06-14 17:29:55 +02005237< Then you can press ":", select text for the system, and press Esc to go
Bram Moolenaar5b418992019-10-27 18:50:25 +01005238 back to Vim using the mouse events.
5239 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5240 "xterm".
5241
5242 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 modeless selection. This doesn't move the text cursor.
5244
5245 See |mouse-using|. Also see |'clipboard'|.
5246
5247 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005248 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 the mouse buttons can still be used by keeping the shift key pressed.
5250 Also see the 'clipboard' option.
5251
5252 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5253'mousefocus' 'mousef' boolean (default off)
5254 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 {only works in the GUI}
5256 The window that the mouse pointer is on is automatically activated.
5257 When changing the window layout or window focus in another way, the
5258 mouse pointer is moved to the window with keyboard focus. Off is the
5259 default because it makes using the pull down menus a little goofy, as
5260 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005261 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
Bram Moolenaar1d9215b2020-01-25 13:27:42 +01005262 using the mouse scroll wheel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263
5264 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5265'mousehide' 'mh' boolean (default on)
5266 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 {only works in the GUI}
5268 When on, the mouse pointer is hidden when characters are typed.
5269 The mouse pointer is restored when the mouse is moved.
5270
5271 *'mousemodel'* *'mousem'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005272'mousemodel' 'mousem' string (default "extend", "popup" for Win32)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 Sets the model to use for the mouse. The name mostly specifies what
5275 the right mouse button is used for:
5276 extend Right mouse button extends a selection. This works
5277 like in an xterm.
5278 popup Right mouse button pops up a menu. The shifted left
5279 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005280 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 popup_setpos Like "popup", but the cursor will be moved to the
5282 position where the mouse was clicked, and thus the
5283 selected operation will act upon the clicked object.
5284 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005285 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286 course, that right clicking outside a selection will
5287 end Visual mode.
5288 Overview of what button does what for each model:
5289 mouse extend popup(_setpos) ~
5290 left click place cursor place cursor
5291 left drag start selection start selection
5292 shift-left search word extend selection
5293 right click extend selection popup menu (place cursor)
5294 right drag extend selection -
5295 middle click paste paste
5296
5297 In the "popup" model the right mouse button produces a pop-up menu.
5298 You need to define this first, see |popup-menu|.
5299
5300 Note that you can further refine the meaning of buttons with mappings.
5301 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5302 selection (because that's handled in the GUI code directly).
5303
5304 The 'mousemodel' option is set by the |:behave| command.
5305
5306 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005307'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5308 vs:leftright,vd:lrsizing,m:no,
5309 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 {only available when compiled with the |+mouseshape|
5312 feature}
5313 This option tells Vim what the mouse pointer should look like in
5314 different modes. The option is a comma separated list of parts, much
5315 like used for 'guicursor'. Each part consist of a mode/location-list
5316 and an argument-list:
5317 mode-list:shape,mode-list:shape,..
5318 The mode-list is a dash separated list of these modes/locations:
5319 In a normal window: ~
5320 n Normal mode
5321 v Visual mode
5322 ve Visual mode with 'selection' "exclusive" (same as 'v',
5323 if not specified)
5324 o Operator-pending mode
5325 i Insert mode
5326 r Replace mode
5327
5328 Others: ~
5329 c appending to the command-line
5330 ci inserting in the command-line
5331 cr replacing in the command-line
5332 m at the 'Hit ENTER' or 'More' prompts
5333 ml idem, but cursor in the last line
5334 e any mode, pointer below last window
5335 s any mode, pointer on a status line
5336 sd any mode, while dragging a status line
5337 vs any mode, pointer on a vertical separator line
5338 vd any mode, while dragging a vertical separator line
5339 a everywhere
5340
5341 The shape is one of the following:
5342 avail name looks like ~
5343 w x arrow Normal mouse pointer
5344 w x blank no pointer at all (use with care!)
5345 w x beam I-beam
5346 w x updown up-down sizing arrows
5347 w x leftright left-right sizing arrows
5348 w x busy The system's usual busy pointer
5349 w x no The system's usual 'no input' pointer
5350 x udsizing indicates up-down resizing
5351 x lrsizing indicates left-right resizing
5352 x crosshair like a big thin +
5353 x hand1 black hand
5354 x hand2 white hand
5355 x pencil what you write with
5356 x question big ?
5357 x rightup-arrow arrow pointing right-up
5358 w x up-arrow arrow pointing up
5359 x <number> any X11 pointer number (see X11/cursorfont.h)
5360
5361 The "avail" column contains a 'w' if the shape is available for Win32,
5362 x for X11.
5363 Any modes not specified or shapes not available use the normal mouse
5364 pointer.
5365
5366 Example: >
5367 :set mouseshape=s:udsizing,m:no
5368< will make the mouse turn to a sizing arrow over the status lines and
5369 indicate no input when the hit-enter prompt is displayed (since
5370 clicking the mouse has no effect in this state.)
5371
5372 *'mousetime'* *'mouset'*
5373'mousetime' 'mouset' number (default 500)
5374 global
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01005375 Only for GUI, Win32 and Unix with xterm. Defines the maximum
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 time in msec between two mouse clicks for the second click to be
5377 recognized as a multi click.
5378
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005379 *'mzschemedll'*
5380'mzschemedll' string (default depends on the build)
5381 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005382 {only available when compiled with the |+mzscheme/dyn|
5383 feature}
5384 Specifies the name of the MzScheme shared library. The default is
5385 DYNAMIC_MZSCH_DLL which was specified at compile time.
5386 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005387 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005388 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005389 This option cannot be set from a |modeline| or in the |sandbox|, for
5390 security reasons.
5391
5392 *'mzschemegcdll'*
5393'mzschemegcdll' string (default depends on the build)
5394 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005395 {only available when compiled with the |+mzscheme/dyn|
5396 feature}
5397 Specifies the name of the MzScheme GC shared library. The default is
5398 DYNAMIC_MZGC_DLL which was specified at compile time.
5399 The value can be equal to 'mzschemedll' if it includes the GC code.
5400 Environment variables are expanded |:set_env|.
5401 This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
5403
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005404 *'mzquantum'* *'mzq'*
5405'mzquantum' 'mzq' number (default 100)
5406 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005407 {not available when compiled without the |+mzscheme|
5408 feature}
5409 The number of milliseconds between polls for MzScheme threads.
5410 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005411 NOTE: This option is set to the Vim default value when 'compatible'
5412 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005413
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005415'nrformats' 'nf' string (default "bin,octal,hex",
5416 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 This defines what bases Vim will consider for numbers when using the
5419 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5420 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005421 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005423 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005424 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005426 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 considered to be hexadecimal. Example: Using CTRL-X on
5428 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005429 bin If included, numbers starting with "0b" or "0B" will be
5430 considered to be binary. Example: Using CTRL-X on
5431 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaaraaad9952020-05-31 15:08:59 +02005432 unsigned If included, numbers are recognized as unsigned. Thus a
5433 leading dash or negative sign won't be considered as part of
5434 the number. Examples:
5435 Using CTRL-X on "2020" in "9-2020" results in "9-2019"
5436 (without "unsigned" it would become "9-2021").
5437 Using CTRL-A on "2020" in "9-2020" results in "9-2021"
5438 (without "unsigned" it would become "9-2019").
Bram Moolenaaracc22402020-06-07 21:07:18 +02005439 Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
5440 (2^64 - 1) has no effect, overflow is prevented.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 Numbers which simply begin with a digit in the range 1-9 are always
5442 considered decimal. This also happens for numbers that are not
5443 recognized as octal or hex.
5444
5445 *'number'* *'nu'* *'nonumber'* *'nonu'*
5446'number' 'nu' boolean (default off)
5447 local to window
5448 Print the line number in front of each line. When the 'n' option is
5449 excluded from 'cpoptions' a wrapped line will not use the column of
5450 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005451 The 'numberwidth' option can be used to set the room used for the line
5452 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 When a long, wrapped line doesn't start with the first character, '-'
5454 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005455 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5456 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005457 *number_relativenumber*
5458 The 'relativenumber' option changes the displayed number to be
5459 relative to the cursor. Together with 'number' there are these
5460 four combinations (cursor in line 3):
5461
Bram Moolenaar3848e002016-03-19 18:42:29 +01005462 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005463 'nornu' 'nornu' 'rnu' 'rnu'
5464
5465 |apple | 1 apple | 2 apple | 2 apple
5466 |pear | 2 pear | 1 pear | 1 pear
5467 |nobody | 3 nobody | 0 nobody |3 nobody
5468 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005470 *'numberwidth'* *'nuw'*
5471'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5472 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005473 {only available when compiled with the |+linebreak|
5474 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005475 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005476 when the 'number' or 'relativenumber' option is set or printing lines
5477 with a line number. Since one space is always between the number and
5478 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005479 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005480 fit the highest line number in the buffer respectively the number of
5481 rows in the window, depending on whether 'number' or 'relativenumber'
5482 is set. Thus with the Vim default of 4 there is room for a line number
5483 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005484 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005485 NOTE: This option is set to the Vi default value when 'compatible' is
5486 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005487
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005488 *'omnifunc'* *'ofu'*
5489'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005490 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005491 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005492 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005493 This option specifies a function to be used for Insert mode omni
5494 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005495 See |complete-functions| for an explanation of how the function is
5496 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005497 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005498 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005499 This option cannot be set from a |modeline| or in the |sandbox|, for
5500 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005501
5502
Bram Moolenaar02467872007-05-06 13:22:01 +00005503 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005504'opendevice' 'odev' boolean (default off)
5505 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01005506 {only for MS-Windows}
Bram Moolenaar043545e2006-10-10 16:44:07 +00005507 Enable reading and writing from devices. This may get Vim stuck on a
5508 device that can be opened but doesn't actually do the I/O. Therefore
5509 it is off by default.
5510 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5511 result in editing a device.
5512
5513
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005514 *'operatorfunc'* *'opfunc'*
5515'operatorfunc' 'opfunc' string (default: empty)
5516 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005517 This option specifies a function to be called by the |g@| operator.
5518 See |:map-operator| for more info and an example.
5519
5520 This option cannot be set from a |modeline| or in the |sandbox|, for
5521 security reasons.
5522
5523
Bram Moolenaar251e1912011-06-19 05:09:16 +02005524 *'osfiletype'* *'oft'*
5525'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005527 This option was supported on RISC OS, which has been removed.
5528
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005530 *'packpath'* *'pp'*
5531'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005532 Directories used to find packages. See |packages|.
5533
5534
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005536'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 global
5538 Specifies the nroff macros that separate paragraphs. These are pairs
5539 of two letters (see |object-motions|).
5540
5541 *'paste'* *'nopaste'*
5542'paste' boolean (default off)
5543 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005544 Put Vim in Paste mode. This is useful if you want to cut or copy
5545 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 unexpected effects.
5547 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005548 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 knows about pasting and will mostly do the right thing without 'paste'
5550 being set. The same is true for a terminal where Vim handles the
5551 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005552 This option is reset when starting the GUI. Thus if you set it in
5553 your .vimrc it will work in a terminal, but not in the GUI. Setting
5554 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5555 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 When the 'paste' option is switched on (also when it was already on):
5557 - mapping in Insert mode and Command-line mode is disabled
5558 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005560 - 'expandtab' is reset
5561 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 - 'revins' is reset
5563 - 'ruler' is reset
5564 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005565 - 'smartindent' is reset
5566 - 'smarttab' is reset
5567 - 'softtabstop' is set to 0
5568 - 'textwidth' is set to 0
5569 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005572 - 'indentexpr'
5573 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 NOTE: When you start editing another file while the 'paste' option is
5575 on, settings from the modelines or autocommands may change the
5576 settings again, causing trouble when pasting text. You might want to
5577 set the 'paste' option again.
5578 When the 'paste' option is reset the mentioned options are restored to
5579 the value before the moment 'paste' was switched from off to on.
5580 Resetting 'paste' before ever setting it does not have any effect.
5581 Since mapping doesn't work while 'paste' is active, you need to use
5582 the 'pastetoggle' option to toggle the 'paste' option with some key.
5583
5584 *'pastetoggle'* *'pt'*
5585'pastetoggle' 'pt' string (default "")
5586 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 When non-empty, specifies the key sequence that toggles the 'paste'
5588 option. This is like specifying a mapping: >
5589 :map {keys} :set invpaste<CR>
5590< Where {keys} is the value of 'pastetoggle'.
5591 The difference is that it will work even when 'paste' is set.
5592 'pastetoggle' works in Insert mode and Normal mode, but not in
5593 Command-line mode.
5594 Mappings are checked first, thus overrule 'pastetoggle'. However,
5595 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5596 this: >
5597 :map <F10> :set paste<CR>
5598 :map <F11> :set nopaste<CR>
5599 :imap <F10> <C-O>:set paste<CR>
5600 :imap <F11> <nop>
5601 :set pastetoggle=<F11>
5602< This will make <F10> start paste mode and <F11> stop paste mode.
5603 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5604 mode everything is inserted literally, except the 'pastetoggle' key
5605 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005606 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607
5608 *'pex'* *'patchexpr'*
5609'patchexpr' 'pex' string (default "")
5610 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 {not available when compiled without the |+diff|
5612 feature}
5613 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005614 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615
Bram Moolenaardbc28022014-07-26 13:40:44 +02005616 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617'patchmode' 'pm' string (default "")
5618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 When non-empty the oldest version of a file is kept. This can be used
5620 to keep the original version of a file if you are changing files in a
5621 source distribution. Only the first time that a file is written a
5622 copy of the original file will be kept. The name of the copy is the
5623 name of the original file with the string in the 'patchmode' option
5624 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005625 ".orig" or ".org". 'backupdir' must not be empty for this to work
5626 (Detail: The backup file is renamed to the patchmode file after the
5627 new file has been successfully written, that's why it must be possible
5628 to write a backup file). If there was no file to be backed up, an
5629 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 When the 'backupskip' pattern matches, a patchmode file is not made.
5631 Using 'patchmode' for compressed files appends the extension at the
5632 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5633 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005634 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005636 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637'path' 'pa' string (default on Unix: ".,/usr/include,,"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 other systems: ".,,")
5639 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005641 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5642 provided that the file being searched for has a relative path (not
5643 starting with "/", "./" or "../"). The directories in the 'path'
5644 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 - Use commas to separate directory names: >
5646 :set path=.,/usr/local/include,/usr/include
5647< - Spaces can also be used to separate directory names (for backwards
5648 compatibility with version 3.0). To have a space in a directory
5649 name, precede it with an extra backslash, and escape the space: >
5650 :set path=.,/dir/with\\\ space
5651< - To include a comma in a directory name precede it with an extra
5652 backslash: >
5653 :set path=.,/dir/with\\,comma
5654< - To search relative to the directory of the current file, use: >
5655 :set path=.
5656< - To search in the current directory use an empty string between two
5657 commas: >
5658 :set path=,,
5659< - A directory name may end in a ':' or '/'.
5660 - Environment variables are expanded |:set_env|.
5661 - When using |netrw.vim| URLs can be used. For example, adding
5662 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005663 - Search upwards and downwards in a directory tree using "*", "**" and
5664 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 {not available when compiled without the |+path_extra| feature}
5666 - Careful with '\' characters, type two to get one in the option: >
5667 :set path=.,c:\\include
5668< Or just use '/' instead: >
5669 :set path=.,c:/include
5670< Don't forget "." or files won't even be found in the same directory as
5671 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005672 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 it is something like 256 or 1024 characters.
5674 You can check if all the include files are found, using the value of
5675 'path', see |:checkpath|.
5676 The use of |:set+=| and |:set-=| is preferred when adding or removing
5677 directories from the list. This avoids problems when a future version
5678 uses another default. To remove the current directory use: >
5679 :set path-=
5680< To add the current directory use: >
5681 :set path+=
5682< To use an environment variable, you probably need to replace the
5683 separator. Here is an example to append $INCL, in which directory
5684 names are separated with a semi-colon: >
5685 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5686< Replace the ';' with a ':' or whatever separator is used. Note that
5687 this doesn't work when $INCL contains a comma or white space.
5688
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005689 *'perldll'*
5690'perldll' string (default depends on the build)
5691 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005692 {only available when compiled with the |+perl/dyn|
5693 feature}
5694 Specifies the name of the Perl shared library. The default is
5695 DYNAMIC_PERL_DLL, which was specified at compile time.
5696 Environment variables are expanded |:set_env|.
5697 This option cannot be set from a |modeline| or in the |sandbox|, for
5698 security reasons.
5699
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5701'preserveindent' 'pi' boolean (default off)
5702 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 When changing the indent of the current line, preserve as much of the
5704 indent structure as possible. Normally the indent is replaced by a
5705 series of tabs followed by spaces as required (unless |'expandtab'| is
5706 enabled, in which case only spaces are used). Enabling this option
5707 means the indent will preserve as many existing characters as possible
5708 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005709 'expandtab' does not apply to the preserved white space, a Tab remains
5710 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 NOTE: When using ">>" multiple times the resulting indent is a mix of
5712 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005713 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 Also see 'copyindent'.
5715 Use |:retab| to clean up white space.
5716
5717 *'previewheight'* *'pvh'*
5718'previewheight' 'pvh' number (default 12)
5719 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005720 {not available when compiled without the |+quickfix|
5721 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005723 commands. Used for |CTRL-W_}| when no count is given. Not used when
5724 'previewpopup' is set.
5725
5726 *'previewpopup'* *'pvp'*
5727'previewpopup' 'pvp' string (default empty)
5728 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005729 {not available when compiled without the |+textprop|
5730 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005731 When not empty a popup window is used for commands that would open a
5732 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005733 Not used for the insert completion info, add "popup" to
5734 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
5736 *'previewwindow'* *'nopreviewwindow'*
5737 *'pvw'* *'nopvw'* *E590*
5738'previewwindow' 'pvw' boolean (default off)
5739 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005740 {not available when compiled without the |+quickfix|
5741 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005742 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 set. It's normally not set directly, but by using one of the commands
5744 |:ptag|, |:pedit|, etc.
5745
5746 *'printdevice'* *'pdev'*
5747'printdevice' 'pdev' string (default empty)
5748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 {only available when compiled with the |+printer|
5750 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005751 The name of the printer to be used for |:hardcopy|.
5752 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005753 This option cannot be set from a |modeline| or in the |sandbox|, for
5754 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755
Bram Moolenaar8299df92004-07-10 09:47:34 +00005756 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005757'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 {only available when compiled with the |+printer|
5760 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005761 Sets the character encoding used when printing.
5762 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763
5764 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005765'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 {only available when compiled with the |+printer|
5768 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005769 Expression used to print the PostScript produced with |:hardcopy|.
5770 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005771 This option cannot be set from a |modeline| or in the |sandbox|, for
5772 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773
Bram Moolenaar8299df92004-07-10 09:47:34 +00005774 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775'printfont' 'pfn' string (default "courier")
5776 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 {only available when compiled with the |+printer|
5778 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005779 The name of the font that will be used for |:hardcopy|.
5780 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781
5782 *'printheader'* *'pheader'*
5783'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 {only available when compiled with the |+printer|
5786 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005787 The format of the header produced in |:hardcopy| output.
5788 See |pheader-option|.
5789
5790 *'printmbcharset'* *'pmbcs'*
5791'printmbcharset' 'pmbcs' string (default "")
5792 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005793 {only available when compiled with the |+printer|
5794 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005795 The CJK character set to be used for CJK output from |:hardcopy|.
5796 See |pmbcs-option|.
5797
5798 *'printmbfont'* *'pmbfn'*
5799'printmbfont' 'pmbfn' string (default "")
5800 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005801 {only available when compiled with the |+printer|
5802 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005803 List of font names to be used for CJK output from |:hardcopy|.
5804 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
5806 *'printoptions'* *'popt'*
5807'printoptions' 'popt' string (default "")
5808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005810 List of items that control the format of the output of |:hardcopy|.
5811 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005813 *'prompt'* *'noprompt'*
5814'prompt' boolean (default on)
5815 global
5816 When on a ":" prompt is used in Ex mode.
5817
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005818 *'pumheight'* *'ph'*
5819'pumheight' 'ph' number (default 0)
5820 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005821 Determines the maximum number of items to show in the popup menu for
5822 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005823 |ins-completion-menu|.
5824
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005825 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005826'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005827 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005828 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005829 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005830
Bram Moolenaard94464e2015-11-02 15:28:18 +01005831 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005832'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005833 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005834 {only available when compiled with the |+python/dyn|
5835 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005836 Specifies the name of the Python 2.x shared library. The default is
5837 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005838 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005839 This option cannot be set from a |modeline| or in the |sandbox|, for
5840 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005841
Bram Moolenaar94073162018-01-31 21:49:05 +01005842 *'pythonhome'*
5843'pythonhome' string (default "")
5844 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005845 {only available when compiled with the |+python/dyn|
5846 feature}
5847 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5848 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5849 which was specified at compile time, will be used for the Python 2.x
5850 home directory.
5851 Environment variables are expanded |:set_env|.
5852 This option cannot be set from a |modeline| or in the |sandbox|, for
5853 security reasons.
5854
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005855 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005856'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005857 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005858 {only available when compiled with the |+python3/dyn|
5859 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005860 Specifies the name of the Python 3 shared library. The default is
5861 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005862 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005863 This option cannot be set from a |modeline| or in the |sandbox|, for
5864 security reasons.
5865
Bram Moolenaar94073162018-01-31 21:49:05 +01005866 *'pythonthreehome'*
5867'pythonthreehome' string (default "")
5868 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005869 {only available when compiled with the |+python3/dyn|
5870 feature}
5871 Specifies the name of the Python 3 home directory. When
5872 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5873 PYTHON3_HOME, which was specified at compile time, will be used for
5874 the Python 3 home directory.
5875 Environment variables are expanded |:set_env|.
5876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005879 *'pyxversion'* *'pyx'*
5880'pyxversion' 'pyx' number (default depends on the build)
5881 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005882 {only available when compiled with the |+python| or
5883 the |+python3| feature}
5884 Specifies the python version used for pyx* functions and commands
5885 |python_x|. The default value is as follows:
5886
5887 Compiled with Default ~
5888 |+python| and |+python3| 0
5889 only |+python| 2
5890 only |+python3| 3
5891
5892 Available values are 0, 2 and 3.
5893 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5894 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5895 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5896 to 2 if Python 2 is available.
5897 See also: |has-pythonx|
5898
5899 If Vim is compiled with only |+python| or |+python3| setting
5900 'pyxversion' has no effect. The pyx* functions and commands are
5901 always the same as the compiled version.
5902
5903 This option cannot be set from a |modeline| or in the |sandbox|, for
5904 security reasons.
5905
Bram Moolenaar858ba062020-05-31 23:11:59 +02005906 *'quickfixtextfunc'* *'qftf'*
5907'quickfixtextfunc' 'qftf' string (default "")
5908 global
5909 {only available when compiled with the |+quickfix|
5910 feature}
5911 This option specifies a function to be used to get the text to display
5912 in the quickfix and location list windows. This can be used to
5913 customize the information displayed in the quickfix or location window
5914 for each entry in the corresponding quickfix or location list. See
5915 |quickfix-window-function| for an explanation of how to write the
Bram Moolenaard43906d2020-07-20 21:31:32 +02005916 function and an example. The value can be the name of a function or a
5917 lambda.
Bram Moolenaar858ba062020-05-31 23:11:59 +02005918
5919 This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
5921
Bram Moolenaar677ee682005-01-27 14:41:15 +00005922 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005923'quoteescape' 'qe' string (default "\")
5924 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005925 The characters that are used to escape quotes in a string. Used for
5926 objects like a', a" and a` |a'|.
5927 When one of the characters in this option is found inside a string,
5928 the following character will be skipped. The default value makes the
5929 text "foo\"bar\\" considered to be one string.
5930
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5932'readonly' 'ro' boolean (default off)
5933 local to buffer
5934 If on, writes fail unless you use a '!'. Protects you from
5935 accidentally overwriting a file. Default on when Vim is started
5936 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005937 When using ":w!" the 'readonly' option is reset for the current
5938 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005939 When using the ":view" command the 'readonly' option is set for the
5940 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005941 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005943 *'redrawtime'* *'rdt'*
5944'redrawtime' 'rdt' number (default 2000)
5945 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005946 {only available when compiled with the |+reltime|
5947 feature}
5948 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005949 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005950 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005951 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005952 matches will be highlighted.
5953 For syntax highlighting the time applies per window. When over the
5954 limit syntax highlighting is disabled until |CTRL-L| is used.
5955 This is used to avoid that Vim hangs when using a very complicated
5956 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005957
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005958 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005959'regexpengine' 're' number (default 0)
5960 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005961 This selects the default regexp engine. |two-engines|
5962 The possible values are:
5963 0 automatic selection
5964 1 old engine
5965 2 NFA engine
5966 Note that when using the NFA engine and the pattern contains something
5967 that is not supported the pattern will not match. This is only useful
5968 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005969 Using automatic selection enables Vim to switch the engine, if the
5970 default engine becomes too costly. E.g., when the NFA engine uses too
5971 many states. This should prevent Vim from hanging on a combination of
5972 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005973
Bram Moolenaar64486672010-05-16 15:46:46 +02005974 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5975'relativenumber' 'rnu' boolean (default off)
5976 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005977 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005978 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005979 precede some vertical motion commands (e.g. j k + -) with, without
5980 having to calculate it yourself. Especially useful in combination with
5981 other commands (e.g. y d c < > gq gw =).
5982 When the 'n' option is excluded from 'cpoptions' a wrapped
5983 line will not use the column of line numbers (this is the default when
5984 'compatible' isn't set).
5985 The 'numberwidth' option can be used to set the room used for the line
5986 number.
5987 When a long, wrapped line doesn't start with the first character, '-'
5988 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005989 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5990 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005991
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005992 The number in front of the cursor line also depends on the value of
5993 'number', see |number_relativenumber| for all combinations of the two
5994 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005995
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 *'remap'* *'noremap'*
5997'remap' boolean (default on)
5998 global
5999 Allows for mappings to work recursively. If you do not want this for
6000 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006001 NOTE: To avoid portability problems with Vim scripts, always keep
6002 this option at the default "on". Only switch it off when working with
6003 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006005 *'renderoptions'* *'rop'*
6006'renderoptions' 'rop' string (default: empty)
6007 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006008 {only available when compiled with GUI and DIRECTX on
6009 MS-Windows}
6010 Select a text renderer and set its options. The options depend on the
6011 renderer.
6012
6013 Syntax: >
6014 set rop=type:{renderer}(,{name}:{value})*
6015<
6016 Currently, only one optional renderer is available.
6017
6018 render behavior ~
6019 directx Vim will draw text using DirectX (DirectWrite). It makes
6020 drawn glyphs more beautiful than default GDI.
6021 It requires 'encoding' is "utf-8", and only works on
6022 MS-Windows Vista or newer version.
6023
6024 Options:
6025 name meaning type value ~
6026 gamma gamma float 1.0 - 2.2 (maybe)
6027 contrast enhancedContrast float (unknown)
6028 level clearTypeLevel float (unknown)
6029 geom pixelGeometry int 0 - 2 (see below)
6030 renmode renderingMode int 0 - 6 (see below)
6031 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01006032 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006033
Bram Moolenaar92467d32017-12-05 13:22:16 +01006034 See this URL for detail (except for scrlines):
6035 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006036
6037 For geom: structure of a device pixel.
6038 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6039 1 - DWRITE_PIXEL_GEOMETRY_RGB
6040 2 - DWRITE_PIXEL_GEOMETRY_BGR
6041
6042 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006043 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006044
6045 For renmode: method of rendering glyphs.
6046 0 - DWRITE_RENDERING_MODE_DEFAULT
6047 1 - DWRITE_RENDERING_MODE_ALIASED
6048 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6049 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6050 4 - DWRITE_RENDERING_MODE_NATURAL
6051 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6052 6 - DWRITE_RENDERING_MODE_OUTLINE
6053
6054 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006055 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006056
6057 For taamode: antialiasing mode used for drawing text.
6058 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6059 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6060 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6061 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6062
6063 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006064 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6065
Bram Moolenaara338adc2018-01-31 20:51:47 +01006066 For scrlines:
6067 This was used for optimizing scrolling behavior, however this
6068 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006069
6070 Example: >
6071 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006072 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006073 set rop=type:directx
6074<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006075 If select a raster font (Courier, Terminal or FixedSys which
6076 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006077 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006078
6079 NOTE: It is known that some fonts and options combination
6080 causes trouble on drawing glyphs.
6081
Bram Moolenaar92467d32017-12-05 13:22:16 +01006082 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006083 special made fonts (True-Type fonts which includes only
6084 bitmap glyphs).
6085 - 'taamode:3' will not work with some vector fonts.
6086
6087 NOTE: With this option, you can display colored emoji
6088 (emoticon) in Windows 8.1 or later. To display colored emoji,
6089 there are some conditions which you should notice.
6090
6091 - If your font includes non-colored emoji already, it will
6092 be used.
6093 - If your font doesn't have emoji, the system chooses an
6094 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6095 will be used.
6096 - When this alternative font didn't have fixed width glyph,
6097 emoji might be rendered beyond the bounding box of drawing
6098 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006099
6100 Other render types are currently not supported.
6101
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 *'report'*
6103'report' number (default 2)
6104 global
6105 Threshold for reporting number of lines changed. When the number of
6106 changed lines is more than 'report' a message will be given for most
6107 ":" commands. If you want it always, set 'report' to 0.
6108 For the ":substitute" command the number of substitutions is used
6109 instead of the number of lines.
6110
6111 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6112'restorescreen' 'rs' boolean (default on)
6113 global
Bram Moolenaar8024f932020-01-14 19:29:13 +01006114 {only in MS-Windows console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 When set, the screen contents is restored when exiting Vim. This also
6116 happens when executing external commands.
6117
6118 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6119 options in your .vimrc. To disable restoring:
6120 set t_ti= t_te=
6121 To enable restoring (for an xterm):
6122 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6123 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6124
6125 *'revins'* *'ri'* *'norevins'* *'nori'*
6126'revins' 'ri' boolean (default off)
6127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 {only available when compiled with the |+rightleft|
6129 feature}
6130 Inserting characters in Insert mode will work backwards. See "typing
6131 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6132 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006133 NOTE: This option is reset when 'compatible' is set.
6134 This option is reset when 'paste' is set and restored when 'paste' is
6135 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136
6137 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6138'rightleft' 'rl' boolean (default off)
6139 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 {only available when compiled with the |+rightleft|
6141 feature}
6142 When on, display orientation becomes right-to-left, i.e., characters
6143 that are stored in the file appear from the right to the left.
6144 Using this option, it is possible to edit files for languages that
6145 are written from the right to the left such as Hebrew and Arabic.
6146 This option is per window, so it is possible to edit mixed files
6147 simultaneously, or to view the same file in both ways (this is
6148 useful whenever you have a mixed text file with both right-to-left
6149 and left-to-right strings so that both sets are displayed properly
6150 in different windows). Also see |rileft.txt|.
6151
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006152 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153'rightleftcmd' 'rlc' string (default "search")
6154 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 {only available when compiled with the |+rightleft|
6156 feature}
6157 Each word in this option enables the command line editing to work in
6158 right-to-left mode for a group of commands:
6159
6160 search "/" and "?" commands
6161
6162 This is useful for languages such as Hebrew, Arabic and Farsi.
6163 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6164
Bram Moolenaard94464e2015-11-02 15:28:18 +01006165 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006166'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006167 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006168 {only available when compiled with the |+ruby/dyn|
6169 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006170 Specifies the name of the Ruby shared library. The default is
6171 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006172 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006173 This option cannot be set from a |modeline| or in the |sandbox|, for
6174 security reasons.
6175
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006177'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 {not available when compiled without the
6180 |+cmdline_info| feature}
6181 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006182 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 text in the file is shown on the far right:
6184 Top first line is visible
6185 Bot last line is visible
6186 All first and last line are visible
6187 45% relative position in the file
6188 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006189 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006191 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 this option takes precedence over 'ruler' and 'rulerformat'
6193 If the number of characters displayed is different from the number of
6194 bytes in the text (e.g., for a TAB or a multi-byte character), both
6195 the text column (byte number) and the screen column are shown,
6196 separated with a dash.
6197 For an empty line "0-1" is shown.
6198 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006199 This option is reset when 'paste' is set and restored when 'paste' is
6200 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 If you don't want to see the ruler all the time but want to know where
6202 you are, use "g CTRL-G" |g_CTRL-G|.
6203 NOTE: This option is reset when 'compatible' is set.
6204
6205 *'rulerformat'* *'ruf'*
6206'rulerformat' 'ruf' string (default empty)
6207 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 {not available when compiled without the |+statusline|
6209 feature}
6210 When this option is not empty, it determines the content of the ruler
6211 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006212 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006213 This option cannot be set in a modeline when 'modelineexpr' is off.
6214
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 The default ruler width is 17 characters. To make the ruler 15
6216 characters wide, put "%15(" at the start and "%)" at the end.
6217 Example: >
6218 :set rulerformat=%15(%c%V\ %p%%%)
6219<
6220 *'runtimepath'* *'rtp'* *vimfiles*
6221'runtimepath' 'rtp' string (default:
6222 Unix: "$HOME/.vim,
6223 $VIM/vimfiles,
6224 $VIMRUNTIME,
6225 $VIM/vimfiles/after,
6226 $HOME/.vim/after"
6227 Amiga: "home:vimfiles,
6228 $VIM/vimfiles,
6229 $VIMRUNTIME,
6230 $VIM/vimfiles/after,
6231 home:vimfiles/after"
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006232 PC: "$HOME/vimfiles,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 $VIM/vimfiles,
6234 $VIMRUNTIME,
6235 $VIM/vimfiles/after,
6236 $HOME/vimfiles/after"
6237 Macintosh: "$VIM:vimfiles,
6238 $VIMRUNTIME,
6239 $VIM:vimfiles:after"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01006240 Haiku: "$BE_USER_SETTINGS/vim,
6241 $VIM/vimfiles,
6242 $VIMRUNTIME,
6243 $VIM/vimfiles/after,
6244 $BE_USER_SETTINGS/vim/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 VMS: "sys$login:vimfiles,
6246 $VIM/vimfiles,
6247 $VIMRUNTIME,
6248 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006249 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 This is a list of directories which will be searched for runtime
6252 files:
6253 filetype.vim filetypes by file name |new-filetype|
6254 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006255 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 colors/ color scheme files |:colorscheme|
6257 compiler/ compiler files |:compiler|
6258 doc/ documentation |write-local-help|
6259 ftplugin/ filetype plugins |write-filetype-plugin|
Bram Moolenaar8a7d6542020-01-26 15:56:19 +01006260 import/ files that are found by `:import`
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 indent/ indent scripts |indent-expression|
6262 keymap/ key mapping files |mbyte-keymap|
6263 lang/ menu translations |:menutrans|
6264 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006265 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 plugin/ plugin scripts |write-plugin|
6267 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006268 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 syntax/ syntax files |mysyntaxfile|
6270 tutor/ files for vimtutor |tutor|
6271
6272 And any other file searched for with the |:runtime| command.
6273
6274 The defaults for most systems are setup to search five locations:
6275 1. In your home directory, for your personal preferences.
6276 2. In a system-wide Vim directory, for preferences from the system
6277 administrator.
6278 3. In $VIMRUNTIME, for files distributed with Vim.
6279 *after-directory*
6280 4. In the "after" directory in the system-wide Vim directory. This is
6281 for the system administrator to overrule or add to the distributed
6282 defaults (rarely needed)
6283 5. In the "after" directory in your home directory. This is for
6284 personal preferences to overrule or add to the distributed defaults
6285 or system-wide settings (rarely needed).
6286
Bram Moolenaard0796902016-09-16 20:02:31 +02006287 More entries are added when using |packages|. If it gets very long
6288 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6289 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006290
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6292 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006293 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 wildcards.
6295 See |:runtime|.
6296 Example: >
6297 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6298< This will use the directory "~/vimruntime" first (containing your
6299 personal Vim runtime files), then "/mygroup/vim" (shared between a
6300 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6301 files).
6302 You probably should always include $VIMRUNTIME somewhere, to use the
6303 distributed runtime files. You can put a directory before $VIMRUNTIME
6304 to find files which replace a distributed runtime files. You can put
6305 a directory after $VIMRUNTIME to find files which add to distributed
6306 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006307 When Vim is started with |--clean| the home directory entries are not
6308 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 This option cannot be set from a |modeline| or in the |sandbox|, for
6310 security reasons.
6311
6312 *'scroll'* *'scr'*
6313'scroll' 'scr' number (default: half the window height)
6314 local to window
6315 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6316 set to half the number of lines in the window when the window size
6317 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006318 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006319 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320
6321 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6322'scrollbind' 'scb' boolean (default off)
6323 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 See also |scroll-binding|. When this option is set, the current
6325 window scrolls as other scrollbind windows (windows that also have
6326 this option set) scroll. This option is useful for viewing the
6327 differences between two versions of a file, see 'diff'.
6328 See |'scrollopt'| for options that determine how this option should be
6329 interpreted.
6330 This option is mostly reset when splitting a window to edit another
6331 file. This means that ":split | edit file" results in two windows
6332 with scroll-binding, but ":split file" does not.
6333
Bram Moolenaarae20f342019-11-05 21:09:23 +01006334 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6335'scrollfocus' 'scf' boolean (default off)
6336 global
6337 {only for MS-Windows GUI}
6338 When using the scroll wheel and this option is set, the window under
6339 the mouse pointer is scrolled. With this option off the current
6340 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006341 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006342
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 *'scrolljump'* *'sj'*
6344'scrolljump' 'sj' number (default 1)
6345 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 Minimal number of lines to scroll when the cursor gets off the
6347 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6348 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006349 When set to a negative number from -1 to -100 this is used as the
6350 percentage of the window height. Thus -50 scrolls half the window
6351 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 NOTE: This option is set to 1 when 'compatible' is set.
6353
6354 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006355'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006356 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 Minimal number of screen lines to keep above and below the cursor.
6358 This will make some context visible around where you are working. If
6359 you set it to a very large value (999) the cursor line will always be
6360 in the middle of the window (except at the start or end of the file or
6361 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006362 After using the local value, go back the global value with one of
6363 these two: >
6364 setlocal scrolloff<
6365 setlocal scrolloff=-1
6366< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 NOTE: This option is set to 0 when 'compatible' is set.
6368
6369 *'scrollopt'* *'sbo'*
6370'scrollopt' 'sbo' string (default "ver,jump")
6371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006373 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6374 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 The following words are available:
6376 ver Bind vertical scrolling for 'scrollbind' windows
6377 hor Bind horizontal scrolling for 'scrollbind' windows
6378 jump Applies to the offset between two windows for vertical
6379 scrolling. This offset is the difference in the first
6380 displayed line of the bound windows. When moving
6381 around in a window, another 'scrollbind' window may
6382 reach a position before the start or after the end of
6383 the buffer. The offset is not changed though, when
6384 moving back the 'scrollbind' window will try to scroll
6385 to the desired position when possible.
6386 When now making that window the current one, two
6387 things can be done with the relative offset:
6388 1. When "jump" is not included, the relative offset is
6389 adjusted for the scroll position in the new current
6390 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006391 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 2. When "jump" is included, the other windows are
6393 scrolled to keep the same relative offset. When
6394 going back to the other window, it still uses the
6395 same relative offset.
6396 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006397 When 'diff' mode is active there always is vertical scroll binding,
6398 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399
6400 *'sections'* *'sect'*
6401'sections' 'sect' string (default "SHNHH HUnhsh")
6402 global
6403 Specifies the nroff macros that separate sections. These are pairs of
6404 two letters (See |object-motions|). The default makes a section start
6405 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6406
6407 *'secure'* *'nosecure'* *E523*
6408'secure' boolean (default off)
6409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 When on, ":autocmd", shell and write commands are not allowed in
6411 ".vimrc" and ".exrc" in the current directory and map commands are
6412 displayed. Switch it off only if you know that you will not run into
6413 problems, or when the 'exrc' option is off. On Unix this option is
6414 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006415 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 'secure' at the end of your ~/.vimrc then.
6417 This option cannot be set from a |modeline| or in the |sandbox|, for
6418 security reasons.
6419
6420 *'selection'* *'sel'*
6421'selection' 'sel' string (default "inclusive")
6422 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 This option defines the behavior of the selection. It is only used
6424 in Visual and Select mode.
6425 Possible values:
6426 value past line inclusive ~
6427 old no yes
6428 inclusive yes yes
6429 exclusive yes no
6430 "past line" means that the cursor is allowed to be positioned one
6431 character past the line.
6432 "inclusive" means that the last character of the selection is included
6433 in an operation. For example, when "x" is used to delete the
6434 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006435 When "old" is used and 'virtualedit' allows the cursor to move past
6436 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 Note that when "exclusive" is used and selecting from the end
6438 backwards, you cannot include the last character of a line, when
6439 starting in Normal mode and 'virtualedit' empty.
6440
6441 The 'selection' option is set by the |:behave| command.
6442
6443 *'selectmode'* *'slm'*
6444'selectmode' 'slm' string (default "")
6445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 This is a comma separated list of words, which specifies when to start
6447 Select mode instead of Visual mode, when a selection is started.
6448 Possible values:
6449 mouse when using the mouse
6450 key when using shifted special keys
6451 cmd when using "v", "V" or CTRL-V
6452 See |Select-mode|.
6453 The 'selectmode' option is set by the |:behave| command.
6454
6455 *'sessionoptions'* *'ssop'*
6456'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006457 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006459 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 feature}
6461 Changes the effect of the |:mksession| command. It is a comma
6462 separated list of words. Each word enables saving and restoring
6463 something:
6464 word save and restore ~
6465 blank empty windows
6466 buffers hidden and unloaded buffers, not just those in windows
6467 curdir the current directory
6468 folds manually created folds, opened/closed folds and local
6469 fold options
6470 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006471 and contain at least one lowercase letter. Only
6472 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 help the help window
6474 localoptions options and mappings local to a window or buffer (not
6475 global values for local options)
6476 options all options and mappings (also global values for local
6477 options)
6478 resize size of the Vim window: 'lines' and 'columns'
6479 sesdir the directory in which the session file is located
6480 will become the current directory (useful with
6481 projects accessed over a network from different
6482 systems)
6483 slash backslashes in file names replaced with forward
6484 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006485 tabpages all tab pages; without this only the current tab page
6486 is restored, so that you can make a session for each
6487 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006488 terminal include terminal windows where the command can be
6489 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 unix with Unix end-of-line format (single <NL>), even when
6491 on Windows or DOS
6492 winpos position of the whole Vim window
6493 winsize window sizes
6494
6495 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006496 When neither "curdir" nor "sesdir" is included, file names are stored
6497 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 "slash" and "unix" are useful on Windows when sharing session files
6499 with Unix. The Unix version of Vim cannot source dos format scripts,
6500 but the Windows version of Vim can source unix format scripts.
6501
6502 *'shell'* *'sh'* *E91*
Bram Moolenaar95a9dd12019-12-19 22:12:03 +01006503'shell' 'sh' string (default $SHELL or "sh", Win32: "cmd.exe")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 global
6505 Name of the shell to use for ! and :! commands. When changing the
6506 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6507 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006508 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006509 See |option-backslash| about including spaces and backslashes.
6510 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006511
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006512 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006513 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6515< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006516 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006518 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006520 Example with escaped space (Vim will do this when initializing the
6521 option from $SHELL): >
6522 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006523< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006524 backslashes are consumed by `:set`.
6525
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 Under MS-Windows, when the executable ends in ".com" it must be
6527 included. Thus setting the shell to "command.com" or "4dos.com"
6528 works, but "command" and "4dos" do not work for all commands (e.g.,
6529 filtering).
6530 For unknown reasons, when using "4dos.com" the current directory is
6531 changed to "C:\". To avoid this set 'shell' like this: >
6532 :set shell=command.com\ /c\ 4dos
6533< This option cannot be set from a |modeline| or in the |sandbox|, for
6534 security reasons.
6535
6536 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006537'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006538 Win32, when 'shell' does not contain "sh"
6539 somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
Bram Moolenaar8024f932020-01-14 19:29:13 +01006542 "bash.exe -c ls" or "cmd.exe /c dir". For MS-Windows, the default is
6543 set according to the value of 'shell', to reduce the need to set this
6544 option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006545 On Unix it can have more than one flag. Each white space separated
6546 part is passed as an argument to the shell command.
6547 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006548 Also see |dos-shell| for MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 This option cannot be set from a |modeline| or in the |sandbox|, for
6550 security reasons.
6551
6552 *'shellpipe'* *'sp'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01006553'shellpipe' 'sp' string (default ">", ">%s 2>&1", "| tee", "|& tee" or
6554 "2>&1| tee")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 {not available when compiled without the |+quickfix|
6557 feature}
6558 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006559 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 including spaces and backslashes.
6561 The name of the temporary file can be represented by "%s" if necessary
6562 (the file name is appended automatically if no %s appears in the value
6563 of this option).
Bram Moolenaar8024f932020-01-14 19:29:13 +01006564 For the Amiga the default is ">". For MS-Windows the default is
6565 ">%s 2>&1". The output is directly saved in a file and not echoed to
6566 the screen.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 For Unix the default it "| tee". The stdout of the compiler is saved
6568 in a file and echoed to the screen. If the 'shell' option is "csh" or
6569 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006570 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6571 "bash" or "fish" the default becomes "2>&1| tee". This means that
6572 stderr is also included. Before using the 'shell' option a path is
6573 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 The initialization of this option is done after reading the ".vimrc"
6575 and the other initializations, so that when the 'shell' option is set
6576 there, the 'shellpipe' option changes automatically, unless it was
6577 explicitly set before.
6578 When 'shellpipe' is set to an empty string, no redirection of the
6579 ":make" output will be done. This is useful if you use a 'makeprg'
6580 that writes to 'makeef' by itself. If you want no piping, but do
6581 want to include the 'makeef', set 'shellpipe' to a single space.
6582 Don't forget to precede the space with a backslash: ":set sp=\ ".
6583 In the future pipes may be used for filtering and this option will
6584 become obsolete (at least for Unix).
6585 This option cannot be set from a |modeline| or in the |sandbox|, for
6586 security reasons.
6587
6588 *'shellquote'* *'shq'*
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006589'shellquote' 'shq' string (default: ""; Win32, when 'shell'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 contains "sh" somewhere: "\"")
6591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 Quoting character(s), put around the command passed to the shell, for
6593 the "!" and ":!" commands. The redirection is kept outside of the
6594 quoting. See 'shellxquote' to include the redirection. It's
6595 probably not useful to set both options.
6596 This is an empty string by default. Only known to be useful for
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006597 third-party shells on MS-Windows-like systems, such as the MKS Korn
6598 Shell or bash, where it should be "\"". The default is adjusted
6599 according the value of 'shell', to reduce the need to set this option
6600 by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 This option cannot be set from a |modeline| or in the |sandbox|, for
6602 security reasons.
6603
6604 *'shellredir'* *'srr'*
6605'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6606 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 String to be used to put the output of a filter command in a temporary
6608 file. See also |:!|. See |option-backslash| about including spaces
6609 and backslashes.
6610 The name of the temporary file can be represented by "%s" if necessary
6611 (the file name is appended automatically if no %s appears in the value
6612 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006613 The default is ">". For Unix, if the 'shell' option is "csh" or
6614 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006615 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6616 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6617 stderr is also included. For Win32, the Unix checks are done and
6618 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6619 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 The initialization of this option is done after reading the ".vimrc"
6621 and the other initializations, so that when the 'shell' option is set
6622 there, the 'shellredir' option changes automatically unless it was
6623 explicitly set before.
6624 In the future pipes may be used for filtering and this option will
6625 become obsolete (at least for Unix).
6626 This option cannot be set from a |modeline| or in the |sandbox|, for
6627 security reasons.
6628
6629 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6630'shellslash' 'ssl' boolean (default off)
6631 global
Bram Moolenaar6f345a12019-12-17 21:27:18 +01006632 {only for MS-Windows}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 When set, a forward slash is used when expanding file names. This is
Bram Moolenaar8024f932020-01-14 19:29:13 +01006634 useful when a Unix-like shell is used instead of cmd.exe. Backward
6635 slashes can still be typed, but they are changed to forward slashes by
6636 Vim.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 Note that setting or resetting this option has no effect for some
6638 existing file names, thus this option needs to be set before opening
6639 any file for best results. This might change in the future.
6640 'shellslash' only works when a backslash can be used as a path
6641 separator. To test if this is so use: >
6642 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006643< Also see 'completeslash'.
6644
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006645 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6646'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6647 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006648 When on, use temp files for shell commands. When off use a pipe.
6649 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006650 Currently a pipe is only supported on Unix and MS-Windows 2K and
6651 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006652 :if has("filterpipe")
6653< The advantage of using a pipe is that nobody can read the temp file
6654 and the 'shell' command does not need to support redirection.
6655 The advantage of using a temp file is that the file type and encoding
6656 can be detected.
6657 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6658 |FilterWritePost| autocommands event are not triggered when
6659 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006660 The `system()` function does not respect this option and always uses
6661 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006662 NOTE: This option is set to the Vim default value when 'compatible'
6663 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006664
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 *'shelltype'* *'st'*
6666'shelltype' 'st' number (default 0)
6667 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006668 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 On the Amiga this option influences the way how the commands work
6670 which use a shell.
6671 0 and 1: always use the shell
6672 2 and 3: use the shell only to filter lines
6673 4 and 5: use shell only for ':sh' command
6674 When not using the shell, the command is executed directly.
6675
6676 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6677 1 and 3: use "shell cmd" to start external commands
6678
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006679 *'shellxescape'* *'sxe'*
6680'shellxescape' 'sxe' string (default: "";
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006681 for MS-Windows: "\"&|<>()@^")
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006682 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006683 When 'shellxquote' is set to "(" then the characters listed in this
6684 option will be escaped with a '^' character. This makes it possible
6685 to execute most external commands with cmd.exe.
6686
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 *'shellxquote'* *'sxq'*
6688'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006689 for Win32, when 'shell' is cmd.exe: "("
6690 for Win32, when 'shell' contains "sh"
6691 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 for Unix, when using system(): "\"")
6693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 Quoting character(s), put around the command passed to the shell, for
6695 the "!" and ":!" commands. Includes the redirection. See
6696 'shellquote' to exclude the redirection. It's probably not useful
6697 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006698 When the value is '(' then ')' is appended. When the value is '"('
6699 then ')"' is appended.
6700 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006701 This is an empty string by default on most systems, but is known to be
6702 useful for on Win32 version, either for cmd.exe which automatically
6703 strips off the first and last quote on a command, or 3rd-party shells
6704 such as the MKS Korn Shell or bash, where it should be "\"". The
6705 default is adjusted according the value of 'shell', to reduce the need
6706 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 This option cannot be set from a |modeline| or in the |sandbox|, for
6708 security reasons.
6709
6710 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6711'shiftround' 'sr' boolean (default off)
6712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 Round indent to multiple of 'shiftwidth'. Applies to > and <
6714 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6715 a multiple of 'shiftwidth' (this is Vi compatible).
6716 NOTE: This option is reset when 'compatible' is set.
6717
6718 *'shiftwidth'* *'sw'*
6719'shiftwidth' 'sw' number (default 8)
6720 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006721 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006723 When zero the 'ts' value will be used. Use the |shiftwidth()|
6724 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725
6726 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006727'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6728 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 This option helps to avoid all the |hit-enter| prompts caused by file
6731 messages, for example with CTRL-G, and to avoid some other messages.
6732 It is a list of flags:
6733 flag meaning when present ~
6734 f use "(3 of 5)" instead of "(file 3 of 5)"
6735 i use "[noeol]" instead of "[Incomplete last line]"
Bram Moolenaar3f40ce72020-07-05 14:10:13 +02006736 l use "999L, 888B" instead of "999 lines, 888 bytes"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 m use "[+]" instead of "[Modified]"
6738 n use "[New]" instead of "[New File]"
6739 r use "[RO]" instead of "[readonly]"
6740 w use "[w]" instead of "written" for file write message
6741 and "[a]" instead of "appended" for ':w >> file' command
6742 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6743 "[unix format]" and "[mac]" instead of "[mac format]".
6744 a all of the above abbreviations
6745
6746 o overwrite message for writing a file with subsequent message
6747 for reading a file (useful for ":wn" or when 'autowrite' on)
6748 O message for reading a file overwrites any previous message.
6749 Also for quickfix message (e.g., ":cn").
6750 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006751 hit TOP, continuing at BOTTOM" messages; when using the search
6752 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 t truncate file message at the start if it is too long to fit
6754 on the command-line, "<" will appear in the left most column.
6755 Ignored in Ex mode.
6756 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006757 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 Ignored in Ex mode.
6759 W don't give "written" or "[w]" when writing a file
6760 A don't give the "ATTENTION" message when an existing swap file
6761 is found.
6762 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006763 c don't give |ins-completion-menu| messages. For example,
6764 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6765 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006766 q use "recording" instead of "recording @a"
6767 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006768 was used for the command; note that this also affects messages
6769 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006770 S do not show search count message when searching, e.g.
6771 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772
6773 This gives you the opportunity to avoid that a change between buffers
6774 requires you to hit <Enter>, but still gives as useful a message as
6775 possible for the space available. To get the whole message that you
6776 would have got with 'shm' empty, use ":file!"
6777 Useful values:
6778 shm= No abbreviation of message.
6779 shm=a Abbreviation, but no loss of information.
6780 shm=at Abbreviation, and truncate message when necessary.
6781
6782 NOTE: This option is set to the Vi default value when 'compatible' is
6783 set and to the Vim default value when 'compatible' is reset.
6784
6785 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6786'shortname' 'sn' boolean (default off)
6787 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 Filenames are assumed to be 8 characters plus one extension of 3
6789 characters. Multiple dots in file names are not allowed. When this
6790 option is on, dots in file names are replaced with underscores when
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01006791 adding an extension (".~" or ".swp"). This option is useful
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 when editing files on an MS-DOS compatible filesystem, e.g., messydos
Bram Moolenaarade0d392020-01-21 22:33:58 +01006793 or crossdos.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794
6795 *'showbreak'* *'sbr'* *E595*
6796'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006797 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006798 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 feature}
6800 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006801 values are "> " or "+++ ": >
6802 :set showbreak=>\
6803< Note the backslash to escape the trailing space. It's easier like
6804 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006805 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006806< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 comma (in a future version the comma might be used to separate the
6808 part that is shown at the end and at the start of a line).
6809 The characters are highlighted according to the '@' flag in
6810 'highlight'.
6811 Note that tabs after the showbreak will be displayed differently.
6812 If you want the 'showbreak' to appear in between line numbers, add the
6813 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006814 A window-local value overrules a global value. If the global value is
6815 set and you want no value in the current window use NONE: >
6816 :setlocal showbreak=NONE
6817<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006819'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6820 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 {not available when compiled without the
6823 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006824 Show (partial) command in the last line of the screen. Set this
6825 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 In Visual mode the size of the selected area is shown:
6827 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006828 If the number of bytes is different it is also displayed: "2-6"
6829 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006831 - When selecting a block, the size in screen characters:
6832 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 NOTE: This option is set to the Vi default value when 'compatible' is
6834 set and to the Vim default value when 'compatible' is reset.
6835
6836 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6837'showfulltag' 'sft' boolean (default off)
6838 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 When completing a word in insert mode (see |ins-completion|) from the
6840 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006841 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 matched a C function, you can see a template for what arguments are
6843 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006844 Note that this doesn't work well together with having "longest" in
6845 'completeopt', because the completion from the search pattern may not
6846 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847
6848 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6849'showmatch' 'sm' boolean (default off)
6850 global
6851 When a bracket is inserted, briefly jump to the matching one. The
6852 jump is only done if the match can be seen on the screen. The time to
6853 show the match can be set with 'matchtime'.
6854 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006855 seen or not).
6856 This option is reset when 'paste' is set and restored when 'paste' is
6857 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 When the 'm' flag is not included in 'cpoptions', typing a character
6859 will immediately move the cursor back to where it belongs.
6860 See the "sm" field in 'guicursor' for setting the cursor shape and
6861 blinking when showing the match.
6862 The 'matchpairs' option can be used to specify the characters to show
6863 matches for. 'rightleft' and 'revins' are used to look for opposite
6864 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006865 Also see the matchparen plugin for highlighting the match when moving
6866 around |pi_paren.txt|.
6867 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868
6869 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6870'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6871 global
6872 If in Insert, Replace or Visual mode put a message on the last line.
6873 Use the 'M' flag in 'highlight' to set the type of highlighting for
6874 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006875 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 doesn't mean XIM is really active, especially when 'imactivatekey' is
6877 not set.
6878 NOTE: This option is set to the Vi default value when 'compatible' is
6879 set and to the Vim default value when 'compatible' is reset.
6880
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006881 *'showtabline'* *'stal'*
6882'showtabline' 'stal' number (default 1)
6883 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006884 The value of this option specifies when the line with tab page labels
6885 will be displayed:
6886 0: never
6887 1: only if there are at least two tab pages
6888 2: always
6889 This is both for the GUI and non-GUI implementation of the tab pages
6890 line.
6891 See |tab-page| for more information about tab pages.
6892
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 *'sidescroll'* *'ss'*
6894'sidescroll' 'ss' number (default 0)
6895 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 The minimal number of columns to scroll horizontally. Used only when
6897 the 'wrap' option is off and the cursor is moved off of the screen.
6898 When it is zero the cursor will be put in the middle of the screen.
6899 When using a slow terminal set it to a large number or 0. When using
6900 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6901 commands.
6902
6903 *'sidescrolloff'* *'siso'*
6904'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006905 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006907 right of the cursor if 'nowrap' is set. Setting this option to a
6908 value greater than 0 while having |'sidescroll'| also at a non-zero
6909 value makes some context visible in the line you are scrolling in
6910 horizontally (except at beginning of the line). Setting this option
6911 to a large value (like 999) has the effect of keeping the cursor
6912 horizontally centered in the window, as long as one does not come too
6913 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006914 After using the local value, go back the global value with one of
6915 these two: >
6916 setlocal sidescrolloff<
6917 setlocal sidescrolloff=-1
6918< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919
6920 Example: Try this together with 'sidescroll' and 'listchars' as
6921 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006922 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923
6924 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6925 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006926<
6927 *'signcolumn'* *'scl'*
6928'signcolumn' 'scl' string (default "auto")
6929 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006930 {not available when compiled without the |+signs|
6931 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006932 Whether or not to draw the signcolumn. Valid values are:
6933 "auto" only when there is a sign to display
6934 "no" never
6935 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006936 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006937 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938
6939
6940 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6941'smartcase' 'scs' boolean (default off)
6942 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 Override the 'ignorecase' option if the search pattern contains upper
6944 case characters. Only used when the search pattern is typed and
6945 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006946 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6948 recalling the search pattern from history and hitting <Enter>.
6949 NOTE: This option is reset when 'compatible' is set.
6950
6951 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6952'smartindent' 'si' boolean (default off)
6953 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954 {not available when compiled without the
6955 |+smartindent| feature}
6956 Do smart autoindenting when starting a new line. Works for C-like
6957 programs, but can also be used for other languages. 'cindent' does
6958 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006959 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006960 setting 'si' has no effect. 'indentexpr' is a more advanced
6961 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 Normally 'autoindent' should also be on when using 'smartindent'.
6963 An indent is automatically inserted:
6964 - After a line ending in '{'.
6965 - After a line starting with a keyword from 'cinwords'.
6966 - Before a line starting with '}' (only with the "O" command).
6967 When typing '}' as the first character in a new line, that line is
6968 given the same indent as the matching '{'.
6969 When typing '#' as the first character in a new line, the indent for
6970 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006971 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6973 When using the ">>" command, lines starting with '#' are not shifted
6974 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006975 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006976 This option is reset when 'paste' is set and restored when 'paste' is
6977 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978
6979 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6980'smarttab' 'sta' boolean (default off)
6981 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006983 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6984 <BS> will delete a 'shiftwidth' worth of space at the start of the
6985 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006986 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006987 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6988 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006989 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006991 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006992 This option is reset when 'paste' is set and restored when 'paste' is
6993 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 NOTE: This option is reset when 'compatible' is set.
6995
6996 *'softtabstop'* *'sts'*
6997'softtabstop' 'sts' number (default 0)
6998 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 Number of spaces that a <Tab> counts for while performing editing
7000 operations, like inserting a <Tab> or using <BS>. It "feels" like
7001 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7002 used. This is useful to keep the 'ts' setting at its standard value
7003 of 8, while being able to edit like it is set to 'sts'. However,
7004 commands like "x" still work on the actual characters.
7005 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007006 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007007 'softtabstop' is set to 0 when the 'paste' option is set and restored
7008 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7010 spaces is minimized by using <Tab>s.
7011 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7012 set.
7013 NOTE: This option is set to 0 when 'compatible' is set.
7014
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007015 If Vim is compiled with the |+vartabs| feature then the value of
7016 'softtabstop' will be ignored if |'varsofttabstop'| is set to
7017 anything other than an empty string.
7018
Bram Moolenaar217ad922005-03-20 22:37:15 +00007019 *'spell'* *'nospell'*
7020'spell' boolean (default off)
7021 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00007022 {not available when compiled without the |+syntax|
7023 feature}
7024 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007025 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007026
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007027 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007028'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007029 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007030 {not available when compiled without the |+syntax|
7031 feature}
7032 Pattern to locate the end of a sentence. The following word will be
7033 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007034 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007035 When this check is not wanted make this option empty.
7036 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007037 Be careful with special characters, see |option-backslash| about
7038 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007039 To set this option automatically depending on the language, see
7040 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007041
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007042 *'spellfile'* *'spf'*
7043'spellfile' 'spf' string (default empty)
7044 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007045 {not available when compiled without the |+syntax|
7046 feature}
7047 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007048 commands. It must end in ".{encoding}.add". You need to include the
7049 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007050 *E765*
7051 It may also be a comma separated list of names. A count before the
7052 |zg| and |zw| commands can be used to access each. This allows using
7053 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007054 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007055 you: Using the first directory in 'runtimepath' that is writable. If
7056 there is no "spell" directory yet it will be created. For the file
7057 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007058 ignoring the region.
7059 The resulting ".spl" file will be used for spell checking, it does not
7060 have to appear in 'spelllang'.
7061 Normally one file is used for all regions, but you can add the region
7062 name if you want to. However, it will then only be used when
7063 'spellfile' is set to it, for entries in 'spelllang' only files
7064 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007065 This option cannot be set from a |modeline| or in the |sandbox|, for
7066 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007067
Bram Moolenaar217ad922005-03-20 22:37:15 +00007068 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007069'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007070 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007071 {not available when compiled without the |+syntax|
7072 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007073 A comma separated list of word list names. When the 'spell' option is
7074 on spellchecking will be done for these languages. Example: >
7075 set spelllang=en_us,nl,medical
7076< This means US English, Dutch and medical words are recognized. Words
7077 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007078 The word list name must consist of alphanumeric characters, a dash or
7079 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007080 recommended to separate the two letter language name from a
7081 specification. Thus "en-rare" is used for rare English words.
7082 A region name must come last and have the form "_xx", where "xx" is
7083 the two-letter, lower case region name. You can use more than one
7084 region by listing them: "en_us,en_ca" supports both US and Canadian
7085 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007086 Britain. (Note: currently en_au and en_nz dictionaries are older than
7087 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007088 If the name "cjk" is included East Asian characters are excluded from
7089 spell checking. This is useful when editing text that also has Asian
7090 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007091 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007092 As a special case the name of a .spl file can be given as-is. The
7093 first "_xx" in the name is removed and used as the region name
7094 (_xx is an underscore, two letters and followed by a non-letter).
7095 This is mainly for testing purposes. You must make sure the correct
7096 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007097 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007098 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7099 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007100 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007101
Bram Moolenaar98692072006-02-04 00:57:42 +00007102 If the |spellfile.vim| plugin is active and you use a language name
7103 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7104 will ask you if you want to download the file.
7105
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007106 After this option has been set successfully, Vim will source the files
7107 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007108 up to the first character that is not an ASCII letter or number and
7109 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007110
Bram Moolenaar362b44b2020-06-10 21:47:00 +02007111 *'spelloptions'* *'spo'*
7112'spelloptions' 'spo' string (default "")
7113 local to buffer
7114 {not available when compiled without the |+syntax|
7115 feature}
7116 A comma separated list of options for spell checking:
7117 camel When a word is CamelCased, assume "Cased" is a
7118 separate word: every upper-case character in a word
7119 that comes after a lower case character indicates the
7120 start of a new word.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007121
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007122 *'spellsuggest'* *'sps'*
7123'spellsuggest' 'sps' string (default "best")
7124 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007125 {not available when compiled without the |+syntax|
7126 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007127 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007128 the |spellsuggest()| function. This is a comma-separated list of
7129 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007130
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007131 best Internal method that works best for English. Finds
7132 changes like "fast" and uses a bit of sound-a-like
7133 scoring to improve the ordering.
7134
7135 double Internal method that uses two methods and mixes the
7136 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007137 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007138 word. That only works when the language specifies
7139 sound folding. Can be slow and doesn't always give
7140 better results.
7141
7142 fast Internal method that only checks for simple changes:
7143 character inserts/deletes/swaps. Works well for
7144 simple typing mistakes.
7145
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007146 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007147 Not used for |spellsuggest()|. The number of
7148 suggestions is never more than the value of 'lines'
7149 minus two.
7150
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007151 file:{filename} Read file {filename}, which must have two columns,
7152 separated by a slash. The first column contains the
7153 bad word, the second column the suggested good word.
7154 Example:
7155 theribal/terrible ~
7156 Use this for common mistakes that do not appear at the
7157 top of the suggestion list with the internal methods.
7158 Lines without a slash are ignored, use this for
7159 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007160 The word in the second column must be correct,
7161 otherwise it will not be used. Add the word to an
7162 ".add" file if it is currently flagged as a spelling
7163 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007164 The file is used for all languages.
7165
7166 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7167 trouble with spaces. |v:val| holds the badly spelled
7168 word. The expression must evaluate to a List of
7169 Lists, each with a suggestion and a score.
7170 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007171 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007172 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007173 internal methods use. A lower score is better.
7174 This may invoke |spellsuggest()| if you temporarily
7175 set 'spellsuggest' to exclude the "expr:" part.
7176 Errors are silently ignored, unless you set the
7177 'verbose' option to a non-zero value.
7178
7179 Only one of "best", "double" or "fast" may be used. The others may
7180 appear several times in any order. Example: >
7181 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7182<
7183 This option cannot be set from a |modeline| or in the |sandbox|, for
7184 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007185
7186
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7188'splitbelow' 'sb' boolean (default off)
7189 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 When on, splitting a window will put the new window below the current
7191 one. |:split|
7192
7193 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7194'splitright' 'spr' boolean (default off)
7195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 When on, splitting a window will put the new window right of the
7197 current one. |:vsplit|
7198
7199 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7200'startofline' 'sol' boolean (default on)
7201 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007203 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007204 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007205 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 with a linewise operator, with "%" with a count and to buffer changing
7207 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7208 only has a line number, e.g., ":25" or ":+".
7209 In case of buffer changing commands the cursor is placed at the column
7210 where it was the last time the buffer was edited.
7211 NOTE: This option is set when 'compatible' is set.
7212
Bram Moolenaar00654022011-02-25 14:42:19 +01007213 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007215 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 {not available when compiled without the |+statusline|
7217 feature}
7218 When nonempty, this option determines the content of the status line.
7219 Also see |status-line|.
7220
7221 The option consists of printf style '%' items interspersed with
7222 normal text. Each status line item is of the form:
7223 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007224 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007225 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226
Bram Moolenaar238a5642006-02-21 22:12:05 +00007227 When the option starts with "%!" then it is used as an expression,
7228 evaluated and the result is used as the option value. Example: >
7229 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007230< The *g:statusline_winid* variable will be set to the |window-ID| of the
7231 window that the status line belongs to.
7232 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007233 Note that the "%!" expression is evaluated in the context of the
7234 current window and buffer, while %{} items are evaluated in the
7235 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007236
7237 When there is error while evaluating the option then it will be made
7238 empty to avoid further errors. Otherwise screen updating would loop.
7239
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 Note that the only effect of 'ruler' when this option is set (and
7241 'laststatus' is 2) is controlling the output of |CTRL-G|.
7242
7243 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007244 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007246 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 minwid Minimum width of the item, padding as set by '-' & '0'.
7248 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007249 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 on the left for text items. Numeric items will be
7251 shifted down to maxwid-2 digits followed by '>'number
7252 where number is the amount of missing digits, much like
7253 an exponential notation.
7254 item A one letter code as described below.
7255
7256 Following is a description of the possible statusline items. The
7257 second character in "item" is the type:
7258 N for number
7259 S for string
7260 F for flags as described below
7261 - not applicable
7262
7263 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007264 f S Path to the file in the buffer, as typed or relative to current
7265 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 F S Full path to the file in the buffer.
7267 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007268 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007270 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007272 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007274 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007276 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007278 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7280 being used: "<keymap>"
7281 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007282 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 B N As above, in hexadecimal.
7284 o N Byte number in file of byte under cursor, first byte is 1.
7285 Mnemonic: Offset from start of file (with one added)
7286 {not available when compiled without |+byte_offset| feature}
7287 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007288 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 l N Line number.
7290 L N Number of lines in buffer.
7291 c N Column number.
7292 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007293 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 p N Percentage through file in lines as in |CTRL-G|.
7295 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007296 percentage described for 'ruler'. Always 3 in length, unless
7297 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007298 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007300 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007301 Note that there is no '%' before the closing '}'. The
7302 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007303 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 ( - Start of item group. Can be used for setting the width and
7305 alignment of a section. Must be followed by %) somewhere.
7306 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007307 T N For 'tabline': start of tab page N label. Use %T after the last
7308 label. This information is used for mouse clicks.
7309 X N For 'tabline': start of close tab N label. Use %X after the
7310 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7311 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 < - Where to truncate line if too long. Default is at the start.
7313 No width fields allowed.
7314 = - Separation point between left and right aligned items.
7315 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007316 # - Set highlight group. The name must follow and then a # again.
7317 Thus use %#HLname# for highlight group HLname. The same
7318 highlighting is used, also for the statusline of non-current
7319 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007321 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 The difference between User{N} and StatusLine will be applied
7323 to StatusLineNC for the statusline of non-current windows.
7324 The number N must be between 1 and 9. See |hl-User1..9|
7325
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007326 When displaying a flag, Vim removes the leading comma, if any, when
7327 that flag comes right after plaintext. This will make a nice display
7328 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329
Bram Moolenaar582fd852005-03-28 20:58:01 +00007330 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 not set) and a minwid is not set for the group, the whole group will
7332 become empty. This will make a group like the following disappear
7333 completely from the statusline when none of the flags are set. >
7334 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007335< Beware that an expression is evaluated each and every time the status
7336 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007337 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
Bram Moolenaarade0d392020-01-21 22:33:58 +01007338 While evaluating %{} the current buffer and current window will be set
7339 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007340 currently being drawn. The expression will evaluate in this context.
7341 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7342 real current buffer and "g:actual_curwin" to the |window-ID| of the
7343 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007344
Bram Moolenaar30b65812012-07-12 22:01:11 +02007345 The 'statusline' option will be evaluated in the |sandbox| if set from
7346 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007347 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007348
7349 It is not allowed to change text or jump to another window while
7350 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351
7352 If the statusline is not updated when you want it (e.g., after setting
7353 a variable that's used in an expression), you can force an update by
7354 setting an option without changing its value. Example: >
7355 :let &ro = &ro
7356
7357< A result of all digits is regarded a number for display purposes.
7358 Otherwise the result is taken as flag text and applied to the rules
7359 described above.
7360
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007361 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007363 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364
7365 Examples:
7366 Emulate standard status line with 'ruler' set >
7367 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7368< Similar, but add ASCII value of char under the cursor (like "ga") >
7369 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7370< Display byte count and byte value, modified flag in red. >
7371 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7372 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7373< Display a ,GZ flag if a compressed file is loaded >
7374 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7375< In the |:autocmd|'s: >
7376 :let b:gzflag = 1
7377< And: >
7378 :unlet b:gzflag
7379< And define this function: >
7380 :function VarExists(var, val)
7381 : if exists(a:var) | return a:val | else | return '' | endif
7382 :endfunction
7383<
7384 *'suffixes'* *'su'*
7385'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 Files with these suffixes get a lower priority when multiple files
7388 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007389 suffixes. Spaces after the comma are ignored. A dot is also seen as
7390 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 separator, precede it with a backslash (see |option-backslash| about
7392 including spaces and backslashes).
7393 See 'wildignore' for completely ignoring files.
7394 The use of |:set+=| and |:set-=| is preferred when adding or removing
7395 suffixes from the list. This avoids problems when a future version
7396 uses another default.
7397
7398 *'suffixesadd'* *'sua'*
7399'suffixesadd' 'sua' string (default "")
7400 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 {not available when compiled without the
7402 |+file_in_path| feature}
7403 Comma separated list of suffixes, which are used when searching for a
7404 file for the "gf", "[I", etc. commands. Example: >
7405 :set suffixesadd=.java
7406<
7407 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7408'swapfile' 'swf' boolean (default on)
7409 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007410 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 swapfile is not wanted for a specific buffer. For example, with
7412 confidential information that even root must not be able to access.
7413 Careful: All text will be in memory:
7414 - Don't use this for big files.
7415 - Recovery will be impossible!
7416 A swapfile will only be present when |'updatecount'| is non-zero and
7417 'swapfile' is set.
7418 When 'swapfile' is reset, the swap file for the current buffer is
7419 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7420 non-zero, a swap file is immediately created.
7421 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007422 If you want to open a new buffer without creating a swap file for it,
7423 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007424 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425
7426 This option is used together with 'bufhidden' and 'buftype' to
7427 specify special kinds of buffers. See |special-buffers|.
7428
7429 *'swapsync'* *'sws'*
7430'swapsync' 'sws' string (default "fsync")
7431 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007433 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 When this option is empty parts of the swap file may be in memory and
7435 not written to disk. When the system crashes you may lose more work.
7436 On Unix the system does a sync now and then without Vim asking for it,
7437 so the disadvantage of setting this option off is small. On some
7438 systems the swap file will not be written at all. For a unix system
7439 setting it to "sync" will use the sync() call instead of the default
7440 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007441 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442
7443 *'switchbuf'* *'swb'*
7444'switchbuf' 'swb' string (default "")
7445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 This option controls the behavior when switching between buffers.
7447 Possible values (comma separated list):
7448 useopen If included, jump to the first open window that
7449 contains the specified buffer (if there is one).
7450 Otherwise: Do not examine other windows.
7451 This setting is checked with |quickfix| commands, when
7452 jumping to errors (":cc", ":cn", "cp", etc.). It is
7453 also used in all buffer related split commands, for
7454 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007455 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007456 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007458 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007459 Otherwise: do not split, use current window (when used
7460 in the quickfix window: the previously used window or
7461 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007462 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007463 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007464 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007465 uselast If included, jump to the previously used window when
7466 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007468 *'synmaxcol'* *'smc'*
7469'synmaxcol' 'smc' number (default 3000)
7470 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007471 {not available when compiled without the |+syntax|
7472 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007473 Maximum column in which to search for syntax items. In long lines the
7474 text after this column is not highlighted and following lines may not
7475 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007476 This helps to avoid very slow redrawing for an XML file that is one
7477 long line.
7478 Set to zero to remove the limit.
7479
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 *'syntax'* *'syn'*
7481'syntax' 'syn' string (default empty)
7482 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483 {not available when compiled without the |+syntax|
7484 feature}
7485 When this option is set, the syntax with this name is loaded, unless
7486 syntax highlighting has been switched off with ":syntax off".
7487 Otherwise this option does not always reflect the current syntax (the
7488 b:current_syntax variable does).
7489 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007490 not automatically recognized. Example, in an IDL file:
7491 /* vim: set syntax=idl : */ ~
7492 When a dot appears in the value then this separates two filetype
7493 names. Example:
7494 /* vim: set syntax=c.doxygen : */ ~
7495 This will use the "c" syntax first, then the "doxygen" syntax.
7496 Note that the second one must be prepared to be loaded as an addition,
7497 otherwise it will be skipped. More than one dot may appear.
7498 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 :set syntax=OFF
7500< To switch syntax highlighting on according to the current value of the
7501 'filetype' option: >
7502 :set syntax=ON
7503< What actually happens when setting the 'syntax' option is that the
7504 Syntax autocommand event is triggered with the value as argument.
7505 This option is not copied to another buffer, independent of the 's' or
7506 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007507 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007509 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007510'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007511 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007512 When nonempty, this option determines the content of the tab pages
7513 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007514 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007515
7516 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007517 option and only when there is no GUI tab line. When 'e' is in
7518 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007519 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007520
7521 The value is evaluated like with 'statusline'. You can use
7522 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007523 the text to be displayed. Use "%1T" for the first label, "%2T" for
7524 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007525
Bram Moolenaare12bab32019-01-08 22:02:56 +01007526 When changing something that is used in 'tabline' that does not
7527 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007528 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007529
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007530 Keep in mind that only one of the tab pages is the current one, others
7531 are invisible and you can't jump to their windows.
7532
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007533
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007534 *'tabpagemax'* *'tpm'*
7535'tabpagemax' 'tpm' number (default 10)
7536 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007537 Maximum number of tab pages to be opened by the |-p| command line
7538 argument or the ":tab all" command. |tabpage|
7539
7540
7541 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542'tabstop' 'ts' number (default 8)
7543 local to buffer
7544 Number of spaces that a <Tab> in the file counts for. Also see
7545 |:retab| command, and 'softtabstop' option.
7546
7547 Note: Setting 'tabstop' to any other value than 8 can make your file
7548 appear wrong in many places (e.g., when printing it).
7549
7550 There are four main ways to use tabs in Vim:
7551 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7552 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007553 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 behave like a tab appears every 4 (or 3) characters.
7555 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7556 'expandtab'. This way you will always insert spaces. The
7557 formatting will never be messed up when 'tabstop' is changed.
7558 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007559 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 works when using Vim to edit the file.
7561 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7562 'noexpandtab'. This should then work (for initial indents only)
7563 for any tabstop setting that people use. It might be nice to have
7564 tabs after the first non-blank inserted as spaces if you do this
7565 though. Otherwise aligned comments will be wrong when 'tabstop' is
7566 changed.
7567
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007568 If Vim is compiled with the |+vartabs| feature then the value of
7569 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7570 than an empty string.
7571
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7573'tagbsearch' 'tbs' boolean (default on)
7574 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007576 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 searching makes searching for a tag a LOT faster, but a linear search
7578 will find more tags if the tags file wasn't properly sorted.
7579 Vim normally assumes that your tags files are sorted, or indicate that
7580 they are not sorted. Only when this is not the case does the
7581 'tagbsearch' option need to be switched off.
7582
7583 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007584 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 certain files, or retry all files with a linear search. When
7586 'tagbsearch' is off, only a linear search is done.
7587
7588 Linear searching is done anyway, for one file, when Vim finds a line
7589 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007590 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591< [The whitespace before and after the '0' must be a single <Tab>]
7592
7593 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007594 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 instead of a normal tag name, a retry is done with a linear search.
7596 Tags in unsorted tags files, and matches with different case will only
7597 be found in the retry.
7598
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007599 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007600 linear search can be avoided when case is ignored. Use a value of '2'
7601 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7602 sorted with the -f switch to "sort" in most unices, as in the command:
7603 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7604 (at least 5.5) the --sort=foldcase switch can be used for this as
7605 well. Note that case must be folded to uppercase for this to work.
7606
7607 By default, tag searches are case-sensitive. Case is ignored when
7608 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7609 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007610 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7611 'tagcase' is "smart", and the pattern contains only lowercase
7612 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613
7614 When 'tagbsearch' is off, tags searching is slower when a full match
7615 exists, but faster when no full match exists. Tags in unsorted tags
7616 files may only be found with 'tagbsearch' off.
7617 When the tags file is not sorted, or sorted in a wrong way (not on
7618 ASCII byte value), 'tagbsearch' should be off, or the line given above
7619 must be included in the tags file.
7620 This option doesn't affect commands that find all matching tags (e.g.,
7621 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007623 *'tagcase'* *'tc'*
7624'tagcase' 'tc' string (default "followic")
7625 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007626 This option specifies how case is handled when searching the tags
7627 file:
7628 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007629 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007630 ignore Ignore case
7631 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007632 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007633 NOTE: This option is set to the Vi default value when 'compatible' is
7634 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007635
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007636 *'tagfunc'* *'tfu'*
7637'tagfunc' 'tfu' string (default: empty)
7638 local to buffer
7639 {not available when compiled without the |+eval|
7640 feature}
7641 This option specifies a function to be used to perform tag searches.
7642 The function gets the tag pattern and should return a List of matching
7643 tags. See |tag-function| for an explanation of how to write the
7644 function and an example.
7645
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 *'taglength'* *'tl'*
7647'taglength' 'tl' number (default 0)
7648 global
7649 If non-zero, tags are significant up to this number of characters.
7650
7651 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7652'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7653 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007654 If on and using a tags file in another directory, file names in that
7655 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 NOTE: This option is set to the Vi default value when 'compatible' is
7657 set and to the Vim default value when 'compatible' is reset.
7658
7659 *'tags'* *'tag'* *E433*
7660'tags' 'tag' string (default "./tags,tags", when compiled with
7661 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7662 global or local to buffer |global-local|
7663 Filenames for the tag command, separated by spaces or commas. To
7664 include a space or comma in a file name, precede it with a backslash
7665 (see |option-backslash| about including spaces and backslashes).
7666 When a file name starts with "./", the '.' is replaced with the path
7667 of the current file. But only when the 'd' flag is not included in
7668 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7669 |tags-option|.
7670 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007671 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7672 find all files named "tags" below "/lib". The filename itself cannot
7673 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7674 files called "tags?". {not available when compiled without the
7675 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007676 The |tagfiles()| function can be used to get a list of the file names
7677 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7679 files are also supported. They are automatically recognized. The
7680 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7681 differences are ignored (MS-Windows). |emacs-tags|
7682 The use of |:set+=| and |:set-=| is preferred when adding or removing
7683 file names from the list. This avoids problems when a future version
7684 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685
7686 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7687'tagstack' 'tgst' boolean (default on)
7688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 When on, the |tagstack| is used normally. When off, a ":tag" or
7690 ":tselect" command with an argument will not push the tag onto the
7691 tagstack. A following ":tag" without an argument, a ":pop" command or
7692 any other command that uses the tagstack will use the unmodified
7693 tagstack, but does change the pointer to the active entry.
7694 Resetting this option is useful when using a ":tag" command in a
7695 mapping which should not change the tagstack.
7696
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007697 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007698'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007699 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007700 {only available when compiled with the |+tcl/dyn|
7701 feature}
7702 Specifies the name of the Tcl shared library. The default is
7703 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007704 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007705 This option cannot be set from a |modeline| or in the |sandbox|, for
7706 security reasons.
7707
Bram Moolenaar071d4272004-06-13 20:20:40 +00007708 *'term'* *E529* *E530* *E531*
7709'term' string (default is $TERM, if that fails:
7710 in the GUI: "builtin_gui"
7711 on Amiga: "amiga"
Bram Moolenaarb3f74062020-02-26 16:16:53 +01007712 on Haiku: "xterm"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 on Mac: "mac-ansi"
7714 on MiNT: "vt52"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 on Unix: "ansi"
7716 on VMS: "ansi"
7717 on Win 32: "win32")
7718 global
7719 Name of the terminal. Used for choosing the terminal control
7720 characters. Environment variables are expanded |:set_env|.
7721 For example: >
7722 :set term=$TERM
7723< See |termcap|.
7724
7725 *'termbidi'* *'tbidi'*
7726 *'notermbidi'* *'notbidi'*
7727'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7728 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 {only available when compiled with the |+arabic|
7730 feature}
7731 The terminal is in charge of Bi-directionality of text (as specified
7732 by Unicode). The terminal is also expected to do the required shaping
7733 that some languages (such as Arabic) require.
7734 Setting this option implies that 'rightleft' will not be set when
7735 'arabic' is set and the value of 'arabicshape' will be ignored.
7736 Note that setting 'termbidi' has the immediate effect that
7737 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7738 This option is reset when the GUI is started.
7739 For further details see |arabic.txt|.
7740
7741 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007742'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 Macintosh GUI: "macroman")
7744 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 Encoding used for the terminal. This specifies what character
7746 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007747 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007748 display). Except for the Mac when 'macatsui' is off, then
7749 'termencoding' should be "macroman".
Bram Moolenaar4b7cdca2020-01-01 16:18:38 +01007750 *E617* *E950*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007751 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7753 Any attempts to set a different value will be rejected, and an error
7754 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007755 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 because the Win32 system always passes Unicode characters.
7757 When empty, the same encoding is used as for the 'encoding' option.
7758 This is the normal value.
7759 Not all combinations for 'termencoding' and 'encoding' are valid. See
7760 |encoding-table|.
7761 The value for this option must be supported by internal conversions or
7762 iconv(). When this is not possible no conversion will be done and you
7763 will probably experience problems with non-ASCII characters.
7764 Example: You are working with the locale set to euc-jp (Japanese) and
7765 want to edit a UTF-8 file: >
7766 :let &termencoding = &encoding
7767 :set encoding=utf-8
7768< You need to do this when your system has no locale support for UTF-8.
7769
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007770 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007771'termguicolors' 'tgc' boolean (default off)
7772 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007773 {not available when compiled without the
7774 |+termguicolors| feature}
7775 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007776 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007777
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007778 Requires a ISO-8613-3 compatible terminal. If setting this option
7779 does not work (produces a colorless UI) reading |xterm-true-color|
7780 might help.
7781
7782 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7783 is required. Use this check to find out: >
7784 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007785< This requires Vim to be built with the |+vtp| feature.
7786
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007787 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007788 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007789
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007790 *'termwinkey'* *'twk'*
7791'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007792 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007793 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007794 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007795 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007796 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007797< The string must be one key stroke but can be multiple bytes.
7798 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007799 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007800 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007801
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007802 *'termwinscroll'* *'twsl'*
7803'termwinscroll' 'twsl' number (default 10000)
7804 local to buffer
7805 {not available when compiled without the
7806 |+terminal| feature}
7807 Number of scrollback lines to keep. When going over this limit the
7808 first 10% of the scrollback lines are deleted. This is just to reduce
7809 the memory usage. See |Terminal-Normal|.
7810
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007811 *'termwinsize'* *'tws'*
7812'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007813 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007814 Size of the |terminal| window. Format: {rows}x{columns} or
7815 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007816 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007817 - When set with a "x" (e.g., "24x80") the terminal size is not
7818 adjusted to the window size. If the window is smaller only the
7819 top-left part is displayed.
7820 - When set with a "*" (e.g., "10*50") the terminal size follows the
7821 window size, but will not be smaller than the specified rows and/or
7822 columns.
7823 - When rows is zero then use the height of the window.
7824 - When columns is zero then use the width of the window.
7825 - Using "0x0" or "0*0" is the same as empty.
7826
7827 Examples:
7828 "30x0" uses 30 rows and the current window width.
7829 "20*0" uses at least 20 rows and the current window width.
7830 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007831 Note that the command running in the terminal window may still change
7832 the size of the terminal. In that case the Vim window will be
7833 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007834
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007835 *'termwintype'* *'twt'*
7836'termwintype' 'twt' string (default "")
7837 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007838 {only available when compiled with the |terminal|
7839 feature on MS-Windows}
7840 Specify the virtual console (pty) used when opening the terminal
7841 window.
7842
7843 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007844 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007845 "winpty" use winpty, fail if not supported
7846 "conpty" use |ConPTY|, fail if not supported
7847
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007848 |ConPTY| support depends on the platform. Windows 10 October 2018
7849 Update is the first version that supports ConPTY, however it is still
7850 considered unstable. ConPTY might become stable in the next release
7851 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007852 supported then you cannot open a terminal window.
7853
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 *'terse'* *'noterse'*
7855'terse' boolean (default off)
7856 global
7857 When set: Add 's' flag to 'shortmess' option (this makes the message
7858 for a search that hits the start or end of the file not being
7859 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7860 shortens a lot of messages}
7861
7862 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7863'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 This option is obsolete. Use 'fileformats'.
7866 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7867 set to the default value for the current system. When 'textauto' is
7868 reset, 'fileformats' is made empty.
7869 NOTE: This option is set to the Vi default value when 'compatible' is
7870 set and to the Vim default value when 'compatible' is reset.
7871
7872 *'textmode'* *'tx'* *'notextmode'* *'notx'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01007873'textmode' 'tx' boolean (Win32: default on,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 others: default off)
7875 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 This option is obsolete. Use 'fileformat'.
7877 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7878 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7879 "unix".
7880
7881 *'textwidth'* *'tw'*
7882'textwidth' 'tw' number (default 0)
7883 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 Maximum width of text that is being inserted. A longer line will be
7885 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007886 this.
7887 'textwidth' is set to 0 when the 'paste' option is set and restored
7888 when 'paste' is reset.
7889 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007891 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 NOTE: This option is set to 0 when 'compatible' is set.
7893
7894 *'thesaurus'* *'tsr'*
7895'thesaurus' 'tsr' string (default "")
7896 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007897 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007898 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7899
7900 Each line in the file should contain words with similar meaning,
7901 separated by non-keyword characters (white space is preferred).
7902 Maximum line length is 510 bytes.
7903
Bram Moolenaard47d5222018-12-09 20:43:55 +01007904 An English word list was added to this github issue:
7905 https://github.com/vim/vim/issues/629#issuecomment-443293282
7906 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7907 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7908 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007909
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007910 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 after a comma are ignored, otherwise spaces are included in the file
7912 name. See |option-backslash| about using backslashes.
7913 The use of |:set+=| and |:set-=| is preferred when adding or removing
7914 directories from the list. This avoids problems when a future version
7915 uses another default.
7916 Backticks cannot be used in this option for security reasons.
7917
7918 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7919'tildeop' 'top' boolean (default off)
7920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 When on: The tilde command "~" behaves like an operator.
7922 NOTE: This option is reset when 'compatible' is set.
7923
7924 *'timeout'* *'to'* *'notimeout'* *'noto'*
7925'timeout' 'to' boolean (default on)
7926 global
7927 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007928'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 These two options together determine the behavior when part of a
7931 mapped key sequence or keyboard code has been received:
7932
7933 'timeout' 'ttimeout' action ~
7934 off off do not time out
7935 on on or off time out on :mappings and key codes
7936 off on time out on key codes
7937
7938 If both options are off, Vim will wait until either the complete
7939 mapping or key sequence has been received, or it is clear that there
7940 is no mapping or key sequence for the received characters. For
7941 example: if you have mapped "vl" and Vim has received 'v', the next
7942 character is needed to see if the 'v' is followed by an 'l'.
7943 When one of the options is on, Vim will wait for about 1 second for
7944 the next character to arrive. After that the already received
7945 characters are interpreted as single characters. The waiting time can
7946 be changed with the 'timeoutlen' option.
7947 On slow terminals or very busy systems timing out may cause
7948 malfunctioning cursor keys. If both options are off, Vim waits
7949 forever after an entered <Esc> if there are key codes that start
7950 with <Esc>. You will have to type <Esc> twice. If you do not have
7951 problems with key codes, but would like to have :mapped key
7952 sequences not timing out in 1 second, set the 'ttimeout' option and
7953 reset the 'timeout' option.
7954
7955 NOTE: 'ttimeout' is reset when 'compatible' is set.
7956
7957 *'timeoutlen'* *'tm'*
7958'timeoutlen' 'tm' number (default 1000)
7959 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007960
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007962'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 The time in milliseconds that is waited for a key code or mapped key
7965 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7966 when part of a command has been typed.
7967 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7968 different timeout value for key codes is desired set 'ttimeoutlen' to
7969 a non-negative number.
7970
7971 ttimeoutlen mapping delay key code delay ~
7972 < 0 'timeoutlen' 'timeoutlen'
7973 >= 0 'timeoutlen' 'ttimeoutlen'
7974
7975 The timeout only happens when the 'timeout' and 'ttimeout' options
7976 tell so. A useful setting would be >
7977 :set timeout timeoutlen=3000 ttimeoutlen=100
7978< (time out on mapping after three seconds, time out on key codes after
7979 a tenth of a second).
7980
7981 *'title'* *'notitle'*
7982'title' boolean (default off, on when title can be restored)
7983 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 {not available when compiled without the |+title|
7985 feature}
7986 When on, the title of the window will be set to the value of
7987 'titlestring' (if it is not empty), or to:
7988 filename [+=-] (path) - VIM
7989 Where:
7990 filename the name of the file being edited
7991 - indicates the file cannot be modified, 'ma' off
7992 + indicates the file was modified
7993 = indicates the file is read-only
7994 =+ indicates the file is read-only and modified
7995 (path) is the path of the file being edited
7996 - VIM the server name |v:servername| or "VIM"
7997 Only works if the terminal supports setting window titles
7998 (currently Amiga console, Win32 console, all GUI versions and
Bram Moolenaard1caa942020-04-10 22:10:56 +02007999 terminals with a non-empty 't_ts' option - these are Unix xterm and
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8001 *X11*
8002 When Vim was compiled with HAVE_X11 defined, the original title will
8003 be restored if possible. The output of ":version" will include "+X11"
8004 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8005 works for the icon name |'icon'|.
8006 But: When Vim was started with the |-X| argument, restoring the title
8007 will not work (except in the GUI).
8008 If the title cannot be restored, it is set to the value of 'titleold'.
8009 You might want to restore the title outside of Vim then.
8010 When using an xterm from a remote machine you can use this command:
8011 rsh machine_name xterm -display $DISPLAY &
8012 then the WINDOWID environment variable should be inherited and the
8013 title of the window should change back to what it should be after
8014 exiting Vim.
8015
8016 *'titlelen'*
8017'titlelen' number (default 85)
8018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 {not available when compiled without the |+title|
8020 feature}
8021 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008022 title. When the title is longer, only the end of the path name is
8023 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 Using a percentage makes this adapt to the width of the window. But
8025 it won't work perfectly, because the actual number of characters
8026 available also depends on the font used and other things in the title
8027 bar. When 'titlelen' is zero the full path is used. Otherwise,
8028 values from 1 to 30000 percent can be used.
8029 'titlelen' is also used for the 'titlestring' option.
8030
8031 *'titleold'*
8032'titleold' string (default "Thanks for flying Vim")
8033 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 {only available when compiled with the |+title|
8035 feature}
8036 This option will be used for the window title when exiting Vim if the
8037 original title cannot be restored. Only happens if 'title' is on or
8038 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008039 This option cannot be set from a |modeline| or in the |sandbox|, for
8040 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 *'titlestring'*
8042'titlestring' string (default "")
8043 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 {not available when compiled without the |+title|
8045 feature}
8046 When this option is not empty, it will be used for the title of the
8047 window. This happens only when the 'title' option is on.
8048 Only works if the terminal supports setting window titles (currently
8049 Amiga console, Win32 console, all GUI versions and terminals with a
8050 non-empty 't_ts' option).
8051 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008052 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008053
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 When this option contains printf-style '%' items, they will be
8055 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008056 This option cannot be set in a modeline when 'modelineexpr' is off.
8057
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 Example: >
8059 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8060 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8061< The value of 'titlelen' is used to align items in the middle or right
8062 of the available space.
8063 Some people prefer to have the file name first: >
8064 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8065< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008066 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 separating space only when needed.
8068 NOTE: Use of special characters in 'titlestring' may cause the display
8069 to be garbled (e.g., when it contains a CR or NL character).
8070 {not available when compiled without the |+statusline| feature}
8071
8072 *'toolbar'* *'tb'*
8073'toolbar' 'tb' string (default "icons,tooltips")
8074 global
8075 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8076 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008077 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 possible values are:
8079 icons Toolbar buttons are shown with icons.
8080 text Toolbar buttons shown with text.
8081 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008082 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 tooltips Tooltips are active for toolbar buttons.
8084 Tooltips refer to the popup help text which appears after the mouse
8085 cursor is placed over a toolbar button for a brief moment.
8086
8087 If you want the toolbar to be shown with icons as well as text, do the
8088 following: >
8089 :set tb=icons,text
8090< Motif and Athena cannot display icons and text at the same time. They
8091 will show icons if both are requested.
8092
8093 If none of the strings specified in 'toolbar' are valid or if
8094 'toolbar' is empty, this option is ignored. If you want to disable
8095 the toolbar, you need to set the 'guioptions' option. For example: >
8096 :set guioptions-=T
8097< Also see |gui-toolbar|.
8098
8099 *'toolbariconsize'* *'tbis'*
8100'toolbariconsize' 'tbis' string (default "small")
8101 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008102 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008104 tiny Use tiny icons.
8105 small Use small icons (default).
8106 medium Use medium-sized icons.
8107 large Use large icons.
8108 huge Use even larger icons.
8109 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008111 the current theme. Common dimensions are giant=48x48, huge=32x32,
8112 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113
8114 If 'toolbariconsize' is empty, the global default size as determined
8115 by user preferences or the current theme is used.
8116
8117 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8118'ttybuiltin' 'tbi' boolean (default on)
8119 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 When on, the builtin termcaps are searched before the external ones.
8121 When off the builtin termcaps are searched after the external ones.
8122 When this option is changed, you should set the 'term' option next for
8123 the change to take effect, for example: >
8124 :set notbi term=$TERM
8125< See also |termcap|.
8126 Rationale: The default for this option is "on", because the builtin
8127 termcap entries are generally better (many systems contain faulty
8128 xterm entries...).
8129
8130 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8131'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8132 sun-cmd, screen, rxvt, dtterm or
8133 iris-ansi; also on when running Vim in
8134 a DOS console)
8135 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136 Indicates a fast terminal connection. More characters will be sent to
8137 the screen for redrawing, instead of using insert/delete line
8138 commands. Improves smoothness of redrawing when there are multiple
8139 windows and the terminal does not support a scrolling region.
8140 Also enables the extra writing of characters at the end of each screen
8141 line for lines that wrap. This helps when using copy/paste with the
8142 mouse in an xterm and other terminals.
8143
8144 *'ttymouse'* *'ttym'*
8145'ttymouse' 'ttym' string (default depends on 'term')
8146 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 {only in Unix and VMS, doesn't work in the GUI; not
8148 available when compiled without |+mouse|}
8149 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008150 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 *xterm-mouse*
8152 xterm xterm-like mouse handling. The mouse generates
8153 "<Esc>[Mscr", where "scr" is three bytes:
8154 "s" = button state
8155 "c" = column plus 33
8156 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008157 This only works up to 223 columns! See "dec",
8158 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 xterm2 Works like "xterm", but with the xterm reporting the
8160 mouse position while the mouse is dragged. This works
8161 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008162 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 work. See below for how Vim detects this
8164 automatically.
8165 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008166 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008168 for the row and column. No other mouse events are
8169 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008170 *dec-mouse*
8171 dec DEC terminal mouse handling. The mouse generates a
8172 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008173 This is also available for an Xterm, if it was
8174 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 *jsbterm-mouse*
8176 jsbterm JSB term mouse handling.
8177 *pterm-mouse*
8178 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008179 *urxvt-mouse*
8180 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008181 The mouse works only if the terminal supports this
8182 encoding style, but it does not have 223 columns limit
8183 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008184 *sgr-mouse*
8185 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008186 mouse reporting. The mouse works even in columns
8187 beyond 223. This option is backward compatible with
8188 "xterm2" because it can also decode "xterm2" style
8189 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190
8191 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008192 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8193 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8195 recognized, if enabled at compile time. DEC terminal mouse codes
8196 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008197 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8198 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008199 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008200 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8201 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8202 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008203 Additionally, if vim is compiled with the |+termresponse| feature and
8204 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008205 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008207 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8208 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8209 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008210 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8211 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 :set t_RV=
8213<
8214 *'ttyscroll'* *'tsl'*
8215'ttyscroll' 'tsl' number (default 999)
8216 global
8217 Maximum number of lines to scroll the screen. If there are more lines
8218 to scroll the window is redrawn. For terminals where scrolling is
8219 very slow and redrawing is not slow this can be set to a small number,
8220 e.g., 3, to speed up displaying.
8221
8222 *'ttytype'* *'tty'*
8223'ttytype' 'tty' string (default from $TERM)
8224 global
8225 Alias for 'term', see above.
8226
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008227 *'undodir'* *'udir'*
8228'undodir' 'udir' string (default ".")
8229 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008230 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008231 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008232 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008233 "." means using the directory of the file. The undo file name for
8234 "file.txt" is ".file.txt.un~".
8235 For other directories the file name is the full path of the edited
8236 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008237 When writing: The first directory that exists is used. "." always
8238 works, no directories after "." will be used for writing.
8239 When reading all entries are tried to find an undo file. The first
8240 undo file that exists is used. When it cannot be read an error is
8241 given, no further entry is used.
8242 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008243 This option cannot be set from a |modeline| or in the |sandbox|, for
8244 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008245
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008246 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008247'undofile' 'udf' boolean (default off)
8248 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008249 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008250 When on, Vim automatically saves undo history to an undo file when
8251 writing a buffer to a file, and restores undo history from the same
8252 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008253 The directory where the undo file is stored is specified by 'undodir'.
8254 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008255 The undo file is not read when 'undoreload' causes the buffer from
8256 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008257 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008258 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008259
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 *'undolevels'* *'ul'*
Bram Moolenaar8024f932020-01-14 19:29:13 +01008261'undolevels' 'ul' number (default 100, 1000 for Unix, VMS and Win32)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008262 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008264 is kept in memory, higher numbers will cause more memory to be used.
8265 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008266 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8267 itself: >
8268 set ul=0
8269< But you can also get Vi compatibility by including the 'u' flag in
8270 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008271 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008272 Set to -1 for no undo at all. You might want to do this only for the
8273 current buffer: >
8274 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008276
8277 The local value is set to -123456 when the global value is to be used.
8278
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008279 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008281 *'undoreload'* *'ur'*
8282'undoreload' 'ur' number (default 10000)
8283 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008284 Save the whole buffer for undo when reloading it. This applies to the
8285 ":e!" command and reloading for when the buffer changed outside of
8286 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008287 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008288 of lines is smaller than the value of this option.
8289 Set this option to zero to disable undo for a reload.
8290
8291 When saving undo for a reload, any undo file is not read.
8292
8293 Note that this causes the whole buffer to be stored in memory. Set
8294 this option to a lower value if you run out of memory.
8295
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 *'updatecount'* *'uc'*
8297'updatecount' 'uc' number (default: 200)
8298 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 After typing this many characters the swap file will be written to
8300 disk. When zero, no swap file will be created at all (see chapter on
8301 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8302 Vim with the "-n" option, see |startup|. When editing in readonly
8303 mode this option will be initialized to 10000.
8304 The swapfile can be disabled per buffer with |'swapfile'|.
8305 When 'updatecount' is set from zero to non-zero, swap files are
8306 created for all buffers that have 'swapfile' set. When 'updatecount'
8307 is set to zero, existing swap files are not deleted.
8308 Also see |'swapsync'|.
8309 This option has no meaning in buffers where |'buftype'| is "nofile"
8310 or "nowrite".
8311
8312 *'updatetime'* *'ut'*
8313'updatetime' 'ut' number (default 4000)
8314 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315 If this many milliseconds nothing is typed the swap file will be
8316 written to disk (see |crash-recovery|). Also used for the
8317 |CursorHold| autocommand event.
8318
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008319 *'varsofttabstop'* *'vsts'*
8320'varsofttabstop' 'vsts' string (default "")
8321 local to buffer
8322 {only available when compiled with the |+vartabs|
8323 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008324 A list of the number of spaces that a <Tab> counts for while editing,
8325 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8326 width <Tab>s are being inserted, while in fact a mixture of spaces
8327 and <Tab>s is used. Tab widths are separated with commas, with the
8328 final value applying to all subsequent tabs.
8329
8330 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008331 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008332 to use the following: >
8333 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008334< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8335 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008336
8337 Note that the value of |'softtabstop'| will be ignored while
8338 'varsofttabstop' is set.
8339
8340 *'vartabstop'* *'vts'*
8341'vartabstop' 'vts' string (default "")
8342 local to buffer
8343 {only available when compiled with the |+vartabs|
8344 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008345 A list of the number of spaces that a <Tab> in the file counts for,
8346 separated by commas. Each value corresponds to one tab, with the
8347 final value applying to all subsequent tabs. For example: >
8348 :set vartabstop=4,20,10,8
8349< This will make the first tab 4 spaces wide, the second 20 spaces,
8350 the third 10 spaces, and all following tabs 8 spaces.
8351
8352 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8353 is set.
8354
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 *'verbose'* *'vbs'*
8356'verbose' 'vbs' number (default 0)
8357 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 When bigger than zero, Vim will give messages about what it is doing.
8359 Currently, these messages are given:
8360 >= 1 When the viminfo file is read or written.
8361 >= 2 When a file is ":source"'ed.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008362 >= 4 Shell commands.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008363 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 >= 8 Files for which a group of autocommands is executed.
8365 >= 9 Every executed autocommand.
Bram Moolenaar647a5302020-05-03 17:01:24 +02008366 >= 11 Finding items in a path
Bram Moolenaar071d4272004-06-13 20:20:40 +00008367 >= 12 Every executed function.
8368 >= 13 When an exception is thrown, caught, finished, or discarded.
8369 >= 14 Anything pending in a ":finally" clause.
Bram Moolenaar823654b2020-05-29 23:03:09 +02008370 >= 15 Every executed Ex command from a script (truncated at 200
8371 characters).
8372 >= 16 Every executed Ex command
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373
8374 This option can also be set with the "-V" argument. See |-V|.
8375 This option is also set by the |:verbose| command.
8376
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008377 When the 'verbosefile' option is set then the verbose messages are not
8378 displayed.
8379
8380 *'verbosefile'* *'vfile'*
8381'verbosefile' 'vfile' string (default empty)
8382 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008383 When not empty all messages are written in a file with this name.
8384 When the file exists messages are appended.
8385 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008386 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008387 Setting 'verbosefile' to a new value is like making it empty first.
8388 The difference with |:redir| is that verbose messages are not
8389 displayed when 'verbosefile' is set.
8390
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 *'viewdir'* *'vdir'*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008392'viewdir' 'vdir' string (default for Amiga and Win32:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 "$VIM/vimfiles/view",
8394 for Unix: "~/.vim/view",
8395 for Macintosh: "$VIM:vimfiles:view"
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008396 for VMS: "sys$login:vimfiles/view")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008397 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008398 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 feature}
8400 Name of the directory where to store files for |:mkview|.
8401 This option cannot be set from a |modeline| or in the |sandbox|, for
8402 security reasons.
8403
8404 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008405'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008407 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 feature}
8409 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008410 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 word save and restore ~
8412 cursor cursor position in file and in window
8413 folds manually created folds, opened/closed folds and local
8414 fold options
8415 options options and mappings local to a window or buffer (not
8416 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008417 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 slash backslashes in file names replaced with forward
8419 slashes
8420 unix with Unix end-of-line format (single <NL>), even when
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008421 on MS-Windows
Bram Moolenaar13e90412017-11-11 18:16:48 +01008422 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008424 "slash" and "unix" are useful on MS-Windows when sharing view files
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 with Unix. The Unix version of Vim cannot source dos format scripts,
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008426 but the MS-Windows version of Vim can source unix format scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427
8428 *'viminfo'* *'vi'* *E526* *E527* *E528*
Bram Moolenaar6f345a12019-12-17 21:27:18 +01008429'viminfo' 'vi' string (Vi default: "", Vim default for
8430 MS-Windows: '100,<50,s10,h,rA:,rB:,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008431 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8432 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008434 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 feature}
8436 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008437 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8438 "NONE".
8439 The string should be a comma separated list of parameters, each
8440 consisting of a single character identifying the particular parameter,
8441 followed by a number or string which specifies the value of that
8442 parameter. If a particular character is left out, then the default
8443 value is used for that parameter. The following is a list of the
8444 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008446 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447 ! When included, save and restore global variables that start
8448 with an uppercase letter, and don't contain a lowercase
8449 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008450 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008451 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008452 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 " Maximum number of lines saved for each register. Old name of
8454 the '<' item, with the disadvantage that you need to put a
8455 backslash before the ", otherwise it will be recognized as the
8456 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008457 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 % When included, save and restore the buffer list. If Vim is
8459 started with a file name argument, the buffer list is not
8460 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008461 buffer list is restored from the viminfo file. Quickfix
8462 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8463 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008464 When followed by a number, the number specifies the maximum
8465 number of buffers that are stored. Without a number all
8466 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008467 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468 ' Maximum number of previously edited files for which the marks
8469 are remembered. This parameter must always be included when
8470 'viminfo' is non-empty.
8471 Including this item also means that the |jumplist| and the
8472 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008473 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008475 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 patterns are also saved. When not included, the value of
8477 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008478 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008480 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008481 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 < Maximum number of lines saved for each register. If zero then
8483 registers are not saved. When not included, all lines are
8484 saved. '"' is the old name for this item.
8485 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008486 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008488 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008489 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 c When included, convert the text in the viminfo file from the
8491 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008492 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008493 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008494 f Whether file marks need to be stored. If zero, file marks ('0
8495 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008496 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008498 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 h Disable the effect of 'hlsearch' when loading the viminfo
8500 file. When not included, it depends on whether ":nohlsearch"
8501 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008502 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008504 the 'n'. Must be at the end of the option! If the
8505 'viminfofile' option is set, that file name overrides the one
8506 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008507 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008508 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 r Removable media. The argument is a string (up to the next
8510 ','). This parameter can be given several times. Each
8511 specifies the start of a path for which no marks will be
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01008512 stored. This is to avoid removable media. For MS-Windows you
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8514 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8515 ignored. Maximum length of each 'r' argument is 50
8516 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008517 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518 s Maximum size of an item in Kbyte. If zero then registers are
8519 not saved. Currently only applies to registers. The default
8520 "s10" will exclude registers with more than 10 Kbyte of text.
8521 Also see the '<' item above: line count limit.
8522
8523 Example: >
8524 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8525<
8526 '50 Marks will be remembered for the last 50 files you
8527 edited.
8528 <1000 Contents of registers (up to 1000 lines each) will be
8529 remembered.
8530 s100 Registers with more than 100 Kbyte text are skipped.
8531 :0 Command-line history will not be saved.
8532 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8533 no / Since '/' is not specified, the default will be used,
8534 that is, save all of the search history, and also the
8535 previous search and substitute patterns.
8536 no % The buffer list will not be saved nor read back.
8537 no h 'hlsearch' highlighting will be restored.
8538
8539 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8540 load the contents of the file, this is not done automatically.
8541
8542 This option cannot be set from a |modeline| or in the |sandbox|, for
8543 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008544 NOTE: This option is set to the Vim default value when 'compatible'
8545 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008547 *'viminfofile'* *'vif'*
8548'viminfofile' 'vif' string (default: "")
8549 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008550 {not available when compiled without the |+viminfo|
8551 feature}
8552 When non-empty, overrides the file name used for viminfo.
8553 When equal to "NONE" no viminfo file will be read or written.
8554 This option can be set with the |-i| command line flag. The |--clean|
8555 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008556 This option cannot be set from a |modeline| or in the |sandbox|, for
8557 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008558
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 *'virtualedit'* *'ve'*
8560'virtualedit' 've' string (default "")
8561 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 A comma separated list of these words:
8563 block Allow virtual editing in Visual block mode.
8564 insert Allow virtual editing in Insert mode.
8565 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008566 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008567
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008569 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 of the line. Useful for selecting a rectangle in Visual mode and
8571 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008572 "onemore" is not the same, it will only allow moving the cursor just
8573 after the last character of the line. This makes some commands more
8574 consistent. Previously the cursor was always past the end of the line
8575 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008576 break some plugins or Vim scripts. For example because |l| can move
8577 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008578 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008579 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008580 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008581 It doesn't make sense to combine "all" with "onemore", but you will
8582 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008583 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584
8585 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8586'visualbell' 'vb' boolean (default off)
8587 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008588 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008590 use: >
8591 :set vb t_vb=
8592< If you want a short flash, you can use this on many terminals: >
8593 :set vb t_vb=[?5h$<100>[?5l
8594< Here $<100> specifies the time, you can use a smaller or bigger value
8595 to get a shorter or longer flash.
8596
8597 Note: Vim will limit the bell to once per half a second. This avoids
8598 having to wait for the flashing to finish when there are lots of
8599 bells, e.g. on key repeat. This also happens without 'visualbell'
8600 set.
8601
Bram Moolenaar071d4272004-06-13 20:20:40 +00008602 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8603 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8604 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008605
8606 Note: When the GUI starts, 't_vb' is reset to its default value. You
8607 might want to set it again in your |gvimrc|.
8608
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 Does not work on the Amiga, you always get a screen flash.
8610 Also see 'errorbells'.
8611
8612 *'warn'* *'nowarn'*
8613'warn' boolean (default on)
8614 global
8615 Give a warning message when a shell command is used while the buffer
8616 has been changed.
8617
8618 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8619'weirdinvert' 'wiv' boolean (default off)
8620 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008621 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 It is provided for backwards compatibility with version 4.x.
8623 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8624 vice versa. Has no effect when the GUI is running.
8625
8626 *'whichwrap'* *'ww'*
8627'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8628 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 Allow specified keys that move the cursor left/right to move to the
8630 previous/next line when the cursor is on the first/last character in
8631 the line. Concatenate characters to allow this for these keys:
8632 char key mode ~
8633 b <BS> Normal and Visual
8634 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008635 h "h" Normal and Visual (not recommended)
8636 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008637 < <Left> Normal and Visual
8638 > <Right> Normal and Visual
8639 ~ "~" Normal
8640 [ <Left> Insert and Replace
8641 ] <Right> Insert and Replace
8642 For example: >
8643 :set ww=<,>,[,]
8644< allows wrap only when cursor keys are used.
8645 When the movement keys are used in combination with a delete or change
8646 operator, the <EOL> also counts for a character. This makes "3h"
8647 different from "3dh" when the cursor crosses the end of a line. This
8648 is also true for "x" and "X", because they do the same as "dl" and
8649 "dh". If you use this, you may also want to use the mapping
8650 ":map <BS> X" to make backspace delete the character in front of the
8651 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008652 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008653 line (not an empty line) then it will not move to the next line. This
8654 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008655 NOTE: This option is set to the Vi default value when 'compatible' is
8656 set and to the Vim default value when 'compatible' is reset.
8657
8658 *'wildchar'* *'wc'*
8659'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008661 Character you have to type to start wildcard expansion in the
8662 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008663 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 The character is not recognized when used inside a macro. See
8665 'wildcharm' for that.
8666 Although 'wc' is a number option, you can set it to a special key: >
8667 :set wc=<Esc>
8668< NOTE: This option is set to the Vi default value when 'compatible' is
8669 set and to the Vim default value when 'compatible' is reset.
8670
8671 *'wildcharm'* *'wcm'*
8672'wildcharm' 'wcm' number (default: none (0))
8673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008675 recognized when used inside a macro. You can find "spare" command-line
8676 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 you'll never actually type 'wildcharm', just use it in mappings that
8678 automatically invoke completion mode, e.g.: >
8679 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008680 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681< Then after typing :ss you can use CTRL-P & CTRL-N.
8682
8683 *'wildignore'* *'wig'*
8684'wildignore' 'wig' string (default "")
8685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 {not available when compiled without the |+wildignore|
8687 feature}
8688 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008689 patterns is ignored when expanding |wildcards|, completing file or
8690 directory names, and influences the result of |expand()|, |glob()| and
8691 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8693 Also see 'suffixes'.
8694 Example: >
8695 :set wildignore=*.o,*.obj
8696< The use of |:set+=| and |:set-=| is preferred when adding or removing
8697 a pattern from the list. This avoids problems when a future version
8698 uses another default.
8699
Bram Moolenaar94950a92010-12-02 16:01:29 +01008700
Bram Moolenaar81af9252010-12-10 20:35:50 +01008701 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008702'wildignorecase' 'wic' boolean (default off)
8703 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008704 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008705 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008706 Does not apply when the shell is used to expand wildcards, which
8707 happens when there are special characters.
8708
8709
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008711'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 {not available if compiled without the |+wildmenu|
8714 feature}
8715 When 'wildmenu' is on, command-line completion operates in an enhanced
8716 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8717 the possible matches are shown just above the command line, with the
8718 first match highlighted (overwriting the status line, if there is
8719 one). Keys that show the previous/next match, such as <Tab> or
8720 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8721 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8722 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008723 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724 If there are more matches than can fit in the line, a ">" is shown on
8725 the right and/or a "<" is shown on the left. The status line scrolls
8726 as needed.
8727 The "wildmenu" mode is abandoned when a key is hit that is not used
8728 for selecting a completion.
8729 While the "wildmenu" is active the following keys have special
8730 meanings:
8731
8732 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8733 <Down> - in filename/menu name completion: move into a
8734 subdirectory or submenu.
8735 <CR> - in menu completion, when the cursor is just after a
8736 dot: move into a submenu.
8737 <Up> - in filename/menu name completion: move up into
8738 parent directory or parent menu.
8739
8740 This makes the menus accessible from the console |console-menus|.
8741
8742 If you prefer the <Left> and <Right> keys to move the cursor instead
8743 of selecting a different match, use this: >
8744 :cnoremap <Left> <Space><BS><Left>
8745 :cnoremap <Right> <Space><BS><Right>
8746<
8747 The "WildMenu" highlighting is used for displaying the current match
8748 |hl-WildMenu|.
8749
8750 *'wildmode'* *'wim'*
8751'wildmode' 'wim' string (Vim default: "full")
8752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008753 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008754 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008755 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 first part specifies the behavior for the first use of 'wildchar',
8757 The second part for the second use, etc.
8758 These are the possible values for each part:
8759 "" Complete only the first match.
8760 "full" Complete the next full match. After the last match,
8761 the original string is used and then the first match
8762 again.
8763 "longest" Complete till longest common string. If this doesn't
8764 result in a longer string, use the next part.
8765 "longest:full" Like "longest", but also start 'wildmenu' if it is
8766 enabled.
8767 "list" When more than one match, list all matches.
8768 "list:full" When more than one match, list all matches and
8769 complete first match.
8770 "list:longest" When more than one match, list all matches and
8771 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008772 "list:lastused" When more than one buffer matches, sort buffers
8773 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008774 When there is only a single match, it is fully completed in all cases.
8775
8776 Examples: >
8777 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008778< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 :set wildmode=longest,full
8780< Complete longest common string, then each full match >
8781 :set wildmode=list:full
8782< List all matches and complete each full match >
8783 :set wildmode=list,full
8784< List all matches without completing, then each full match >
8785 :set wildmode=longest,list
8786< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008787 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008789 *'wildoptions'* *'wop'*
8790'wildoptions' 'wop' string (default "")
8791 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008792 {not available when compiled without the |+wildignore|
8793 feature}
8794 A list of words that change how command line completion is done.
8795 Currently only one word is allowed:
8796 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008797 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008798 is displayed per line. Often used tag kinds are:
8799 d #define
8800 f function
8801 Also see |cmdline-completion|.
8802
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 *'winaltkeys'* *'wak'*
8804'winaltkeys' 'wak' string (default "menu")
8805 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806 {only used in Win32, Motif, GTK and Photon GUI}
8807 Some GUI versions allow the access to menu entries by using the ALT
8808 key in combination with a character that appears underlined in the
8809 menu. This conflicts with the use of the ALT key for mappings and
8810 entering special characters. This option tells what to do:
8811 no Don't use ALT keys for menus. ALT key combinations can be
8812 mapped, but there is no automatic handling. This can then be
8813 done with the |:simalt| command.
8814 yes ALT key handling is done by the windowing system. ALT key
8815 combinations cannot be mapped.
8816 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008817 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 keys can be mapped.
8819 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8820 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008821 This option is not used for <F10>; on Win32 and with GTK <F10> will
8822 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008824 *'wincolor'* *'wcr'*
8825'wincolor' 'wcr' string (default empty)
8826 local to window
8827 Highlight group name to use for this window instead of the Normal
8828 color |hl-Normal|.
8829
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008830 *'window'* *'wi'*
8831'window' 'wi' number (default screen height - 1)
8832 global
8833 Window height. Do not confuse this with the height of the Vim window,
8834 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008835 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8836 value is smaller than 'lines' minus one. The screen will scroll
8837 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008838 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8839 in a much smarter way, taking care of wrapping lines.
8840 When resizing the Vim window, the value is smaller than 1 or more than
8841 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008842
Bram Moolenaar071d4272004-06-13 20:20:40 +00008843 *'winheight'* *'wh'* *E591*
8844'winheight' 'wh' number (default 1)
8845 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008846 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008847 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008848 focus goes to a window that is smaller, its size is increased, at the
8849 cost of the height of other windows.
8850 Set 'winheight' to a small number for normal editing.
8851 Set it to 999 to make the current window fill most of the screen.
8852 Other windows will be only 'winminheight' high. This has the drawback
8853 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8854 to create only two windows, set the option after startup is done,
8855 using the |VimEnter| event: >
8856 au VimEnter * set winheight=999
8857< Minimum value is 1.
8858 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008859 height of the current window.
8860 'winheight' applies to the current window. Use 'winminheight' to set
8861 the minimal height for other windows.
8862
8863 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8864'winfixheight' 'wfh' boolean (default off)
8865 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008867 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8868 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869 The height may be changed anyway when running out of room.
8870
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008871 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8872'winfixwidth' 'wfw' boolean (default off)
8873 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008874 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008875 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008876 The width may be changed anyway when running out of room.
8877
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 *'winminheight'* *'wmh'*
8879'winminheight' 'wmh' number (default 1)
8880 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881 The minimal height of a window, when it's not the current window.
8882 This is a hard minimum, windows will never become smaller.
8883 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8884 status bar) if necessary. They will return to at least one line when
8885 they become active (since the cursor has to have somewhere to go.)
8886 Use 'winheight' to set the minimal height of the current window.
8887 This option is only checked when making a window smaller. Don't use a
8888 large number, it will cause errors when opening more than a few
8889 windows. A value of 0 to 3 is reasonable.
8890
8891 *'winminwidth'* *'wmw'*
8892'winminwidth' 'wmw' number (default 1)
8893 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 The minimal width of a window, when it's not the current window.
8895 This is a hard minimum, windows will never become smaller.
8896 When set to zero, windows may be "squashed" to zero columns (i.e. just
8897 a vertical separator) if necessary. They will return to at least one
8898 line when they become active (since the cursor has to have somewhere
8899 to go.)
8900 Use 'winwidth' to set the minimal width of the current window.
8901 This option is only checked when making a window smaller. Don't use a
8902 large number, it will cause errors when opening more than a few
8903 windows. A value of 0 to 12 is reasonable.
8904
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008905 *'winptydll'*
8906'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8907 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008908 {only available when compiled with the |terminal|
8909 feature on MS-Windows}
8910 Specifies the name of the winpty shared library, used for the
8911 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008912 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008913 a fallback.
8914 Environment variables are expanded |:set_env|.
8915 This option cannot be set from a |modeline| or in the |sandbox|, for
8916 security reasons.
8917
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918 *'winwidth'* *'wiw'* *E592*
8919'winwidth' 'wiw' number (default 20)
8920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 Minimal number of columns for the current window. This is not a hard
8922 minimum, Vim will use fewer columns if there is not enough room. If
8923 the current window is smaller, its size is increased, at the cost of
8924 the width of other windows. Set it to 999 to make the current window
8925 always fill the screen. Set it to a small number for normal editing.
8926 The width is not adjusted after one of the commands to change the
8927 width of the current window.
8928 'winwidth' applies to the current window. Use 'winminwidth' to set
8929 the minimal width for other windows.
8930
8931 *'wrap'* *'nowrap'*
8932'wrap' boolean (default on)
8933 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008934 This option changes how text is displayed. It doesn't change the text
8935 in the buffer, see 'textwidth' for that.
8936 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008937 displaying continues on the next line. When off lines will not wrap
8938 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008939 moved to a part that is not shown, the screen will scroll
8940 horizontally.
8941 The line will be broken in the middle of a word if necessary. See
8942 'linebreak' to get the break at a word boundary.
8943 To make scrolling horizontally a bit more useful, try this: >
8944 :set sidescroll=5
8945 :set listchars+=precedes:<,extends:>
8946< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008947 This option can't be set from a |modeline| when the 'diff' option is
8948 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949
8950 *'wrapmargin'* *'wm'*
8951'wrapmargin' 'wm' number (default 0)
8952 local to buffer
8953 Number of characters from the right window border where wrapping
8954 starts. When typing text beyond this limit, an <EOL> will be inserted
8955 and inserting continues on the next line.
8956 Options that add a margin, such as 'number' and 'foldcolumn', cause
8957 the text width to be further reduced. This is Vi compatible.
8958 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008959 This option is set to 0 when 'paste' is set and restored when 'paste'
8960 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008961 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008962
8963 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8964'wrapscan' 'ws' boolean (default on) *E384* *E385*
8965 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008966 Searches wrap around the end of the file. Also applies to |]s| and
8967 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968
8969 *'write'* *'nowrite'*
8970'write' boolean (default on)
8971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008972 Allows writing files. When not set, writing a file is not allowed.
8973 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008974 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008975 argument. Filtering text is still possible, even though this requires
8976 writing a temporary file.
8977
8978 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8979'writeany' 'wa' boolean (default off)
8980 global
8981 Allows writing to any file with no need for "!" override.
8982
8983 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8984'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8985 otherwise)
8986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008987 Make a backup before overwriting a file. The backup is removed after
8988 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008989 also on.
8990 WARNING: Switching this option off means that when Vim fails to write
8991 your buffer correctly and then, for whatever reason, Vim exits, you
8992 lose both the original file and what you were writing. Only reset
8993 this option if your file system is almost full and it makes the write
8994 fail (and make sure not to exit Vim until the write was successful).
8995 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008996 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008997 Depending on 'backupcopy' the backup is a new file or the original
8998 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 NOTE: This option is set to the default value when 'compatible' is
9000 set.
9001
9002 *'writedelay'* *'wd'*
9003'writedelay' 'wd' number (default 0)
9004 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009005 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009006 screen. When non-zero, characters are sent to the terminal one by
Bram Moolenaar5666fcd2019-12-26 14:35:26 +01009007 one. For debugging purposes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009008
Bram Moolenaar91f84f62018-07-29 15:07:52 +02009009 vim:tw=78:ts=8:noet:ft=help:norl: