blob: 25b3f1835b2f7d0de9b30e2edb857ae892c02106 [file] [log] [blame]
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02001*options.txt* For Vim version 8.0. Last change: 2017 Jun 04
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
405 {not available when compiled without the |+eval| or
406 |+autocmd| features}
407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100420On MS-Windows, if $HOME is not defined as an environment variable, then
421at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
422
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423NOTE: expanding environment variables and "~/" is only done with the ":set"
424command, not when assigning a value to an option with ":let".
425
426
427Note the maximum length of an expanded option is limited. How much depends on
428the system, mostly it is something like 256 or 1024 characters.
429
430 *:fix* *:fixdel*
431:fix[del] Set the value of 't_kD':
432 't_kb' is 't_kD' becomes ~
433 CTRL-? CTRL-H
434 not CTRL-? CTRL-?
435
436 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
437
438 If your delete key terminal code is wrong, but the
439 code for backspace is alright, you can put this in
440 your .vimrc: >
441 :fixdel
442< This works no matter what the actual code for
443 backspace is.
444
445 If the backspace key terminal code is wrong you can
446 use this: >
447 :if &term == "termname"
448 : set t_kb=^V<BS>
449 : fixdel
450 :endif
451< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000452 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453 with your terminal name.
454
455 If your <Delete> key sends a strange key sequence (not
456 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
457 :if &term == "termname"
458 : set t_kD=^V<Delete>
459 :endif
460< Where "^V" is CTRL-V and "<Delete>" is the delete key
461 (don't type eight characters!). Replace "termname"
462 with your terminal name.
463
464 *Linux-backspace*
465 Note about Linux: By default the backspace key
466 produces CTRL-?, which is wrong. You can fix it by
467 putting this line in your rc.local: >
468 echo "keycode 14 = BackSpace" | loadkeys
469<
470 *NetBSD-backspace*
471 Note about NetBSD: If your backspace doesn't produce
472 the right code, try this: >
473 xmodmap -e "keycode 22 = BackSpace"
474< If this works, add this in your .Xmodmap file: >
475 keysym 22 = BackSpace
476< You need to restart for this to take effect.
477
478==============================================================================
4792. Automatically setting options *auto-setting*
480
481Besides changing options with the ":set" command, there are three alternatives
482to set options automatically for one or more files:
483
4841. When starting Vim initializations are read from various places. See
485 |initialization|. Most of them are performed for all editing sessions,
486 and some of them depend on the directory where Vim is started.
487 You can create an initialization file with |:mkvimrc|, |:mkview| and
488 |:mksession|.
4892. If you start editing a new file, the automatic commands are executed.
490 This can be used to set options for files matching a particular pattern and
491 many other things. See |autocommand|.
4923. If you start editing a new file, and the 'modeline' option is on, a
493 number of lines at the beginning and end of the file are checked for
494 modelines. This is explained here.
495
496 *modeline* *vim:* *vi:* *ex:* *E520*
497There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200498 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000499
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200500[text] any text or empty
501{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200502{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200503[white] optional white space
504{options} a list of option settings, separated with white space
505 or ':', where each part between ':' is the argument
506 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000507
Bram Moolenaar14b69452013-06-29 23:05:20 +0200508Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000509 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
512The second form (this is compatible with some versions of Vi):
513
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516[text] any text or empty
517{white} at least one blank character (<Space> or <Tab>)
518{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
519[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520se[t] the string "set " or "se " (note the space); When
521 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200522{options} a list of options, separated with white space, which
523 is the argument for a ":set" command
524: a colon
525[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar14b69452013-06-29 23:05:20 +0200527Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000528 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200529 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000530
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200531The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
532chance that a normal word like "lex:" is caught. There is one exception:
533"vi:" and "vim:" can also be at the start of the line (for compatibility with
534version 3.0). Using "ex:" at the start of the line will be ignored (this
535could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
537 *modeline-local*
538The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000539buffer and window that contain the file. Although it's possible to set global
540options from a modeline, this is unusual. If you have two windows open and
541the files in it set the same global option to a different value, the result
542depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000544When editing a file that was already loaded, only the window-local options
545from the modeline are used. Thus if you manually changed a buffer-local
546option after opening the file, it won't be changed if you edit the same buffer
547in another window. But window-local options will be set.
548
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 *modeline-version*
550If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200551number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552 vim{vers}: version {vers} or later
553 vim<{vers}: version before {vers}
554 vim={vers}: version {vers}
555 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100556{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
557For example, to use a modeline only for Vim 7.0:
558 /* vim700: set foldmethod=marker */ ~
559To use a modeline for Vim after version 7.2:
560 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561There can be no blanks between "vim" and the ":".
562
563
564The number of lines that are checked can be set with the 'modelines' option.
565If 'modeline' is off or 'modelines' is 0 no lines are checked.
566
567Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000568like:
569 /* vi:ts=4: */ ~
570will give an error message for the trailing "*/". This line is OK:
571 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573If an error is detected the rest of the line is skipped.
574
575If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000576backslash in front of the ':' will be removed. Example:
577 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578This sets the 'dir' option to "c:\tmp". Only a single backslash before the
579':' is removed. Thus to include "\:" you have to specify "\\:".
580
581No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000582might create a Trojan horse text file with modelines). And not all options
583can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000584|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000585causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
586are wrapped unexpectedly. So disable modelines before editing untrusted text.
587The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000588
589Hint: If you would like to do something else than setting an option, you could
590define an autocommand that checks the file for a specific string. For
591example: >
592 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
593And define a function SetVar() that does something with the line containing
594"VAR".
595
596==============================================================================
5973. Options summary *option-summary*
598
599In the list below all the options are mentioned with their full name and with
600an abbreviation if there is one. Both forms may be used.
601
602In this document when a boolean option is "set" that means that ":set option"
603is entered. When an option is "reset", ":set nooption" is used.
604
605For some options there are two default values: The "Vim default", which is
606used when 'compatible' is not set, and the "Vi default", which is used when
607'compatible' is set.
608
609Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000610are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611different value in each window. For example the 'list' option can be set in
612one window and reset in another for the same text, giving both types of view
613at the same time. There are a few options that are specific to a certain
614file. These can have a different value for each file or buffer. For example
615the 'textwidth' option can be 78 for a normal text file and 0 for a C
616program.
617
618 global one option for all buffers and windows
619 local to window each window has its own copy of this option
620 local to buffer each buffer has its own copy of this option
621
622When creating a new window the option values from the currently active window
623are used as a default value for the window-specific options. For the
624buffer-specific options this depends on the 's' and 'S' flags in the
625'cpoptions' option. If 's' is included (which is the default) the values for
626buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000627first entered. If 'S' is present the options are copied each time the buffer
628is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629present, the options are copied from the currently active buffer when the
630buffer is created.
631
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000632Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000634Not all options are supported in all versions. This depends on the supported
635features and sometimes on the system. A remark about this is in curly braces
636below. When an option is not supported it may still be set without getting an
637error, this is called a hidden option. You can't get the value of a hidden
638option though, it is not stored.
639
640To test if option "foo" can be used with ":set" use something like this: >
641 if exists('&foo')
642This also returns true for a hidden option. To test if option "foo" is really
643supported use something like this: >
644 if exists('+foo')
645<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 *E355*
647A jump table for the options with a short description can be found at |Q_op|.
648
649 *'aleph'* *'al'* *aleph* *Aleph*
650'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
651 global
652 {not in Vi}
653 {only available when compiled with the |+rightleft|
654 feature}
655 The ASCII code for the first letter of the Hebrew alphabet. The
656 routine that maps the keyboard in Hebrew mode, both in Insert mode
657 (when hkmap is set) and on the command-line (when hitting CTRL-_)
658 outputs the Hebrew characters in the range [aleph..aleph+26].
659 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
660 See |rileft.txt|.
661
662 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
663'allowrevins' 'ari' boolean (default off)
664 global
665 {not in Vi}
666 {only available when compiled with the |+rightleft|
667 feature}
668 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
669 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
670 into reverse Insert mode, and don't know how to get out. See
671 'revins'.
672 NOTE: This option is reset when 'compatible' is set.
673
674 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
675'altkeymap' 'akm' boolean (default off)
676 global
677 {not in Vi}
678 {only available when compiled with the |+farsi|
679 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000680 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 the keyboard map between Farsi and English, when 'allowrevins' set.
682
Bram Moolenaar582fd852005-03-28 20:58:01 +0000683 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 is useful to start the Vim in native mode i.e. English (left-to-right
685 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000686 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687
688 *'ambiwidth'* *'ambw'*
689'ambiwidth' 'ambw' string (default: "single")
690 global
691 {not in Vi}
692 {only available when compiled with the |+multi_byte|
693 feature}
694 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
695 Tells Vim what to do with characters with East Asian Width Class
696 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
697 letters, Cyrillic letters).
698
699 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000700 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701 expected by most users.
702 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200703 *E834* *E835*
704 The value "double" cannot be used if 'listchars' or 'fillchars'
705 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706
707 There are a number of CJK fonts for which the width of glyphs for
708 those characters are solely based on how many octets they take in
709 legacy/traditional CJK encodings. In those encodings, Euro,
710 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000713 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000714 Vim is running inside a terminal (emulators) that uses a CJK font
715 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
716 this option should be set to "double" to match the width perceived
717 by Vim with the width of glyphs in the font. Perhaps it also has
718 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
719 when the system locale is set to one of CJK locales. See Unicode
720 Standard Annex #11 (http://www.unicode.org/reports/tr11).
721
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100722 Vim may set this option automatically at startup time when Vim is
723 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200724 escape sequence to request cursor position report.
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
729 {not in Vi}
730 {only available when compiled with GUI enabled
731 on Mac OS X}
732 This option only has an effect in the GUI version of Vim on Mac OS X
733 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
734 which can be easier to read at certain sizes on certain displays.
735 Setting this option can sometimes cause problems if 'guifont' is set
736 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100737 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738
739 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
740'autochdir' 'acd' boolean (default off)
741 global
742 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200743 {only available when compiled with it, use
744 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000745 When on, Vim will change the current working directory whenever you
746 open a file, switch buffers, delete a buffer or open/close a window.
747 It will change to the directory containing the file which was opened
748 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000749 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
752'arabic' 'arab' boolean (default off)
753 local to window
754 {not in Vi}
755 {only available when compiled with the |+arabic|
756 feature}
757 This option can be set to start editing Arabic text.
758 Setting this option will:
759 - Set the 'rightleft' option, unless 'termbidi' is set.
760 - Set the 'arabicshape' option, unless 'termbidi' is set.
761 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
762 between typing English and Arabic key mapping.
763 - Set the 'delcombine' option
764 Note that 'encoding' must be "utf-8" for working with Arabic text.
765
766 Resetting this option will:
767 - Reset the 'rightleft' option.
768 - Disable the use of 'keymap' (without changing its value).
769 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200770 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100771 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Also see |arabic.txt|.
773
774 *'arabicshape'* *'arshape'*
775 *'noarabicshape'* *'noarshape'*
776'arabicshape' 'arshape' boolean (default on)
777 global
778 {not in Vi}
779 {only available when compiled with the |+arabic|
780 feature}
781 When on and 'termbidi' is off, the required visual character
782 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200783 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 one which encompasses:
785 a) the changing/morphing of characters based on their location
786 within a word (initial, medial, final and stand-alone).
787 b) the enabling of the ability to compose characters
788 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100789 When disabled the display shows each character's true stand-alone
790 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 Arabic is a complex language which requires other settings, for
792 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100793 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000794
795 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
796'autoindent' 'ai' boolean (default off)
797 local to buffer
798 Copy indent from current line when starting a new line (typing <CR>
799 in Insert mode or when using the "o" or "O" command). If you do not
800 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000801 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
802 to another line has the same effect, unless the 'I' flag is included
803 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000804 When autoindent is on, formatting (with the "gq" command or when you
805 reach 'textwidth' in Insert mode) uses the indentation of the first
806 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 When 'smartindent' or 'cindent' is on the indent is changed in
808 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200809 The 'autoindent' option is reset when the 'paste' option is set and
810 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 {small difference from Vi: After the indent is deleted when typing
812 <Esc> or <CR>, the cursor position when moving up or down is after the
813 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
814
815 *'autoread'* *'ar'* *'noautoread'* *'noar'*
816'autoread' 'ar' boolean (default off)
817 global or local to buffer |global-local|
818 {not in Vi}
819 When a file has been detected to have been changed outside of Vim and
820 it has not been changed inside of Vim, automatically read it again.
821 When the file has been deleted this is not done. |timestamp|
822 If this option has a local value, use this command to switch back to
823 using the global value: >
824 :set autoread<
825<
826 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
827'autowrite' 'aw' boolean (default off)
828 global
829 Write the contents of the file, if it has been modified, on each
830 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000831 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
833 Note that for some commands the 'autowrite' option is not used, see
834 'autowriteall' for that.
835
836 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
837'autowriteall' 'awa' boolean (default off)
838 global
839 {not in Vi}
840 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
841 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
842 Setting this option also implies that Vim behaves like 'autowrite' has
843 been set.
844
845 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200846'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000847 global
848 {not in Vi}
849 When set to "dark", Vim will try to use colors that look good on a
850 dark background. When set to "light", Vim will try to use colors that
851 look good on a light background. Any other value is illegal.
852 Vim tries to set the default value according to the terminal used.
853 This will not always be correct.
854 Setting this option does not change the background color, it tells Vim
855 what the background color looks like. For changing the background
856 color, see |:hi-normal|.
857
858 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000859 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000860 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100861 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 setting 'background' will cause the color scheme to be reloaded. If
863 the color scheme adjusts to the value of 'background' this will work.
864 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100865 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866
867 When setting 'background' to the default value with: >
868 :set background&
869< Vim will guess the value. In the GUI this should work correctly,
870 in other cases Vim might not be able to guess the right value.
871
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200872 When the t_BG option is set, Vim will use it to request the background
873 color from the terminal. If the returned RGB value is dark/light and
874 'background' is not dark/light, 'background' will be set and the
875 screen is redrawn. This may have side effects, make t_BG empty in
876 your .vimrc if you suspect this problem.
877
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 When starting the GUI, the default value for 'background' will be
879 "light". When the value is not set in the .gvimrc, and Vim detects
880 that the background is actually quite dark, 'background' is set to
881 "dark". But this happens only AFTER the .gvimrc file has been read
882 (because the window needs to be opened to find the actual background
883 color). To get around this, force the GUI window to be opened by
884 putting a ":gui" command in the .gvimrc file, before where the value
885 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200886
887 For MS-DOS, Windows and OS/2 the default is "dark".
888 For other systems "dark" is used when 'term' is "linux",
889 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
890 background. Otherwise the default is "light".
891
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 Normally this option would be set in the .vimrc file. Possibly
893 depending on the terminal name. Example: >
894 :if &term == "pcterm"
895 : set background=dark
896 :endif
897< When this option is set, the default settings for the highlight groups
898 will change. To use other settings, place ":highlight" commands AFTER
899 the setting of the 'background' option.
900 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
901 to select the colors for syntax highlighting. After changing this
902 option, you must load syntax.vim again to see the result. This can be
903 done with ":syntax on".
904
905 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200906'backspace' 'bs' string (default "", set to "indent,eol,start"
907 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000908 global
909 {not in Vi}
910 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.
918
919 When the value is empty, Vi compatible backspacing is used.
920
921 For backwards compatibility with version 5.4 and earlier:
922 value effect ~
923 0 same as ":set backspace=" (Vi compatible)
924 1 same as ":set backspace=indent,eol"
925 2 same as ":set backspace=indent,eol,start"
926
927 See |:fixdel| if your <BS> or <Del> key does not do what you want.
928 NOTE: This option is set to "" when 'compatible' is set.
929
930 *'backup'* *'bk'* *'nobackup'* *'nobk'*
931'backup' 'bk' boolean (default off)
932 global
933 {not in Vi}
934 Make a backup before overwriting a file. Leave it around after the
935 file has been successfully written. If you do not want to keep the
936 backup file, but you do want a backup while the file is being
937 written, reset this option and set the 'writebackup' option (this is
938 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000939 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 |backup-table| for more explanations.
941 When the 'backupskip' pattern matches, a backup is not made anyway.
942 When 'patchmode' is set, the backup may be renamed to become the
943 oldest version of a file.
944 NOTE: This option is reset when 'compatible' is set.
945
946 *'backupcopy'* *'bkc'*
947'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200948 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000949 {not in Vi}
950 When writing a file and a backup is made, this option tells how it's
951 done. This is a comma separated list of words.
952
953 The main values are:
954 "yes" make a copy of the file and overwrite the original one
955 "no" rename the file and write a new one
956 "auto" one of the previous, what works best
957
958 Extra values that can be combined with the ones above are:
959 "breaksymlink" always break symlinks when writing
960 "breakhardlink" always break hardlinks when writing
961
962 Making a copy and overwriting the original file:
963 - Takes extra time to copy the file.
964 + When the file has special attributes, is a (hard/symbolic) link or
965 has a resource fork, all this is preserved.
966 - When the file is a link the backup will have the name of the link,
967 not of the real file.
968
969 Renaming the file and writing a new one:
970 + It's fast.
971 - Sometimes not all attributes of the file can be copied to the new
972 file.
973 - When the file is a link the new file will not be a link.
974
975 The "auto" value is the middle way: When Vim sees that renaming file
976 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000977 the file is not a link) that is used. When problems are expected, a
978 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979
980 The "breaksymlink" and "breakhardlink" values can be used in
981 combination with any of "yes", "no" and "auto". When included, they
982 force Vim to always break either symbolic or hard links by doing
983 exactly what the "no" option does, renaming the original file to
984 become the backup and writing a new file in its place. This can be
985 useful for example in source trees where all the files are symbolic or
986 hard links and any changes should stay in the local source tree, not
987 be propagated back to the original source.
988 *crontab*
989 One situation where "no" and "auto" will cause problems: A program
990 that opens a file, invokes Vim to edit that file, and then tests if
991 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000992 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993 example.
994
995 When a copy is made, the original file is truncated and then filled
996 with the new text. This means that protection bits, owner and
997 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000998 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 group of the backup is set to the group of the original file. If this
1000 fails, the protection bits for the group are made the same as for
1001 others.
1002
1003 When the file is renamed this is the other way around: The backup has
1004 the same attributes of the original file, and the newly written file
1005 is owned by the current user. When the file was a (hard/symbolic)
1006 link, the new file will not! That's why the "auto" value doesn't
1007 rename when the file is a link. The owner and group of the newly
1008 written file will be set to the same ones as the original file, but
1009 the system may refuse to do this. In that case the "auto" value will
1010 again not rename the file.
1011
Bram Moolenaar036986f2017-03-16 17:41:02 +01001012 NOTE: This option is set to the Vi default value when 'compatible' is
1013 set and to the Vim default value when 'compatible' is reset.
1014
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 *'backupdir'* *'bdir'*
1016'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001017 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 for Unix: ".,~/tmp,~/")
1019 global
1020 {not in Vi}
1021 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 Moolenaar009b2592004-10-24 19:18:58 +00001029 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 put the backup file relative to where the edited file is. The
1031 leading "." is replaced with the path name of the edited file.
1032 ("." 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 '/'.
1038 - Environment variables are expanded |:set_env|.
1039 - Careful with '\' characters, type one before a space, type two to
1040 get one in the option (see |option-backslash|), for example: >
1041 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1042< - For backwards compatibility with Vim version 3.0 a '>' at the start
1043 of the option is removed.
1044 See also 'backup' and 'writebackup' options.
1045 If you want to hide your backup files on Unix, consider this value: >
1046 :set backupdir=./.backup,~/.backup,.,/tmp
1047< You must create a ".backup" directory in each directory and in your
1048 home directory for this to work properly.
1049 The use of |:set+=| and |:set-=| is preferred when adding or removing
1050 directories from the list. This avoids problems when a future version
1051 uses another default.
1052 This option cannot be set from a |modeline| or in the |sandbox|, for
1053 security reasons.
1054
1055 *'backupext'* *'bex'* *E589*
1056'backupext' 'bex' string (default "~", for VMS: "_")
1057 global
1058 {not in Vi}
1059 String which is appended to a file name to make the name of the
1060 backup file. The default is quite unusual, because this avoids
1061 accidentally overwriting existing files with a backup file. You might
1062 prefer using ".bak", but make sure that you don't have files with
1063 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001064 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001066 If you like to keep a lot of backups, you could use a BufWritePre
1067 autocommand to change 'backupext' just before writing the file to
1068 include a timestamp. >
1069 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1070< Use 'backupdir' to put the backup in a different directory.
1071
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 *'backupskip'* *'bsk'*
1073'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1074 global
1075 {not in Vi}
1076 {not available when compiled without the |+wildignore|
1077 feature}
1078 A list of file patterns. When one of the patterns matches with the
1079 name of the file which is written, no backup file is created. Both
1080 the specified file name and the full path name of the file are used.
1081 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1082 Watch out for special characters, see |option-backslash|.
1083 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001084 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001085
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001086 WARNING: Not having a backup file means that when Vim fails to write
1087 your buffer correctly and then, for whatever reason, Vim exits, you
1088 lose both the original file and what you were writing. Only disable
1089 backups if you don't care about losing the file.
1090
Bram Moolenaar02467872007-05-06 13:22:01 +00001091 Note that environment variables are not expanded. If you want to use
1092 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001093 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001094
1095< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001096 backup would be made by renaming the original file crontab won't see
1097 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098
1099 *'balloondelay'* *'bdlay'*
1100'balloondelay' 'bdlay' number (default: 600)
1101 global
1102 {not in Vi}
1103 {only available when compiled with the |+balloon_eval|
1104 feature}
1105 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1106
1107 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1108'ballooneval' 'beval' boolean (default off)
1109 global
1110 {not in Vi}
1111 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001112 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 Switch on the |balloon-eval| functionality.
1114
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 *'balloonexpr'* *'bexpr'*
1116'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001117 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 {not in Vi}
1119 {only available when compiled with the |+balloon_eval|
1120 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001121 Expression for text to show in evaluation balloon. It is only used
1122 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123
1124 v:beval_bufnr number of the buffer in which balloon is going to show
1125 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001126 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001127 v:beval_lnum line number
1128 v:beval_col column number (byte index)
1129 v:beval_text word under or after the mouse pointer
1130
1131 The evaluation of the expression must not have side effects!
1132 Example: >
1133 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001134 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001135 \', column ' . v:beval_col .
1136 \ ' of file ' . bufname(v:beval_bufnr) .
1137 \ ' on word "' . v:beval_text . '"'
1138 endfunction
1139 set bexpr=MyBalloonExpr()
1140 set ballooneval
1141<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001142 Also see |balloon_show()|, can be used if the content of the balloon
1143 is to be fetched asynchronously.
1144
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 NOTE: The balloon is displayed only if the cursor is on a text
1146 character. If the result of evaluating 'balloonexpr' is not empty,
1147 Vim does not try to send a message to an external debugger (Netbeans
1148 or Sun Workshop).
1149
Bram Moolenaar30b65812012-07-12 22:01:11 +02001150 The expression will be evaluated in the |sandbox| when set from a
1151 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001152
1153 It is not allowed to change text or jump to another window while
1154 evaluating 'balloonexpr' |textlock|.
1155
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001156 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001157 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001158< When they are supported "\n" characters will start a new line. If the
1159 expression evaluates to a |List| this is equal to using each List item
1160 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001161 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001162
Bram Moolenaar165bc692015-07-21 17:53:25 +02001163 *'belloff'* *'bo'*
1164'belloff' 'bo' string (default "")
1165 global
1166 {not in Vi}
1167 Specifies for which events the bell will not be rung. It is a comma
1168 separated list of items. For each item that is present, the bell
1169 will be silenced. This is most useful to specify specific events in
1170 insert mode to be silenced.
1171
1172 item meaning when present ~
1173 all All events.
1174 backspace When hitting <BS> or <Del> and deleting results in an
1175 error.
1176 cursor Fail to move around using the cursor keys or
1177 <PageUp>/<PageDown> in |Insert-mode|.
1178 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1179 |i_CTRL-X_CTRL-T|.
1180 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1181 |i_CTRL-E|.
1182 ctrlg Unknown Char after <C-G> in Insert mode.
1183 error Other Error occurred (e.g. try to join last line)
1184 (mostly used in |Normal-mode| or |Cmdline-mode|).
1185 esc hitting <Esc> in |Normal-mode|.
1186 ex In |Visual-mode|, hitting |Q| results in an error.
1187 hangul Error occurred when using hangul input.
1188 insertmode Pressing <Esc> in 'insertmode'.
1189 lang Calling the beep module for Lua/Mzscheme/TCL.
1190 mess No output available for |g<|.
1191 showmatch Error occurred for 'showmatch' function.
1192 operator Empty region error |cpo-E|.
1193 register Unknown register after <C-R> in |Insert-mode|.
1194 shell Bell from shell output |:!|.
1195 spell Error happened on spell suggest.
1196 wildmode More matches in |cmdline-completion| available
1197 (depends on the 'wildmode' setting).
1198
Bram Moolenaar036986f2017-03-16 17:41:02 +01001199 This is most useful to fine tune when in Insert mode the bell should
1200 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001201 indicate that an error occurred. It can be silenced by adding the
1202 "error" keyword.
1203
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1205'binary' 'bin' boolean (default off)
1206 local to buffer
1207 {not in Vi}
1208 This option should be set before editing a binary file. You can also
1209 use the |-b| Vim argument. When this option is switched on a few
1210 options will be changed (also when it already was on):
1211 'textwidth' will be set to 0
1212 'wrapmargin' will be set to 0
1213 'modeline' will be off
1214 'expandtab' will be off
1215 Also, 'fileformat' and 'fileformats' options will not be used, the
1216 file is read and written like 'fileformat' was "unix" (a single <NL>
1217 separates lines).
1218 The 'fileencoding' and 'fileencodings' options will not be used, the
1219 file is read without conversion.
1220 NOTE: When you start editing a(nother) file while the 'bin' option is
1221 on, settings from autocommands may change the settings again (e.g.,
1222 'textwidth'), causing trouble when editing. You might want to set
1223 'bin' again when the file has been loaded.
1224 The previous values of these options are remembered and restored when
1225 'bin' is switched from on to off. Each buffer has its own set of
1226 saved option values.
1227 To edit a file with 'binary' set you can use the |++bin| argument.
1228 This avoids you have to do ":set bin", which would have effect for all
1229 files you edit.
1230 When writing a file the <EOL> for the last line is only written if
1231 there was one in the original file (normally Vim appends an <EOL> to
1232 the last line if there is none; this would make the file longer). See
1233 the 'endofline' option.
1234
1235 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1236'bioskey' 'biosk' boolean (default on)
1237 global
1238 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001239 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240
1241 *'bomb'* *'nobomb'*
1242'bomb' boolean (default off)
1243 local to buffer
1244 {not in Vi}
1245 {only available when compiled with the |+multi_byte|
1246 feature}
1247 When writing a file and the following conditions are met, a BOM (Byte
1248 Order Mark) is prepended to the file:
1249 - this option is on
1250 - the 'binary' option is off
1251 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1252 endian variants.
1253 Some applications use the BOM to recognize the encoding of the file.
1254 Often used for UCS-2 files on MS-Windows. For other applications it
1255 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001256 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1258 check for the presence of the BOM is done and 'bomb' set accordingly.
1259 Unless 'binary' is set, it is removed from the first line, so that you
1260 don't see it when editing. When you don't change the options, the BOM
1261 will be restored when writing the file.
1262
1263 *'breakat'* *'brk'*
1264'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1265 global
1266 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001267 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 feature}
1269 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001270 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1271 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001273 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001274'breakindent' 'bri' boolean (default off)
1275 local to window
1276 {not in Vi}
1277 {not available when compiled without the |+linebreak|
1278 feature}
1279 Every wrapped line will continue visually indented (same amount of
1280 space as the beginning of that line), thus preserving horizontal blocks
1281 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001282 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001283
1284 *'breakindentopt'* *'briopt'*
1285'breakindentopt' 'briopt' string (default empty)
1286 local to window
1287 {not in Vi}
1288 {not available when compiled without the |+linebreak|
1289 feature}
1290 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001291 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 min:{n} Minimum text width that will be kept after
1293 applying 'breakindent', even if the resulting
1294 text should normally be narrower. This prevents
1295 text indented almost to the right window border
1296 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001297 shift:{n} After applying 'breakindent', the wrapped line's
1298 beginning will be shifted by the given number of
1299 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300 indentation (negative) or emphasizing the line
1301 continuation (positive).
1302 sbr Display the 'showbreak' value before applying the
1303 additional indent.
1304 The default value for min is 20 and shift is 0.
1305
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001307'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001309 {not in Vi} {only for Motif, Athena, GTK, Mac and
1310 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001312 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001313 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 buffer Use the directory of the related buffer.
1315 current Use the current directory.
1316 {path} Use the specified directory
1317
1318 *'bufhidden'* *'bh'*
1319'bufhidden' 'bh' string (default: "")
1320 local to buffer
1321 {not in Vi}
1322 {not available when compiled without the |+quickfix|
1323 feature}
1324 This option specifies what happens when a buffer is no longer
1325 displayed in a window:
1326 <empty> follow the global 'hidden' option
1327 hide hide the buffer (don't unload it), also when 'hidden'
1328 is not set
1329 unload unload the buffer, also when 'hidden' is set or using
1330 |:hide|
1331 delete delete the buffer from the buffer list, also when
1332 'hidden' is set or using |:hide|, like using
1333 |:bdelete|
1334 wipe wipe out the buffer from the buffer list, also when
1335 'hidden' is set or using |:hide|, like using
1336 |:bwipeout|
1337
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001338 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001339 are lost without a warning. Also, these values may break autocommands
1340 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 This option is used together with 'buftype' and 'swapfile' to specify
1342 special kinds of buffers. See |special-buffers|.
1343
1344 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1345'buflisted' 'bl' boolean (default: on)
1346 local to buffer
1347 {not in Vi}
1348 When this option is set, the buffer shows up in the buffer list. If
1349 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1350 This option is reset by Vim for buffers that are only used to remember
1351 a file name or marks. Vim sets it when starting to edit a buffer.
1352 But not when moving to a buffer with ":buffer".
1353
1354 *'buftype'* *'bt'* *E382*
1355'buftype' 'bt' string (default: "")
1356 local to buffer
1357 {not in Vi}
1358 {not available when compiled without the |+quickfix|
1359 feature}
1360 The value of this option specifies the type of a buffer:
1361 <empty> normal buffer
1362 nofile buffer which is not related to a file and will not be
1363 written
1364 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001365 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001366 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001367 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001368 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001369 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 help help buffer (you are not supposed to set this
1371 manually)
1372
1373 This option is used together with 'bufhidden' and 'swapfile' to
1374 specify special kinds of buffers. See |special-buffers|.
1375
1376 Be careful with changing this option, it can have many side effects!
1377
Bram Moolenaar280f1262006-01-30 00:14:18 +00001378 A "quickfix" buffer is only used for the error list and the location
1379 list. This value is set by the |:cwindow| and |:lwindow| commands and
1380 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 "nofile" and "nowrite" buffers are similar:
1383 both: The buffer is not to be written to disk, ":w" doesn't
1384 work (":w filename" does work though).
1385 both: The buffer is never considered to be |'modified'|.
1386 There is no warning when the changes will be lost, for
1387 example when you quit Vim.
1388 both: A swap file is only created when using too much memory
1389 (when 'swapfile' has been reset there is never a swap
1390 file).
1391 nofile only: The buffer name is fixed, it is not handled like a
1392 file name. It is not modified in response to a |:cd|
1393 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001394 both: When using ":e bufname" and already editing "bufname"
1395 the buffer is made empty and autocommands are
1396 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001397 *E676*
1398 "acwrite" implies that the buffer name is not related to a file, like
1399 "nofile", but it will be written. Thus, in contrast to "nofile" and
1400 "nowrite", ":w" does work and a modified buffer can't be abandoned
1401 without saving. For writing there must be matching |BufWriteCmd|,
1402 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 *'casemap'* *'cmp'*
1405'casemap' 'cmp' string (default: "internal,keepascii")
1406 global
1407 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001408 {only available when compiled with the |+multi_byte|
1409 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 Specifies details about changing the case of letters. It may contain
1411 these words, separated by a comma:
1412 internal Use internal case mapping functions, the current
1413 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001414 matters when 'encoding' is a Unicode encoding,
1415 "latin1" or "iso-8859-15". When "internal" is
1416 omitted, the towupper() and towlower() system library
1417 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1419 case mapping, the current locale is not effective.
1420 This probably only matters for Turkish.
1421
1422 *'cdpath'* *'cd'* *E344* *E346*
1423'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1424 global
1425 {not in Vi}
1426 {not available when compiled without the
1427 |+file_in_path| feature}
1428 This is a list of directories which will be searched when using the
1429 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001430 for has a relative path, not an absolute part starting with "/", "./"
1431 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 The 'cdpath' option's value has the same form and semantics as
1433 |'path'|. Also see |file-searching|.
1434 The default value is taken from $CDPATH, with a "," prepended to look
1435 in the current directory first.
1436 If the default value taken from $CDPATH is not what you want, include
1437 a modified version of the following command in your vimrc file to
1438 override it: >
1439 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1440< This option cannot be set from a |modeline| or in the |sandbox|, for
1441 security reasons.
1442 (parts of 'cdpath' can be passed to the shell to expand file names).
1443
1444 *'cedit'*
1445'cedit' string (Vi default: "", Vim default: CTRL-F)
1446 global
1447 {not in Vi}
1448 {not available when compiled without the |+vertsplit|
1449 feature}
1450 The key used in Command-line Mode to open the command-line window.
1451 The default is CTRL-F when 'compatible' is off.
1452 Only non-printable keys are allowed.
1453 The key can be specified as a single character, but it is difficult to
1454 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001455 :exe "set cedit=\<C-Y>"
1456 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457< |Nvi| also has this option, but it only uses the first character.
1458 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001459 NOTE: This option is set to the Vim default value when 'compatible'
1460 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461
1462 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1463'charconvert' 'ccv' string (default "")
1464 global
1465 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001466 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001467 {not in Vi}
1468 An expression that is used for character encoding conversion. It is
1469 evaluated when a file that is to be read or has been written has a
1470 different encoding from what is desired.
1471 'charconvert' is not used when the internal iconv() function is
1472 supported and is able to do the conversion. Using iconv() is
1473 preferred, because it is much faster.
1474 'charconvert' is not used when reading stdin |--|, because there is no
1475 file to convert from. You will have to save the text in a file first.
1476 The expression must return zero or an empty string for success,
1477 non-zero for failure.
1478 The possible encoding names encountered are in 'encoding'.
1479 Additionally, names given in 'fileencodings' and 'fileencoding' are
1480 used.
1481 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1482 is done internally by Vim, 'charconvert' is not used for this.
1483 'charconvert' is also used to convert the viminfo file, if the 'c'
1484 flag is present in 'viminfo'. Also used for Unicode conversion.
1485 Example: >
1486 set charconvert=CharConvert()
1487 fun CharConvert()
1488 system("recode "
1489 \ . v:charconvert_from . ".." . v:charconvert_to
1490 \ . " <" . v:fname_in . " >" v:fname_out)
1491 return v:shell_error
1492 endfun
1493< The related Vim variables are:
1494 v:charconvert_from name of the current encoding
1495 v:charconvert_to name of the desired encoding
1496 v:fname_in name of the input file
1497 v:fname_out name of the output file
1498 Note that v:fname_in and v:fname_out will never be the same.
1499 Note that v:charconvert_from and v:charconvert_to may be different
1500 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1501 Encryption is not done by Vim when using 'charconvert'. If you want
1502 to encrypt the file after conversion, 'charconvert' should take care
1503 of this.
1504 This option cannot be set from a |modeline| or in the |sandbox|, for
1505 security reasons.
1506
1507 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1508'cindent' 'cin' boolean (default off)
1509 local to buffer
1510 {not in Vi}
1511 {not available when compiled without the |+cindent|
1512 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001513 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 that trigger reindenting in insert mode and 'cinoptions' to set your
1515 preferred indent style.
1516 If 'indentexpr' is not empty, it overrules 'cindent'.
1517 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1518 the "=" operator indents using this algorithm rather than calling an
1519 external program.
1520 See |C-indenting|.
1521 When you don't like the way 'cindent' works, try the 'smartindent'
1522 option or 'indentexpr'.
1523 This option is not used when 'paste' is set.
1524 NOTE: This option is reset when 'compatible' is set.
1525
1526 *'cinkeys'* *'cink'*
1527'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1528 local to buffer
1529 {not in Vi}
1530 {not available when compiled without the |+cindent|
1531 feature}
1532 A list of keys that, when typed in Insert mode, cause reindenting of
1533 the current line. Only used if 'cindent' is on and 'indentexpr' is
1534 empty.
1535 For the format of this option see |cinkeys-format|.
1536 See |C-indenting|.
1537
1538 *'cinoptions'* *'cino'*
1539'cinoptions' 'cino' string (default "")
1540 local to buffer
1541 {not in Vi}
1542 {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
1552 {not in Vi}
1553 {not available when compiled without both the
1554 |+cindent| and the |+smartindent| features}
1555 These keywords start an extra indent in the next line when
1556 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1557 an appropriate place (inside {}).
1558 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1559 matter, include the keyword both the uppercase and lowercase:
1560 "if,If,IF".
1561
1562 *'clipboard'* *'cb'*
1563'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1564 for X-windows, "" otherwise)
1565 global
1566 {not in Vi}
1567 {only in GUI versions or when the |+xterm_clipboard|
1568 feature is included}
1569 This option is a list of comma separated names.
1570 These names are recognized:
1571
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001572 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 unnamed When included, Vim will use the clipboard register '*'
1574 for all yank, delete, change and put operations which
1575 would normally go to the unnamed register. When a
1576 register is explicitly specified, it will always be
1577 used regardless of whether "unnamed" is in 'clipboard'
1578 or not. The clipboard register can always be
1579 explicitly accessed using the "* notation. Also see
1580 |gui-clipboard|.
1581
Bram Moolenaar30b65812012-07-12 22:01:11 +02001582 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001583 unnamedplus A variant of the "unnamed" flag which uses the
1584 clipboard register '+' (|quoteplus|) instead of
1585 register '*' for all yank, delete, change and put
1586 operations which would normally go to the unnamed
1587 register. When "unnamed" is also included to the
1588 option, yank operations (but not delete, change or
1589 put) will additionally copy the text into register
1590 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001591 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001592 Availability can be checked with: >
1593 if has('unnamedplus')
1594<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001595 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 autoselect Works like the 'a' flag in 'guioptions': If present,
1597 then whenever Visual mode is started, or the Visual
1598 area extended, Vim tries to become the owner of the
1599 windowing system's global selection or put the
1600 selected text on the clipboard used by the selection
1601 register "*. See |guioptions_a| and |quotestar| for
1602 details. When the GUI is active, the 'a' flag in
1603 'guioptions' is used, when the GUI is not active, this
1604 "autoselect" flag is used.
1605 Also applies to the modeless selection.
1606
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001607 *clipboard-autoselectplus*
1608 autoselectplus Like "autoselect" but using the + register instead of
1609 the * register. Compare to the 'P' flag in
1610 'guioptions'.
1611
1612 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 autoselectml Like "autoselect", but for the modeless selection
1614 only. Compare to the 'A' flag in 'guioptions'.
1615
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001616 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001617 html When the clipboard contains HTML, use this when
1618 pasting. When putting text on the clipboard, mark it
1619 as HTML. This works to copy rendered HTML from
1620 Firefox, paste it as raw HTML in Vim, select the HTML
1621 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001622 You probably want to add this only temporarily,
1623 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001624 Only supported for GTK version 2 and later.
1625 Only available with the |+multi_byte| feature.
1626
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001627 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 exclude:{pattern}
1629 Defines a pattern that is matched against the name of
1630 the terminal 'term'. If there is a match, no
1631 connection will be made to the X server. This is
1632 useful in this situation:
1633 - Running Vim in a console.
1634 - $DISPLAY is set to start applications on another
1635 display.
1636 - You do not want to connect to the X server in the
1637 console, but do want this in a terminal emulator.
1638 To never connect to the X server use: >
1639 exclude:.*
1640< This has the same effect as using the |-X| argument.
1641 Note that when there is no connection to the X server
1642 the window title won't be restored and the clipboard
1643 cannot be accessed.
1644 The value of 'magic' is ignored, {pattern} is
1645 interpreted as if 'magic' was on.
1646 The rest of the option value will be used for
1647 {pattern}, this must be the last entry.
1648
1649 *'cmdheight'* *'ch'*
1650'cmdheight' 'ch' number (default 1)
1651 global
1652 {not in Vi}
1653 Number of screen lines to use for the command-line. Helps avoiding
1654 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001655 The value of this option is stored with the tab page, so that each tab
1656 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657
1658 *'cmdwinheight'* *'cwh'*
1659'cmdwinheight' 'cwh' number (default 7)
1660 global
1661 {not in Vi}
1662 {not available when compiled without the |+vertsplit|
1663 feature}
1664 Number of screen lines to use for the command-line window. |cmdwin|
1665
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001666 *'colorcolumn'* *'cc'*
1667'colorcolumn' 'cc' string (default "")
1668 local to window
1669 {not in Vi}
1670 {not available when compiled without the |+syntax|
1671 feature}
1672 'colorcolumn' is a comma separated list of screen columns that are
1673 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1674 text. Will make screen redrawing slower.
1675 The screen column can be an absolute number, or a number preceded with
1676 '+' or '-', which is added to or subtracted from 'textwidth'. >
1677
1678 :set cc=+1 " highlight column after 'textwidth'
1679 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1680 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1681<
1682 When 'textwidth' is zero then the items with '-' and '+' are not used.
1683 A maximum of 256 columns are highlighted.
1684
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 *'columns'* *'co'* *E594*
1686'columns' 'co' number (default 80 or terminal width)
1687 global
1688 {not in Vi}
1689 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001690 initialization and does not have to be set by hand. Also see
1691 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 When Vim is running in the GUI or in a resizable window, setting this
1693 option will cause the window size to be changed. When you only want
1694 to use the size for the GUI, put the command in your |gvimrc| file.
1695 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001696 number of columns of the display, the display may be messed up. For
1697 the GUI it is always possible and Vim limits the number of columns to
1698 what fits on the screen. You can use this command to get the widest
1699 window possible: >
1700 :set columns=9999
1701< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702
1703 *'comments'* *'com'* *E524* *E525*
1704'comments' 'com' string (default
1705 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1706 local to buffer
1707 {not in Vi}
1708 {not available when compiled without the |+comments|
1709 feature}
1710 A comma separated list of strings that can start a comment line. See
1711 |format-comments|. See |option-backslash| about using backslashes to
1712 insert a space.
1713
1714 *'commentstring'* *'cms'* *E537*
1715'commentstring' 'cms' string (default "/*%s*/")
1716 local to buffer
1717 {not in Vi}
1718 {not available when compiled without the |+folding|
1719 feature}
1720 A template for a comment. The "%s" in the value is replaced with the
1721 comment text. Currently only used to add markers for folding, see
1722 |fold-marker|.
1723
1724 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001725'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001726 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 global
1728 {not in Vi}
1729 This option has the effect of making Vim either more Vi-compatible, or
1730 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001733 other options are also changed as a side effect.
1734 NOTE: Setting or resetting this option can have a lot of unexpected
1735 effects: Mappings are interpreted in another way, undo behaves
1736 differently, etc. If you set this option in your vimrc file, you
1737 should probably put it at the very start.
1738
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 By default this option is on and the Vi defaults are used for the
1740 options. This default was chosen for those people who want to use Vim
1741 just like Vi, and don't even (want to) know about the 'compatible'
1742 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001743 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001744 this option is switched off, and all options that have not been
1745 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001746 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001747 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001748 happen for the system-wide vimrc or gvimrc file, nor for a file given
1749 with the |-u| argument). Also see |compatible-default| and
1750 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 You can also set this option with the "-C" argument, and reset it with
1752 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001753 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754
Bram Moolenaar214641f2017-03-05 17:04:09 +01001755 When this option is set, numerous other options are set to make Vim as
1756 Vi-compatible as possible. When this option is unset, various options
1757 are set to make Vim more useful. The table below lists all the
1758 options affected.
1759 The {?} column indicates when the options are affected:
1760 + Means that the option is set to the value given in {set value} when
1761 'compatible' is set.
1762 & Means that the option is set to the value given in {set value} when
1763 'compatible' is set AND is set to its Vim default value when
1764 'compatible' is unset.
1765 - Means the option is NOT changed when setting 'compatible' but IS
1766 set to its Vim default when 'compatible' is unset.
1767 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
Bram Moolenaar036986f2017-03-16 17:41:02 +01001769 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001770
1771 'allowrevins' + off no CTRL-_ command
1772 'antialias' + off don't use antialiased fonts
1773 'arabic' + off reset arabic-related options
1774 'arabicshape' + on correct character shapes
1775 'backspace' + "" normal backspace
1776 'backup' + off no backup file
1777 'backupcopy' & Unix: "yes" backup file is a copy
1778 else: "auto" copy or rename backup file
1779 'balloonexpr' + "" text to show in evaluation balloon
1780 'breakindent' + off don't indent when wrapping lines
1781 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1782 'cindent' + off no C code indentation
1783 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1784 'copyindent' + off don't copy indent structure
1785 'cpoptions' & (all flags) Vi-compatible flags
1786 'cscopepathcomp'+ 0 don't show directories in tags list
1787 'cscoperelative'+ off
1788 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001789 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'cscopeverbose' + off see |cscopeverbose|
1791 'delcombine' + off unicode: delete whole char combination
1792 'digraph' + off no digraphs
1793 'esckeys' & off no <Esc>-keys in Insert mode
1794 'expandtab' + off tabs not expanded to spaces
1795 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001797 'formatexpr' + "" use 'formatprg' for auto-formatting
1798 'formatoptions' & "vt" Vi compatible formatting
1799 'gdefault' + off no default 'g' flag for ":s"
1800 'history' & 0 no commandline history
1801 'hkmap' + off no Hebrew keyboard mapping
1802 'hkmapp' + off no phonetic Hebrew keyboard mapping
1803 'hlsearch' + off no highlighting of search matches
1804 'incsearch' + off no incremental searching
1805 'indentexpr' + "" no indenting by expression
1806 'insertmode' + off do not start in Insert mode
1807 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001809 'joinspaces' + on insert 2 spaces after period
1810 'modeline' & off no modelines
1811 'more' & off no pauses in listings
1812 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1813 'numberwidth' & 8 min number of columns for line number
1814 'preserveindent'+ off don't preserve current indent structure
1815 when changing it
1816 'revins' + off no reverse insert
1817 'ruler' + off no ruler
1818 'scrolljump' + 1 no jump scroll
1819 'scrolloff' + 0 no scroll offset
1820 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1821 'shiftround' + off indent not rounded to shiftwidth
1822 'shortmess' & "" no shortening of messages
1823 'showcmd' & off command characters not shown
1824 'showmode' & off current mode not shown
1825 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1826 'smartcase' + off no automatic ignore case switch
1827 'smartindent' + off no smart indentation
1828 'smarttab' + off no smart tab size
1829 'softtabstop' + 0 tabs are always 'tabstop' positions
1830 'startofline' + on goto startofline with some commands
1831 'tagcase' & "followic" 'ignorecase' when searching tags file
1832 'tagrelative' & off tag file names are not relative
1833 'termguicolors' + off don't use highlight-(guifg|guibg)
1834 'textauto' & off no automatic textmode detection
1835 'textwidth' + 0 no automatic line wrap
1836 'tildeop' + off tilde is not an operator
1837 'ttimeout' + off no terminal timeout
1838 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001839 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001840 'virtualedit' + "" cursor can only be placed on characters
1841 'whichwrap' & "" left-right movements don't wrap
1842 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001844 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845
1846 *'complete'* *'cpt'* *E535*
1847'complete' 'cpt' string (default: ".,w,b,u,t,i")
1848 local to buffer
1849 {not in Vi}
1850 This option specifies how keyword completion |ins-completion| works
1851 when CTRL-P or CTRL-N are used. It is also used for whole-line
1852 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1853 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001854 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 w scan buffers from other windows
1856 b scan other loaded buffers that are in the buffer list
1857 u scan the unloaded buffers that are in the buffer list
1858 U scan the buffers that are not in the buffer list
1859 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001860 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 k{dict} scan the file {dict}. Several "k" flags can be given,
1862 patterns are valid too. For example: >
1863 :set cpt=k/usr/dict/*,k~/spanish
1864< s scan the files given with the 'thesaurus' option
1865 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1866 are valid too.
1867 i scan current and included files
1868 d scan current and included files for defined name or macro
1869 |i_CTRL-X_CTRL-D|
1870 ] tag completion
1871 t same as "]"
1872
1873 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1874 not executed, this may lead to unexpected completions from some files
1875 (gzipped files for example). Unloaded buffers are not scanned for
1876 whole-line completion.
1877
1878 The default is ".,w,b,u,t,i", which means to scan:
1879 1. the current buffer
1880 2. buffers in other windows
1881 3. other loaded buffers
1882 4. unloaded buffers
1883 5. tags
1884 6. included files
1885
1886 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001887 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1888 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001890 *'completefunc'* *'cfu'*
1891'completefunc' 'cfu' string (default: empty)
1892 local to buffer
1893 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001894 {not available when compiled without the |+eval|
1895 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001896 This option specifies a function to be used for Insert mode completion
1897 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001898 See |complete-functions| for an explanation of how the function is
1899 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001900 This option cannot be set from a |modeline| or in the |sandbox|, for
1901 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001902
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001903 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001904'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001905 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001906 {not available when compiled without the
1907 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001908 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001909 A comma separated list of options for Insert mode completion
1910 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001911
1912 menu Use a popup menu to show the possible completions. The
1913 menu is only shown when there is more than one match and
1914 sufficient colors are available. |ins-completion-menu|
1915
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001916 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001917 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001918 match, e.g., what file it comes from.
1919
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001920 longest Only insert the longest common text of the matches. If
1921 the menu is displayed you can use CTRL-L to add more
1922 characters. Whether case is ignored depends on the kind
1923 of completion. For buffer text the 'ignorecase' option is
1924 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001925
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001926 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001927 completion in the preview window. Only works in
1928 combination with "menu" or "menuone".
1929
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001930 noinsert Do not insert any text for a match until the user selects
1931 a match from the menu. Only works in combination with
1932 "menu" or "menuone". No effect if "longest" is present.
1933
1934 noselect Do not select a match in the menu, force the user to
1935 select one from the menu. Only works in combination with
1936 "menu" or "menuone".
1937
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001938
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001939 *'concealcursor'* *'cocu'*
1940'concealcursor' 'cocu' string (default: "")
1941 local to window
1942 {not in Vi}
1943 {not available when compiled without the |+conceal|
1944 feature}
1945 Sets the modes in which text in the cursor line can also be concealed.
1946 When the current mode is listed then concealing happens just like in
1947 other lines.
1948 n Normal mode
1949 v Visual mode
1950 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001951 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001953 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001954 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001955 are moving around text is concealed, but when starting to insert text
1956 or selecting a Visual area the concealed text is displayed, so that
1957 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001958 Keep in mind that the cursor position is not always where it's
1959 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001960
1961
1962'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001963 number (default 0)
1964 local to window
1965 {not in Vi}
1966 {not available when compiled without the |+conceal|
1967 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001968 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1969 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001970
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001971 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001972 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001973 1 Each block of concealed text is replaced with one
1974 character. If the syntax item does not have a custom
1975 replacement character defined (see |:syn-cchar|) the
1976 character defined in 'listchars' is used (default is a
1977 space).
1978 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001979 2 Concealed text is completely hidden unless it has a
1980 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001981 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001982 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001983
Bram Moolenaara7781e02010-07-19 20:13:22 +02001984 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001985 edit and copy the text. This can be changed with the 'concealcursor'
1986 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1989'confirm' 'cf' boolean (default off)
1990 global
1991 {not in Vi}
1992 When 'confirm' is on, certain operations that would normally
1993 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1994 instead raise a |dialog| asking if you wish to save the current
1995 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1996 If 'confirm' is off you can still activate confirmation for one
1997 command only (this is most useful in mappings) with the |:confirm|
1998 command.
1999 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2000
2001 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2002'conskey' 'consk' boolean (default off)
2003 global
2004 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002005 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006
2007 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2008'copyindent' 'ci' boolean (default off)
2009 local to buffer
2010 {not in Vi}
2011 Copy the structure of the existing lines indent when autoindenting a
2012 new line. Normally the new indent is reconstructed by a series of
2013 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2014 in which case only spaces are used). Enabling this option makes the
2015 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002016 existing line. 'expandtab' has no effect on these characters, a Tab
2017 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002019 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 Also see 'preserveindent'.
2021
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002022 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023'cpoptions' 'cpo' string (Vim default: "aABceFs",
2024 Vi default: all flags)
2025 global
2026 {not in Vi}
2027 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002028 this indicates Vi-compatible behavior. This is used for things where
2029 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 'cpoptions' stands for "compatible-options".
2031 Commas can be added for readability.
2032 To avoid problems with flags that are added in the future, use the
2033 "+=" and "-=" feature of ":set" |add-option-flags|.
2034 NOTE: This option is set to the Vi default value when 'compatible' is
2035 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002036 NOTE: This option is set to the POSIX default value at startup when
2037 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002038 variable exists |posix|. This means Vim tries to behave like the
2039 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040
2041 contains behavior ~
2042 *cpo-a*
2043 a When included, a ":read" command with a file name
2044 argument will set the alternate file name for the
2045 current window.
2046 *cpo-A*
2047 A When included, a ":write" command with a file name
2048 argument will set the alternate file name for the
2049 current window.
2050 *cpo-b*
2051 b "\|" in a ":map" command is recognized as the end of
2052 the map command. The '\' is included in the mapping,
2053 the text after the '|' is interpreted as the next
2054 command. Use a CTRL-V instead of a backslash to
2055 include the '|' in the mapping. Applies to all
2056 mapping, abbreviation, menu and autocmd commands.
2057 See also |map_bar|.
2058 *cpo-B*
2059 B A backslash has no special meaning in mappings,
2060 abbreviations and the "to" part of the menu commands.
2061 Remove this flag to be able to use a backslash like a
2062 CTRL-V. For example, the command ":map X \<Esc>"
2063 results in X being mapped to:
2064 'B' included: "\^[" (^[ is a real <Esc>)
2065 'B' excluded: "<Esc>" (5 characters)
2066 ('<' excluded in both cases)
2067 *cpo-c*
2068 c Searching continues at the end of any match at the
2069 cursor position, but not further than the start of the
2070 next line. When not present searching continues
2071 one character from the cursor position. With 'c'
2072 "abababababab" only gets three matches when repeating
2073 "/abab", without 'c' there are five matches.
2074 *cpo-C*
2075 C Do not concatenate sourced lines that start with a
2076 backslash. See |line-continuation|.
2077 *cpo-d*
2078 d Using "./" in the 'tags' option doesn't mean to use
2079 the tags file relative to the current file, but the
2080 tags file in the current directory.
2081 *cpo-D*
2082 D Can't use CTRL-K to enter a digraph after Normal mode
2083 commands with a character argument, like |r|, |f| and
2084 |t|.
2085 *cpo-e*
2086 e When executing a register with ":@r", always add a
2087 <CR> to the last line, also when the register is not
2088 linewise. If this flag is not present, the register
2089 is not linewise and the last line does not end in a
2090 <CR>, then the last line is put on the command-line
2091 and can be edited before hitting <CR>.
2092 *cpo-E*
2093 E It is an error when using "y", "d", "c", "g~", "gu" or
2094 "gU" on an Empty region. The operators only work when
2095 at least one character is to be operate on. Example:
2096 This makes "y0" fail in the first column.
2097 *cpo-f*
2098 f When included, a ":read" command with a file name
2099 argument will set the file name for the current buffer,
2100 if the current buffer doesn't have a file name yet.
2101 *cpo-F*
2102 F When included, a ":write" command with a file name
2103 argument will set the file name for the current
2104 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002105 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 *cpo-g*
2107 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002108 *cpo-H*
2109 H When using "I" on a line with only blanks, insert
2110 before the last blank. Without this flag insert after
2111 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 *cpo-i*
2113 i When included, interrupting the reading of a file will
2114 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002115 *cpo-I*
2116 I When moving the cursor up or down just after inserting
2117 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 *cpo-j*
2119 j When joining lines, only add two spaces after a '.',
2120 not after '!' or '?'. Also see 'joinspaces'.
2121 *cpo-J*
2122 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002123 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 white space.
2125 *cpo-k*
2126 k Disable the recognition of raw key codes in
2127 mappings, abbreviations, and the "to" part of menu
2128 commands. For example, if <Key> sends ^[OA (where ^[
2129 is <Esc>), the command ":map X ^[OA" results in X
2130 being mapped to:
2131 'k' included: "^[OA" (3 characters)
2132 'k' excluded: "<Key>" (one key code)
2133 Also see the '<' flag below.
2134 *cpo-K*
2135 K Don't wait for a key code to complete when it is
2136 halfway a mapping. This breaks mapping <F1><F1> when
2137 only part of the second <F1> has been read. It
2138 enables cancelling the mapping by typing <F1><Esc>.
2139 *cpo-l*
2140 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002141 literally, only "\]", "\^", "\-" and "\\" are special.
2142 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2144 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002145 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 *cpo-L*
2147 L When the 'list' option is set, 'wrapmargin',
2148 'textwidth', 'softtabstop' and Virtual Replace mode
2149 (see |gR|) count a <Tab> as two characters, instead of
2150 the normal behavior of a <Tab>.
2151 *cpo-m*
2152 m When included, a showmatch will always wait half a
2153 second. When not included, a showmatch will wait half
2154 a second or until a character is typed. |'showmatch'|
2155 *cpo-M*
2156 M When excluded, "%" matching will take backslashes into
2157 account. Thus in "( \( )" and "\( ( \)" the outer
2158 parenthesis match. When included "%" ignores
2159 backslashes, which is Vi compatible.
2160 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002161 n When included, the column used for 'number' and
2162 'relativenumber' will also be used for text of wrapped
2163 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 *cpo-o*
2165 o Line offset to search command is not remembered for
2166 next search.
2167 *cpo-O*
2168 O Don't complain if a file is being overwritten, even
2169 when it didn't exist when editing it. This is a
2170 protection against a file unexpectedly created by
2171 someone else. Vi didn't complain about this.
2172 *cpo-p*
2173 p Vi compatible Lisp indenting. When not present, a
2174 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002175 *cpo-P*
2176 P When included, a ":write" command that appends to a
2177 file will set the file name for the current buffer, if
2178 the current buffer doesn't have a file name yet and
2179 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 *cpo-q*
2181 q When joining multiple lines leave the cursor at the
2182 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 *cpo-r*
2184 r Redo ("." command) uses "/" to repeat a search
2185 command, instead of the actually used search string.
2186 *cpo-R*
2187 R Remove marks from filtered lines. Without this flag
2188 marks are kept like |:keepmarks| was used.
2189 *cpo-s*
2190 s Set buffer options when entering the buffer for the
2191 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002192 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 set when the buffer is created.
2194 *cpo-S*
2195 S Set buffer options always when entering a buffer
2196 (except 'readonly', 'fileformat', 'filetype' and
2197 'syntax'). This is the (most) Vi compatible setting.
2198 The options are set to the values in the current
2199 buffer. When you change an option and go to another
2200 buffer, the value is copied. Effectively makes the
2201 buffer options global to all buffers.
2202
2203 's' 'S' copy buffer options
2204 no no when buffer created
2205 yes no when buffer first entered (default)
2206 X yes each time when buffer entered (vi comp.)
2207 *cpo-t*
2208 t Search pattern for the tag command is remembered for
2209 "n" command. Otherwise Vim only puts the pattern in
2210 the history for search pattern, but doesn't change the
2211 last used search pattern.
2212 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002213 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 *cpo-v*
2215 v Backspaced characters remain visible on the screen in
2216 Insert mode. Without this flag the characters are
2217 erased from the screen right away. With this flag the
2218 screen newly typed text overwrites backspaced
2219 characters.
2220 *cpo-w*
2221 w When using "cw" on a blank character, only change one
2222 character and not all blanks until the start of the
2223 next word.
2224 *cpo-W*
2225 W Don't overwrite a readonly file. When omitted, ":w!"
2226 overwrites a readonly file, if possible.
2227 *cpo-x*
2228 x <Esc> on the command-line executes the command-line.
2229 The default in Vim is to abandon the command-line,
2230 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002231 *cpo-X*
2232 X When using a count with "R" the replaced text is
2233 deleted only once. Also when repeating "R" with "."
2234 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 *cpo-y*
2236 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002237 *cpo-Z*
2238 Z When using "w!" while the 'readonly' option is set,
2239 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 *cpo-!*
2241 ! When redoing a filter command, use the last used
2242 external command, whatever it was. Otherwise the last
2243 used -filter- command is used.
2244 *cpo-$*
2245 $ When making a change to one line, don't redisplay the
2246 line, but put a '$' at the end of the changed text.
2247 The changed text will be overwritten when you type the
2248 new text. The line is redisplayed if you type any
2249 command that moves the cursor from the insertion
2250 point.
2251 *cpo-%*
2252 % Vi-compatible matching is done for the "%" command.
2253 Does not recognize "#if", "#endif", etc.
2254 Does not recognize "/*" and "*/".
2255 Parens inside single and double quotes are also
2256 counted, causing a string that contains a paren to
2257 disturb the matching. For example, in a line like
2258 "if (strcmp("foo(", s))" the first paren does not
2259 match the last one. When this flag is not included,
2260 parens inside single and double quotes are treated
2261 specially. When matching a paren outside of quotes,
2262 everything inside quotes is ignored. When matching a
2263 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002264 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002265 This flag is also used for other features, such as
2266 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002267 *cpo--*
2268 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002269 it would go above the first line or below the last
2270 line. Without it the cursor moves to the first or
2271 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002272 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002273 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002274 *cpo-+*
2275 + When included, a ":write file" command will reset the
2276 'modified' flag of the buffer, even though the buffer
2277 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002278 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 * Use ":*" in the same way as ":@". When not included,
2280 ":*" is an alias for ":'<,'>", select the Visual area.
2281 *cpo-<*
2282 < Disable the recognition of special key codes in |<>|
2283 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 ":map X <Tab>" results in X being mapped to:
2286 '<' included: "<Tab>" (5 characters)
2287 '<' excluded: "^I" (^I is a real <Tab>)
2288 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002289 *cpo->*
2290 > When appending to a register, put a line break before
2291 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002292 *cpo-;*
2293 ; When using |,| or |;| to repeat the last |t| search
2294 and the cursor is right in front of the searched
2295 character, the cursor won't move. When not included,
2296 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002297 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002298
2299 POSIX flags. These are not included in the Vi default value, except
2300 when $VIM_POSIX was set on startup. |posix|
2301
2302 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002303 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002304 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305 *cpo-&*
2306 & When ":preserve" was used keep the swap file when
2307 exiting normally while this buffer is still loaded.
2308 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002309 *cpo-\*
2310 \ Backslash in a [] range in a search pattern is taken
2311 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002312 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2313 '\' excluded: "/[ \-]" finds <Space> and '-'
2314 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002315 *cpo-/*
2316 / When "%" is used as the replacement string in a |:s|
2317 command, use the previous replacement string. |:s%|
2318 *cpo-{*
2319 { The |{| and |}| commands also stop at a "{" character
2320 at the start of a line.
2321 *cpo-.*
2322 . The ":chdir" and ":cd" commands fail if the current
2323 buffer is modified, unless ! is used. Vim doesn't
2324 need this, since it remembers the full path of an
2325 opened file.
2326 *cpo-bar*
2327 | The value of the $LINES and $COLUMNS environment
2328 variables overrule the terminal size values obtained
2329 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002332 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002333'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002334 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002335 {not in Vi}
2336 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002337 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002338 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002339 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002340 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002341 blowfish Blowfish method. Medium strong encryption but it has
2342 an implementation flaw. Requires Vim 7.3 or later,
2343 files can NOT be read by Vim 7.2 and older. This adds
2344 a "seed" to the file, every time you write the file
2345 the encrypted bytes will be different.
2346 *blowfish2*
2347 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002348 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002349 and older. This adds a "seed" to the file, every time
2350 you write the file the encrypted bytes will be
2351 different. The whole undo file is encrypted, not just
2352 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002353
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002354 You should use "blowfish2", also to re-encrypt older files.
2355
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002356 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002357 to the detected method of the file being read. Thus if you write it
2358 without changing 'cryptmethod' the same method will be used.
2359 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002360 explicitly write it, you don't get a warning unless there are other
2361 modifications. Also see |:X|.
2362
2363 When setting the global value to an empty string, it will end up with
2364 the value "zip". When setting the local value to an empty string the
2365 buffer will use the global value.
2366
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002367 When a new encryption method is added in a later version of Vim, and
2368 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002369 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002370
2371
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 *'cscopepathcomp'* *'cspc'*
2373'cscopepathcomp' 'cspc' number (default 0)
2374 global
2375 {not available when compiled without the |+cscope|
2376 feature}
2377 {not in Vi}
2378 Determines how many components of the path to show in a list of tags.
2379 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002380 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381
2382 *'cscopeprg'* *'csprg'*
2383'cscopeprg' 'csprg' string (default "cscope")
2384 global
2385 {not available when compiled without the |+cscope|
2386 feature}
2387 {not in Vi}
2388 Specifies the command to execute cscope. See |cscopeprg|.
2389 This option cannot be set from a |modeline| or in the |sandbox|, for
2390 security reasons.
2391
2392 *'cscopequickfix'* *'csqf'*
2393'cscopequickfix' 'csqf' string (default "")
2394 global
2395 {not available when compiled without the |+cscope|
2396 or |+quickfix| features}
2397 {not in Vi}
2398 Specifies whether to use quickfix window to show cscope results.
2399 See |cscopequickfix|.
2400
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002401 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002402'cscoperelative' 'csre' boolean (default off)
2403 global
2404 {not available when compiled without the |+cscope|
2405 feature}
2406 {not in Vi}
2407 In the absence of a prefix (-P) for cscope. setting this option enables
2408 to use the basename of cscope.out path as the prefix.
2409 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002410 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002411
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2413'cscopetag' 'cst' boolean (default off)
2414 global
2415 {not available when compiled without the |+cscope|
2416 feature}
2417 {not in Vi}
2418 Use cscope for tag commands. See |cscope-options|.
2419 NOTE: This option is reset when 'compatible' is set.
2420
2421 *'cscopetagorder'* *'csto'*
2422'cscopetagorder' 'csto' number (default 0)
2423 global
2424 {not available when compiled without the |+cscope|
2425 feature}
2426 {not in Vi}
2427 Determines the order in which ":cstag" performs a search. See
2428 |cscopetagorder|.
2429 NOTE: This option is set to 0 when 'compatible' is set.
2430
2431 *'cscopeverbose'* *'csverb'*
2432 *'nocscopeverbose'* *'nocsverb'*
2433'cscopeverbose' 'csverb' boolean (default off)
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
2437 {not in Vi}
2438 Give messages when adding a cscope database. See |cscopeverbose|.
2439 NOTE: This option is reset when 'compatible' is set.
2440
Bram Moolenaar860cae12010-06-05 23:22:07 +02002441 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2442'cursorbind' 'crb' boolean (default off)
2443 local to window
2444 {not in Vi}
2445 {not available when compiled without the |+cursorbind|
2446 feature}
2447 When this option is set, as the cursor in the current
2448 window moves other cursorbound windows (windows that also have
2449 this option set) move their cursors to the corresponding line and
2450 column. This option is useful for viewing the
2451 differences between two versions of a file (see 'diff'); in diff mode,
2452 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002453 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002454
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002455
2456 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2457'cursorcolumn' 'cuc' boolean (default off)
2458 local to window
2459 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002460 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002461 feature}
2462 Highlight the screen column of the cursor with CursorColumn
2463 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2464 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002465 If you only want the highlighting in the current window you can use
2466 these autocommands: >
2467 au WinLeave * set nocursorline nocursorcolumn
2468 au WinEnter * set cursorline cursorcolumn
2469<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470
2471 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2472'cursorline' 'cul' boolean (default off)
2473 local to window
2474 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002475 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002476 feature}
2477 Highlight the screen line of the cursor with CursorLine
2478 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2479 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002480 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002481 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002482
2483
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 *'debug'*
2485'debug' string (default "")
2486 global
2487 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002488 These values can be used:
2489 msg Error messages that would otherwise be omitted will be given
2490 anyway.
2491 throw Error messages that would otherwise be omitted will be given
2492 anyway and also throw an exception and set |v:errmsg|.
2493 beep A message will be given when otherwise only a beep would be
2494 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002495 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002496 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2497 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498
2499 *'define'* *'def'*
2500'define' 'def' string (default "^\s*#\s*define")
2501 global or local to buffer |global-local|
2502 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002503 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 pattern, just like for the "/" command. This option is used for the
2505 commands like "[i" and "[d" |include-search|. The 'isident' option is
2506 used to recognize the defined name after the match:
2507 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2508 See |option-backslash| about inserting backslashes to include a space
2509 or backslash.
2510 The default value is for C programs. For C++ this value would be
2511 useful, to include const type declarations: >
2512 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2513< When using the ":set" command, you need to double the backslashes!
2514
2515 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2516'delcombine' 'deco' boolean (default off)
2517 global
2518 {not in Vi}
2519 {only available when compiled with the |+multi_byte|
2520 feature}
2521 If editing Unicode and this option is set, backspace and Normal mode
2522 "x" delete each combining character on its own. When it is off (the
2523 default) the character along with its combining characters are
2524 deleted.
2525 Note: When 'delcombine' is set "xx" may work different from "2x"!
2526
2527 This is useful for Arabic, Hebrew and many other languages where one
2528 may have combining characters overtop of base characters, and want
2529 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002530 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531
2532 *'dictionary'* *'dict'*
2533'dictionary' 'dict' string (default "")
2534 global or local to buffer |global-local|
2535 {not in Vi}
2536 List of file names, separated by commas, that are used to lookup words
2537 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2538 contain a list of words. This can be one word per line, or several
2539 words per line, separated by non-keyword characters (white space is
2540 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002541 When this option is empty, or an entry "spell" is present, spell
2542 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002543 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 after a comma are ignored, otherwise spaces are included in the file
2545 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002546 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 Where to find a list of words?
2548 - On FreeBSD, there is the file "/usr/share/dict/words".
2549 - In the Simtel archive, look in the "msdos/linguist" directory.
2550 - In "miscfiles" of the GNU collection.
2551 The use of |:set+=| and |:set-=| is preferred when adding or removing
2552 directories from the list. This avoids problems when a future version
2553 uses another default.
2554 Backticks cannot be used in this option for security reasons.
2555
2556 *'diff'* *'nodiff'*
2557'diff' boolean (default off)
2558 local to window
2559 {not in Vi}
2560 {not available when compiled without the |+diff|
2561 feature}
2562 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002563 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564
2565 *'dex'* *'diffexpr'*
2566'diffexpr' 'dex' string (default "")
2567 global
2568 {not in Vi}
2569 {not available when compiled without the |+diff|
2570 feature}
2571 Expression which is evaluated to obtain an ed-style diff file from two
2572 versions of a file. See |diff-diffexpr|.
2573 This option cannot be set from a |modeline| or in the |sandbox|, for
2574 security reasons.
2575
2576 *'dip'* *'diffopt'*
2577'diffopt' 'dip' string (default "filler")
2578 global
2579 {not in Vi}
2580 {not available when compiled without the |+diff|
2581 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002582 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 All are optional. Items must be separated by a comma.
2584
2585 filler Show filler lines, to keep the text
2586 synchronized with a window that has inserted
2587 lines at the same position. Mostly useful
2588 when windows are side-by-side and 'scrollbind'
2589 is set.
2590
2591 context:{n} Use a context of {n} lines between a change
2592 and a fold that contains unchanged lines.
2593 When omitted a context of six lines is used.
2594 See |fold-diff|.
2595
2596 icase Ignore changes in case of text. "a" and "A"
2597 are considered the same. Adds the "-i" flag
2598 to the "diff" command if 'diffexpr' is empty.
2599
2600 iwhite Ignore changes in amount of white space. Adds
2601 the "-b" flag to the "diff" command if
2602 'diffexpr' is empty. Check the documentation
2603 of the "diff" command for what this does
2604 exactly. It should ignore adding trailing
2605 white space, but not leading white space.
2606
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002607 horizontal Start diff mode with horizontal splits (unless
2608 explicitly specified otherwise).
2609
2610 vertical Start diff mode with vertical splits (unless
2611 explicitly specified otherwise).
2612
2613 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2614 starting diff mode. Without this 2 is used.
2615
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 Examples: >
2617
2618 :set diffopt=filler,context:4
2619 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002620 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621<
2622 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2623'digraph' 'dg' boolean (default off)
2624 global
2625 {not in Vi}
2626 {not available when compiled without the |+digraphs|
2627 feature}
2628 Enable the entering of digraphs in Insert mode with {char1} <BS>
2629 {char2}. See |digraphs|.
2630 NOTE: This option is reset when 'compatible' is set.
2631
2632 *'directory'* *'dir'*
2633'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002634 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 for Unix: ".,~/tmp,/var/tmp,/tmp")
2636 global
2637 List of directory names for the swap file, separated with commas.
2638 - The swap file will be created in the first directory where this is
2639 possible.
2640 - Empty means that no swap file will be used (recovery is
2641 impossible!).
2642 - A directory "." means to put the swap file in the same directory as
2643 the edited file. On Unix, a dot is prepended to the file name, so
2644 it doesn't show in a directory listing. On MS-Windows the "hidden"
2645 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002646 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 put the swap file relative to where the edited file is. The leading
2648 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002649 - For Unix and Win32, if a directory ends in two path separators "//"
2650 or "\\", the swap file name will be built from the complete path to
2651 the file with all path separators substituted to percent '%' signs.
2652 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002653 On Win32, when a separating comma is following, you must use "//",
2654 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655 - Spaces after the comma are ignored, other spaces are considered part
2656 of the directory name. To have a space at the start of a directory
2657 name, precede it with a backslash.
2658 - To include a comma in a directory name precede it with a backslash.
2659 - A directory name may end in an ':' or '/'.
2660 - Environment variables are expanded |:set_env|.
2661 - Careful with '\' characters, type one before a space, type two to
2662 get one in the option (see |option-backslash|), for example: >
2663 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2664< - For backwards compatibility with Vim version 3.0 a '>' at the start
2665 of the option is removed.
2666 Using "." first in the list is recommended. This means that editing
2667 the same file twice will result in a warning. Using "/tmp" on Unix is
2668 discouraged: When the system crashes you lose the swap file.
2669 "/var/tmp" is often not cleared when rebooting, thus is a better
2670 choice than "/tmp". But it can contain a lot of files, your swap
2671 files get lost in the crowd. That is why a "tmp" directory in your
2672 home directory is tried first.
2673 The use of |:set+=| and |:set-=| is preferred when adding or removing
2674 directories from the list. This avoids problems when a future version
2675 uses another default.
2676 This option cannot be set from a |modeline| or in the |sandbox|, for
2677 security reasons.
2678 {Vi: directory to put temp file in, defaults to "/tmp"}
2679
2680 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002681'display' 'dy' string (default "", set to "truncate" in
2682 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 global
2684 {not in Vi}
2685 Change the way text is displayed. This is comma separated list of
2686 flags:
2687 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002688 in a window will be displayed. "@@@" is put in the
2689 last columns of the last screen line to indicate the
2690 rest of the line is not displayed.
2691 truncate Like "lastline", but "@@@" is displayed in the first
2692 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 uhex Show unprintable characters hexadecimal as <xx>
2694 instead of using ^C and ~C.
2695
Bram Moolenaard0796902016-09-16 20:02:31 +02002696 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002697 doesn't fit is replaced with "@" lines.
2698
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 *'eadirection'* *'ead'*
2700'eadirection' 'ead' string (default "both")
2701 global
2702 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002703 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 feature}
2705 Tells when the 'equalalways' option applies:
2706 ver vertically, width of windows is not affected
2707 hor horizontally, height of windows is not affected
2708 both width and height of windows is affected
2709
2710 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2711'edcompatible' 'ed' boolean (default off)
2712 global
2713 Makes the 'g' and 'c' flags of the ":substitute" command to be
2714 toggled each time the flag is given. See |complex-change|. See
2715 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002716 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717
Bram Moolenaar03413f42016-04-12 21:07:15 +02002718 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002719'emoji' 'emo' boolean (default: on)
2720 global
2721 {not in Vi}
2722 {only available when compiled with the |+multi_byte|
2723 feature}
2724 When on all Unicode emoji characters are considered to be full width.
2725
2726
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 *'encoding'* *'enc'* *E543*
2728'encoding' 'enc' string (default: "latin1" or value from $LANG)
2729 global
2730 {only available when compiled with the |+multi_byte|
2731 feature}
2732 {not in Vi}
2733 Sets the character encoding used inside Vim. It applies to text in
2734 the buffers, registers, Strings in expressions, text stored in the
2735 viminfo file, etc. It sets the kind of characters which Vim can work
2736 with. See |encoding-names| for the possible values.
2737
2738 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002739 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002741 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742
Bram Moolenaar865242e2010-07-14 21:12:05 +02002743 This option cannot be set from a |modeline|. It would most likely
2744 corrupt the text.
2745
Bram Moolenaar3df01732017-02-17 22:47:16 +01002746 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2747 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 'encoding', "utf-8" is the natural choice for the environment and
2749 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002750 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 versions, and to avoid changing the encoding of newly created files
2752 without your knowledge (in case 'fileencodings' is empty).
2753
2754 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002755 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 iconv() or as specified with 'charconvert'.
2757
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002758 If you need to know whether 'encoding' is a multi-byte encoding, you
2759 can use: >
2760 if has("multi_byte_encoding")
2761<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 Normally 'encoding' will be equal to your current locale. This will
2763 be the default if Vim recognizes your environment settings. If
2764 'encoding' is not set to the current locale, 'termencoding' must be
2765 set to convert typed and displayed text. See |encoding-table|.
2766
2767 When you set this option, it fires the |EncodingChanged| autocommand
2768 event so that you can set up fonts if necessary.
2769
2770 When the option is set, the value is converted to lowercase. Thus
2771 you can set it with uppercase values too. Underscores are translated
2772 to '-' signs.
2773 When the encoding is recognized, it is changed to the standard name.
2774 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2775 "iso-8859-2" and "utf8" becomes "utf-8".
2776
2777 Note: "latin1" is also used when the encoding could not be detected.
2778 This only works when editing files in the same encoding! When the
2779 actual character set is not latin1, make sure 'fileencoding' and
2780 'fileencodings' are empty. When conversion is needed, switch to using
2781 utf-8.
2782
2783 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2784 You don't notice this while editing, but it does matter for the
2785 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2786 setting 'encoding' to one of these values instead of utf-8 only has
2787 effect for encoding used for files when 'fileencoding' is empty.
2788
Bram Moolenaar661b1822005-07-28 22:36:45 +00002789 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2790 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
2792 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2793'endofline' 'eol' boolean (default on)
2794 local to buffer
2795 {not in Vi}
2796 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002797 is on, or 'fixeol' option is off, no <EOL> will be written for the
2798 last line in the file. This option is automatically set or reset when
2799 starting to edit a new file, depending on whether file has an <EOL>
2800 for the last line in the file. Normally you don't have to set or
2801 reset this option.
2802 When 'binary' is off and 'fixeol' is on the value is not used when
2803 writing the file. When 'binary' is on or 'fixeol' is off it is used
2804 to remember the presence of a <EOL> for the last line in the file, so
2805 that when you write the file the situation from the original file can
2806 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807
2808 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2809'equalalways' 'ea' boolean (default on)
2810 global
2811 {not in Vi}
2812 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002813 splitting or closing a window. This also happens the moment the
2814 option is switched on. When off, splitting a window will reduce the
2815 size of the current window and leave the other windows the same. When
2816 closing a window the extra lines are given to the window next to it
2817 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 When mixing vertically and horizontally split windows, a minimal size
2819 is computed and some windows may be larger if there is room. The
2820 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002821 Changing the height and width of a window can be avoided by setting
2822 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002823 If a window size is specified when creating a new window sizes are
2824 currently not equalized (it's complicated, but may be implemented in
2825 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826
2827 *'equalprg'* *'ep'*
2828'equalprg' 'ep' string (default "")
2829 global or local to buffer |global-local|
2830 {not in Vi}
2831 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002832 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002833 or 'indentexpr'. When Vim was compiled without internal formatting,
2834 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002835 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 about including spaces and backslashes.
2837 This option cannot be set from a |modeline| or in the |sandbox|, for
2838 security reasons.
2839
2840 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2841'errorbells' 'eb' boolean (default off)
2842 global
2843 Ring the bell (beep or screen flash) for error messages. This only
2844 makes a difference for error messages, the bell will be used always
2845 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002846 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002847 screen flash or do nothing. See 'belloff' to finetune when to ring the
2848 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849
2850 *'errorfile'* *'ef'*
2851'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2852 others: "errors.err")
2853 global
2854 {not in Vi}
2855 {not available when compiled without the |+quickfix|
2856 feature}
2857 Name of the errorfile for the QuickFix mode (see |:cf|).
2858 When the "-q" command-line argument is used, 'errorfile' is set to the
2859 following argument. See |-q|.
2860 NOT used for the ":make" command. See 'makeef' for that.
2861 Environment variables are expanded |:set_env|.
2862 See |option-backslash| about including spaces and backslashes.
2863 This option cannot be set from a |modeline| or in the |sandbox|, for
2864 security reasons.
2865
2866 *'errorformat'* *'efm'*
2867'errorformat' 'efm' string (default is very long)
2868 global or local to buffer |global-local|
2869 {not in Vi}
2870 {not available when compiled without the |+quickfix|
2871 feature}
2872 Scanf-like description of the format for the lines in the error file
2873 (see |errorformat|).
2874
2875 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2876'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2877 global
2878 {not in Vi}
2879 Function keys that start with an <Esc> are recognized in Insert
2880 mode. When this option is off, the cursor and function keys cannot be
2881 used in Insert mode if they start with an <Esc>. The advantage of
2882 this is that the single <Esc> is recognized immediately, instead of
2883 after one second. Instead of resetting this option, you might want to
2884 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2885 when 'esckeys' is off, you can still map anything, but the cursor keys
2886 won't work by default.
2887 NOTE: This option is set to the Vi default value when 'compatible' is
2888 set and to the Vim default value when 'compatible' is reset.
2889
2890 *'eventignore'* *'ei'*
2891'eventignore' 'ei' string (default "")
2892 global
2893 {not in Vi}
2894 {not available when compiled without the |+autocmd|
2895 feature}
2896 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002897 When set to "all" or when "all" is one of the items, all autocommand
2898 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 Otherwise this is a comma separated list of event names. Example: >
2900 :set ei=WinEnter,WinLeave
2901<
2902 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2903'expandtab' 'et' boolean (default off)
2904 local to buffer
2905 {not in Vi}
2906 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2909 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002910 This option is reset when the 'paste' option is set and restored when
2911 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 NOTE: This option is reset when 'compatible' is set.
2913
2914 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2915'exrc' 'ex' boolean (default off)
2916 global
2917 {not in Vi}
2918 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002919 directory.
2920
2921 Setting this option is a potential security leak. E.g., consider
2922 unpacking a package or fetching files from github, a .vimrc in there
2923 might be a trojan horse. BETTER NOT SET THIS OPTION!
2924 Instead, define an autocommand in your .vimrc to set options for a
2925 matching directory.
2926
2927 If you do switch this option on you should also consider setting the
2928 'secure' option (see |initialization|).
2929 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 This option cannot be set from a |modeline| or in the |sandbox|, for
2931 security reasons.
2932
2933 *'fileencoding'* *'fenc'* *E213*
2934'fileencoding' 'fenc' string (default: "")
2935 local to buffer
2936 {only available when compiled with the |+multi_byte|
2937 feature}
2938 {not in Vi}
2939 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002942 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 When 'fileencoding' is empty, the same value as 'encoding' will be
2944 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002945 No error will be given when the value is set, only when it is used,
2946 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002947 Conversion will also be done when 'encoding' and 'fileencoding' are
2948 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2949 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002951 'encoding' is "utf-8" or another Unicode encoding, conversion
2952 is most likely done in a way that the reverse conversion
2953 results in the same text. When 'encoding' is not "utf-8" some
2954 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002955
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 See 'encoding' for the possible values. Additionally, values may be
2957 specified that can be handled by the converter, see
2958 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002959
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 When reading a file 'fileencoding' will be set from 'fileencodings'.
2961 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002962 'fileencoding', use the |++enc| argument. One exception: when
2963 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002964 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002965
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2967 When the option is set, the value is converted to lowercase. Thus
2968 you can set it with uppercase values too. '_' characters are
2969 replaced with '-'. If a name is recognized from the list for
2970 'encoding', it is replaced by the standard name. For example
2971 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 When this option is set, after starting to edit a file, the 'modified'
2974 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975
2976 Keep in mind that changing 'fenc' from a modeline happens
2977 AFTER the text has been read, thus it applies to when the file will be
2978 written. If you do set 'fenc' in a modeline, you might want to set
2979 'nomodified' to avoid not being able to ":q".
2980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 This option can not be changed when 'modifiable' is off.
2982
2983 *'fe'*
2984 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002985 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 old short name was 'fe', which is no longer used.
2987
2988 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002989'fileencodings' 'fencs' string (default: "ucs-bom",
2990 "ucs-bom,utf-8,default,latin1" when
2991 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 global
2993 {only available when compiled with the |+multi_byte|
2994 feature}
2995 {not in Vi}
2996 This is a list of character encodings considered when starting to edit
2997 an existing file. When a file is read, Vim tries to use the first
2998 mentioned character encoding. If an error is detected, the next one
2999 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 an empty string, which means the value of 'encoding' is used.
3002 WARNING: Conversion can cause loss of information! When
3003 'encoding' is "utf-8" (or one of the other Unicode variants)
3004 conversion is most likely done in a way that the reverse
3005 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003006 "utf-8" some non-ASCII characters may be lost! You can use
3007 the |++bad| argument to specify what is done with characters
3008 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 For an empty file or a file with only ASCII characters most encodings
3010 will work and the first entry of 'fileencodings' will be used (except
3011 "ucs-bom", which requires the BOM to be present). If you prefer
3012 another encoding use an BufReadPost autocommand event to test if your
3013 preferred encoding is to be used. Example: >
3014 au BufReadPost * if search('\S', 'w') == 0 |
3015 \ set fenc=iso-2022-jp | endif
3016< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3017 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003018 When the |++enc| argument is used then the value of 'fileencodings' is
3019 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003020 Note that 'fileencodings' is not used for a new file, the global value
3021 of 'fileencoding' is used instead. You can set it with: >
3022 :setglobal fenc=iso-8859-2
3023< This means that a non-existing file may get a different encoding than
3024 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 The special value "ucs-bom" can be used to check for a Unicode BOM
3026 (Byte Order Mark) at the start of the file. It must not be preceded
3027 by "utf-8" or another Unicode encoding for this to work properly.
3028 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3029 because Vim cannot detect an error, thus the encoding is always
3030 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003031 The special value "default" can be used for the encoding from the
3032 environment. This is the default value for 'encoding'. It is useful
3033 when 'encoding' is set to "utf-8" and your environment uses a
3034 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003035 When 'encoding' is "utf-8" and a file contains an illegal byte
3036 sequence it won't be recognized as UTF-8. You can use the |8g8|
3037 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 WRONG VALUES: WHAT'S WRONG:
3039 latin1,utf-8 "latin1" will always be used
3040 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3041 file
3042 cp1250,latin1 "cp1250" will always be used
3043 If 'fileencodings' is empty, 'fileencoding' is not modified.
3044 See 'fileencoding' for the possible values.
3045 Setting this option does not have an effect until the next time a file
3046 is read.
3047
3048 *'fileformat'* *'ff'*
3049'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3050 Unix default: "unix",
3051 Macintosh default: "mac")
3052 local to buffer
3053 {not in Vi}
3054 This gives the <EOL> of the current buffer, which is used for
3055 reading/writing the buffer from/to a file:
3056 dos <CR> <NL>
3057 unix <NL>
3058 mac <CR>
3059 When "dos" is used, CTRL-Z at the end of a file is ignored.
3060 See |file-formats| and |file-read|.
3061 For the character encoding of the file see 'fileencoding'.
3062 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003063 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064 This option is set automatically when starting to edit a file and
3065 'fileformats' is not empty and 'binary' is off.
3066 When this option is set, after starting to edit a file, the 'modified'
3067 option is set, because the file would be different when written.
3068 This option can not be changed when 'modifiable' is off.
3069 For backwards compatibility: When this option is set to "dos",
3070 'textmode' is set, otherwise 'textmode' is reset.
3071
3072 *'fileformats'* *'ffs'*
3073'fileformats' 'ffs' string (default:
3074 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3075 Vim Unix: "unix,dos",
3076 Vim Mac: "mac,unix,dos",
3077 Vi Cygwin: "unix,dos",
3078 Vi others: "")
3079 global
3080 {not in Vi}
3081 This gives the end-of-line (<EOL>) formats that will be tried when
3082 starting to edit a new buffer and when reading a file into an existing
3083 buffer:
3084 - When empty, the format defined with 'fileformat' will be used
3085 always. It is not set automatically.
3086 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003087 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 'fileformats' name will be used when a file is read into an existing
3089 buffer, no matter what 'fileformat' for that buffer is set to.
3090 - When more than one name is present, separated by commas, automatic
3091 <EOL> detection will be done when reading a file. When starting to
3092 edit a file, a check is done for the <EOL>:
3093 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3094 'fileformat' is set to "dos".
3095 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003096 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003098 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3099 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003100 This means that "mac" is only chosen when:
3101 "unix" is not present or no <NL> is found in the file, and
3102 "dos" is not present or no <CR><NL> is found in the file.
3103 Except: if "unix" was chosen, but there is a <CR> before
3104 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003105 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 4. If 'fileformat' is still not set, the first name from
3107 'fileformats' is used.
3108 When reading a file into an existing buffer, the same is done, but
3109 this happens like 'fileformat' has been set appropriately for that
3110 file only, the option is not changed.
3111 When 'binary' is set, the value of 'fileformats' is not used.
3112
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003113 When Vim starts up with an empty buffer the first item is used. You
3114 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003115
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3117 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3118 done:
3119 - When 'fileformats' is empty, there is no automatic detection. Dos
3120 format will be used.
3121 - When 'fileformats' is set to one or more names, automatic detection
3122 is done. This is based on the first <NL> in the file: If there is a
3123 <CR> in front of it, Dos format is used, otherwise Unix format is
3124 used.
3125 Also see |file-formats|.
3126 For backwards compatibility: When this option is set to an empty
3127 string or one format (no comma is included), 'textauto' is reset,
3128 otherwise 'textauto' is set.
3129 NOTE: This option is set to the Vi default value when 'compatible' is
3130 set and to the Vim default value when 'compatible' is reset.
3131
Bram Moolenaarbf884932013-04-05 22:26:15 +02003132 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3133'fileignorecase' 'fic' boolean (default on for systems where case in file
3134 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003135 global
3136 {not in Vi}
3137 When set case is ignored when using file names and directories.
3138 See 'wildignorecase' for only ignoring case when doing completion.
3139
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 *'filetype'* *'ft'*
3141'filetype' 'ft' string (default: "")
3142 local to buffer
3143 {not in Vi}
3144 {not available when compiled without the |+autocmd|
3145 feature}
3146 When this option is set, the FileType autocommand event is triggered.
3147 All autocommands that match with the value of this option will be
3148 executed. Thus the value of 'filetype' is used in place of the file
3149 name.
3150 Otherwise this option does not always reflect the current file type.
3151 This option is normally set when the file type is detected. To enable
3152 this use the ":filetype on" command. |:filetype|
3153 Setting this option to a different value is most useful in a modeline,
3154 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003155 Example, for in an IDL file:
3156 /* vim: set filetype=idl : */ ~
3157 |FileType| |filetypes|
3158 When a dot appears in the value then this separates two filetype
3159 names. Example:
3160 /* vim: set filetype=c.doxygen : */ ~
3161 This will use the "c" filetype first, then the "doxygen" filetype.
3162 This works both for filetype plugins and for syntax files. More than
3163 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 This option is not copied to another buffer, independent of the 's' or
3165 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003166 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167
3168 *'fillchars'* *'fcs'*
3169'fillchars' 'fcs' string (default "vert:|,fold:-")
3170 global
3171 {not in Vi}
3172 {not available when compiled without the |+windows|
3173 and |+folding| features}
3174 Characters to fill the statuslines and vertical separators.
3175 It is a comma separated list of items:
3176
3177 item default Used for ~
3178 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003179 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 vert:c '|' vertical separators |:vsplit|
3181 fold:c '-' filling 'foldtext'
3182 diff:c '-' deleted lines of the 'diff' option
3183
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003184 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003185 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 otherwise.
3187
3188 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003189 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190< This is similar to the default, except that these characters will also
3191 be used when there is highlighting.
3192
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003193 for "stl" and "stlnc" only single-byte values are supported.
3194
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 The highlighting used for these items:
3196 item highlight group ~
3197 stl:c StatusLine |hl-StatusLine|
3198 stlnc:c StatusLineNC |hl-StatusLineNC|
3199 vert:c VertSplit |hl-VertSplit|
3200 fold:c Folded |hl-Folded|
3201 diff:c DiffDelete |hl-DiffDelete|
3202
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003203 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3204'fixendofline' 'fixeol' boolean (default on)
3205 local to buffer
3206 {not in Vi}
3207 When writing a file and this option is on, <EOL> at the end of file
3208 will be restored if missing. Turn this option off if you want to
3209 preserve the situation from the original file.
3210 When the 'binary' option is set the value of this option doesn't
3211 matter.
3212 See the 'endofline' option.
3213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3215'fkmap' 'fk' boolean (default off) *E198*
3216 global
3217 {not in Vi}
3218 {only available when compiled with the |+rightleft|
3219 feature}
3220 When on, the keyboard is mapped for the Farsi character set.
3221 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003222 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223
3224 *'foldclose'* *'fcl'*
3225'foldclose' 'fcl' string (default "")
3226 global
3227 {not in Vi}
3228 {not available when compiled without the |+folding|
3229 feature}
3230 When set to "all", a fold is closed when the cursor isn't in it and
3231 its level is higher than 'foldlevel'. Useful if you want folds to
3232 automatically close when moving out of them.
3233
3234 *'foldcolumn'* *'fdc'*
3235'foldcolumn' 'fdc' number (default 0)
3236 local to window
3237 {not in Vi}
3238 {not available when compiled without the |+folding|
3239 feature}
3240 When non-zero, a column with the specified width is shown at the side
3241 of the window which indicates open and closed folds. The maximum
3242 value is 12.
3243 See |folding|.
3244
3245 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3246'foldenable' 'fen' boolean (default on)
3247 local to window
3248 {not in Vi}
3249 {not available when compiled without the |+folding|
3250 feature}
3251 When off, all folds are open. This option can be used to quickly
3252 switch between showing all text unfolded and viewing the text with
3253 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003254 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 'foldenable' is off.
3256 This option is set by commands that create a new fold or close a fold.
3257 See |folding|.
3258
3259 *'foldexpr'* *'fde'*
3260'foldexpr' 'fde' string (default: "0")
3261 local to window
3262 {not in Vi}
3263 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003264 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003266 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003267
Bram Moolenaar30b65812012-07-12 22:01:11 +02003268 The expression will be evaluated in the |sandbox| if set from a
3269 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003270 This option can't be set from a |modeline| when the 'diff' option is
3271 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003272
3273 It is not allowed to change text or jump to another window while
3274 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275
3276 *'foldignore'* *'fdi'*
3277'foldignore' 'fdi' string (default: "#")
3278 local to window
3279 {not in Vi}
3280 {not available when compiled without the |+folding|
3281 feature}
3282 Used only when 'foldmethod' is "indent". Lines starting with
3283 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 The default "#" works well for C programs. See |fold-indent|.
3286
3287 *'foldlevel'* *'fdl'*
3288'foldlevel' 'fdl' number (default: 0)
3289 local to window
3290 {not in Vi}
3291 {not available when compiled without the |+folding|
3292 feature}
3293 Sets the fold level: Folds with a higher level will be closed.
3294 Setting this option to zero will close all folds. Higher numbers will
3295 close fewer folds.
3296 This option is set by commands like |zm|, |zM| and |zR|.
3297 See |fold-foldlevel|.
3298
3299 *'foldlevelstart'* *'fdls'*
3300'foldlevelstart' 'fdls' number (default: -1)
3301 global
3302 {not in Vi}
3303 {not available when compiled without the |+folding|
3304 feature}
3305 Sets 'foldlevel' when starting to edit another buffer in a window.
3306 Useful to always start editing with all folds closed (value zero),
3307 some folds closed (one) or no folds closed (99).
3308 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 ignores this option and closes all folds.
3311 It is also done before BufReadPre autocommands, to allow an autocmd to
3312 overrule the 'foldlevel' value for specific files.
3313 When the value is negative, it is not used.
3314
3315 *'foldmarker'* *'fmr'* *E536*
3316'foldmarker' 'fmr' string (default: "{{{,}}}")
3317 local to window
3318 {not in Vi}
3319 {not available when compiled without the |+folding|
3320 feature}
3321 The start and end marker used when 'foldmethod' is "marker". There
3322 must be one comma, which separates the start and end marker. The
3323 marker is a literal string (a regular expression would be too slow).
3324 See |fold-marker|.
3325
3326 *'foldmethod'* *'fdm'*
3327'foldmethod' 'fdm' string (default: "manual")
3328 local to window
3329 {not in Vi}
3330 {not available when compiled without the |+folding|
3331 feature}
3332 The kind of folding used for the current window. Possible values:
3333 |fold-manual| manual Folds are created manually.
3334 |fold-indent| indent Lines with equal indent form a fold.
3335 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3336 |fold-marker| marker Markers are used to specify folds.
3337 |fold-syntax| syntax Syntax highlighting items specify folds.
3338 |fold-diff| diff Fold text that is not changed.
3339
3340 *'foldminlines'* *'fml'*
3341'foldminlines' 'fml' number (default: 1)
3342 local to window
3343 {not in Vi}
3344 {not available when compiled without the |+folding|
3345 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003346 Sets the number of screen lines above which a fold can be displayed
3347 closed. Also for manually closed folds. With the default value of
3348 one a fold can only be closed if it takes up two or more screen lines.
3349 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003350 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 "zc" to close a fold, which is displayed open because it's smaller
3352 than 'foldminlines', a following "zc" may close a containing fold.
3353
3354 *'foldnestmax'* *'fdn'*
3355'foldnestmax' 'fdn' number (default: 20)
3356 local to window
3357 {not in Vi}
3358 {not available when compiled without the |+folding|
3359 feature}
3360 Sets the maximum nesting of folds for the "indent" and "syntax"
3361 methods. This avoids that too many folds will be created. Using more
3362 than 20 doesn't work, because the internal limit is 20.
3363
3364 *'foldopen'* *'fdo'*
3365'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3366 search,tag,undo")
3367 global
3368 {not in Vi}
3369 {not available when compiled without the |+folding|
3370 feature}
3371 Specifies for which type of commands folds will be opened, if the
3372 command moves the cursor into a closed fold. It is a comma separated
3373 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003374 NOTE: When the command is part of a mapping this option is not used.
3375 Add the |zv| command to the mapping to get the same effect.
3376 (rationale: the mapping may want to control opening folds itself)
3377
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 item commands ~
3379 all any
3380 block "(", "{", "[[", "[{", etc.
3381 hor horizontal movements: "l", "w", "fx", etc.
3382 insert any command in Insert mode
3383 jump far jumps: "G", "gg", etc.
3384 mark jumping to a mark: "'m", CTRL-O, etc.
3385 percent "%"
3386 quickfix ":cn", ":crew", ":make", etc.
3387 search search for a pattern: "/", "n", "*", "gd", etc.
3388 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003389 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 tag jumping to a tag: ":ta", CTRL-T, etc.
3391 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 When a movement command is used for an operator (e.g., "dl" or "y%")
3393 this option is not used. This means the operator will include the
3394 whole closed fold.
3395 Note that vertical movements are not here, because it would make it
3396 very difficult to move onto a closed fold.
3397 In insert mode the folds containing the cursor will always be open
3398 when text is inserted.
3399 To close folds you can re-apply 'foldlevel' with the |zx| command or
3400 set the 'foldclose' option to "all".
3401
3402 *'foldtext'* *'fdt'*
3403'foldtext' 'fdt' string (default: "foldtext()")
3404 local to window
3405 {not in Vi}
3406 {not available when compiled without the |+folding|
3407 feature}
3408 An expression which is used to specify the text displayed for a closed
3409 fold. See |fold-foldtext|.
3410
Bram Moolenaar30b65812012-07-12 22:01:11 +02003411 The expression will be evaluated in the |sandbox| if set from a
3412 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003413
3414 It is not allowed to change text or jump to another window while
3415 evaluating 'foldtext' |textlock|.
3416
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003417 *'formatexpr'* *'fex'*
3418'formatexpr' 'fex' string (default "")
3419 local to buffer
3420 {not in Vi}
3421 {not available when compiled without the |+eval|
3422 feature}
3423 Expression which is evaluated to format a range of lines for the |gq|
3424 operator or automatic formatting (see 'formatoptions'). When this
3425 option is empty 'formatprg' is used.
3426
3427 The |v:lnum| variable holds the first line to be formatted.
3428 The |v:count| variable holds the number of lines to be formatted.
3429 The |v:char| variable holds the character that is going to be
3430 inserted if the expression is being evaluated due to
3431 automatic formatting. This can be empty. Don't insert
3432 it yet!
3433
3434 Example: >
3435 :set formatexpr=mylang#Format()
3436< This will invoke the mylang#Format() function in the
3437 autoload/mylang.vim file in 'runtimepath'. |autoload|
3438
3439 The expression is also evaluated when 'textwidth' is set and adding
3440 text beyond that limit. This happens under the same conditions as
3441 when internal formatting is used. Make sure the cursor is kept in the
3442 same spot relative to the text then! The |mode()| function will
3443 return "i" or "R" in this situation.
3444
3445 When the expression evaluates to non-zero Vim will fall back to using
3446 the internal format mechanism.
3447
3448 The expression will be evaluated in the |sandbox| when set from a
3449 modeline, see |sandbox-option|. That stops the option from working,
3450 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003451 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 *'formatoptions'* *'fo'*
3454'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3455 local to buffer
3456 {not in Vi}
3457 This is a sequence of letters which describes how automatic
3458 formatting is to be done. See |fo-table|. When the 'paste' option is
3459 on, no formatting is done (like 'formatoptions' is empty). Commas can
3460 be inserted for readability.
3461 To avoid problems with flags that are added in the future, use the
3462 "+=" and "-=" feature of ":set" |add-option-flags|.
3463 NOTE: This option is set to the Vi default value when 'compatible' is
3464 set and to the Vim default value when 'compatible' is reset.
3465
Bram Moolenaar86b68352004-12-27 21:59:20 +00003466 *'formatlistpat'* *'flp'*
3467'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3468 local to buffer
3469 {not in Vi}
3470 A pattern that is used to recognize a list header. This is used for
3471 the "n" flag in 'formatoptions'.
3472 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003473 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003474 while still checking more characters. There must be a character
3475 following the pattern, when it matches the whole line it is handled
3476 like there is no match.
3477 The default recognizes a number, followed by an optional punctuation
3478 character and white space.
3479
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 *'formatprg'* *'fp'*
3481'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003482 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 {not in Vi}
3484 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003485 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003487 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003488 If the 'formatexpr' option is not empty it will be used instead.
3489 Otherwise, if 'formatprg' option is an empty string, the internal
3490 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003491 Environment variables are expanded |:set_env|. See |option-backslash|
3492 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003493 This option cannot be set from a |modeline| or in the |sandbox|, for
3494 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495
Bram Moolenaard94464e2015-11-02 15:28:18 +01003496 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003497'fsync' 'fs' boolean (default on)
3498 global
3499 {not in Vi}
3500 When on, the library function fsync() will be called after writing a
3501 file. This will flush a file to disk, ensuring that it is safely
3502 written even on filesystems which do metadata-only journaling. This
3503 will force the harddrive to spin up on Linux systems running in laptop
3504 mode, so it may be undesirable in some situations. Be warned that
3505 turning this off increases the chances of data loss after a crash. On
3506 systems without an fsync() implementation, this variable is always
3507 off.
3508 Also see 'swapsync' for controlling fsync() on swap files.
3509
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3511'gdefault' 'gd' boolean (default off)
3512 global
3513 {not in Vi}
3514 When on, the ":substitute" flag 'g' is default on. This means that
3515 all matches in a line are substituted instead of one. When a 'g' flag
3516 is given to a ":substitute" command, this will toggle the substitution
3517 of all or one match. See |complex-change|.
3518
3519 command 'gdefault' on 'gdefault' off ~
3520 :s/// subst. all subst. one
3521 :s///g subst. one subst. all
3522 :s///gg subst. all subst. one
3523
3524 NOTE: This option is reset when 'compatible' is set.
3525
3526 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003527'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 global
3529 {not in Vi}
3530 Format to recognize for the ":grep" command output.
3531 This is a scanf-like string that uses the same format as the
3532 'errorformat' option: see |errorformat|.
3533
3534 *'grepprg'* *'gp'*
3535'grepprg' 'gp' string (default "grep -n ",
3536 Unix: "grep -n $* /dev/null",
3537 Win32: "findstr /n" or "grep -n",
3538 VMS: "SEARCH/NUMBERS ")
3539 global or local to buffer |global-local|
3540 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003541 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 and '#' characters, which are expanded like when used in a command-
3543 line. The placeholder "$*" is allowed to specify where the arguments
3544 will be included. Environment variables are expanded |:set_env|. See
3545 |option-backslash| about including spaces and backslashes.
3546 When your "grep" accepts the "-H" argument, use this to make ":grep"
3547 also work well with a single file: >
3548 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003549< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003550 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3551 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003552 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 apply equally to 'grepprg'.
3554 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3555 otherwise it's "grep -n".
3556 This option cannot be set from a |modeline| or in the |sandbox|, for
3557 security reasons.
3558
3559 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3560'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3561 ve:ver35-Cursor,
3562 o:hor50-Cursor,
3563 i-ci:ver25-Cursor/lCursor,
3564 r-cr:hor20-Cursor/lCursor,
3565 sm:block-Cursor
3566 -blinkwait175-blinkoff150-blinkon175",
3567 for MS-DOS and Win32 console:
3568 "n-v-c:block,o:hor50,i-ci:hor15,
3569 r-cr:hor30,sm:block")
3570 global
3571 {not in Vi}
3572 {only available when compiled with GUI enabled, and
3573 for MS-DOS and Win32 console}
3574 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003575 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 the height of the cursor can be changed. This can be done by
3577 specifying a block cursor, or a percentage for a vertical or
3578 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003579 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3580 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003582 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 mode-list and an argument-list:
3584 mode-list:argument-list,mode-list:argument-list,..
3585 The mode-list is a dash separated list of these modes:
3586 n Normal mode
3587 v Visual mode
3588 ve Visual mode with 'selection' "exclusive" (same as 'v',
3589 if not specified)
3590 o Operator-pending mode
3591 i Insert mode
3592 r Replace mode
3593 c Command-line Normal (append) mode
3594 ci Command-line Insert mode
3595 cr Command-line Replace mode
3596 sm showmatch in Insert mode
3597 a all modes
3598 The argument-list is a dash separated list of these arguments:
3599 hor{N} horizontal bar, {N} percent of the character height
3600 ver{N} vertical bar, {N} percent of the character width
3601 block block cursor, fills the whole character
3602 [only one of the above three should be present]
3603 blinkwait{N} *cursor-blinking*
3604 blinkon{N}
3605 blinkoff{N}
3606 blink times for cursor: blinkwait is the delay before
3607 the cursor starts blinking, blinkon is the time that
3608 the cursor is shown and blinkoff is the time that the
3609 cursor is not shown. The times are in msec. When one
3610 of the numbers is zero, there is no blinking. The
3611 default is: "blinkwait700-blinkon400-blinkoff250".
3612 These numbers are used for a missing entry. This
3613 means that blinking is enabled by default. To switch
3614 blinking off you can use "blinkon0". The cursor only
3615 blinks when Vim is waiting for input, not while
3616 executing a command.
3617 To make the cursor blink in an xterm, see
3618 |xterm-blink|.
3619 {group-name}
3620 a highlight group name, that sets the color and font
3621 for the cursor
3622 {group-name}/{group-name}
3623 Two highlight group names, the first is used when
3624 no language mappings are used, the other when they
3625 are. |language-mapping|
3626
3627 Examples of parts:
3628 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3629 block cursor with colors from the "nCursor"
3630 highlight group
3631 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3632 In Insert and Command-line Insert mode, use a
3633 30% vertical bar cursor with colors from the
3634 "iCursor" highlight group. Blink a bit
3635 faster.
3636
3637 The 'a' mode is different. It will set the given argument-list for
3638 all modes. It does not reset anything to defaults. This can be used
3639 to do a common setting for all modes. For example, to switch off
3640 blinking: "a:blinkon0"
3641
3642 Examples of cursor highlighting: >
3643 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3644 :highlight Cursor gui=NONE guifg=bg guibg=fg
3645<
3646 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003647 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648'guifont' 'gfn' string (default "")
3649 global
3650 {not in Vi}
3651 {only available when compiled with GUI enabled}
3652 This is a list of fonts which will be used for the GUI version of Vim.
3653 In its simplest form the value is just one font name. When
3654 the font cannot be found you will get an error message. To try other
3655 font names a list can be specified, font names separated with commas.
3656 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003657
Bram Moolenaar05159a02005-02-26 23:04:13 +00003658 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3659 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003660
Bram Moolenaar3df01732017-02-17 22:47:16 +01003661 Note: As to the GTK GUIs, no error is given against any invalid names,
3662 and the first element of the list is always picked up and made use of.
3663 This is because, instead of identifying a given name with a font, the
3664 GTK GUIs use it to construct a pattern and try to look up a font which
3665 best matches the pattern among available fonts, and this way, the
3666 matching never fails. An invalid name doesn't matter because a number
3667 of font properties other than name will do to get the matching done.
3668
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 Spaces after a comma are ignored. To include a comma in a font name
3670 precede it with a backslash. Setting an option requires an extra
3671 backslash before a space and a backslash. See also
3672 |option-backslash|. For example: >
3673 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003674< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003676
3677 If none of the fonts can be loaded, Vim will keep the current setting.
3678 If an empty font list is given, Vim will try using other resource
3679 settings (for X, it will use the Vim.font resource), and finally it
3680 will try some builtin default which should always be there ("7x13" in
3681 the case of X). The font names given should be "normal" fonts. Vim
3682 will try to find the related bold and italic fonts.
3683
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003684 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003685 :set guifont=*
3686< will bring up a font requester, where you can pick the font you want.
3687
3688 The font name depends on the GUI used. See |setting-guifont| for a
3689 way to set 'guifont' for various systems.
3690
Bram Moolenaar3df01732017-02-17 22:47:16 +01003691 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003693< That's all. XLFDs are not used. For Chinese this is reported to work
3694 well: >
3695 if has("gui_gtk2")
3696 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3697 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3698 endif
3699<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003700 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3701
Bram Moolenaar05159a02005-02-26 23:04:13 +00003702 For Mac OSX you can use something like this: >
3703 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003704< Also see 'macatsui', it can help fix display problems.
3705 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003707 width). An exception is GTK: all fonts are accepted, but mono-spaced
3708 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003709
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 To preview a font on X11, you might be able to use the "xfontsel"
3711 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003712
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 For the Win32 GUI *E244* *E245*
3714 - takes these options in the font name:
3715 hXX - height is XX (points, can be floating-point)
3716 wXX - width is XX (points, can be floating-point)
3717 b - bold
3718 i - italic
3719 u - underline
3720 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003721 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3723 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3724 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003725 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003726 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003727 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003728 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003729 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730
3731 Use a ':' to separate the options.
3732 - A '_' can be used in the place of a space, so you don't need to use
3733 backslashes to escape the spaces.
3734 - Examples: >
3735 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3736 :set guifont=Andale_Mono:h7.5:w4.5
3737< See also |font-sizes|.
3738
3739 *'guifontset'* *'gfs'*
3740 *E250* *E252* *E234* *E597* *E598*
3741'guifontset' 'gfs' string (default "")
3742 global
3743 {not in Vi}
3744 {only available when compiled with GUI enabled and
3745 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003746 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 When not empty, specifies two (or more) fonts to be used. The first
3748 one for normal English, the second one for your special language. See
3749 |xfontset|.
3750 Setting this option also means that all font names will be handled as
3751 a fontset name. Also the ones used for the "font" argument of the
3752 |:highlight| command.
3753 The fonts must match with the current locale. If fonts for the
3754 character sets that the current locale uses are not included, setting
3755 'guifontset' will fail.
3756 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3757 the comma-separated names are alternative names, one of which will be
3758 used. In 'guifontset' the whole string is one fontset name,
3759 including the commas. It is not possible to specify alternative
3760 fontset names.
3761 This example works on many X11 systems: >
3762 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3763<
3764 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3765'guifontwide' 'gfw' string (default "")
3766 global
3767 {not in Vi}
3768 {only available when compiled with GUI enabled}
3769 When not empty, specifies a comma-separated list of fonts to be used
3770 for double-width characters. The first font that can be loaded is
3771 used.
3772 Note: The size of these fonts must be exactly twice as wide as the one
3773 specified with 'guifont' and the same height.
3774
Bram Moolenaar3df01732017-02-17 22:47:16 +01003775 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776
3777 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3778 'guifontset' is empty or invalid.
3779 When 'guifont' is set and a valid font is found in it and
3780 'guifontwide' is empty Vim will attempt to find a matching
3781 double-width font and set 'guifontwide' to it.
3782
Bram Moolenaar3df01732017-02-17 22:47:16 +01003783 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784
3785 If set and valid, 'guifontwide' is always used for double width
3786 characters, even if 'encoding' is not set to "utf-8".
3787 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003788 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 font for characters not available in 'guifont'. Thus you do not need
3790 to set 'guifontwide' at all unless you want to override the choice
3791 made by Pango/Xft.
3792
Bram Moolenaar0f272122013-01-23 18:37:40 +01003793 Windows +multibyte only: *guifontwide_win_mbyte*
3794
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003795 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003796
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 *'guiheadroom'* *'ghr'*
3798'guiheadroom' 'ghr' number (default 50)
3799 global
3800 {not in Vi} {only for GTK and X11 GUI}
3801 The number of pixels subtracted from the screen height when fitting
3802 the GUI window on the screen. Set this before the GUI is started,
3803 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003804 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 lines will be left for window decorations and other items on the
3806 screen. Set it to a negative value to allow windows taller than the
3807 screen.
3808
3809 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003810'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3811 removed in |defaults.vim|),
3812 "aegimrLtT" (GTK, Motif and Athena),
3813 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 global
3815 {not in Vi}
3816 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003817 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 sequence of letters which describes what components and options of the
3819 GUI should be used.
3820 To avoid problems with flags that are added in the future, use the
3821 "+=" and "-=" feature of ":set" |add-option-flags|.
3822
3823 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003824 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 'a' Autoselect: If present, then whenever VISUAL mode is started,
3826 or the Visual area extended, Vim tries to become the owner of
3827 the windowing system's global selection. This means that the
3828 Visually highlighted text is available for pasting into other
3829 applications as well as into Vim itself. When the Visual mode
3830 ends, possibly due to an operation on the text, or when an
3831 application wants to paste the selection, the highlighted text
3832 is automatically yanked into the "* selection register.
3833 Thus the selection is still available for pasting into other
3834 applications after the VISUAL mode has ended.
3835 If not present, then Vim won't become the owner of the
3836 windowing system's global selection unless explicitly told to
3837 by a yank or delete operation for the "* register.
3838 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003839 *'go-P'*
3840 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003841 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003842 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003843 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 applies to the modeless selection.
3845
3846 'guioptions' autoselect Visual autoselect modeless ~
3847 "" - -
3848 "a" yes yes
3849 "A" - yes
3850 "aA" yes yes
3851
Bram Moolenaar02467872007-05-06 13:22:01 +00003852 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 'c' Use console dialogs instead of popup dialogs for simple
3854 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003855 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003856 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003857 'guitablabel' can be used to change the text in the labels.
3858 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003859 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003860 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003861 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 'f' Foreground: Don't use fork() to detach the GUI from the shell
3863 where it was started. Use this for programs that wait for the
3864 editor to finish (e.g., an e-mail program). Alternatively you
3865 can use "gvim -f" or ":gui -f" to start the GUI in the
3866 foreground. |gui-fork|
3867 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003868 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003869 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3871 corner of the window. It's black&white on non-GTK, because of
3872 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003873 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003875 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003878 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 file is sourced the system menu has already been loaded; the
3880 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003881 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 'g' Grey menu items: Make menu items that are not active grey. If
3883 'g' is not included inactive menu items are not shown at all.
3884 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003885 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 't' Include tearoff menu items. Currently only works for Win32,
3887 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003888 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003889 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003890 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003891 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003893 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 'R' Right-hand scrollbar is present when there is a vertically
3895 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003896 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003898 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'L' Left-hand scrollbar is present when there is a vertically
3900 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003901 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3903 the longest visible line, or on the cursor line if the 'h'
3904 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003905 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 'h' Limit horizontal scrollbar size to the length of the cursor
3907 line. Reduces computations. |gui-horiz-scroll|
3908
3909 And yes, you may even have scrollbars on the left AND the right if
3910 you really want to :-). See |gui-scrollbars| for more information.
3911
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003912 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 'v' Use a vertical button layout for dialogs. When not included,
3914 a horizontal layout is preferred, but when it doesn't fit a
3915 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003916 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 'p' Use Pointer callbacks for X11 GUI. This is required for some
3918 window managers. If the cursor is not blinking or hollow at
3919 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003920 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003923 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924
Bram Moolenaar02467872007-05-06 13:22:01 +00003925
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 *'guipty'* *'noguipty'*
3927'guipty' boolean (default on)
3928 global
3929 {not in Vi}
3930 {only available when compiled with GUI enabled}
3931 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3932 I/O to/from shell commands. See |gui-pty|.
3933
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003934 *'guitablabel'* *'gtl'*
3935'guitablabel' 'gtl' string (default empty)
3936 global
3937 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003938 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003939 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003940 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003941 pages line. When empty and when the result is empty Vim will use a
3942 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003943
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003944 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003945 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003946 The expression will be evaluated in the |sandbox| when set from a
3947 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003948
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003949 Only used when the GUI tab pages line is displayed. 'e' must be
3950 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3951 used.
3952
Bram Moolenaar57657d82006-04-21 22:12:41 +00003953 *'guitabtooltip'* *'gtt'*
3954'guitabtooltip' 'gtt' string (default empty)
3955 global
3956 {not in Vi}
3957 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003958 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003959 When nonempty describes the text to use in a tooltip for the GUI tab
3960 pages line. When empty Vim will use a default tooltip.
3961 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003962 You can include a line break. Simplest method is to use |:let|: >
3963 :let &guitabtooltip = "line one\nline two"
3964<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003965
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 *'helpfile'* *'hf'*
3967'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3968 (others) "$VIMRUNTIME/doc/help.txt")
3969 global
3970 {not in Vi}
3971 Name of the main help file. All distributed help files should be
3972 placed together in one directory. Additionally, all "doc" directories
3973 in 'runtimepath' will be used.
3974 Environment variables are expanded |:set_env|. For example:
3975 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003976 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 spaces and backslashes.
3978 This option cannot be set from a |modeline| or in the |sandbox|, for
3979 security reasons.
3980
3981 *'helpheight'* *'hh'*
3982'helpheight' 'hh' number (default 20)
3983 global
3984 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003985 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 feature}
3987 Minimal initial height of the help window when it is opened with the
3988 ":help" command. The initial height of the help window is half of the
3989 current window, or (when the 'ea' option is on) the same as other
3990 windows. When the height is less than 'helpheight', the height is
3991 set to 'helpheight'. Set to zero to disable.
3992
3993 *'helplang'* *'hlg'*
3994'helplang' 'hlg' string (default: messages language or empty)
3995 global
3996 {only available when compiled with the |+multi_lang|
3997 feature}
3998 {not in Vi}
3999 Comma separated list of languages. Vim will use the first language
4000 for which the desired help can be found. The English help will always
4001 be used as a last resort. You can add "en" to prefer English over
4002 another language, but that will only find tags that exist in that
4003 language and not in the English help.
4004 Example: >
4005 :set helplang=de,it
4006< This will first search German, then Italian and finally English help
4007 files.
4008 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4009 try to find the tag in the current language before using this option.
4010 See |help-translated|.
4011
4012 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4013'hidden' 'hid' boolean (default off)
4014 global
4015 {not in Vi}
4016 When off a buffer is unloaded when it is |abandon|ed. When on a
4017 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4018 displayed in another window, it does not become hidden, of course.
4019 The commands that move through the buffer list sometimes make a buffer
4020 hidden although the 'hidden' option is off: When the buffer is
4021 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004022 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004023 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 This option is set for one command with ":hide {command}" |:hide|.
4025 WARNING: It's easy to forget that you have changes in hidden buffers.
4026 Think twice when using ":q!" or ":qa!".
4027
4028 *'highlight'* *'hl'*
4029'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004030 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4031 d:Directory,e:ErrorMsg,i:IncSearch,
4032 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4033 N:CursorLineNr,r:Question,s:StatusLine,
4034 S:StatusLineNC,c:VertSplit,t:Title,
4035 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4036 F:FoldColumn,A:DiffAdd,C:DiffChange,
4037 D:DiffDelete,T:DiffText,>:SignColumn,
4038 B:SpellBad,P:SpellCap,R:SpellRare,
4039 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004040 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 global
4042 {not in Vi}
4043 This option can be used to set highlighting mode for various
4044 occasions. It is a comma separated list of character pairs. The
4045 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004046 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004048 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4049 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 characters from 'showbreak'
4051 |hl-Directory| d directories in CTRL-D listing and other special
4052 things in listings
4053 |hl-ErrorMsg| e error messages
4054 h (obsolete, ignored)
4055 |hl-IncSearch| i 'incsearch' highlighting
4056 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4057 |hl-MoreMsg| m |more-prompt|
4058 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004059 |hl-LineNr| n line number for ":number" and ":#" commands, and
4060 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004061 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4062 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 |hl-Question| r |hit-enter| prompt and yes/no questions
4064 |hl-StatusLine| s status line of current window |status-line|
4065 |hl-StatusLineNC| S status lines of not-current windows
4066 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4067 |hl-VertSplit| c column used to separate vertically split windows
4068 |hl-Visual| v Visual mode
4069 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4070 Selection" Only X11 Gui's |gui-x11| and
4071 |xterm-clipboard|.
4072 |hl-WarningMsg| w warning messages
4073 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4074 |hl-Folded| f line used for closed folds
4075 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004076 |hl-DiffAdd| A added line in diff mode
4077 |hl-DiffChange| C changed line in diff mode
4078 |hl-DiffDelete| D deleted line in diff mode
4079 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004081 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004082 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004083 |hl-SpellRare| R rare word |spell|
4084 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004085 |hl-Conceal| - the placeholders used for concealed characters
4086 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004087 |hl-Pmenu| + popup menu normal line
4088 |hl-PmenuSel| = popup menu normal line
4089 |hl-PmenuSbar| x popup menu scrollbar
4090 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091
4092 The display modes are:
4093 r reverse (termcap entry "mr" and "me")
4094 i italic (termcap entry "ZH" and "ZR")
4095 b bold (termcap entry "md" and "me")
4096 s standout (termcap entry "so" and "se")
4097 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004098 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 n no highlighting
4100 - no highlighting
4101 : use a highlight group
4102 The default is used for occasions that are not included.
4103 If you want to change what the display modes do, see |dos-colors|
4104 for an example.
4105 When using the ':' display mode, this must be followed by the name of
4106 a highlight group. A highlight group can be used to define any type
4107 of highlighting, including using color. See |:highlight| on how to
4108 define one. The default uses a different group for each occasion.
4109 See |highlight-default| for the default highlight groups.
4110
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004112'history' 'hi' number (Vim default: 50, Vi default: 0,
4113 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 global
4115 {not in Vi}
4116 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004117 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004119 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 NOTE: This option is set to the Vi default value when 'compatible' is
4121 set and to the Vim default value when 'compatible' is reset.
4122
4123 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4124'hkmap' 'hk' boolean (default off)
4125 global
4126 {not in Vi}
4127 {only available when compiled with the |+rightleft|
4128 feature}
4129 When on, the keyboard is mapped for the Hebrew character set.
4130 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4131 toggle this option. See |rileft.txt|.
4132 NOTE: This option is reset when 'compatible' is set.
4133
4134 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4135'hkmapp' 'hkp' boolean (default off)
4136 global
4137 {not in Vi}
4138 {only available when compiled with the |+rightleft|
4139 feature}
4140 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4141 This is useful if you have a non-Hebrew keyboard.
4142 See |rileft.txt|.
4143 NOTE: This option is reset when 'compatible' is set.
4144
Bram Moolenaar036986f2017-03-16 17:41:02 +01004145 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4146'hlsearch' 'hls' boolean (default off)
4147 global
4148 {not in Vi}
4149 {not available when compiled without the
4150 |+extra_search| feature}
4151 When there is a previous search pattern, highlight all its matches.
4152 The type of highlighting used can be set with the 'l' occasion in the
4153 'highlight' option. This uses the "Search" highlight group by
4154 default. Note that only the matching text is highlighted, any offsets
4155 are not applied.
4156 See also: 'incsearch' and |:match|.
4157 When you get bored looking at the highlighted matches, you can turn it
4158 off with |:nohlsearch|. This does not change the option value, as
4159 soon as you use a search command, the highlighting comes back.
4160 'redrawtime' specifies the maximum time spent on finding matches.
4161 When the search pattern can match an end-of-line, Vim will try to
4162 highlight all of the matched text. However, this depends on where the
4163 search starts. This will be the first line in the window or the first
4164 line below a closed fold. A match in a previous line which is not
4165 drawn may not continue in a newly drawn line.
4166 You can specify whether the highlight status is restored on startup
4167 with the 'h' flag in 'viminfo' |viminfo-h|.
4168 NOTE: This option is reset when 'compatible' is set.
4169
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 *'icon'* *'noicon'*
4171'icon' boolean (default off, on when title can be restored)
4172 global
4173 {not in Vi}
4174 {not available when compiled without the |+title|
4175 feature}
4176 When on, the icon text of the window will be set to the value of
4177 'iconstring' (if it is not empty), or to the name of the file
4178 currently being edited. Only the last part of the name is used.
4179 Overridden by the 'iconstring' option.
4180 Only works if the terminal supports setting window icons (currently
4181 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4182 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4183 builtin termcap).
4184 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004185 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004187 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188
4189 *'iconstring'*
4190'iconstring' string (default "")
4191 global
4192 {not in Vi}
4193 {not available when compiled without the |+title|
4194 feature}
4195 When this option is not empty, it will be used for the icon text of
4196 the window. This happens only when the 'icon' option is on.
4197 Only works if the terminal supports setting window icon text
4198 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4199 Does not work for MS Windows.
4200 When Vim was compiled with HAVE_X11 defined, the original icon will be
4201 restored if possible |X11|.
4202 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004203 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 'titlestring' for example settings.
4205 {not available when compiled without the |+statusline| feature}
4206
4207 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4208'ignorecase' 'ic' boolean (default off)
4209 global
4210 Ignore case in search patterns. Also used when searching in the tags
4211 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004212 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 Can be overruled by using "\c" or "\C" in the pattern, see
4214 |/ignorecase|.
4215
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004216 *'imactivatefunc'* *'imaf'*
4217'imactivatefunc' 'imaf' string (default "")
4218 global
4219 {not in Vi}
4220 {only available when compiled with |+xim| and
4221 |+GUI_GTK|}
4222 This option specifies a function that will be called to
4223 activate/inactivate Input Method.
4224
4225 Example: >
4226 function ImActivateFunc(active)
4227 if a:active
4228 ... do something
4229 else
4230 ... do something
4231 endif
4232 " return value is not used
4233 endfunction
4234 set imactivatefunc=ImActivateFunc
4235<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 *'imactivatekey'* *'imak'*
4237'imactivatekey' 'imak' string (default "")
4238 global
4239 {not in Vi}
4240 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004241 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242 Specifies the key that your Input Method in X-Windows uses for
4243 activation. When this is specified correctly, vim can fully control
4244 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4245 You can't use this option to change the activation key, the option
4246 tells Vim what the key is.
4247 Format:
4248 [MODIFIER_FLAG-]KEY_STRING
4249
4250 These characters can be used for MODIFIER_FLAG (case is ignored):
4251 S Shift key
4252 L Lock key
4253 C Control key
4254 1 Mod1 key
4255 2 Mod2 key
4256 3 Mod3 key
4257 4 Mod4 key
4258 5 Mod5 key
4259 Combinations are allowed, for example "S-C-space" or "SC-space" are
4260 both shift+ctrl+space.
4261 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4262
4263 Example: >
4264 :set imactivatekey=S-space
4265< "S-space" means shift+space. This is the activation key for kinput2 +
4266 canna (Japanese), and ami (Korean).
4267
4268 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4269'imcmdline' 'imc' boolean (default off)
4270 global
4271 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004272 {only available when compiled with the |+xim|,
4273 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 When set the Input Method is always on when starting to edit a command
4275 line, unless entering a search pattern (see 'imsearch' for that).
4276 Setting this option is useful when your input method allows entering
4277 English characters directly, e.g., when it's used to type accented
4278 characters with dead keys.
4279
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004280 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4282 global
4283 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004284 {only available when compiled with the |+xim|,
4285 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 When set the Input Method is never used. This is useful to disable
4287 the IM when it doesn't work properly.
4288 Currently this option is on by default for SGI/IRIX machines. This
4289 may change in later releases.
4290
4291 *'iminsert'* *'imi'*
4292'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4293 local to buffer
4294 {not in Vi}
4295 Specifies whether :lmap or an Input Method (IM) is to be used in
4296 Insert mode. Valid values:
4297 0 :lmap is off and IM is off
4298 1 :lmap is ON and IM is off
4299 2 :lmap is off and IM is ON
4300 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4301 or |global-ime|.
4302 To always reset the option to zero when leaving Insert mode with <Esc>
4303 this can be used: >
4304 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4305< This makes :lmap and IM turn off automatically when leaving Insert
4306 mode.
4307 Note that this option changes when using CTRL-^ in Insert mode
4308 |i_CTRL-^|.
4309 The value is set to 1 when setting 'keymap' to a valid keymap name.
4310 It is also used for the argument of commands like "r" and "f".
4311 The value 0 may not work correctly with Athena and Motif with some XIM
4312 methods. Use 'imdisable' to disable XIM then.
4313
4314 *'imsearch'* *'ims'*
4315'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4316 local to buffer
4317 {not in Vi}
4318 Specifies whether :lmap or an Input Method (IM) is to be used when
4319 entering a search pattern. Valid values:
4320 -1 the value of 'iminsert' is used, makes it look like
4321 'iminsert' is also used when typing a search pattern
4322 0 :lmap is off and IM is off
4323 1 :lmap is ON and IM is off
4324 2 :lmap is off and IM is ON
4325 Note that this option changes when using CTRL-^ in Command-line mode
4326 |c_CTRL-^|.
4327 The value is set to 1 when it is not -1 and setting the 'keymap'
4328 option to a valid keymap name.
4329 The value 0 may not work correctly with Athena and Motif with some XIM
4330 methods. Use 'imdisable' to disable XIM then.
4331
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004332 *'imstatusfunc'* *'imsf'*
4333'imstatusfunc' 'imsf' string (default "")
4334 global
4335 {not in Vi}
4336 {only available when compiled with |+xim| and
4337 |+GUI_GTK|}
4338 This option specifies a function that is called to obtain the status
4339 of Input Method. It must return a positive number when IME is active.
4340
4341 Example: >
4342 function ImStatusFunc()
4343 let is_active = ...do something
4344 return is_active ? 1 : 0
4345 endfunction
4346 set imstatusfunc=ImStatusFunc
4347<
4348 NOTE: This function is invoked very often. Keep it fast.
4349
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 *'include'* *'inc'*
4351'include' 'inc' string (default "^\s*#\s*include")
4352 global or local to buffer |global-local|
4353 {not in Vi}
4354 {not available when compiled without the
4355 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004356 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 pattern, just like for the "/" command (See |pattern|). The default
4358 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004359 "]I", "[d", etc.
4360 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004361 comes after the matched pattern. But if "\zs" appears in the pattern
4362 then the text matched from "\zs" to the end, or until "\ze" if it
4363 appears, is used as the file name. Use this to include characters
4364 that are not in 'isfname', such as a space. You can then use
4365 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004366 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367
4368 *'includeexpr'* *'inex'*
4369'includeexpr' 'inex' string (default "")
4370 local to buffer
4371 {not in Vi}
4372 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004373 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004375 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 :set includeexpr=substitute(v:fname,'\\.','/','g')
4377< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004378
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004380 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 Also used for |<cfile>|.
4382
Bram Moolenaar30b65812012-07-12 22:01:11 +02004383 The expression will be evaluated in the |sandbox| when set from a
4384 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004385
4386 It is not allowed to change text or jump to another window while
4387 evaluating 'includeexpr' |textlock|.
4388
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004390'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4391 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 global
4393 {not in Vi}
4394 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004395 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004396 While typing a search command, show where the pattern, as it was typed
4397 so far, matches. The matched string is highlighted. If the pattern
4398 is invalid or not found, nothing is shown. The screen will be updated
4399 often, this is only useful on fast terminals.
4400 Note that the match will be shown, but the cursor will return to its
4401 original position when no match is found and when pressing <Esc>. You
4402 still need to finish the search command with <Enter> to move the
4403 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004404 You can use the CTRL-G and CTRL-T keys to move to the next and
4405 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004406 When compiled with the |+reltime| feature Vim only searches for about
4407 half a second. With a complicated pattern and/or a lot of text the
4408 match may not be found. This is to avoid that Vim hangs while you
4409 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004410 The highlighting can be set with the 'i' flag in 'highlight'.
4411 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004412 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004413 to the command line. If 'ignorecase' and 'smartcase' are set and the
4414 command line has no uppercase characters, the added character is
4415 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004416 CTRL-R CTRL-W can be used to add the word at the end of the current
4417 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 NOTE: This option is reset when 'compatible' is set.
4419
4420 *'indentexpr'* *'inde'*
4421'indentexpr' 'inde' string (default "")
4422 local to buffer
4423 {not in Vi}
4424 {not available when compiled without the |+cindent|
4425 or |+eval| features}
4426 Expression which is evaluated to obtain the proper indent for a line.
4427 It is used when a new line is created, for the |=| operator and
4428 in Insert mode as specified with the 'indentkeys' option.
4429 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004430 'smartindent' indenting. When 'lisp' is set, this option is
4431 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 When 'paste' is set this option is not used for indenting.
4433 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004434 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 when the expression is evaluated (but it may be moved around).
4436 The expression must return the number of spaces worth of indent. It
4437 can return "-1" to keep the current indent (this means 'autoindent' is
4438 used for the indent).
4439 Functions useful for computing the indent are |indent()|, |cindent()|
4440 and |lispindent()|.
4441 The evaluation of the expression must not have side effects! It must
4442 not change the text, jump to another window, etc. Afterwards the
4443 cursor position is always restored, thus the cursor may be moved.
4444 Normally this option would be set to call a function: >
4445 :set indentexpr=GetMyIndent()
4446< Error messages will be suppressed, unless the 'debug' option contains
4447 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004448 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004449 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450
Bram Moolenaar30b65812012-07-12 22:01:11 +02004451 The expression will be evaluated in the |sandbox| when set from a
4452 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004453
4454 It is not allowed to change text or jump to another window while
4455 evaluating 'indentexpr' |textlock|.
4456
4457
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 *'indentkeys'* *'indk'*
4459'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4460 local to buffer
4461 {not in Vi}
4462 {not available when compiled without the |+cindent|
4463 feature}
4464 A list of keys that, when typed in Insert mode, cause reindenting of
4465 the current line. Only happens if 'indentexpr' isn't empty.
4466 The format is identical to 'cinkeys', see |indentkeys-format|.
4467 See |C-indenting| and |indent-expression|.
4468
4469 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4470'infercase' 'inf' boolean (default off)
4471 local to buffer
4472 {not in Vi}
4473 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004474 'ignorecase' is also on, the case of the match is adjusted depending
4475 on the typed text. If the typed text contains a lowercase letter
4476 where the match has an upper case letter, the completed part is made
4477 lowercase. If the typed text has no lowercase letters and the match
4478 has a lowercase letter where the typed text has an uppercase letter,
4479 and there is a letter before it, the completed part is made uppercase.
4480 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481
4482 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4483'insertmode' 'im' boolean (default off)
4484 global
4485 {not in Vi}
4486 Makes Vim work in a way that Insert mode is the default mode. Useful
4487 if you want to use Vim as a modeless editor. Used for |evim|.
4488 These Insert mode commands will be useful:
4489 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004490 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 this is a mapping, it is executed as if 'insertmode' was off.
4492 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004494 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4495 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496
4497 These items change when 'insertmode' is set:
4498 - when starting to edit of a file, Vim goes to Insert mode.
4499 - <Esc> in Insert mode is a no-op and beeps.
4500 - <Esc> in Normal mode makes Vim go to Insert mode.
4501 - CTRL-L in Insert mode is a command, it is not inserted.
4502 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4503 However, when <Esc> is used inside a mapping, it behaves like
4504 'insertmode' was not set. This was done to be able to use the same
4505 mappings with 'insertmode' set or not set.
4506 When executing commands with |:normal| 'insertmode' is not used.
4507
4508 NOTE: This option is reset when 'compatible' is set.
4509
4510 *'isfname'* *'isf'*
4511'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4512 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4513 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4514 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4515 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4516 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4517 global
4518 {not in Vi}
4519 The characters specified by this option are included in file names and
4520 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004521 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 Multi-byte characters 256 and above are always included, only the
4523 characters up to 255 are specified with this option.
4524 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004525 Think twice before adding white space to this option. Although a
4526 space may appear inside a file name, the effect will be that Vim
4527 doesn't know where a file name starts or ends when doing completion.
4528 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529
4530 Note that on systems using a backslash as path separator, Vim tries to
4531 do its best to make it work as you would expect. That is a bit
4532 tricky, since Vi originally used the backslash to escape special
4533 characters. Vim will not remove a backslash in front of a normal file
4534 name character on these systems, but it will on Unix and alikes. The
4535 '&' and '^' are not included by default, because these are special for
4536 cmd.exe.
4537
4538 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004539 Each part can be a single character number or a range. A range is two
4540 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 decimal number between 0 and 255 or the ASCII character itself (does
4542 not work for digits). Example:
4543 "_,-,128-140,#-43" (include '_' and '-' and the range
4544 128 to 140 and '#' to 43)
4545 If a part starts with '^', the following character number or range
4546 will be excluded from the option. The option is interpreted from left
4547 to right. Put the excluded character after the range where it is
4548 included. To include '^' itself use it as the last character of the
4549 option or the end of a range. Example:
4550 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4551 If the character is '@', all characters where isalpha() returns TRUE
4552 are included. Normally these are the characters a to z and A to Z,
4553 plus accented characters. To include '@' itself use "@-@". Examples:
4554 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004555 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 "a-z,A-Z,@-@" All letters plus the '@' character.
4557 A comma can be included by using it where a character number is
4558 expected. Example:
4559 "48-57,,,_" Digits, comma and underscore.
4560 A comma can be excluded by prepending a '^'. Example:
4561 " -~,^,,9" All characters from space to '~', excluding
4562 comma, plus <Tab>.
4563 See |option-backslash| about including spaces and backslashes.
4564
4565 *'isident'* *'isi'*
4566'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4567 "@,48-57,_,128-167,224-235"
4568 otherwise: "@,48-57,_,192-255")
4569 global
4570 {not in Vi}
4571 The characters given by this option are included in identifiers.
4572 Identifiers are used in recognizing environment variables and after a
4573 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004574 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 option.
4576 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004577 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4579
4580 *'iskeyword'* *'isk'*
4581'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4582 "@,48-57,_,128-167,224-235"
4583 otherwise: "@,48-57,_,192-255"
4584 Vi default: "@,48-57,_")
4585 local to buffer
4586 {not in Vi}
4587 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004588 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589 'isfname' for a description of the format of this option. For C
4590 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4591 For a help file it is set to all non-blank printable characters except
4592 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4593 command).
4594 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004595 This option also influences syntax highlighting, unless the syntax
4596 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 NOTE: This option is set to the Vi default value when 'compatible' is
4598 set and to the Vim default value when 'compatible' is reset.
4599
4600 *'isprint'* *'isp'*
4601'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4602 "@,~-255"; otherwise: "@,161-255")
4603 global
4604 {not in Vi}
4605 The characters given by this option are displayed directly on the
4606 screen. It is also used for "\p" in a |pattern|. The characters from
4607 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4608 even when they are not included in 'isprint' or excluded. See
4609 'isfname' for a description of the format of this option.
4610
4611 Non-printable characters are displayed with two characters:
4612 0 - 31 "^@" - "^_"
4613 32 - 126 always single characters
4614 127 "^?"
4615 128 - 159 "~@" - "~_"
4616 160 - 254 "| " - "|~"
4617 255 "~?"
4618 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4619 displayed as <xx>, with the hexadecimal value of the byte.
4620 When 'display' contains "uhex" all unprintable characters are
4621 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004622 The SpecialKey highlighting will be used for unprintable characters.
4623 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624
4625 Multi-byte characters 256 and above are always included, only the
4626 characters up to 255 are specified with this option. When a character
4627 is printable but it is not available in the current font, a
4628 replacement character will be shown.
4629 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4630 There is no option to specify these characters.
4631
4632 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4633'joinspaces' 'js' boolean (default on)
4634 global
4635 {not in Vi}
4636 Insert two spaces after a '.', '?' and '!' with a join command.
4637 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4638 Otherwise only one space is inserted.
4639 NOTE: This option is set when 'compatible' is set.
4640
4641 *'key'*
4642'key' string (default "")
4643 local to buffer
4644 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004645 {only available when compiled with the |+cryptv|
4646 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004648 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 Careful: Do not set the key value by hand, someone might see the typed
4650 key. Use the |:X| command. But you can make 'key' empty: >
4651 :set key=
4652< It is not possible to get the value of this option with ":set key" or
4653 "echo &key". This is to avoid showing it to someone who shouldn't
4654 know. It also means you cannot see it yourself once you have set it,
4655 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004656 You can use "&key" in an expression to detect whether encryption is
4657 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658
4659 *'keymap'* *'kmp'* *E544*
4660'keymap' 'kmp' string (default "")
4661 local to buffer
4662 {not in Vi}
4663 {only available when compiled with the |+keymap|
4664 feature}
4665 Name of a keyboard mapping. See |mbyte-keymap|.
4666 Setting this option to a valid keymap name has the side effect of
4667 setting 'iminsert' to one, so that the keymap becomes effective.
4668 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004669 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670
4671 *'keymodel'* *'km'*
4672'keymodel' 'km' string (default "")
4673 global
4674 {not in Vi}
4675 List of comma separated words, which enable special things that keys
4676 can do. These values can be used:
4677 startsel Using a shifted special key starts selection (either
4678 Select mode or Visual mode, depending on "key" being
4679 present in 'selectmode').
4680 stopsel Using a not-shifted special key stops selection.
4681 Special keys in this context are the cursor keys, <End>, <Home>,
4682 <PageUp> and <PageDown>.
4683 The 'keymodel' option is set by the |:behave| command.
4684
4685 *'keywordprg'* *'kp'*
4686'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004687 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 global or local to buffer |global-local|
4689 {not in Vi}
4690 Program to use for the |K| command. Environment variables are
4691 expanded |:set_env|. ":help" may be used to access the Vim internal
4692 help. (Note that previously setting the global option to the empty
4693 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004694 When the first character is ":", the command is invoked as a Vim
4695 Ex command prefixed with [count].
4696 When "man", "man -s" or an Ex command is used, Vim will automatically
4697 translate a count for the "K" command and pass it as the first
4698 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 See |option-backslash| about including spaces and backslashes.
4700 Example: >
4701 :set keywordprg=man\ -s
4702< This option cannot be set from a |modeline| or in the |sandbox|, for
4703 security reasons.
4704
4705 *'langmap'* *'lmap'* *E357* *E358*
4706'langmap' 'lmap' string (default "")
4707 global
4708 {not in Vi}
4709 {only available when compiled with the |+langmap|
4710 feature}
4711 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004712 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004713 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 care of translating these special characters to the original meaning
4715 of the key. This means you don't have to change the keyboard mode to
4716 be able to execute Normal mode commands.
4717 This is the opposite of the 'keymap' option, where characters are
4718 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004719 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004720 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004721 This option cannot be set from a |modeline| or in the |sandbox|, for
4722 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004724 Example (for Greek, in UTF-8): *greek* >
4725 :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 +00004726< Example (exchanges meaning of z and y for commands): >
4727 :set langmap=zy,yz,ZY,YZ
4728<
4729 The 'langmap' option is a list of parts, separated with commas. Each
4730 part can be in one of two forms:
4731 1. A list of pairs. Each pair is a "from" character immediately
4732 followed by the "to" character. Examples: "aA", "aAbBcC".
4733 2. A list of "from" characters, a semi-colon and a list of "to"
4734 characters. Example: "abc;ABC"
4735 Example: "aA,fgh;FGH,cCdDeE"
4736 Special characters need to be preceded with a backslash. These are
4737 ";", ',' and backslash itself.
4738
4739 This will allow you to activate vim actions without having to switch
4740 back and forth between the languages. Your language characters will
4741 be understood as normal vim English characters (according to the
4742 langmap mappings) in the following cases:
4743 o Normal/Visual mode (commands, buffer/register names, user mappings)
4744 o Insert/Replace Mode: Register names after CTRL-R
4745 o Insert/Replace Mode: Mappings
4746 Characters entered in Command-line mode will NOT be affected by
4747 this option. Note that this option can be changed at any time
4748 allowing to switch between mappings for different languages/encodings.
4749 Use a mapping to avoid having to type it each time!
4750
4751 *'langmenu'* *'lm'*
4752'langmenu' 'lm' string (default "")
4753 global
4754 {not in Vi}
4755 {only available when compiled with the |+menu| and
4756 |+multi_lang| features}
4757 Language to use for menu translation. Tells which file is loaded
4758 from the "lang" directory in 'runtimepath': >
4759 "lang/menu_" . &langmenu . ".vim"
4760< (without the spaces). For example, to always use the Dutch menus, no
4761 matter what $LANG is set to: >
4762 :set langmenu=nl_NL.ISO_8859-1
4763< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004764 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 If your $LANG is set to a non-English language but you do want to use
4766 the English menus: >
4767 :set langmenu=none
4768< This option must be set before loading menus, switching on filetype
4769 detection or syntax highlighting. Once the menus are defined setting
4770 this option has no effect. But you could do this: >
4771 :source $VIMRUNTIME/delmenu.vim
4772 :set langmenu=de_DE.ISO_8859-1
4773 :source $VIMRUNTIME/menu.vim
4774< Warning: This deletes all menus that you defined yourself!
4775
Bram Moolenaard94464e2015-11-02 15:28:18 +01004776 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004777'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004778 global
4779 {not in Vi}
4780 {only available when compiled with the |+langmap|
4781 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004782 This is just like 'langremap' but with the value inverted. It only
4783 exists for backwards compatibility. When setting 'langremap' then
4784 'langnoremap' is set to the inverted value, and the other way around.
4785
4786 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4787'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4788 global
4789 {not in Vi}
4790 {only available when compiled with the |+langmap|
4791 feature}
4792 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004793 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004794 'langmap' disables some of your mappings, try resetting this option.
4795 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004796 that works for you to avoid mappings to break.
4797
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 *'laststatus'* *'ls'*
4799'laststatus' 'ls' number (default 1)
4800 global
4801 {not in Vi}
4802 The value of this option influences when the last window will have a
4803 status line:
4804 0: never
4805 1: only if there are at least two windows
4806 2: always
4807 The screen looks nicer with a status line if you have several
4808 windows, but it takes another screen line. |status-line|
4809
4810 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4811'lazyredraw' 'lz' boolean (default off)
4812 global
4813 {not in Vi}
4814 When this option is set, the screen will not be redrawn while
4815 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004816 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 update use |:redraw|.
4818
4819 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4820'linebreak' 'lbr' boolean (default off)
4821 local to window
4822 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004823 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004825 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 than at the last character that fits on the screen. Unlike
4827 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004828 it only affects the way the file is displayed, not its contents.
4829 If 'breakindent' is set, line is visually indented. Then, the value
4830 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004831 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 Note that <Tab> characters after an <EOL> are mostly not displayed
4833 with the right amount of white space.
4834
4835 *'lines'* *E593*
4836'lines' number (default 24 or terminal height)
4837 global
4838 Number of lines of the Vim window.
4839 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004840 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 When Vim is running in the GUI or in a resizable window, setting this
4842 option will cause the window size to be changed. When you only want
4843 to use the size for the GUI, put the command in your |gvimrc| file.
4844 Vim limits the number of lines to what fits on the screen. You can
4845 use this command to get the tallest window possible: >
4846 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004847< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004848 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 When you set this option and Vim is unable to change the physical
4850 number of lines of the display, the display may be messed up.
4851
4852 *'linespace'* *'lsp'*
4853'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4854 global
4855 {not in Vi}
4856 {only in the GUI}
4857 Number of pixel lines inserted between characters. Useful if the font
4858 uses the full character cell height, making lines touch each other.
4859 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004860 With some fonts there can be too much room between lines (to have
4861 space for ascents and descents). Then it makes sense to set
4862 'linespace' to a negative value. This may cause display problems
4863 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864
4865 *'lisp'* *'nolisp'*
4866'lisp' boolean (default off)
4867 local to buffer
4868 {not available when compiled without the |+lispindent|
4869 feature}
4870 Lisp mode: When <Enter> is typed in insert mode set the indent for
4871 the next line to Lisp standards (well, sort of). Also happens with
4872 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4873 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4874 better. Also see 'lispwords'.
4875 The '-' character is included in keyword characters. Redefines the
4876 "=" operator to use this same indentation algorithm rather than
4877 calling an external program if 'equalprg' is empty.
4878 This option is not used when 'paste' is set.
4879 {Vi: Does it a little bit differently}
4880
4881 *'lispwords'* *'lw'*
4882'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004883 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 {not in Vi}
4885 {not available when compiled without the |+lispindent|
4886 feature}
4887 Comma separated list of words that influence the Lisp indenting.
4888 |'lisp'|
4889
4890 *'list'* *'nolist'*
4891'list' boolean (default off)
4892 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004893 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4894 line. Useful to see the difference between tabs and spaces and for
4895 trailing blanks. Further changed by the 'listchars' option.
4896
4897 The cursor is displayed at the start of the space a Tab character
4898 occupies, not at the end as usual in Normal mode. To get this cursor
4899 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004900 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004901<
4902 Note that list mode will also affect formatting (set with 'textwidth'
4903 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 changing the way tabs are displayed.
4905
4906 *'listchars'* *'lcs'*
4907'listchars' 'lcs' string (default "eol:$")
4908 global
4909 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004910 Strings to use in 'list' mode and for the |:list| command. It is a
4911 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004912 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 eol:c Character to show at the end of each line. When
4914 omitted, there is no extra character at the end of the
4915 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004916 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004917 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004919 fill the space that the tab normally occupies.
4920 "tab:>-" will show a tab that takes four spaces as
4921 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004922 *lcs-space*
4923 space:c Character to show for a space. When omitted, spaces
4924 are left blank.
4925 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004926 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004927 trailing spaces are blank. Overrides the "space"
4928 setting for trailing spaces.
4929 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 extends:c Character to show in the last column, when 'wrap' is
4931 off and the line continues beyond the right of the
4932 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004933 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934 precedes:c Character to show in the first column, when 'wrap'
4935 is off and there is text preceding the character
4936 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004937 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004938 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004939 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004940 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004941 nbsp:c Character to show for a non-breakable space character
4942 (0xA0 (160 decimal) and U+202F). Left blank when
4943 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004945 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004947 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948
4949 Examples: >
4950 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004951 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 :set lcs=extends:>,precedes:<
4953< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004954 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004955 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4958'loadplugins' 'lpl' boolean (default on)
4959 global
4960 {not in Vi}
4961 When on the plugin scripts are loaded when starting up |load-plugins|.
4962 This option can be reset in your |vimrc| file to disable the loading
4963 of plugins.
4964 Note that using the "-u NONE" and "--noplugin" command line arguments
4965 reset this option. |-u| |--noplugin|
4966
Bram Moolenaard94464e2015-11-02 15:28:18 +01004967 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004968'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004969 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004970 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004971 {only available when compiled with the |+lua/dyn|
4972 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004973 Specifies the name of the Lua shared library. The default is
4974 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004975 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004976 This option cannot be set from a |modeline| or in the |sandbox|, for
4977 security reasons.
4978
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004979 *'macatsui'* *'nomacatsui'*
4980'macatsui' boolean (default on)
4981 global
4982 {only available in Mac GUI version}
4983 This is a workaround for when drawing doesn't work properly. When set
4984 and compiled with multi-byte support ATSUI text drawing is used. When
4985 not set ATSUI text drawing is not used. Switch this option off when
4986 you experience drawing problems. In a future version the problems may
4987 be solved and this option becomes obsolete. Therefore use this method
4988 to unset it: >
4989 if exists('&macatsui')
4990 set nomacatsui
4991 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004992< Another option to check if you have drawing problems is
4993 'termencoding'.
4994
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 *'magic'* *'nomagic'*
4996'magic' boolean (default on)
4997 global
4998 Changes the special characters that can be used in search patterns.
4999 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005000 WARNING: Switching this option off most likely breaks plugins! That
5001 is because many patterns assume it's on and will fail when it's off.
5002 Only switch it off when working with old Vi scripts. In any other
5003 situation write patterns that work when 'magic' is on. Include "\M"
5004 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005
5006 *'makeef'* *'mef'*
5007'makeef' 'mef' string (default: "")
5008 global
5009 {not in Vi}
5010 {not available when compiled without the |+quickfix|
5011 feature}
5012 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5013 and the |:grep| command.
5014 When it is empty, an internally generated temp file will be used.
5015 When "##" is included, it is replaced by a number to make the name
5016 unique. This makes sure that the ":make" command doesn't overwrite an
5017 existing file.
5018 NOT used for the ":cf" command. See 'errorfile' for that.
5019 Environment variables are expanded |:set_env|.
5020 See |option-backslash| about including spaces and backslashes.
5021 This option cannot be set from a |modeline| or in the |sandbox|, for
5022 security reasons.
5023
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005024 *'makeencoding'* *'menc'*
5025'makeencoding' 'menc' string (default "")
5026 global or local to buffer |global-local|
5027 {only available when compiled with the |+multi_byte|
5028 feature}
5029 {not in Vi}
5030 Encoding used for reading the output of external commands. When empty,
5031 encoding is not converted.
5032 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5033 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5034 and `:laddfile`.
5035
5036 This would be mostly useful when you use MS-Windows and set 'encoding'
5037 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5038 'makeencoding' to "char" has the same effect as setting to the system
5039 locale encoding. Example: >
5040 :set encoding=utf-8
5041 :set makeencoding=char " system locale is used
5042<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 *'makeprg'* *'mp'*
5044'makeprg' 'mp' string (default "make", VMS: "MMS")
5045 global or local to buffer |global-local|
5046 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005047 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005048 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5049 which are expanded to the current and alternate file name. Use |::S|
5050 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005051 Environment variables are expanded |:set_env|. See |option-backslash|
5052 about including spaces and backslashes.
5053 Note that a '|' must be escaped twice: once for ":set" and once for
5054 the interpretation of a command. When you use a filter called
5055 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 :set makeprg=gmake\ \\\|\ myfilter
5057< The placeholder "$*" can be given (even multiple times) to specify
5058 where the arguments will be included, for example: >
5059 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5060< This option cannot be set from a |modeline| or in the |sandbox|, for
5061 security reasons.
5062
5063 *'matchpairs'* *'mps'*
5064'matchpairs' 'mps' string (default "(:),{:},[:]")
5065 local to buffer
5066 {not in Vi}
5067 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005068 other.
5069 Only character pairs are allowed that are different, thus you cannot
5070 jump between two double quotes.
5071 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 The pairs must be separated by a comma. Example for including '<' and
5073 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 :set mps+=<:>
5075
5076< A more exotic example, to jump between the '=' and ';' in an
5077 assignment, useful for languages like C and Java: >
5078 :au FileType c,cpp,java set mps+==:;
5079
5080< For a more advanced way of using "%", see the matchit.vim plugin in
5081 the $VIMRUNTIME/macros directory. |add-local-help|
5082
5083 *'matchtime'* *'mat'*
5084'matchtime' 'mat' number (default 5)
5085 global
5086 {not in Vi}{in Nvi}
5087 Tenths of a second to show the matching paren, when 'showmatch' is
5088 set. Note that this is not in milliseconds, like other options that
5089 set a time. This is to be compatible with Nvi.
5090
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005091 *'maxcombine'* *'mco'*
5092'maxcombine' 'mco' number (default 2)
5093 global
5094 {not in Vi}
5095 {only available when compiled with the |+multi_byte|
5096 feature}
5097 The maximum number of combining characters supported for displaying.
5098 Only used when 'encoding' is "utf-8".
5099 The default is OK for most languages. Hebrew may require 4.
5100 Maximum value is 6.
5101 Even when this option is set to 2 you can still edit text with more
5102 combining characters, you just can't see them. Use |g8| or |ga|.
5103 See |mbyte-combining|.
5104
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 *'maxfuncdepth'* *'mfd'*
5106'maxfuncdepth' 'mfd' number (default 100)
5107 global
5108 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005109 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005110 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 Maximum depth of function calls for user functions. This normally
5112 catches endless recursion. When using a recursive function with
5113 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5114 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005115 Increasing this limit above 200 also changes the maximum for Ex
5116 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 See also |:function|.
5118
5119 *'maxmapdepth'* *'mmd'* *E223*
5120'maxmapdepth' 'mmd' number (default 1000)
5121 global
5122 {not in Vi}
5123 Maximum number of times a mapping is done without resulting in a
5124 character to be used. This normally catches endless mappings, like
5125 ":map x y" with ":map y x". It still does not catch ":map g wg",
5126 because the 'w' is used before the next mapping is done. See also
5127 |key-mapping|.
5128
5129 *'maxmem'* *'mm'*
5130'maxmem' 'mm' number (default between 256 to 5120 (system
5131 dependent) or half the amount of memory
5132 available)
5133 global
5134 {not in Vi}
5135 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5136 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005137 other memory to be freed. The maximum usable value is about 2000000.
5138 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005140 *'maxmempattern'* *'mmp'*
5141'maxmempattern' 'mmp' number (default 1000)
5142 global
5143 {not in Vi}
5144 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005145 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005146 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005147 When Vim runs into the limit it gives an error message and mostly
5148 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005149 Running into the limit often means that the pattern is very
5150 inefficient or too complex. This may already happen with the pattern
5151 "\(.\)*" on a very long line. ".*" works much better.
5152 Vim may run out of memory before hitting the 'maxmempattern' limit.
5153
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 *'maxmemtot'* *'mmt'*
5155'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5156 dependent) or half the amount of memory
5157 available)
5158 global
5159 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005160 Maximum amount of memory in Kbyte to use for all buffers together.
5161 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005162 without a limit.
5163 On 64 bit machines higher values might work. But hey, do you really
5164 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005165 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005166 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005167 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168
5169 *'menuitems'* *'mis'*
5170'menuitems' 'mis' number (default 25)
5171 global
5172 {not in Vi}
5173 {not available when compiled without the |+menu|
5174 feature}
5175 Maximum number of items to use in a menu. Used for menus that are
5176 generated from a list of items, e.g., the Buffers menu. Changing this
5177 option has no direct effect, the menu must be refreshed first.
5178
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005179 *'mkspellmem'* *'msm'*
5180'mkspellmem' 'msm' string (default "460000,2000,500")
5181 global
5182 {not in Vi}
5183 {not available when compiled without the |+syntax|
5184 feature}
5185 Parameters for |:mkspell|. This tunes when to start compressing the
5186 word tree. Compression can be slow when there are many words, but
5187 it's needed to avoid running out of memory. The amount of memory used
5188 per word depends very much on how similar the words are, that's why
5189 this tuning is complicated.
5190
5191 There are three numbers, separated by commas:
5192 {start},{inc},{added}
5193
5194 For most languages the uncompressed word tree fits in memory. {start}
5195 gives the amount of memory in Kbyte that can be used before any
5196 compression is done. It should be a bit smaller than the amount of
5197 memory that is available to Vim.
5198
5199 When going over the {start} limit the {inc} number specifies the
5200 amount of memory in Kbyte that can be allocated before another
5201 compression is done. A low number means compression is done after
5202 less words are added, which is slow. A high number means more memory
5203 will be allocated.
5204
5205 After doing compression, {added} times 1024 words can be added before
5206 the {inc} limit is ignored and compression is done when any extra
5207 amount of memory is needed. A low number means there is a smaller
5208 chance of hitting the {inc} limit, less memory is used but it's
5209 slower.
5210
5211 The languages for which these numbers are important are Italian and
5212 Hungarian. The default works for when you have about 512 Mbyte. If
5213 you have 1 Gbyte you could use: >
5214 :set mkspellmem=900000,3000,800
5215< If you have less than 512 Mbyte |:mkspell| may fail for some
5216 languages, no matter what you set 'mkspellmem' to.
5217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005219'modeline' 'ml' boolean (Vim default: on (off for root),
5220 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 local to buffer
5222 *'modelines'* *'mls'*
5223'modelines' 'mls' number (default 5)
5224 global
5225 {not in Vi}
5226 If 'modeline' is on 'modelines' gives the number of lines that is
5227 checked for set commands. If 'modeline' is off or 'modelines' is zero
5228 no lines are checked. See |modeline|.
5229 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5230 set and to the Vim default value when 'compatible' is reset.
5231
5232 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5233'modifiable' 'ma' boolean (default on)
5234 local to buffer
5235 {not in Vi} *E21*
5236 When off the buffer contents cannot be changed. The 'fileformat' and
5237 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005238 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239
5240 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5241'modified' 'mod' boolean (default off)
5242 local to buffer
5243 {not in Vi}
5244 When on, the buffer is considered to be modified. This option is set
5245 when:
5246 1. A change was made to the text since it was last written. Using the
5247 |undo| command to go back to the original text will reset the
5248 option. But undoing changes that were made before writing the
5249 buffer will set the option again, since the text is different from
5250 when it was written.
5251 2. 'fileformat' or 'fileencoding' is different from its original
5252 value. The original value is set when the buffer is read or
5253 written. A ":set nomodified" command also resets the original
5254 values to the current values and the 'modified' option will be
5255 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005256 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005257 This option is not set when a change is made to the buffer as the
5258 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5259 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5260 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5262 will be ignored.
5263
5264 *'more'* *'nomore'*
5265'more' boolean (Vim default: on, Vi default: off)
5266 global
5267 {not in Vi}
5268 When on, listings pause when the whole screen is filled. You will get
5269 the |more-prompt|. When this option is off there are no pauses, the
5270 listing continues until finished.
5271 NOTE: This option is set to the Vi default value when 'compatible' is
5272 set and to the Vim default value when 'compatible' is reset.
5273
5274 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005275'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5276 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 global
5278 {not in Vi}
5279 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005280 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5281 sysmouse and Linux console with gpm). For using the mouse in the
5282 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 The mouse can be enabled for different modes:
5284 n Normal mode
5285 v Visual mode
5286 i Insert mode
5287 c Command-line mode
5288 h all previous modes when editing a help file
5289 a all previous modes
5290 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 Normally you would enable the mouse in all four modes with: >
5292 :set mouse=a
5293< When the mouse is not enabled, the GUI will still use the mouse for
5294 modeless selection. This doesn't move the text cursor.
5295
5296 See |mouse-using|. Also see |'clipboard'|.
5297
5298 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005299 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 the mouse buttons can still be used by keeping the shift key pressed.
5301 Also see the 'clipboard' option.
5302
5303 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5304'mousefocus' 'mousef' boolean (default off)
5305 global
5306 {not in Vi}
5307 {only works in the GUI}
5308 The window that the mouse pointer is on is automatically activated.
5309 When changing the window layout or window focus in another way, the
5310 mouse pointer is moved to the window with keyboard focus. Off is the
5311 default because it makes using the pull down menus a little goofy, as
5312 a pointer transit may activate a window unintentionally.
5313
5314 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5315'mousehide' 'mh' boolean (default on)
5316 global
5317 {not in Vi}
5318 {only works in the GUI}
5319 When on, the mouse pointer is hidden when characters are typed.
5320 The mouse pointer is restored when the mouse is moved.
5321
5322 *'mousemodel'* *'mousem'*
5323'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5324 global
5325 {not in Vi}
5326 Sets the model to use for the mouse. The name mostly specifies what
5327 the right mouse button is used for:
5328 extend Right mouse button extends a selection. This works
5329 like in an xterm.
5330 popup Right mouse button pops up a menu. The shifted left
5331 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005332 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 popup_setpos Like "popup", but the cursor will be moved to the
5334 position where the mouse was clicked, and thus the
5335 selected operation will act upon the clicked object.
5336 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005337 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 course, that right clicking outside a selection will
5339 end Visual mode.
5340 Overview of what button does what for each model:
5341 mouse extend popup(_setpos) ~
5342 left click place cursor place cursor
5343 left drag start selection start selection
5344 shift-left search word extend selection
5345 right click extend selection popup menu (place cursor)
5346 right drag extend selection -
5347 middle click paste paste
5348
5349 In the "popup" model the right mouse button produces a pop-up menu.
5350 You need to define this first, see |popup-menu|.
5351
5352 Note that you can further refine the meaning of buttons with mappings.
5353 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5354 selection (because that's handled in the GUI code directly).
5355
5356 The 'mousemodel' option is set by the |:behave| command.
5357
5358 *'mouseshape'* *'mouses'* *E547*
5359'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005360 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361 global
5362 {not in Vi}
5363 {only available when compiled with the |+mouseshape|
5364 feature}
5365 This option tells Vim what the mouse pointer should look like in
5366 different modes. The option is a comma separated list of parts, much
5367 like used for 'guicursor'. Each part consist of a mode/location-list
5368 and an argument-list:
5369 mode-list:shape,mode-list:shape,..
5370 The mode-list is a dash separated list of these modes/locations:
5371 In a normal window: ~
5372 n Normal mode
5373 v Visual mode
5374 ve Visual mode with 'selection' "exclusive" (same as 'v',
5375 if not specified)
5376 o Operator-pending mode
5377 i Insert mode
5378 r Replace mode
5379
5380 Others: ~
5381 c appending to the command-line
5382 ci inserting in the command-line
5383 cr replacing in the command-line
5384 m at the 'Hit ENTER' or 'More' prompts
5385 ml idem, but cursor in the last line
5386 e any mode, pointer below last window
5387 s any mode, pointer on a status line
5388 sd any mode, while dragging a status line
5389 vs any mode, pointer on a vertical separator line
5390 vd any mode, while dragging a vertical separator line
5391 a everywhere
5392
5393 The shape is one of the following:
5394 avail name looks like ~
5395 w x arrow Normal mouse pointer
5396 w x blank no pointer at all (use with care!)
5397 w x beam I-beam
5398 w x updown up-down sizing arrows
5399 w x leftright left-right sizing arrows
5400 w x busy The system's usual busy pointer
5401 w x no The system's usual 'no input' pointer
5402 x udsizing indicates up-down resizing
5403 x lrsizing indicates left-right resizing
5404 x crosshair like a big thin +
5405 x hand1 black hand
5406 x hand2 white hand
5407 x pencil what you write with
5408 x question big ?
5409 x rightup-arrow arrow pointing right-up
5410 w x up-arrow arrow pointing up
5411 x <number> any X11 pointer number (see X11/cursorfont.h)
5412
5413 The "avail" column contains a 'w' if the shape is available for Win32,
5414 x for X11.
5415 Any modes not specified or shapes not available use the normal mouse
5416 pointer.
5417
5418 Example: >
5419 :set mouseshape=s:udsizing,m:no
5420< will make the mouse turn to a sizing arrow over the status lines and
5421 indicate no input when the hit-enter prompt is displayed (since
5422 clicking the mouse has no effect in this state.)
5423
5424 *'mousetime'* *'mouset'*
5425'mousetime' 'mouset' number (default 500)
5426 global
5427 {not in Vi}
5428 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5429 time in msec between two mouse clicks for the second click to be
5430 recognized as a multi click.
5431
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005432 *'mzquantum'* *'mzq'*
5433'mzquantum' 'mzq' number (default 100)
5434 global
5435 {not in Vi}
5436 {not available when compiled without the |+mzscheme|
5437 feature}
5438 The number of milliseconds between polls for MzScheme threads.
5439 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005440 NOTE: This option is set to the Vim default value when 'compatible'
5441 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005442
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005444'nrformats' 'nf' string (default "bin,octal,hex",
5445 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 local to buffer
5447 {not in Vi}
5448 This defines what bases Vim will consider for numbers when using the
5449 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5450 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005451 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005453 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005454 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005456 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 considered to be hexadecimal. Example: Using CTRL-X on
5458 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005459 bin If included, numbers starting with "0b" or "0B" will be
5460 considered to be binary. Example: Using CTRL-X on
5461 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 Numbers which simply begin with a digit in the range 1-9 are always
5463 considered decimal. This also happens for numbers that are not
5464 recognized as octal or hex.
5465
5466 *'number'* *'nu'* *'nonumber'* *'nonu'*
5467'number' 'nu' boolean (default off)
5468 local to window
5469 Print the line number in front of each line. When the 'n' option is
5470 excluded from 'cpoptions' a wrapped line will not use the column of
5471 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005472 The 'numberwidth' option can be used to set the room used for the line
5473 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 When a long, wrapped line doesn't start with the first character, '-'
5475 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005476 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5477 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005478 *number_relativenumber*
5479 The 'relativenumber' option changes the displayed number to be
5480 relative to the cursor. Together with 'number' there are these
5481 four combinations (cursor in line 3):
5482
Bram Moolenaar3848e002016-03-19 18:42:29 +01005483 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005484 'nornu' 'nornu' 'rnu' 'rnu'
5485
5486 |apple | 1 apple | 2 apple | 2 apple
5487 |pear | 2 pear | 1 pear | 1 pear
5488 |nobody | 3 nobody | 0 nobody |3 nobody
5489 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005491 *'numberwidth'* *'nuw'*
5492'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5493 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005494 {not in Vi}
5495 {only available when compiled with the |+linebreak|
5496 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005497 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005498 when the 'number' or 'relativenumber' option is set or printing lines
5499 with a line number. Since one space is always between the number and
5500 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005501 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005502 fit the highest line number in the buffer respectively the number of
5503 rows in the window, depending on whether 'number' or 'relativenumber'
5504 is set. Thus with the Vim default of 4 there is room for a line number
5505 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005506 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005507 NOTE: This option is set to the Vi default value when 'compatible' is
5508 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005509
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005510 *'omnifunc'* *'ofu'*
5511'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005512 local to buffer
5513 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005514 {not available when compiled without the |+eval|
5515 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005516 This option specifies a function to be used for Insert mode omni
5517 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005518 See |complete-functions| for an explanation of how the function is
5519 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005520 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005521 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005522 This option cannot be set from a |modeline| or in the |sandbox|, for
5523 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005524
5525
Bram Moolenaar02467872007-05-06 13:22:01 +00005526 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005527'opendevice' 'odev' boolean (default off)
5528 global
5529 {not in Vi}
5530 {only for MS-DOS, MS-Windows and OS/2}
5531 Enable reading and writing from devices. This may get Vim stuck on a
5532 device that can be opened but doesn't actually do the I/O. Therefore
5533 it is off by default.
5534 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5535 result in editing a device.
5536
5537
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005538 *'operatorfunc'* *'opfunc'*
5539'operatorfunc' 'opfunc' string (default: empty)
5540 global
5541 {not in Vi}
5542 This option specifies a function to be called by the |g@| operator.
5543 See |:map-operator| for more info and an example.
5544
5545 This option cannot be set from a |modeline| or in the |sandbox|, for
5546 security reasons.
5547
5548
Bram Moolenaar251e1912011-06-19 05:09:16 +02005549 *'osfiletype'* *'oft'*
5550'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 local to buffer
5552 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005553 This option was supported on RISC OS, which has been removed.
5554
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005556 *'packpath'* *'pp'*
5557'packpath' 'pp' string (default: see 'runtimepath')
5558 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005559 Directories used to find packages. See |packages|.
5560
5561
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005563'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 global
5565 Specifies the nroff macros that separate paragraphs. These are pairs
5566 of two letters (see |object-motions|).
5567
5568 *'paste'* *'nopaste'*
5569'paste' boolean (default off)
5570 global
5571 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005572 Put Vim in Paste mode. This is useful if you want to cut or copy
5573 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574 unexpected effects.
5575 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005576 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 knows about pasting and will mostly do the right thing without 'paste'
5578 being set. The same is true for a terminal where Vim handles the
5579 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005580 This option is reset when starting the GUI. Thus if you set it in
5581 your .vimrc it will work in a terminal, but not in the GUI. Setting
5582 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5583 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 When the 'paste' option is switched on (also when it was already on):
5585 - mapping in Insert mode and Command-line mode is disabled
5586 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005588 - 'expandtab' is reset
5589 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 - 'revins' is reset
5591 - 'ruler' is reset
5592 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005593 - 'smartindent' is reset
5594 - 'smarttab' is reset
5595 - 'softtabstop' is set to 0
5596 - 'textwidth' is set to 0
5597 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005600 - 'indentexpr'
5601 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 NOTE: When you start editing another file while the 'paste' option is
5603 on, settings from the modelines or autocommands may change the
5604 settings again, causing trouble when pasting text. You might want to
5605 set the 'paste' option again.
5606 When the 'paste' option is reset the mentioned options are restored to
5607 the value before the moment 'paste' was switched from off to on.
5608 Resetting 'paste' before ever setting it does not have any effect.
5609 Since mapping doesn't work while 'paste' is active, you need to use
5610 the 'pastetoggle' option to toggle the 'paste' option with some key.
5611
5612 *'pastetoggle'* *'pt'*
5613'pastetoggle' 'pt' string (default "")
5614 global
5615 {not in Vi}
5616 When non-empty, specifies the key sequence that toggles the 'paste'
5617 option. This is like specifying a mapping: >
5618 :map {keys} :set invpaste<CR>
5619< Where {keys} is the value of 'pastetoggle'.
5620 The difference is that it will work even when 'paste' is set.
5621 'pastetoggle' works in Insert mode and Normal mode, but not in
5622 Command-line mode.
5623 Mappings are checked first, thus overrule 'pastetoggle'. However,
5624 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5625 this: >
5626 :map <F10> :set paste<CR>
5627 :map <F11> :set nopaste<CR>
5628 :imap <F10> <C-O>:set paste<CR>
5629 :imap <F11> <nop>
5630 :set pastetoggle=<F11>
5631< This will make <F10> start paste mode and <F11> stop paste mode.
5632 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5633 mode everything is inserted literally, except the 'pastetoggle' key
5634 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005635 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636
5637 *'pex'* *'patchexpr'*
5638'patchexpr' 'pex' string (default "")
5639 global
5640 {not in Vi}
5641 {not available when compiled without the |+diff|
5642 feature}
5643 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005644 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645
Bram Moolenaardbc28022014-07-26 13:40:44 +02005646 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647'patchmode' 'pm' string (default "")
5648 global
5649 {not in Vi}
5650 When non-empty the oldest version of a file is kept. This can be used
5651 to keep the original version of a file if you are changing files in a
5652 source distribution. Only the first time that a file is written a
5653 copy of the original file will be kept. The name of the copy is the
5654 name of the original file with the string in the 'patchmode' option
5655 appended. This option should start with a dot. Use a string like
5656 ".org". 'backupdir' must not be empty for this to work (Detail: The
5657 backup file is renamed to the patchmode file after the new file has
5658 been successfully written, that's why it must be possible to write a
5659 backup file). If there was no file to be backed up, an empty file is
5660 created.
5661 When the 'backupskip' pattern matches, a patchmode file is not made.
5662 Using 'patchmode' for compressed files appends the extension at the
5663 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5664 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005665 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005667 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668'path' 'pa' string (default on Unix: ".,/usr/include,,"
5669 on OS/2: ".,/emx/include,,"
5670 other systems: ".,,")
5671 global or local to buffer |global-local|
5672 {not in Vi}
5673 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005674 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5675 provided that the file being searched for has a relative path (not
5676 starting with "/", "./" or "../"). The directories in the 'path'
5677 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 - Use commas to separate directory names: >
5679 :set path=.,/usr/local/include,/usr/include
5680< - Spaces can also be used to separate directory names (for backwards
5681 compatibility with version 3.0). To have a space in a directory
5682 name, precede it with an extra backslash, and escape the space: >
5683 :set path=.,/dir/with\\\ space
5684< - To include a comma in a directory name precede it with an extra
5685 backslash: >
5686 :set path=.,/dir/with\\,comma
5687< - To search relative to the directory of the current file, use: >
5688 :set path=.
5689< - To search in the current directory use an empty string between two
5690 commas: >
5691 :set path=,,
5692< - A directory name may end in a ':' or '/'.
5693 - Environment variables are expanded |:set_env|.
5694 - When using |netrw.vim| URLs can be used. For example, adding
5695 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005696 - Search upwards and downwards in a directory tree using "*", "**" and
5697 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 {not available when compiled without the |+path_extra| feature}
5699 - Careful with '\' characters, type two to get one in the option: >
5700 :set path=.,c:\\include
5701< Or just use '/' instead: >
5702 :set path=.,c:/include
5703< Don't forget "." or files won't even be found in the same directory as
5704 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005705 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 it is something like 256 or 1024 characters.
5707 You can check if all the include files are found, using the value of
5708 'path', see |:checkpath|.
5709 The use of |:set+=| and |:set-=| is preferred when adding or removing
5710 directories from the list. This avoids problems when a future version
5711 uses another default. To remove the current directory use: >
5712 :set path-=
5713< To add the current directory use: >
5714 :set path+=
5715< To use an environment variable, you probably need to replace the
5716 separator. Here is an example to append $INCL, in which directory
5717 names are separated with a semi-colon: >
5718 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5719< Replace the ';' with a ':' or whatever separator is used. Note that
5720 this doesn't work when $INCL contains a comma or white space.
5721
Bram Moolenaard94464e2015-11-02 15:28:18 +01005722 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005723'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005724 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005725 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005726 {only available when compiled with the |+perl/dyn|
5727 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005728 Specifies the name of the Perl shared library. The default is
5729 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005730 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005731 This option cannot be set from a |modeline| or in the |sandbox|, for
5732 security reasons.
5733
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5735'preserveindent' 'pi' boolean (default off)
5736 local to buffer
5737 {not in Vi}
5738 When changing the indent of the current line, preserve as much of the
5739 indent structure as possible. Normally the indent is replaced by a
5740 series of tabs followed by spaces as required (unless |'expandtab'| is
5741 enabled, in which case only spaces are used). Enabling this option
5742 means the indent will preserve as many existing characters as possible
5743 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005744 'expandtab' does not apply to the preserved white space, a Tab remains
5745 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 NOTE: When using ">>" multiple times the resulting indent is a mix of
5747 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005748 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 Also see 'copyindent'.
5750 Use |:retab| to clean up white space.
5751
5752 *'previewheight'* *'pvh'*
5753'previewheight' 'pvh' number (default 12)
5754 global
5755 {not in Vi}
5756 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005757 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 Default height for a preview window. Used for |:ptag| and associated
5759 commands. Used for |CTRL-W_}| when no count is given.
5760
5761 *'previewwindow'* *'nopreviewwindow'*
5762 *'pvw'* *'nopvw'* *E590*
5763'previewwindow' 'pvw' boolean (default off)
5764 local to window
5765 {not in Vi}
5766 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005767 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005768 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 set. It's normally not set directly, but by using one of the commands
5770 |:ptag|, |:pedit|, etc.
5771
5772 *'printdevice'* *'pdev'*
5773'printdevice' 'pdev' string (default empty)
5774 global
5775 {not in Vi}
5776 {only available when compiled with the |+printer|
5777 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005778 The name of the printer to be used for |:hardcopy|.
5779 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005780 This option cannot be set from a |modeline| or in the |sandbox|, for
5781 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005782
Bram Moolenaar8299df92004-07-10 09:47:34 +00005783 *'printencoding'* *'penc'*
5784'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 global
5786 {not in Vi}
5787 {only available when compiled with the |+printer|
5788 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005789 Sets the character encoding used when printing.
5790 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791
5792 *'printexpr'* *'pexpr'*
5793'printexpr' 'pexpr' String (default: see below)
5794 global
5795 {not in Vi}
5796 {only available when compiled with the |+printer|
5797 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005798 Expression used to print the PostScript produced with |:hardcopy|.
5799 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005800 This option cannot be set from a |modeline| or in the |sandbox|, for
5801 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802
Bram Moolenaar8299df92004-07-10 09:47:34 +00005803 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804'printfont' 'pfn' string (default "courier")
5805 global
5806 {not in Vi}
5807 {only available when compiled with the |+printer|
5808 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005809 The name of the font that will be used for |:hardcopy|.
5810 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811
5812 *'printheader'* *'pheader'*
5813'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5814 global
5815 {not in Vi}
5816 {only available when compiled with the |+printer|
5817 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005818 The format of the header produced in |:hardcopy| output.
5819 See |pheader-option|.
5820
5821 *'printmbcharset'* *'pmbcs'*
5822'printmbcharset' 'pmbcs' string (default "")
5823 global
5824 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005825 {only available when compiled with the |+printer|,
5826 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005827 The CJK character set to be used for CJK output from |:hardcopy|.
5828 See |pmbcs-option|.
5829
5830 *'printmbfont'* *'pmbfn'*
5831'printmbfont' 'pmbfn' string (default "")
5832 global
5833 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005834 {only available when compiled with the |+printer|,
5835 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005836 List of font names to be used for CJK output from |:hardcopy|.
5837 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838
5839 *'printoptions'* *'popt'*
5840'printoptions' 'popt' string (default "")
5841 global
5842 {not in Vi}
5843 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005844 List of items that control the format of the output of |:hardcopy|.
5845 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005847 *'prompt'* *'noprompt'*
5848'prompt' boolean (default on)
5849 global
5850 When on a ":" prompt is used in Ex mode.
5851
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005852 *'pumheight'* *'ph'*
5853'pumheight' 'ph' number (default 0)
5854 global
5855 {not available when compiled without the
5856 |+insert_expand| feature}
5857 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005858 Determines the maximum number of items to show in the popup menu for
5859 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005860 |ins-completion-menu|.
5861
Bram Moolenaard94464e2015-11-02 15:28:18 +01005862 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005863'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005864 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005865 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005866 {only available when compiled with the |+python/dyn|
5867 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005868 Specifies the name of the Python 2.x shared library. The default is
5869 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005870 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005873
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005874 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005875'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005876 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005877 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005878 {only available when compiled with the |+python3/dyn|
5879 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005880 Specifies the name of the Python 3 shared library. The default is
5881 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005882 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005883 This option cannot be set from a |modeline| or in the |sandbox|, for
5884 security reasons.
5885
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005886 *'pyxversion'* *'pyx'*
5887'pyxversion' 'pyx' number (default depends on the build)
5888 global
5889 {not in Vi}
5890 {only available when compiled with the |+python| or
5891 the |+python3| feature}
5892 Specifies the python version used for pyx* functions and commands
5893 |python_x|. The default value is as follows:
5894
5895 Compiled with Default ~
5896 |+python| and |+python3| 0
5897 only |+python| 2
5898 only |+python3| 3
5899
5900 Available values are 0, 2 and 3.
5901 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5902 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5903 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5904 to 2 if Python 2 is available.
5905 See also: |has-pythonx|
5906
5907 If Vim is compiled with only |+python| or |+python3| setting
5908 'pyxversion' has no effect. The pyx* functions and commands are
5909 always the same as the compiled version.
5910
5911 This option cannot be set from a |modeline| or in the |sandbox|, for
5912 security reasons.
5913
Bram Moolenaar677ee682005-01-27 14:41:15 +00005914 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005915'quoteescape' 'qe' string (default "\")
5916 local to buffer
5917 {not in Vi}
5918 The characters that are used to escape quotes in a string. Used for
5919 objects like a', a" and a` |a'|.
5920 When one of the characters in this option is found inside a string,
5921 the following character will be skipped. The default value makes the
5922 text "foo\"bar\\" considered to be one string.
5923
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5925'readonly' 'ro' boolean (default off)
5926 local to buffer
5927 If on, writes fail unless you use a '!'. Protects you from
5928 accidentally overwriting a file. Default on when Vim is started
5929 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005930 When using ":w!" the 'readonly' option is reset for the current
5931 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005933 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005934 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005936 *'redrawtime'* *'rdt'*
5937'redrawtime' 'rdt' number (default 2000)
5938 global
5939 {not in Vi}
5940 {only available when compiled with the |+reltime|
5941 feature}
5942 The time in milliseconds for redrawing the display. This applies to
5943 searching for patterns for 'hlsearch' and |:match| highlighting.
5944 When redrawing takes more than this many milliseconds no further
5945 matches will be highlighted. This is used to avoid that Vim hangs
5946 when using a very complicated pattern.
5947
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005948 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005949'regexpengine' 're' number (default 0)
5950 global
5951 {not in Vi}
5952 This selects the default regexp engine. |two-engines|
5953 The possible values are:
5954 0 automatic selection
5955 1 old engine
5956 2 NFA engine
5957 Note that when using the NFA engine and the pattern contains something
5958 that is not supported the pattern will not match. This is only useful
5959 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005960 Using automatic selection enables Vim to switch the engine, if the
5961 default engine becomes too costly. E.g., when the NFA engine uses too
5962 many states. This should prevent Vim from hanging on a combination of
5963 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005964
Bram Moolenaar64486672010-05-16 15:46:46 +02005965 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5966'relativenumber' 'rnu' boolean (default off)
5967 local to window
5968 {not in Vi}
5969 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005970 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005971 precede some vertical motion commands (e.g. j k + -) with, without
5972 having to calculate it yourself. Especially useful in combination with
5973 other commands (e.g. y d c < > gq gw =).
5974 When the 'n' option is excluded from 'cpoptions' a wrapped
5975 line will not use the column of line numbers (this is the default when
5976 'compatible' isn't set).
5977 The 'numberwidth' option can be used to set the room used for the line
5978 number.
5979 When a long, wrapped line doesn't start with the first character, '-'
5980 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005981 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5982 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005983
5984 The number in front of the cursor line also depends on the value of
5985 'number', see |number_relativenumber| for all combinations of the two
5986 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005987
Bram Moolenaar071d4272004-06-13 20:20:40 +00005988 *'remap'* *'noremap'*
5989'remap' boolean (default on)
5990 global
5991 Allows for mappings to work recursively. If you do not want this for
5992 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005993 NOTE: To avoid portability problems with Vim scripts, always keep
5994 this option at the default "on". Only switch it off when working with
5995 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005997 *'renderoptions'* *'rop'*
5998'renderoptions' 'rop' string (default: empty)
5999 global
6000 {not in Vi}
6001 {only available when compiled with GUI and DIRECTX on
6002 MS-Windows}
6003 Select a text renderer and set its options. The options depend on the
6004 renderer.
6005
6006 Syntax: >
6007 set rop=type:{renderer}(,{name}:{value})*
6008<
6009 Currently, only one optional renderer is available.
6010
6011 render behavior ~
6012 directx Vim will draw text using DirectX (DirectWrite). It makes
6013 drawn glyphs more beautiful than default GDI.
6014 It requires 'encoding' is "utf-8", and only works on
6015 MS-Windows Vista or newer version.
6016
6017 Options:
6018 name meaning type value ~
6019 gamma gamma float 1.0 - 2.2 (maybe)
6020 contrast enhancedContrast float (unknown)
6021 level clearTypeLevel float (unknown)
6022 geom pixelGeometry int 0 - 2 (see below)
6023 renmode renderingMode int 0 - 6 (see below)
6024 taamode textAntialiasMode int 0 - 3 (see below)
6025
6026 See this URL for detail:
6027 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6028
6029 For geom: structure of a device pixel.
6030 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6031 1 - DWRITE_PIXEL_GEOMETRY_RGB
6032 2 - DWRITE_PIXEL_GEOMETRY_BGR
6033
6034 See this URL for detail:
6035 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6036
6037 For renmode: method of rendering glyphs.
6038 0 - DWRITE_RENDERING_MODE_DEFAULT
6039 1 - DWRITE_RENDERING_MODE_ALIASED
6040 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6041 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6042 4 - DWRITE_RENDERING_MODE_NATURAL
6043 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6044 6 - DWRITE_RENDERING_MODE_OUTLINE
6045
6046 See this URL for detail:
6047 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6048
6049 For taamode: antialiasing mode used for drawing text.
6050 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6051 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6052 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6053 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6054
6055 See this URL for detail:
6056 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6057
6058 Example: >
6059 set encoding=utf-8
6060 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6061 set rop=type:directx
6062<
6063 If select a raster font (Courier, Terminal or FixedSys) to
6064 'guifont', it fallbacks to be drawn by GDI automatically.
6065
6066 Other render types are currently not supported.
6067
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 *'report'*
6069'report' number (default 2)
6070 global
6071 Threshold for reporting number of lines changed. When the number of
6072 changed lines is more than 'report' a message will be given for most
6073 ":" commands. If you want it always, set 'report' to 0.
6074 For the ":substitute" command the number of substitutions is used
6075 instead of the number of lines.
6076
6077 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6078'restorescreen' 'rs' boolean (default on)
6079 global
6080 {not in Vi} {only in Windows 95/NT console version}
6081 When set, the screen contents is restored when exiting Vim. This also
6082 happens when executing external commands.
6083
6084 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6085 options in your .vimrc. To disable restoring:
6086 set t_ti= t_te=
6087 To enable restoring (for an xterm):
6088 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6089 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6090
6091 *'revins'* *'ri'* *'norevins'* *'nori'*
6092'revins' 'ri' boolean (default off)
6093 global
6094 {not in Vi}
6095 {only available when compiled with the |+rightleft|
6096 feature}
6097 Inserting characters in Insert mode will work backwards. See "typing
6098 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6099 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006100 NOTE: This option is reset when 'compatible' is set.
6101 This option is reset when 'paste' is set and restored when 'paste' is
6102 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103
6104 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6105'rightleft' 'rl' boolean (default off)
6106 local to window
6107 {not in Vi}
6108 {only available when compiled with the |+rightleft|
6109 feature}
6110 When on, display orientation becomes right-to-left, i.e., characters
6111 that are stored in the file appear from the right to the left.
6112 Using this option, it is possible to edit files for languages that
6113 are written from the right to the left such as Hebrew and Arabic.
6114 This option is per window, so it is possible to edit mixed files
6115 simultaneously, or to view the same file in both ways (this is
6116 useful whenever you have a mixed text file with both right-to-left
6117 and left-to-right strings so that both sets are displayed properly
6118 in different windows). Also see |rileft.txt|.
6119
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006120 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121'rightleftcmd' 'rlc' string (default "search")
6122 local to window
6123 {not in Vi}
6124 {only available when compiled with the |+rightleft|
6125 feature}
6126 Each word in this option enables the command line editing to work in
6127 right-to-left mode for a group of commands:
6128
6129 search "/" and "?" commands
6130
6131 This is useful for languages such as Hebrew, Arabic and Farsi.
6132 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6133
Bram Moolenaard94464e2015-11-02 15:28:18 +01006134 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006135'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006136 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006137 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006138 {only available when compiled with the |+ruby/dyn|
6139 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006140 Specifies the name of the Ruby shared library. The default is
6141 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006142 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006143 This option cannot be set from a |modeline| or in the |sandbox|, for
6144 security reasons.
6145
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006147'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 global
6149 {not in Vi}
6150 {not available when compiled without the
6151 |+cmdline_info| feature}
6152 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006153 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 text in the file is shown on the far right:
6155 Top first line is visible
6156 Bot last line is visible
6157 All first and last line are visible
6158 45% relative position in the file
6159 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006160 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006162 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 this option takes precedence over 'ruler' and 'rulerformat'
6164 If the number of characters displayed is different from the number of
6165 bytes in the text (e.g., for a TAB or a multi-byte character), both
6166 the text column (byte number) and the screen column are shown,
6167 separated with a dash.
6168 For an empty line "0-1" is shown.
6169 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006170 This option is reset when 'paste' is set and restored when 'paste' is
6171 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 If you don't want to see the ruler all the time but want to know where
6173 you are, use "g CTRL-G" |g_CTRL-G|.
6174 NOTE: This option is reset when 'compatible' is set.
6175
6176 *'rulerformat'* *'ruf'*
6177'rulerformat' 'ruf' string (default empty)
6178 global
6179 {not in Vi}
6180 {not available when compiled without the |+statusline|
6181 feature}
6182 When this option is not empty, it determines the content of the ruler
6183 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006184 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 The default ruler width is 17 characters. To make the ruler 15
6186 characters wide, put "%15(" at the start and "%)" at the end.
6187 Example: >
6188 :set rulerformat=%15(%c%V\ %p%%%)
6189<
6190 *'runtimepath'* *'rtp'* *vimfiles*
6191'runtimepath' 'rtp' string (default:
6192 Unix: "$HOME/.vim,
6193 $VIM/vimfiles,
6194 $VIMRUNTIME,
6195 $VIM/vimfiles/after,
6196 $HOME/.vim/after"
6197 Amiga: "home:vimfiles,
6198 $VIM/vimfiles,
6199 $VIMRUNTIME,
6200 $VIM/vimfiles/after,
6201 home:vimfiles/after"
6202 PC, OS/2: "$HOME/vimfiles,
6203 $VIM/vimfiles,
6204 $VIMRUNTIME,
6205 $VIM/vimfiles/after,
6206 $HOME/vimfiles/after"
6207 Macintosh: "$VIM:vimfiles,
6208 $VIMRUNTIME,
6209 $VIM:vimfiles:after"
6210 RISC-OS: "Choices:vimfiles,
6211 $VIMRUNTIME,
6212 Choices:vimfiles/after"
6213 VMS: "sys$login:vimfiles,
6214 $VIM/vimfiles,
6215 $VIMRUNTIME,
6216 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006217 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 global
6219 {not in Vi}
6220 This is a list of directories which will be searched for runtime
6221 files:
6222 filetype.vim filetypes by file name |new-filetype|
6223 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006224 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 colors/ color scheme files |:colorscheme|
6226 compiler/ compiler files |:compiler|
6227 doc/ documentation |write-local-help|
6228 ftplugin/ filetype plugins |write-filetype-plugin|
6229 indent/ indent scripts |indent-expression|
6230 keymap/ key mapping files |mbyte-keymap|
6231 lang/ menu translations |:menutrans|
6232 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006233 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 plugin/ plugin scripts |write-plugin|
6235 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006236 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 syntax/ syntax files |mysyntaxfile|
6238 tutor/ files for vimtutor |tutor|
6239
6240 And any other file searched for with the |:runtime| command.
6241
6242 The defaults for most systems are setup to search five locations:
6243 1. In your home directory, for your personal preferences.
6244 2. In a system-wide Vim directory, for preferences from the system
6245 administrator.
6246 3. In $VIMRUNTIME, for files distributed with Vim.
6247 *after-directory*
6248 4. In the "after" directory in the system-wide Vim directory. This is
6249 for the system administrator to overrule or add to the distributed
6250 defaults (rarely needed)
6251 5. In the "after" directory in your home directory. This is for
6252 personal preferences to overrule or add to the distributed defaults
6253 or system-wide settings (rarely needed).
6254
Bram Moolenaard0796902016-09-16 20:02:31 +02006255 More entries are added when using |packages|. If it gets very long
6256 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6257 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006258
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6260 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006261 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 wildcards.
6263 See |:runtime|.
6264 Example: >
6265 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6266< This will use the directory "~/vimruntime" first (containing your
6267 personal Vim runtime files), then "/mygroup/vim" (shared between a
6268 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6269 files).
6270 You probably should always include $VIMRUNTIME somewhere, to use the
6271 distributed runtime files. You can put a directory before $VIMRUNTIME
6272 to find files which replace a distributed runtime files. You can put
6273 a directory after $VIMRUNTIME to find files which add to distributed
6274 runtime files.
6275 This option cannot be set from a |modeline| or in the |sandbox|, for
6276 security reasons.
6277
6278 *'scroll'* *'scr'*
6279'scroll' 'scr' number (default: half the window height)
6280 local to window
6281 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6282 set to half the number of lines in the window when the window size
6283 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006284 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6286 the number of screen lines instead of file lines, makes a difference
6287 when lines wrap}
6288
6289 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6290'scrollbind' 'scb' boolean (default off)
6291 local to window
6292 {not in Vi}
6293 {not available when compiled without the |+scrollbind|
6294 feature}
6295 See also |scroll-binding|. When this option is set, the current
6296 window scrolls as other scrollbind windows (windows that also have
6297 this option set) scroll. This option is useful for viewing the
6298 differences between two versions of a file, see 'diff'.
6299 See |'scrollopt'| for options that determine how this option should be
6300 interpreted.
6301 This option is mostly reset when splitting a window to edit another
6302 file. This means that ":split | edit file" results in two windows
6303 with scroll-binding, but ":split file" does not.
6304
6305 *'scrolljump'* *'sj'*
6306'scrolljump' 'sj' number (default 1)
6307 global
6308 {not in Vi}
6309 Minimal number of lines to scroll when the cursor gets off the
6310 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6311 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006312 When set to a negative number from -1 to -100 this is used as the
6313 percentage of the window height. Thus -50 scrolls half the window
6314 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 NOTE: This option is set to 1 when 'compatible' is set.
6316
6317 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006318'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 global
6320 {not in Vi}
6321 Minimal number of screen lines to keep above and below the cursor.
6322 This will make some context visible around where you are working. If
6323 you set it to a very large value (999) the cursor line will always be
6324 in the middle of the window (except at the start or end of the file or
6325 when long lines wrap).
6326 For scrolling horizontally see 'sidescrolloff'.
6327 NOTE: This option is set to 0 when 'compatible' is set.
6328
6329 *'scrollopt'* *'sbo'*
6330'scrollopt' 'sbo' string (default "ver,jump")
6331 global
6332 {not available when compiled without the |+scrollbind|
6333 feature}
6334 {not in Vi}
6335 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006336 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6337 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 The following words are available:
6339 ver Bind vertical scrolling for 'scrollbind' windows
6340 hor Bind horizontal scrolling for 'scrollbind' windows
6341 jump Applies to the offset between two windows for vertical
6342 scrolling. This offset is the difference in the first
6343 displayed line of the bound windows. When moving
6344 around in a window, another 'scrollbind' window may
6345 reach a position before the start or after the end of
6346 the buffer. The offset is not changed though, when
6347 moving back the 'scrollbind' window will try to scroll
6348 to the desired position when possible.
6349 When now making that window the current one, two
6350 things can be done with the relative offset:
6351 1. When "jump" is not included, the relative offset is
6352 adjusted for the scroll position in the new current
6353 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006354 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 2. When "jump" is included, the other windows are
6356 scrolled to keep the same relative offset. When
6357 going back to the other window, it still uses the
6358 same relative offset.
6359 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006360 When 'diff' mode is active there always is vertical scroll binding,
6361 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362
6363 *'sections'* *'sect'*
6364'sections' 'sect' string (default "SHNHH HUnhsh")
6365 global
6366 Specifies the nroff macros that separate sections. These are pairs of
6367 two letters (See |object-motions|). The default makes a section start
6368 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6369
6370 *'secure'* *'nosecure'* *E523*
6371'secure' boolean (default off)
6372 global
6373 {not in Vi}
6374 When on, ":autocmd", shell and write commands are not allowed in
6375 ".vimrc" and ".exrc" in the current directory and map commands are
6376 displayed. Switch it off only if you know that you will not run into
6377 problems, or when the 'exrc' option is off. On Unix this option is
6378 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 'secure' at the end of your ~/.vimrc then.
6381 This option cannot be set from a |modeline| or in the |sandbox|, for
6382 security reasons.
6383
6384 *'selection'* *'sel'*
6385'selection' 'sel' string (default "inclusive")
6386 global
6387 {not in Vi}
6388 This option defines the behavior of the selection. It is only used
6389 in Visual and Select mode.
6390 Possible values:
6391 value past line inclusive ~
6392 old no yes
6393 inclusive yes yes
6394 exclusive yes no
6395 "past line" means that the cursor is allowed to be positioned one
6396 character past the line.
6397 "inclusive" means that the last character of the selection is included
6398 in an operation. For example, when "x" is used to delete the
6399 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006400 When "old" is used and 'virtualedit' allows the cursor to move past
6401 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 Note that when "exclusive" is used and selecting from the end
6403 backwards, you cannot include the last character of a line, when
6404 starting in Normal mode and 'virtualedit' empty.
6405
6406 The 'selection' option is set by the |:behave| command.
6407
6408 *'selectmode'* *'slm'*
6409'selectmode' 'slm' string (default "")
6410 global
6411 {not in Vi}
6412 This is a comma separated list of words, which specifies when to start
6413 Select mode instead of Visual mode, when a selection is started.
6414 Possible values:
6415 mouse when using the mouse
6416 key when using shifted special keys
6417 cmd when using "v", "V" or CTRL-V
6418 See |Select-mode|.
6419 The 'selectmode' option is set by the |:behave| command.
6420
6421 *'sessionoptions'* *'ssop'*
6422'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006423 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 global
6425 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006426 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 feature}
6428 Changes the effect of the |:mksession| command. It is a comma
6429 separated list of words. Each word enables saving and restoring
6430 something:
6431 word save and restore ~
6432 blank empty windows
6433 buffers hidden and unloaded buffers, not just those in windows
6434 curdir the current directory
6435 folds manually created folds, opened/closed folds and local
6436 fold options
6437 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006438 and contain at least one lowercase letter. Only
6439 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 help the help window
6441 localoptions options and mappings local to a window or buffer (not
6442 global values for local options)
6443 options all options and mappings (also global values for local
6444 options)
6445 resize size of the Vim window: 'lines' and 'columns'
6446 sesdir the directory in which the session file is located
6447 will become the current directory (useful with
6448 projects accessed over a network from different
6449 systems)
6450 slash backslashes in file names replaced with forward
6451 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006452 tabpages all tab pages; without this only the current tab page
6453 is restored, so that you can make a session for each
6454 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 unix with Unix end-of-line format (single <NL>), even when
6456 on Windows or DOS
6457 winpos position of the whole Vim window
6458 winsize window sizes
6459
6460 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006461 When neither "curdir" nor "sesdir" is included, file names are stored
6462 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 "slash" and "unix" are useful on Windows when sharing session files
6464 with Unix. The Unix version of Vim cannot source dos format scripts,
6465 but the Windows version of Vim can source unix format scripts.
6466
6467 *'shell'* *'sh'* *E91*
6468'shell' 'sh' string (default $SHELL or "sh",
6469 MS-DOS and Win32: "command.com" or
6470 "cmd.exe", OS/2: "cmd")
6471 global
6472 Name of the shell to use for ! and :! commands. When changing the
6473 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6474 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 See |option-backslash| about including spaces and backslashes.
6477 Environment variables are expanded |:set_env|.
6478 If the name of the shell contains a space, you might need to enclose
6479 it in quotes. Example: >
6480 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6481< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006482 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 "-f" is not inside the quotes, because it is not part of the command
6484 name. And Vim automagically recognizes the backslashes that are path
6485 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006486 Under MS-Windows, when the executable ends in ".com" it must be
6487 included. Thus setting the shell to "command.com" or "4dos.com"
6488 works, but "command" and "4dos" do not work for all commands (e.g.,
6489 filtering).
6490 For unknown reasons, when using "4dos.com" the current directory is
6491 changed to "C:\". To avoid this set 'shell' like this: >
6492 :set shell=command.com\ /c\ 4dos
6493< This option cannot be set from a |modeline| or in the |sandbox|, for
6494 security reasons.
6495
6496 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006497'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006498 MS-DOS and Win32, when 'shell' does not
6499 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 global
6501 {not in Vi}
6502 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6503 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6504 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006505 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006506 On Unix it can have more than one flag. Each white space separated
6507 part is passed as an argument to the shell command.
6508 See |option-backslash| about including spaces and backslashes.
6509 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 This option cannot be set from a |modeline| or in the |sandbox|, for
6511 security reasons.
6512
6513 *'shellpipe'* *'sp'*
6514'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6515 global
6516 {not in Vi}
6517 {not available when compiled without the |+quickfix|
6518 feature}
6519 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006520 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 including spaces and backslashes.
6522 The name of the temporary file can be represented by "%s" if necessary
6523 (the file name is appended automatically if no %s appears in the value
6524 of this option).
6525 For the Amiga and MS-DOS the default is ">". The output is directly
6526 saved in a file and not echoed to the screen.
6527 For Unix the default it "| tee". The stdout of the compiler is saved
6528 in a file and echoed to the screen. If the 'shell' option is "csh" or
6529 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006530 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6531 default becomes "2>&1| tee". This means that stderr is also included.
6532 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6533 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 The initialization of this option is done after reading the ".vimrc"
6535 and the other initializations, so that when the 'shell' option is set
6536 there, the 'shellpipe' option changes automatically, unless it was
6537 explicitly set before.
6538 When 'shellpipe' is set to an empty string, no redirection of the
6539 ":make" output will be done. This is useful if you use a 'makeprg'
6540 that writes to 'makeef' by itself. If you want no piping, but do
6541 want to include the 'makeef', set 'shellpipe' to a single space.
6542 Don't forget to precede the space with a backslash: ":set sp=\ ".
6543 In the future pipes may be used for filtering and this option will
6544 become obsolete (at least for Unix).
6545 This option cannot be set from a |modeline| or in the |sandbox|, for
6546 security reasons.
6547
6548 *'shellquote'* *'shq'*
6549'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6550 contains "sh" somewhere: "\"")
6551 global
6552 {not in Vi}
6553 Quoting character(s), put around the command passed to the shell, for
6554 the "!" and ":!" commands. The redirection is kept outside of the
6555 quoting. See 'shellxquote' to include the redirection. It's
6556 probably not useful to set both options.
6557 This is an empty string by default. Only known to be useful for
6558 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6559 or bash, where it should be "\"". The default is adjusted according
6560 the value of 'shell', to reduce the need to set this option by the
6561 user. See |dos-shell|.
6562 This option cannot be set from a |modeline| or in the |sandbox|, for
6563 security reasons.
6564
6565 *'shellredir'* *'srr'*
6566'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6567 global
6568 {not in Vi}
6569 String to be used to put the output of a filter command in a temporary
6570 file. See also |:!|. See |option-backslash| about including spaces
6571 and backslashes.
6572 The name of the temporary file can be represented by "%s" if necessary
6573 (the file name is appended automatically if no %s appears in the value
6574 of this option).
6575 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6576 or "zsh" during initializations, the default becomes ">&". If the
6577 'shell' option is "sh", "ksh" or "bash" the default becomes
6578 ">%s 2>&1". This means that stderr is also included.
6579 For Win32, the Unix checks are done and additionally "cmd" is checked
6580 for, which makes the default ">%s 2>&1". Also, the same names with
6581 ".exe" appended are checked for.
6582 The initialization of this option is done after reading the ".vimrc"
6583 and the other initializations, so that when the 'shell' option is set
6584 there, the 'shellredir' option changes automatically unless it was
6585 explicitly set before.
6586 In the future pipes may be used for filtering and this option will
6587 become obsolete (at least for Unix).
6588 This option cannot be set from a |modeline| or in the |sandbox|, for
6589 security reasons.
6590
6591 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6592'shellslash' 'ssl' boolean (default off)
6593 global
6594 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6595 When set, a forward slash is used when expanding file names. This is
6596 useful when a Unix-like shell is used instead of command.com or
6597 cmd.exe. Backward slashes can still be typed, but they are changed to
6598 forward slashes by Vim.
6599 Note that setting or resetting this option has no effect for some
6600 existing file names, thus this option needs to be set before opening
6601 any file for best results. This might change in the future.
6602 'shellslash' only works when a backslash can be used as a path
6603 separator. To test if this is so use: >
6604 if exists('+shellslash')
6605<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006606 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6607'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6608 global
6609 {not in Vi}
6610 When on, use temp files for shell commands. When off use a pipe.
6611 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006612 Currently a pipe is only supported on Unix and MS-Windows 2K and
6613 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006614 :if has("filterpipe")
6615< The advantage of using a pipe is that nobody can read the temp file
6616 and the 'shell' command does not need to support redirection.
6617 The advantage of using a temp file is that the file type and encoding
6618 can be detected.
6619 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6620 |FilterWritePost| autocommands event are not triggered when
6621 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006622 The `system()` function does not respect this option and always uses
6623 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006624 NOTE: This option is set to the Vim default value when 'compatible'
6625 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006626
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 *'shelltype'* *'st'*
6628'shelltype' 'st' number (default 0)
6629 global
6630 {not in Vi} {only for the Amiga}
6631 On the Amiga this option influences the way how the commands work
6632 which use a shell.
6633 0 and 1: always use the shell
6634 2 and 3: use the shell only to filter lines
6635 4 and 5: use shell only for ':sh' command
6636 When not using the shell, the command is executed directly.
6637
6638 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6639 1 and 3: use "shell cmd" to start external commands
6640
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006641 *'shellxescape'* *'sxe'*
6642'shellxescape' 'sxe' string (default: "";
6643 for MS-DOS and MS-Windows: "\"&|<>()@^")
6644 global
6645 {not in Vi}
6646 When 'shellxquote' is set to "(" then the characters listed in this
6647 option will be escaped with a '^' character. This makes it possible
6648 to execute most external commands with cmd.exe.
6649
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 *'shellxquote'* *'sxq'*
6651'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006652 for Win32, when 'shell' is cmd.exe: "("
6653 for Win32, when 'shell' contains "sh"
6654 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 for Unix, when using system(): "\"")
6656 global
6657 {not in Vi}
6658 Quoting character(s), put around the command passed to the shell, for
6659 the "!" and ":!" commands. Includes the redirection. See
6660 'shellquote' to exclude the redirection. It's probably not useful
6661 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006662 When the value is '(' then ')' is appended. When the value is '"('
6663 then ')"' is appended.
6664 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006665 This is an empty string by default on most systems, but is known to be
6666 useful for on Win32 version, either for cmd.exe which automatically
6667 strips off the first and last quote on a command, or 3rd-party shells
6668 such as the MKS Korn Shell or bash, where it should be "\"". The
6669 default is adjusted according the value of 'shell', to reduce the need
6670 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 This option cannot be set from a |modeline| or in the |sandbox|, for
6672 security reasons.
6673
6674 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6675'shiftround' 'sr' boolean (default off)
6676 global
6677 {not in Vi}
6678 Round indent to multiple of 'shiftwidth'. Applies to > and <
6679 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6680 a multiple of 'shiftwidth' (this is Vi compatible).
6681 NOTE: This option is reset when 'compatible' is set.
6682
6683 *'shiftwidth'* *'sw'*
6684'shiftwidth' 'sw' number (default 8)
6685 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006686 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006688 When zero the 'ts' value will be used. Use the |shiftwidth()|
6689 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690
6691 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006692'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6693 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 global
6695 {not in Vi}
6696 This option helps to avoid all the |hit-enter| prompts caused by file
6697 messages, for example with CTRL-G, and to avoid some other messages.
6698 It is a list of flags:
6699 flag meaning when present ~
6700 f use "(3 of 5)" instead of "(file 3 of 5)"
6701 i use "[noeol]" instead of "[Incomplete last line]"
6702 l use "999L, 888C" instead of "999 lines, 888 characters"
6703 m use "[+]" instead of "[Modified]"
6704 n use "[New]" instead of "[New File]"
6705 r use "[RO]" instead of "[readonly]"
6706 w use "[w]" instead of "written" for file write message
6707 and "[a]" instead of "appended" for ':w >> file' command
6708 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6709 "[unix format]" and "[mac]" instead of "[mac format]".
6710 a all of the above abbreviations
6711
6712 o overwrite message for writing a file with subsequent message
6713 for reading a file (useful for ":wn" or when 'autowrite' on)
6714 O message for reading a file overwrites any previous message.
6715 Also for quickfix message (e.g., ":cn").
6716 s don't give "search hit BOTTOM, continuing at TOP" or "search
6717 hit TOP, continuing at BOTTOM" messages
6718 t truncate file message at the start if it is too long to fit
6719 on the command-line, "<" will appear in the left most column.
6720 Ignored in Ex mode.
6721 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006722 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 Ignored in Ex mode.
6724 W don't give "written" or "[w]" when writing a file
6725 A don't give the "ATTENTION" message when an existing swap file
6726 is found.
6727 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006728 c don't give |ins-completion-menu| messages. For example,
6729 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6730 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006731 q use "recording" instead of "recording @a"
6732 F don't give the file info when editing a file, like `:silent`
6733 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734
6735 This gives you the opportunity to avoid that a change between buffers
6736 requires you to hit <Enter>, but still gives as useful a message as
6737 possible for the space available. To get the whole message that you
6738 would have got with 'shm' empty, use ":file!"
6739 Useful values:
6740 shm= No abbreviation of message.
6741 shm=a Abbreviation, but no loss of information.
6742 shm=at Abbreviation, and truncate message when necessary.
6743
6744 NOTE: This option is set to the Vi default value when 'compatible' is
6745 set and to the Vim default value when 'compatible' is reset.
6746
6747 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6748'shortname' 'sn' boolean (default off)
6749 local to buffer
6750 {not in Vi, not in MS-DOS versions}
6751 Filenames are assumed to be 8 characters plus one extension of 3
6752 characters. Multiple dots in file names are not allowed. When this
6753 option is on, dots in file names are replaced with underscores when
6754 adding an extension (".~" or ".swp"). This option is not available
6755 for MS-DOS, because then it would always be on. This option is useful
6756 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6757 or crossdos. When running the Win32 GUI version under Win32s, this
6758 option is always on by default.
6759
6760 *'showbreak'* *'sbr'* *E595*
6761'showbreak' 'sbr' string (default "")
6762 global
6763 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006764 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 feature}
6766 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006767 values are "> " or "+++ ": >
6768 :set showbreak=>\
6769< Note the backslash to escape the trailing space. It's easier like
6770 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006771 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006772< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 comma (in a future version the comma might be used to separate the
6774 part that is shown at the end and at the start of a line).
6775 The characters are highlighted according to the '@' flag in
6776 'highlight'.
6777 Note that tabs after the showbreak will be displayed differently.
6778 If you want the 'showbreak' to appear in between line numbers, add the
6779 "n" flag to 'cpoptions'.
6780
6781 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006782'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6783 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 global
6785 {not in Vi}
6786 {not available when compiled without the
6787 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006788 Show (partial) command in the last line of the screen. Set this
6789 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 In Visual mode the size of the selected area is shown:
6791 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006792 If the number of bytes is different it is also displayed: "2-6"
6793 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006795 - When selecting a block, the size in screen characters:
6796 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797 NOTE: This option is set to the Vi default value when 'compatible' is
6798 set and to the Vim default value when 'compatible' is reset.
6799
6800 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6801'showfulltag' 'sft' boolean (default off)
6802 global
6803 {not in Vi}
6804 When completing a word in insert mode (see |ins-completion|) from the
6805 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006806 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 matched a C function, you can see a template for what arguments are
6808 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006809 Note that this doesn't work well together with having "longest" in
6810 'completeopt', because the completion from the search pattern may not
6811 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812
6813 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6814'showmatch' 'sm' boolean (default off)
6815 global
6816 When a bracket is inserted, briefly jump to the matching one. The
6817 jump is only done if the match can be seen on the screen. The time to
6818 show the match can be set with 'matchtime'.
6819 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006820 seen or not).
6821 This option is reset when 'paste' is set and restored when 'paste' is
6822 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 When the 'm' flag is not included in 'cpoptions', typing a character
6824 will immediately move the cursor back to where it belongs.
6825 See the "sm" field in 'guicursor' for setting the cursor shape and
6826 blinking when showing the match.
6827 The 'matchpairs' option can be used to specify the characters to show
6828 matches for. 'rightleft' and 'revins' are used to look for opposite
6829 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006830 Also see the matchparen plugin for highlighting the match when moving
6831 around |pi_paren.txt|.
6832 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833
6834 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6835'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6836 global
6837 If in Insert, Replace or Visual mode put a message on the last line.
6838 Use the 'M' flag in 'highlight' to set the type of highlighting for
6839 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006840 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 doesn't mean XIM is really active, especially when 'imactivatekey' is
6842 not set.
6843 NOTE: This option is set to the Vi default value when 'compatible' is
6844 set and to the Vim default value when 'compatible' is reset.
6845
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006846 *'showtabline'* *'stal'*
6847'showtabline' 'stal' number (default 1)
6848 global
6849 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006850 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006851 feature}
6852 The value of this option specifies when the line with tab page labels
6853 will be displayed:
6854 0: never
6855 1: only if there are at least two tab pages
6856 2: always
6857 This is both for the GUI and non-GUI implementation of the tab pages
6858 line.
6859 See |tab-page| for more information about tab pages.
6860
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 *'sidescroll'* *'ss'*
6862'sidescroll' 'ss' number (default 0)
6863 global
6864 {not in Vi}
6865 The minimal number of columns to scroll horizontally. Used only when
6866 the 'wrap' option is off and the cursor is moved off of the screen.
6867 When it is zero the cursor will be put in the middle of the screen.
6868 When using a slow terminal set it to a large number or 0. When using
6869 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6870 commands.
6871
6872 *'sidescrolloff'* *'siso'*
6873'sidescrolloff' 'siso' number (default 0)
6874 global
6875 {not in Vi}
6876 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006877 right of the cursor if 'nowrap' is set. Setting this option to a
6878 value greater than 0 while having |'sidescroll'| also at a non-zero
6879 value makes some context visible in the line you are scrolling in
6880 horizontally (except at beginning of the line). Setting this option
6881 to a large value (like 999) has the effect of keeping the cursor
6882 horizontally centered in the window, as long as one does not come too
6883 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 NOTE: This option is set to 0 when 'compatible' is set.
6885
6886 Example: Try this together with 'sidescroll' and 'listchars' as
6887 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006888 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889
6890 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6891 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006892<
6893 *'signcolumn'* *'scl'*
6894'signcolumn' 'scl' string (default "auto")
6895 local to window
6896 {not in Vi}
6897 {not available when compiled without the |+signs|
6898 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006899 Whether or not to draw the signcolumn. Valid values are:
6900 "auto" only when there is a sign to display
6901 "no" never
6902 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903
6904
6905 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6906'smartcase' 'scs' boolean (default off)
6907 global
6908 {not in Vi}
6909 Override the 'ignorecase' option if the search pattern contains upper
6910 case characters. Only used when the search pattern is typed and
6911 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006912 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6914 recalling the search pattern from history and hitting <Enter>.
6915 NOTE: This option is reset when 'compatible' is set.
6916
6917 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6918'smartindent' 'si' boolean (default off)
6919 local to buffer
6920 {not in Vi}
6921 {not available when compiled without the
6922 |+smartindent| feature}
6923 Do smart autoindenting when starting a new line. Works for C-like
6924 programs, but can also be used for other languages. 'cindent' does
6925 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006926 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006927 setting 'si' has no effect. 'indentexpr' is a more advanced
6928 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 Normally 'autoindent' should also be on when using 'smartindent'.
6930 An indent is automatically inserted:
6931 - After a line ending in '{'.
6932 - After a line starting with a keyword from 'cinwords'.
6933 - Before a line starting with '}' (only with the "O" command).
6934 When typing '}' as the first character in a new line, that line is
6935 given the same indent as the matching '{'.
6936 When typing '#' as the first character in a new line, the indent for
6937 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006938 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6940 When using the ">>" command, lines starting with '#' are not shifted
6941 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006942 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006943 This option is reset when 'paste' is set and restored when 'paste' is
6944 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945
6946 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6947'smarttab' 'sta' boolean (default off)
6948 global
6949 {not in Vi}
6950 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006951 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6952 <BS> will delete a 'shiftwidth' worth of space at the start of the
6953 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006954 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006955 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6956 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006957 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006959 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006960 This option is reset when 'paste' is set and restored when 'paste' is
6961 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 NOTE: This option is reset when 'compatible' is set.
6963
6964 *'softtabstop'* *'sts'*
6965'softtabstop' 'sts' number (default 0)
6966 local to buffer
6967 {not in Vi}
6968 Number of spaces that a <Tab> counts for while performing editing
6969 operations, like inserting a <Tab> or using <BS>. It "feels" like
6970 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6971 used. This is useful to keep the 'ts' setting at its standard value
6972 of 8, while being able to edit like it is set to 'sts'. However,
6973 commands like "x" still work on the actual characters.
6974 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006975 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006976 'softtabstop' is set to 0 when the 'paste' option is set and restored
6977 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6979 spaces is minimized by using <Tab>s.
6980 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6981 set.
6982 NOTE: This option is set to 0 when 'compatible' is set.
6983
Bram Moolenaar217ad922005-03-20 22:37:15 +00006984 *'spell'* *'nospell'*
6985'spell' boolean (default off)
6986 local to window
6987 {not in Vi}
6988 {not available when compiled without the |+syntax|
6989 feature}
6990 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006991 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006992
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006993 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006994'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006995 local to buffer
6996 {not in Vi}
6997 {not available when compiled without the |+syntax|
6998 feature}
6999 Pattern to locate the end of a sentence. The following word will be
7000 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007001 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007002 When this check is not wanted make this option empty.
7003 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007004 Be careful with special characters, see |option-backslash| about
7005 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007006 To set this option automatically depending on the language, see
7007 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007008
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007009 *'spellfile'* *'spf'*
7010'spellfile' 'spf' string (default empty)
7011 local to buffer
7012 {not in Vi}
7013 {not available when compiled without the |+syntax|
7014 feature}
7015 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007016 commands. It must end in ".{encoding}.add". You need to include the
7017 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007018 *E765*
7019 It may also be a comma separated list of names. A count before the
7020 |zg| and |zw| commands can be used to access each. This allows using
7021 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007022 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007023 you: Using the first directory in 'runtimepath' that is writable. If
7024 there is no "spell" directory yet it will be created. For the file
7025 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007026 ignoring the region.
7027 The resulting ".spl" file will be used for spell checking, it does not
7028 have to appear in 'spelllang'.
7029 Normally one file is used for all regions, but you can add the region
7030 name if you want to. However, it will then only be used when
7031 'spellfile' is set to it, for entries in 'spelllang' only files
7032 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007033 This option cannot be set from a |modeline| or in the |sandbox|, for
7034 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007035
Bram Moolenaar217ad922005-03-20 22:37:15 +00007036 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007037'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007038 local to buffer
7039 {not in Vi}
7040 {not available when compiled without the |+syntax|
7041 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007042 A comma separated list of word list names. When the 'spell' option is
7043 on spellchecking will be done for these languages. Example: >
7044 set spelllang=en_us,nl,medical
7045< This means US English, Dutch and medical words are recognized. Words
7046 that are not recognized will be highlighted.
7047 The word list name must not include a comma or dot. Using a dash is
7048 recommended to separate the two letter language name from a
7049 specification. Thus "en-rare" is used for rare English words.
7050 A region name must come last and have the form "_xx", where "xx" is
7051 the two-letter, lower case region name. You can use more than one
7052 region by listing them: "en_us,en_ca" supports both US and Canadian
7053 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007054 Britain. (Note: currently en_au and en_nz dictionaries are older than
7055 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007056 If the name "cjk" is included East Asian characters are excluded from
7057 spell checking. This is useful when editing text that also has Asian
7058 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007059 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007060 As a special case the name of a .spl file can be given as-is. The
7061 first "_xx" in the name is removed and used as the region name
7062 (_xx is an underscore, two letters and followed by a non-letter).
7063 This is mainly for testing purposes. You must make sure the correct
7064 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007065 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007066 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7067 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007068 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007069
Bram Moolenaar98692072006-02-04 00:57:42 +00007070 If the |spellfile.vim| plugin is active and you use a language name
7071 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7072 will ask you if you want to download the file.
7073
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007074 After this option has been set successfully, Vim will source the files
7075 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007076 up to the first comma, dot or underscore.
7077 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007078
7079
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007080 *'spellsuggest'* *'sps'*
7081'spellsuggest' 'sps' string (default "best")
7082 global
7083 {not in Vi}
7084 {not available when compiled without the |+syntax|
7085 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007086 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007087 the |spellsuggest()| function. This is a comma-separated list of
7088 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007089
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007090 best Internal method that works best for English. Finds
7091 changes like "fast" and uses a bit of sound-a-like
7092 scoring to improve the ordering.
7093
7094 double Internal method that uses two methods and mixes the
7095 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007096 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007097 word. That only works when the language specifies
7098 sound folding. Can be slow and doesn't always give
7099 better results.
7100
7101 fast Internal method that only checks for simple changes:
7102 character inserts/deletes/swaps. Works well for
7103 simple typing mistakes.
7104
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007105 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007106 Not used for |spellsuggest()|. The number of
7107 suggestions is never more than the value of 'lines'
7108 minus two.
7109
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007110 file:{filename} Read file {filename}, which must have two columns,
7111 separated by a slash. The first column contains the
7112 bad word, the second column the suggested good word.
7113 Example:
7114 theribal/terrible ~
7115 Use this for common mistakes that do not appear at the
7116 top of the suggestion list with the internal methods.
7117 Lines without a slash are ignored, use this for
7118 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007119 The word in the second column must be correct,
7120 otherwise it will not be used. Add the word to an
7121 ".add" file if it is currently flagged as a spelling
7122 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007123 The file is used for all languages.
7124
7125 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7126 trouble with spaces. |v:val| holds the badly spelled
7127 word. The expression must evaluate to a List of
7128 Lists, each with a suggestion and a score.
7129 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007130 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007131 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007132 internal methods use. A lower score is better.
7133 This may invoke |spellsuggest()| if you temporarily
7134 set 'spellsuggest' to exclude the "expr:" part.
7135 Errors are silently ignored, unless you set the
7136 'verbose' option to a non-zero value.
7137
7138 Only one of "best", "double" or "fast" may be used. The others may
7139 appear several times in any order. Example: >
7140 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7141<
7142 This option cannot be set from a |modeline| or in the |sandbox|, for
7143 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007144
7145
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7147'splitbelow' 'sb' boolean (default off)
7148 global
7149 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007150 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 feature}
7152 When on, splitting a window will put the new window below the current
7153 one. |:split|
7154
7155 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7156'splitright' 'spr' boolean (default off)
7157 global
7158 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007159 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 feature}
7161 When on, splitting a window will put the new window right of the
7162 current one. |:vsplit|
7163
7164 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7165'startofline' 'sol' boolean (default on)
7166 global
7167 {not in Vi}
7168 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007169 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007170 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007171 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 with a linewise operator, with "%" with a count and to buffer changing
7173 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7174 only has a line number, e.g., ":25" or ":+".
7175 In case of buffer changing commands the cursor is placed at the column
7176 where it was the last time the buffer was edited.
7177 NOTE: This option is set when 'compatible' is set.
7178
Bram Moolenaar00654022011-02-25 14:42:19 +01007179 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007181 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 {not in Vi}
7183 {not available when compiled without the |+statusline|
7184 feature}
7185 When nonempty, this option determines the content of the status line.
7186 Also see |status-line|.
7187
7188 The option consists of printf style '%' items interspersed with
7189 normal text. Each status line item is of the form:
7190 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007191 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007192 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193
Bram Moolenaar238a5642006-02-21 22:12:05 +00007194 When the option starts with "%!" then it is used as an expression,
7195 evaluated and the result is used as the option value. Example: >
7196 :set statusline=%!MyStatusLine()
7197< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007198 Note that the "%!" expression is evaluated in the context of the
7199 current window and buffer, while %{} items are evaluated in the
7200 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007201
7202 When there is error while evaluating the option then it will be made
7203 empty to avoid further errors. Otherwise screen updating would loop.
7204
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 Note that the only effect of 'ruler' when this option is set (and
7206 'laststatus' is 2) is controlling the output of |CTRL-G|.
7207
7208 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007209 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007211 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 minwid Minimum width of the item, padding as set by '-' & '0'.
7213 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007214 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 on the left for text items. Numeric items will be
7216 shifted down to maxwid-2 digits followed by '>'number
7217 where number is the amount of missing digits, much like
7218 an exponential notation.
7219 item A one letter code as described below.
7220
7221 Following is a description of the possible statusline items. The
7222 second character in "item" is the type:
7223 N for number
7224 S for string
7225 F for flags as described below
7226 - not applicable
7227
7228 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007229 f S Path to the file in the buffer, as typed or relative to current
7230 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 F S Full path to the file in the buffer.
7232 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007233 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007235 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007237 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007239 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007241 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7243 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007244 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7246 being used: "<keymap>"
7247 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007248 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 B N As above, in hexadecimal.
7250 o N Byte number in file of byte under cursor, first byte is 1.
7251 Mnemonic: Offset from start of file (with one added)
7252 {not available when compiled without |+byte_offset| feature}
7253 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007254 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 l N Line number.
7256 L N Number of lines in buffer.
7257 c N Column number.
7258 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007259 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 p N Percentage through file in lines as in |CTRL-G|.
7261 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007262 percentage described for 'ruler'. Always 3 in length, unless
7263 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007264 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007266 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007267 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 ( - Start of item group. Can be used for setting the width and
7269 alignment of a section. Must be followed by %) somewhere.
7270 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007271 T N For 'tabline': start of tab page N label. Use %T after the last
7272 label. This information is used for mouse clicks.
7273 X N For 'tabline': start of close tab N label. Use %X after the
7274 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7275 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 < - Where to truncate line if too long. Default is at the start.
7277 No width fields allowed.
7278 = - Separation point between left and right aligned items.
7279 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007280 # - Set highlight group. The name must follow and then a # again.
7281 Thus use %#HLname# for highlight group HLname. The same
7282 highlighting is used, also for the statusline of non-current
7283 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007285 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 The difference between User{N} and StatusLine will be applied
7287 to StatusLineNC for the statusline of non-current windows.
7288 The number N must be between 1 and 9. See |hl-User1..9|
7289
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007290 When displaying a flag, Vim removes the leading comma, if any, when
7291 that flag comes right after plaintext. This will make a nice display
7292 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293
Bram Moolenaar582fd852005-03-28 20:58:01 +00007294 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007295 not set) and a minwid is not set for the group, the whole group will
7296 become empty. This will make a group like the following disappear
7297 completely from the statusline when none of the flags are set. >
7298 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007299< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 Beware that an expression is evaluated each and every time the status
7301 line is displayed. The current buffer and current window will be set
7302 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007303 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007305 real current buffer.
7306
Bram Moolenaar30b65812012-07-12 22:01:11 +02007307 The 'statusline' option will be evaluated in the |sandbox| if set from
7308 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007309
7310 It is not allowed to change text or jump to another window while
7311 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312
7313 If the statusline is not updated when you want it (e.g., after setting
7314 a variable that's used in an expression), you can force an update by
7315 setting an option without changing its value. Example: >
7316 :let &ro = &ro
7317
7318< A result of all digits is regarded a number for display purposes.
7319 Otherwise the result is taken as flag text and applied to the rules
7320 described above.
7321
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007322 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7324 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7325
7326 Examples:
7327 Emulate standard status line with 'ruler' set >
7328 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7329< Similar, but add ASCII value of char under the cursor (like "ga") >
7330 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7331< Display byte count and byte value, modified flag in red. >
7332 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7333 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7334< Display a ,GZ flag if a compressed file is loaded >
7335 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7336< In the |:autocmd|'s: >
7337 :let b:gzflag = 1
7338< And: >
7339 :unlet b:gzflag
7340< And define this function: >
7341 :function VarExists(var, val)
7342 : if exists(a:var) | return a:val | else | return '' | endif
7343 :endfunction
7344<
7345 *'suffixes'* *'su'*
7346'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7347 global
7348 {not in Vi}
7349 Files with these suffixes get a lower priority when multiple files
7350 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007351 suffixes. Spaces after the comma are ignored. A dot is also seen as
7352 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 separator, precede it with a backslash (see |option-backslash| about
7354 including spaces and backslashes).
7355 See 'wildignore' for completely ignoring files.
7356 The use of |:set+=| and |:set-=| is preferred when adding or removing
7357 suffixes from the list. This avoids problems when a future version
7358 uses another default.
7359
7360 *'suffixesadd'* *'sua'*
7361'suffixesadd' 'sua' string (default "")
7362 local to buffer
7363 {not in Vi}
7364 {not available when compiled without the
7365 |+file_in_path| feature}
7366 Comma separated list of suffixes, which are used when searching for a
7367 file for the "gf", "[I", etc. commands. Example: >
7368 :set suffixesadd=.java
7369<
7370 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7371'swapfile' 'swf' boolean (default on)
7372 local to buffer
7373 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007374 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 swapfile is not wanted for a specific buffer. For example, with
7376 confidential information that even root must not be able to access.
7377 Careful: All text will be in memory:
7378 - Don't use this for big files.
7379 - Recovery will be impossible!
7380 A swapfile will only be present when |'updatecount'| is non-zero and
7381 'swapfile' is set.
7382 When 'swapfile' is reset, the swap file for the current buffer is
7383 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7384 non-zero, a swap file is immediately created.
7385 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007386 If you want to open a new buffer without creating a swap file for it,
7387 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388
7389 This option is used together with 'bufhidden' and 'buftype' to
7390 specify special kinds of buffers. See |special-buffers|.
7391
7392 *'swapsync'* *'sws'*
7393'swapsync' 'sws' string (default "fsync")
7394 global
7395 {not in Vi}
7396 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007397 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 When this option is empty parts of the swap file may be in memory and
7399 not written to disk. When the system crashes you may lose more work.
7400 On Unix the system does a sync now and then without Vim asking for it,
7401 so the disadvantage of setting this option off is small. On some
7402 systems the swap file will not be written at all. For a unix system
7403 setting it to "sync" will use the sync() call instead of the default
7404 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007405 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007406
7407 *'switchbuf'* *'swb'*
7408'switchbuf' 'swb' string (default "")
7409 global
7410 {not in Vi}
7411 This option controls the behavior when switching between buffers.
7412 Possible values (comma separated list):
7413 useopen If included, jump to the first open window that
7414 contains the specified buffer (if there is one).
7415 Otherwise: Do not examine other windows.
7416 This setting is checked with |quickfix| commands, when
7417 jumping to errors (":cc", ":cn", "cp", etc.). It is
7418 also used in all buffer related split commands, for
7419 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007420 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007421 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007423 a buffer for a |quickfix| command that display errors.
7424 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007425 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007426 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007427 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007429 *'synmaxcol'* *'smc'*
7430'synmaxcol' 'smc' number (default 3000)
7431 local to buffer
7432 {not in Vi}
7433 {not available when compiled without the |+syntax|
7434 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007435 Maximum column in which to search for syntax items. In long lines the
7436 text after this column is not highlighted and following lines may not
7437 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007438 This helps to avoid very slow redrawing for an XML file that is one
7439 long line.
7440 Set to zero to remove the limit.
7441
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442 *'syntax'* *'syn'*
7443'syntax' 'syn' string (default empty)
7444 local to buffer
7445 {not in Vi}
7446 {not available when compiled without the |+syntax|
7447 feature}
7448 When this option is set, the syntax with this name is loaded, unless
7449 syntax highlighting has been switched off with ":syntax off".
7450 Otherwise this option does not always reflect the current syntax (the
7451 b:current_syntax variable does).
7452 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007453 not automatically recognized. Example, in an IDL file:
7454 /* vim: set syntax=idl : */ ~
7455 When a dot appears in the value then this separates two filetype
7456 names. Example:
7457 /* vim: set syntax=c.doxygen : */ ~
7458 This will use the "c" syntax first, then the "doxygen" syntax.
7459 Note that the second one must be prepared to be loaded as an addition,
7460 otherwise it will be skipped. More than one dot may appear.
7461 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 :set syntax=OFF
7463< To switch syntax highlighting on according to the current value of the
7464 'filetype' option: >
7465 :set syntax=ON
7466< What actually happens when setting the 'syntax' option is that the
7467 Syntax autocommand event is triggered with the value as argument.
7468 This option is not copied to another buffer, independent of the 's' or
7469 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007470 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007472 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007473'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007474 global
7475 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007476 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007477 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007478 When nonempty, this option determines the content of the tab pages
7479 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007480 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007481
7482 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007483 option and only when there is no GUI tab line. When 'e' is in
7484 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007485 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007486
7487 The value is evaluated like with 'statusline'. You can use
7488 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007489 the text to be displayed. Use "%1T" for the first label, "%2T" for
7490 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007491
7492 Keep in mind that only one of the tab pages is the current one, others
7493 are invisible and you can't jump to their windows.
7494
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007495
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007496 *'tabpagemax'* *'tpm'*
7497'tabpagemax' 'tpm' number (default 10)
7498 global
7499 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007500 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007501 feature}
7502 Maximum number of tab pages to be opened by the |-p| command line
7503 argument or the ":tab all" command. |tabpage|
7504
7505
7506 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007507'tabstop' 'ts' number (default 8)
7508 local to buffer
7509 Number of spaces that a <Tab> in the file counts for. Also see
7510 |:retab| command, and 'softtabstop' option.
7511
7512 Note: Setting 'tabstop' to any other value than 8 can make your file
7513 appear wrong in many places (e.g., when printing it).
7514
7515 There are four main ways to use tabs in Vim:
7516 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7517 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007518 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 behave like a tab appears every 4 (or 3) characters.
7520 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7521 'expandtab'. This way you will always insert spaces. The
7522 formatting will never be messed up when 'tabstop' is changed.
7523 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 works when using Vim to edit the file.
7526 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7527 'noexpandtab'. This should then work (for initial indents only)
7528 for any tabstop setting that people use. It might be nice to have
7529 tabs after the first non-blank inserted as spaces if you do this
7530 though. Otherwise aligned comments will be wrong when 'tabstop' is
7531 changed.
7532
7533 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7534'tagbsearch' 'tbs' boolean (default on)
7535 global
7536 {not in Vi}
7537 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007538 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 searching makes searching for a tag a LOT faster, but a linear search
7540 will find more tags if the tags file wasn't properly sorted.
7541 Vim normally assumes that your tags files are sorted, or indicate that
7542 they are not sorted. Only when this is not the case does the
7543 'tagbsearch' option need to be switched off.
7544
7545 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007546 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 certain files, or retry all files with a linear search. When
7548 'tagbsearch' is off, only a linear search is done.
7549
7550 Linear searching is done anyway, for one file, when Vim finds a line
7551 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007552 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553< [The whitespace before and after the '0' must be a single <Tab>]
7554
7555 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007556 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 instead of a normal tag name, a retry is done with a linear search.
7558 Tags in unsorted tags files, and matches with different case will only
7559 be found in the retry.
7560
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007561 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007562 linear search can be avoided when case is ignored. Use a value of '2'
7563 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7564 sorted with the -f switch to "sort" in most unices, as in the command:
7565 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7566 (at least 5.5) the --sort=foldcase switch can be used for this as
7567 well. Note that case must be folded to uppercase for this to work.
7568
7569 By default, tag searches are case-sensitive. Case is ignored when
7570 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7571 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007572 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7573 'tagcase' is "smart", and the pattern contains only lowercase
7574 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575
7576 When 'tagbsearch' is off, tags searching is slower when a full match
7577 exists, but faster when no full match exists. Tags in unsorted tags
7578 files may only be found with 'tagbsearch' off.
7579 When the tags file is not sorted, or sorted in a wrong way (not on
7580 ASCII byte value), 'tagbsearch' should be off, or the line given above
7581 must be included in the tags file.
7582 This option doesn't affect commands that find all matching tags (e.g.,
7583 command-line completion and ":help").
7584 {Vi: always uses binary search in some versions}
7585
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007586 *'tagcase'* *'tc'*
7587'tagcase' 'tc' string (default "followic")
7588 global or local to buffer |global-local|
7589 {not in Vi}
7590 This option specifies how case is handled when searching the tags
7591 file:
7592 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007593 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007594 ignore Ignore case
7595 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007596 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007597 NOTE: This option is set to the Vi default value when 'compatible' is
7598 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007599
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 *'taglength'* *'tl'*
7601'taglength' 'tl' number (default 0)
7602 global
7603 If non-zero, tags are significant up to this number of characters.
7604
7605 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7606'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7607 global
7608 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007609 If on and using a tags file in another directory, file names in that
7610 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 NOTE: This option is set to the Vi default value when 'compatible' is
7612 set and to the Vim default value when 'compatible' is reset.
7613
7614 *'tags'* *'tag'* *E433*
7615'tags' 'tag' string (default "./tags,tags", when compiled with
7616 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7617 global or local to buffer |global-local|
7618 Filenames for the tag command, separated by spaces or commas. To
7619 include a space or comma in a file name, precede it with a backslash
7620 (see |option-backslash| about including spaces and backslashes).
7621 When a file name starts with "./", the '.' is replaced with the path
7622 of the current file. But only when the 'd' flag is not included in
7623 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7624 |tags-option|.
7625 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007626 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7627 find all files named "tags" below "/lib". The filename itself cannot
7628 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7629 files called "tags?". {not available when compiled without the
7630 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007631 The |tagfiles()| function can be used to get a list of the file names
7632 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7634 files are also supported. They are automatically recognized. The
7635 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7636 differences are ignored (MS-Windows). |emacs-tags|
7637 The use of |:set+=| and |:set-=| is preferred when adding or removing
7638 file names from the list. This avoids problems when a future version
7639 uses another default.
7640 {Vi: default is "tags /usr/lib/tags"}
7641
7642 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7643'tagstack' 'tgst' boolean (default on)
7644 global
7645 {not in all versions of Vi}
7646 When on, the |tagstack| is used normally. When off, a ":tag" or
7647 ":tselect" command with an argument will not push the tag onto the
7648 tagstack. A following ":tag" without an argument, a ":pop" command or
7649 any other command that uses the tagstack will use the unmodified
7650 tagstack, but does change the pointer to the active entry.
7651 Resetting this option is useful when using a ":tag" command in a
7652 mapping which should not change the tagstack.
7653
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007654 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007655'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007656 global
7657 {not in Vi}
7658 {only available when compiled with the |+tcl/dyn|
7659 feature}
7660 Specifies the name of the Tcl shared library. The default is
7661 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007662 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007663 This option cannot be set from a |modeline| or in the |sandbox|, for
7664 security reasons.
7665
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 *'term'* *E529* *E530* *E531*
7667'term' string (default is $TERM, if that fails:
7668 in the GUI: "builtin_gui"
7669 on Amiga: "amiga"
7670 on BeOS: "beos-ansi"
7671 on Mac: "mac-ansi"
7672 on MiNT: "vt52"
7673 on MS-DOS: "pcterm"
7674 on OS/2: "os2ansi"
7675 on Unix: "ansi"
7676 on VMS: "ansi"
7677 on Win 32: "win32")
7678 global
7679 Name of the terminal. Used for choosing the terminal control
7680 characters. Environment variables are expanded |:set_env|.
7681 For example: >
7682 :set term=$TERM
7683< See |termcap|.
7684
7685 *'termbidi'* *'tbidi'*
7686 *'notermbidi'* *'notbidi'*
7687'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7688 global
7689 {not in Vi}
7690 {only available when compiled with the |+arabic|
7691 feature}
7692 The terminal is in charge of Bi-directionality of text (as specified
7693 by Unicode). The terminal is also expected to do the required shaping
7694 that some languages (such as Arabic) require.
7695 Setting this option implies that 'rightleft' will not be set when
7696 'arabic' is set and the value of 'arabicshape' will be ignored.
7697 Note that setting 'termbidi' has the immediate effect that
7698 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7699 This option is reset when the GUI is started.
7700 For further details see |arabic.txt|.
7701
7702 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007703'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 Macintosh GUI: "macroman")
7705 global
7706 {only available when compiled with the |+multi_byte|
7707 feature}
7708 {not in Vi}
7709 Encoding used for the terminal. This specifies what character
7710 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007711 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007712 display). Except for the Mac when 'macatsui' is off, then
7713 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007715 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7717 Any attempts to set a different value will be rejected, and an error
7718 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007719 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 because the Win32 system always passes Unicode characters.
7721 When empty, the same encoding is used as for the 'encoding' option.
7722 This is the normal value.
7723 Not all combinations for 'termencoding' and 'encoding' are valid. See
7724 |encoding-table|.
7725 The value for this option must be supported by internal conversions or
7726 iconv(). When this is not possible no conversion will be done and you
7727 will probably experience problems with non-ASCII characters.
7728 Example: You are working with the locale set to euc-jp (Japanese) and
7729 want to edit a UTF-8 file: >
7730 :let &termencoding = &encoding
7731 :set encoding=utf-8
7732< You need to do this when your system has no locale support for UTF-8.
7733
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007734 *'termguicolors'* *'tgc'*
7735'termguicolors' 'tgc' boolean (default off)
7736 global
7737 {not in Vi}
7738 {not available when compiled without the
7739 |+termguicolors| feature}
7740 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7741 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7742 compatible terminal.
7743 If setting this option does not work (produces a colorless UI)
7744 reading |xterm-true-color| might help.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007745 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007746 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007747
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748 *'terse'* *'noterse'*
7749'terse' boolean (default off)
7750 global
7751 When set: Add 's' flag to 'shortmess' option (this makes the message
7752 for a search that hits the start or end of the file not being
7753 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7754 shortens a lot of messages}
7755
7756 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7757'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7758 global
7759 {not in Vi}
7760 This option is obsolete. Use 'fileformats'.
7761 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7762 set to the default value for the current system. When 'textauto' is
7763 reset, 'fileformats' is made empty.
7764 NOTE: This option is set to the Vi default value when 'compatible' is
7765 set and to the Vim default value when 'compatible' is reset.
7766
7767 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7768'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7769 others: default off)
7770 local to buffer
7771 {not in Vi}
7772 This option is obsolete. Use 'fileformat'.
7773 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7774 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7775 "unix".
7776
7777 *'textwidth'* *'tw'*
7778'textwidth' 'tw' number (default 0)
7779 local to buffer
7780 {not in Vi}
7781 Maximum width of text that is being inserted. A longer line will be
7782 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007783 this.
7784 'textwidth' is set to 0 when the 'paste' option is set and restored
7785 when 'paste' is reset.
7786 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007788 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 NOTE: This option is set to 0 when 'compatible' is set.
7790
7791 *'thesaurus'* *'tsr'*
7792'thesaurus' 'tsr' string (default "")
7793 global or local to buffer |global-local|
7794 {not in Vi}
7795 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007796 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 the file should contain words with similar meaning, separated by
7798 non-keyword characters (white space is preferred). Maximum line
7799 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007800 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007801 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007802 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007803 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007804 after a comma are ignored, otherwise spaces are included in the file
7805 name. See |option-backslash| about using backslashes.
7806 The use of |:set+=| and |:set-=| is preferred when adding or removing
7807 directories from the list. This avoids problems when a future version
7808 uses another default.
7809 Backticks cannot be used in this option for security reasons.
7810
7811 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7812'tildeop' 'top' boolean (default off)
7813 global
7814 {not in Vi}
7815 When on: The tilde command "~" behaves like an operator.
7816 NOTE: This option is reset when 'compatible' is set.
7817
7818 *'timeout'* *'to'* *'notimeout'* *'noto'*
7819'timeout' 'to' boolean (default on)
7820 global
7821 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007822'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 global
7824 {not in Vi}
7825 These two options together determine the behavior when part of a
7826 mapped key sequence or keyboard code has been received:
7827
7828 'timeout' 'ttimeout' action ~
7829 off off do not time out
7830 on on or off time out on :mappings and key codes
7831 off on time out on key codes
7832
7833 If both options are off, Vim will wait until either the complete
7834 mapping or key sequence has been received, or it is clear that there
7835 is no mapping or key sequence for the received characters. For
7836 example: if you have mapped "vl" and Vim has received 'v', the next
7837 character is needed to see if the 'v' is followed by an 'l'.
7838 When one of the options is on, Vim will wait for about 1 second for
7839 the next character to arrive. After that the already received
7840 characters are interpreted as single characters. The waiting time can
7841 be changed with the 'timeoutlen' option.
7842 On slow terminals or very busy systems timing out may cause
7843 malfunctioning cursor keys. If both options are off, Vim waits
7844 forever after an entered <Esc> if there are key codes that start
7845 with <Esc>. You will have to type <Esc> twice. If you do not have
7846 problems with key codes, but would like to have :mapped key
7847 sequences not timing out in 1 second, set the 'ttimeout' option and
7848 reset the 'timeout' option.
7849
7850 NOTE: 'ttimeout' is reset when 'compatible' is set.
7851
7852 *'timeoutlen'* *'tm'*
7853'timeoutlen' 'tm' number (default 1000)
7854 global
7855 {not in all versions of Vi}
7856 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007857'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 global
7859 {not in Vi}
7860 The time in milliseconds that is waited for a key code or mapped key
7861 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7862 when part of a command has been typed.
7863 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7864 different timeout value for key codes is desired set 'ttimeoutlen' to
7865 a non-negative number.
7866
7867 ttimeoutlen mapping delay key code delay ~
7868 < 0 'timeoutlen' 'timeoutlen'
7869 >= 0 'timeoutlen' 'ttimeoutlen'
7870
7871 The timeout only happens when the 'timeout' and 'ttimeout' options
7872 tell so. A useful setting would be >
7873 :set timeout timeoutlen=3000 ttimeoutlen=100
7874< (time out on mapping after three seconds, time out on key codes after
7875 a tenth of a second).
7876
7877 *'title'* *'notitle'*
7878'title' boolean (default off, on when title can be restored)
7879 global
7880 {not in Vi}
7881 {not available when compiled without the |+title|
7882 feature}
7883 When on, the title of the window will be set to the value of
7884 'titlestring' (if it is not empty), or to:
7885 filename [+=-] (path) - VIM
7886 Where:
7887 filename the name of the file being edited
7888 - indicates the file cannot be modified, 'ma' off
7889 + indicates the file was modified
7890 = indicates the file is read-only
7891 =+ indicates the file is read-only and modified
7892 (path) is the path of the file being edited
7893 - VIM the server name |v:servername| or "VIM"
7894 Only works if the terminal supports setting window titles
7895 (currently Amiga console, Win32 console, all GUI versions and
7896 terminals with a non- empty 't_ts' option - these are Unix xterm and
7897 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7898 *X11*
7899 When Vim was compiled with HAVE_X11 defined, the original title will
7900 be restored if possible. The output of ":version" will include "+X11"
7901 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7902 works for the icon name |'icon'|.
7903 But: When Vim was started with the |-X| argument, restoring the title
7904 will not work (except in the GUI).
7905 If the title cannot be restored, it is set to the value of 'titleold'.
7906 You might want to restore the title outside of Vim then.
7907 When using an xterm from a remote machine you can use this command:
7908 rsh machine_name xterm -display $DISPLAY &
7909 then the WINDOWID environment variable should be inherited and the
7910 title of the window should change back to what it should be after
7911 exiting Vim.
7912
7913 *'titlelen'*
7914'titlelen' number (default 85)
7915 global
7916 {not in Vi}
7917 {not available when compiled without the |+title|
7918 feature}
7919 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007920 title. When the title is longer, only the end of the path name is
7921 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 Using a percentage makes this adapt to the width of the window. But
7923 it won't work perfectly, because the actual number of characters
7924 available also depends on the font used and other things in the title
7925 bar. When 'titlelen' is zero the full path is used. Otherwise,
7926 values from 1 to 30000 percent can be used.
7927 'titlelen' is also used for the 'titlestring' option.
7928
7929 *'titleold'*
7930'titleold' string (default "Thanks for flying Vim")
7931 global
7932 {not in Vi}
7933 {only available when compiled with the |+title|
7934 feature}
7935 This option will be used for the window title when exiting Vim if the
7936 original title cannot be restored. Only happens if 'title' is on or
7937 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007938 This option cannot be set from a |modeline| or in the |sandbox|, for
7939 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 *'titlestring'*
7941'titlestring' string (default "")
7942 global
7943 {not in Vi}
7944 {not available when compiled without the |+title|
7945 feature}
7946 When this option is not empty, it will be used for the title of the
7947 window. This happens only when the 'title' option is on.
7948 Only works if the terminal supports setting window titles (currently
7949 Amiga console, Win32 console, all GUI versions and terminals with a
7950 non-empty 't_ts' option).
7951 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007952 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 When this option contains printf-style '%' items, they will be
7954 expanded according to the rules used for 'statusline'.
7955 Example: >
7956 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7957 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7958< The value of 'titlelen' is used to align items in the middle or right
7959 of the available space.
7960 Some people prefer to have the file name first: >
7961 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7962< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007963 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 separating space only when needed.
7965 NOTE: Use of special characters in 'titlestring' may cause the display
7966 to be garbled (e.g., when it contains a CR or NL character).
7967 {not available when compiled without the |+statusline| feature}
7968
7969 *'toolbar'* *'tb'*
7970'toolbar' 'tb' string (default "icons,tooltips")
7971 global
7972 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7973 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007974 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 possible values are:
7976 icons Toolbar buttons are shown with icons.
7977 text Toolbar buttons shown with text.
7978 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007979 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 tooltips Tooltips are active for toolbar buttons.
7981 Tooltips refer to the popup help text which appears after the mouse
7982 cursor is placed over a toolbar button for a brief moment.
7983
7984 If you want the toolbar to be shown with icons as well as text, do the
7985 following: >
7986 :set tb=icons,text
7987< Motif and Athena cannot display icons and text at the same time. They
7988 will show icons if both are requested.
7989
7990 If none of the strings specified in 'toolbar' are valid or if
7991 'toolbar' is empty, this option is ignored. If you want to disable
7992 the toolbar, you need to set the 'guioptions' option. For example: >
7993 :set guioptions-=T
7994< Also see |gui-toolbar|.
7995
7996 *'toolbariconsize'* *'tbis'*
7997'toolbariconsize' 'tbis' string (default "small")
7998 global
7999 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008000 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008002 tiny Use tiny icons.
8003 small Use small icons (default).
8004 medium Use medium-sized icons.
8005 large Use large icons.
8006 huge Use even larger icons.
8007 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008009 the current theme. Common dimensions are giant=48x48, huge=32x32,
8010 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011
8012 If 'toolbariconsize' is empty, the global default size as determined
8013 by user preferences or the current theme is used.
8014
8015 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8016'ttybuiltin' 'tbi' boolean (default on)
8017 global
8018 {not in Vi}
8019 When on, the builtin termcaps are searched before the external ones.
8020 When off the builtin termcaps are searched after the external ones.
8021 When this option is changed, you should set the 'term' option next for
8022 the change to take effect, for example: >
8023 :set notbi term=$TERM
8024< See also |termcap|.
8025 Rationale: The default for this option is "on", because the builtin
8026 termcap entries are generally better (many systems contain faulty
8027 xterm entries...).
8028
8029 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8030'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8031 sun-cmd, screen, rxvt, dtterm or
8032 iris-ansi; also on when running Vim in
8033 a DOS console)
8034 global
8035 {not in Vi}
8036 Indicates a fast terminal connection. More characters will be sent to
8037 the screen for redrawing, instead of using insert/delete line
8038 commands. Improves smoothness of redrawing when there are multiple
8039 windows and the terminal does not support a scrolling region.
8040 Also enables the extra writing of characters at the end of each screen
8041 line for lines that wrap. This helps when using copy/paste with the
8042 mouse in an xterm and other terminals.
8043
8044 *'ttymouse'* *'ttym'*
8045'ttymouse' 'ttym' string (default depends on 'term')
8046 global
8047 {not in Vi}
8048 {only in Unix and VMS, doesn't work in the GUI; not
8049 available when compiled without |+mouse|}
8050 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008051 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 *xterm-mouse*
8053 xterm xterm-like mouse handling. The mouse generates
8054 "<Esc>[Mscr", where "scr" is three bytes:
8055 "s" = button state
8056 "c" = column plus 33
8057 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008058 This only works up to 223 columns! See "dec",
8059 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 xterm2 Works like "xterm", but with the xterm reporting the
8061 mouse position while the mouse is dragged. This works
8062 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008063 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 work. See below for how Vim detects this
8065 automatically.
8066 *netterm-mouse*
8067 netterm NetTerm mouse handling. The mouse generates
8068 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8069 for the row and column.
8070 *dec-mouse*
8071 dec DEC terminal mouse handling. The mouse generates a
8072 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008073 This is also available for an Xterm, if it was
8074 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 *jsbterm-mouse*
8076 jsbterm JSB term mouse handling.
8077 *pterm-mouse*
8078 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008079 *urxvt-mouse*
8080 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008081 The mouse works only if the terminal supports this
8082 encoding style, but it does not have 223 columns limit
8083 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008084 *sgr-mouse*
8085 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008086 mouse reporting. The mouse works even in columns
8087 beyond 223. This option is backward compatible with
8088 "xterm2" because it can also decode "xterm2" style
8089 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090
8091 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008092 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8093 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8095 recognized, if enabled at compile time. DEC terminal mouse codes
8096 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008097 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8098 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008100 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8101 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8102 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008103 Additionally, if vim is compiled with the |+termresponse| feature and
8104 |t_RV| is set to the escape sequence to request the xterm version
8105 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008107 from 95 to 276. The "sgr" value will be set if the xterm version is
8108 277 or highter.
8109 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8110 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111 :set t_RV=
8112<
8113 *'ttyscroll'* *'tsl'*
8114'ttyscroll' 'tsl' number (default 999)
8115 global
8116 Maximum number of lines to scroll the screen. If there are more lines
8117 to scroll the window is redrawn. For terminals where scrolling is
8118 very slow and redrawing is not slow this can be set to a small number,
8119 e.g., 3, to speed up displaying.
8120
8121 *'ttytype'* *'tty'*
8122'ttytype' 'tty' string (default from $TERM)
8123 global
8124 Alias for 'term', see above.
8125
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008126 *'undodir'* *'udir'*
8127'undodir' 'udir' string (default ".")
8128 global
8129 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008130 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008131 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008132 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008133 "." means using the directory of the file. The undo file name for
8134 "file.txt" is ".file.txt.un~".
8135 For other directories the file name is the full path of the edited
8136 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008137 When writing: The first directory that exists is used. "." always
8138 works, no directories after "." will be used for writing.
8139 When reading all entries are tried to find an undo file. The first
8140 undo file that exists is used. When it cannot be read an error is
8141 given, no further entry is used.
8142 See |undo-persistence|.
8143
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008144 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008145'undofile' 'udf' boolean (default off)
8146 local to buffer
8147 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008148 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008149 When on, Vim automatically saves undo history to an undo file when
8150 writing a buffer to a file, and restores undo history from the same
8151 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008152 The directory where the undo file is stored is specified by 'undodir'.
8153 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008154 The undo file is not read when 'undoreload' causes the buffer from
8155 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008156 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008157 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008158
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 *'undolevels'* *'ul'*
8160'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8161 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008162 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 {not in Vi}
8164 Maximum number of changes that can be undone. Since undo information
8165 is kept in memory, higher numbers will cause more memory to be used
8166 (nevertheless, a single change can use an unlimited amount of memory).
8167 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8168 itself: >
8169 set ul=0
8170< But you can also get Vi compatibility by including the 'u' flag in
8171 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008172 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008173 Set to -1 for no undo at all. You might want to do this only for the
8174 current buffer: >
8175 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008177
8178 The local value is set to -123456 when the global value is to be used.
8179
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008180 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008182 *'undoreload'* *'ur'*
8183'undoreload' 'ur' number (default 10000)
8184 global
8185 {not in Vi}
8186 Save the whole buffer for undo when reloading it. This applies to the
8187 ":e!" command and reloading for when the buffer changed outside of
8188 Vim. |FileChangedShell|
8189 The save only happens when this options is negative or when the number
8190 of lines is smaller than the value of this option.
8191 Set this option to zero to disable undo for a reload.
8192
8193 When saving undo for a reload, any undo file is not read.
8194
8195 Note that this causes the whole buffer to be stored in memory. Set
8196 this option to a lower value if you run out of memory.
8197
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 *'updatecount'* *'uc'*
8199'updatecount' 'uc' number (default: 200)
8200 global
8201 {not in Vi}
8202 After typing this many characters the swap file will be written to
8203 disk. When zero, no swap file will be created at all (see chapter on
8204 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8205 Vim with the "-n" option, see |startup|. When editing in readonly
8206 mode this option will be initialized to 10000.
8207 The swapfile can be disabled per buffer with |'swapfile'|.
8208 When 'updatecount' is set from zero to non-zero, swap files are
8209 created for all buffers that have 'swapfile' set. When 'updatecount'
8210 is set to zero, existing swap files are not deleted.
8211 Also see |'swapsync'|.
8212 This option has no meaning in buffers where |'buftype'| is "nofile"
8213 or "nowrite".
8214
8215 *'updatetime'* *'ut'*
8216'updatetime' 'ut' number (default 4000)
8217 global
8218 {not in Vi}
8219 If this many milliseconds nothing is typed the swap file will be
8220 written to disk (see |crash-recovery|). Also used for the
8221 |CursorHold| autocommand event.
8222
8223 *'verbose'* *'vbs'*
8224'verbose' 'vbs' number (default 0)
8225 global
8226 {not in Vi, although some versions have a boolean
8227 verbose option}
8228 When bigger than zero, Vim will give messages about what it is doing.
8229 Currently, these messages are given:
8230 >= 1 When the viminfo file is read or written.
8231 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008232 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 >= 8 Files for which a group of autocommands is executed.
8234 >= 9 Every executed autocommand.
8235 >= 12 Every executed function.
8236 >= 13 When an exception is thrown, caught, finished, or discarded.
8237 >= 14 Anything pending in a ":finally" clause.
8238 >= 15 Every executed Ex command (truncated at 200 characters).
8239
8240 This option can also be set with the "-V" argument. See |-V|.
8241 This option is also set by the |:verbose| command.
8242
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008243 When the 'verbosefile' option is set then the verbose messages are not
8244 displayed.
8245
8246 *'verbosefile'* *'vfile'*
8247'verbosefile' 'vfile' string (default empty)
8248 global
8249 {not in Vi}
8250 When not empty all messages are written in a file with this name.
8251 When the file exists messages are appended.
8252 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008253 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008254 Setting 'verbosefile' to a new value is like making it empty first.
8255 The difference with |:redir| is that verbose messages are not
8256 displayed when 'verbosefile' is set.
8257
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 *'viewdir'* *'vdir'*
8259'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8260 "$VIM/vimfiles/view",
8261 for Unix: "~/.vim/view",
8262 for Macintosh: "$VIM:vimfiles:view"
8263 for VMS: "sys$login:vimfiles/view"
8264 for RiscOS: "Choices:vimfiles/view")
8265 global
8266 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008267 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 feature}
8269 Name of the directory where to store files for |:mkview|.
8270 This option cannot be set from a |modeline| or in the |sandbox|, for
8271 security reasons.
8272
8273 *'viewoptions'* *'vop'*
8274'viewoptions' 'vop' string (default: "folds,options,cursor")
8275 global
8276 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008277 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 feature}
8279 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008280 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008281 word save and restore ~
8282 cursor cursor position in file and in window
8283 folds manually created folds, opened/closed folds and local
8284 fold options
8285 options options and mappings local to a window or buffer (not
8286 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008287 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 slash backslashes in file names replaced with forward
8289 slashes
8290 unix with Unix end-of-line format (single <NL>), even when
8291 on Windows or DOS
8292
8293 "slash" and "unix" are useful on Windows when sharing view files
8294 with Unix. The Unix version of Vim cannot source dos format scripts,
8295 but the Windows version of Vim can source unix format scripts.
8296
8297 *'viminfo'* *'vi'* *E526* *E527* *E528*
8298'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008299 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8300 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8301 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 global
8303 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008304 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305 feature}
8306 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008307 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 separated list of parameters, each consisting of a single character
8309 identifying the particular parameter, followed by a number or string
8310 which specifies the value of that parameter. If a particular
8311 character is left out, then the default value is used for that
8312 parameter. The following is a list of the identifying characters and
8313 the effect of their value.
8314 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008315 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 ! When included, save and restore global variables that start
8317 with an uppercase letter, and don't contain a lowercase
8318 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008319 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008320 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008321 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 " Maximum number of lines saved for each register. Old name of
8323 the '<' item, with the disadvantage that you need to put a
8324 backslash before the ", otherwise it will be recognized as the
8325 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008326 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 % When included, save and restore the buffer list. If Vim is
8328 started with a file name argument, the buffer list is not
8329 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008330 buffer list is restored from the viminfo file. Quickfix
8331 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8332 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008333 When followed by a number, the number specifies the maximum
8334 number of buffers that are stored. Without a number all
8335 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008336 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 ' Maximum number of previously edited files for which the marks
8338 are remembered. This parameter must always be included when
8339 'viminfo' is non-empty.
8340 Including this item also means that the |jumplist| and the
8341 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008342 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008344 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 patterns are also saved. When not included, the value of
8346 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008347 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008349 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008350 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 < Maximum number of lines saved for each register. If zero then
8352 registers are not saved. When not included, all lines are
8353 saved. '"' is the old name for this item.
8354 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008355 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008357 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008358 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 c When included, convert the text in the viminfo file from the
8360 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008361 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008362 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 f Whether file marks need to be stored. If zero, file marks ('0
8364 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008365 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008367 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 h Disable the effect of 'hlsearch' when loading the viminfo
8369 file. When not included, it depends on whether ":nohlsearch"
8370 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008371 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008373 the 'n'. Must be at the end of the option! If the "-i"
8374 argument was given when starting Vim, that file name overrides
8375 the one given here with 'viminfo'. Environment variables are
8376 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008377 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 r Removable media. The argument is a string (up to the next
8379 ','). This parameter can be given several times. Each
8380 specifies the start of a path for which no marks will be
8381 stored. This is to avoid removable media. For MS-DOS you
8382 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8383 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8384 ignored. Maximum length of each 'r' argument is 50
8385 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008386 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 s Maximum size of an item in Kbyte. If zero then registers are
8388 not saved. Currently only applies to registers. The default
8389 "s10" will exclude registers with more than 10 Kbyte of text.
8390 Also see the '<' item above: line count limit.
8391
8392 Example: >
8393 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8394<
8395 '50 Marks will be remembered for the last 50 files you
8396 edited.
8397 <1000 Contents of registers (up to 1000 lines each) will be
8398 remembered.
8399 s100 Registers with more than 100 Kbyte text are skipped.
8400 :0 Command-line history will not be saved.
8401 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8402 no / Since '/' is not specified, the default will be used,
8403 that is, save all of the search history, and also the
8404 previous search and substitute patterns.
8405 no % The buffer list will not be saved nor read back.
8406 no h 'hlsearch' highlighting will be restored.
8407
8408 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8409 load the contents of the file, this is not done automatically.
8410
8411 This option cannot be set from a |modeline| or in the |sandbox|, for
8412 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008413 NOTE: This option is set to the Vim default value when 'compatible'
8414 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415
8416 *'virtualedit'* *'ve'*
8417'virtualedit' 've' string (default "")
8418 global
8419 {not in Vi}
8420 {not available when compiled without the
8421 |+virtualedit| feature}
8422 A comma separated list of these words:
8423 block Allow virtual editing in Visual block mode.
8424 insert Allow virtual editing in Insert mode.
8425 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008426 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008427
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008429 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 of the line. Useful for selecting a rectangle in Visual mode and
8431 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008432 "onemore" is not the same, it will only allow moving the cursor just
8433 after the last character of the line. This makes some commands more
8434 consistent. Previously the cursor was always past the end of the line
8435 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008436 break some plugins or Vim scripts. For example because |l| can move
8437 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008438 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008439 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008440 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008441 It doesn't make sense to combine "all" with "onemore", but you will
8442 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008443 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008444
8445 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8446'visualbell' 'vb' boolean (default off)
8447 global
8448 {not in Vi}
8449 Use visual bell instead of beeping. The terminal code to display the
8450 visual bell is given with 't_vb'. When no beep or flash is wanted,
8451 use ":set vb t_vb=".
8452 Note: When the GUI starts, 't_vb' is reset to its default value. You
8453 might want to set it again in your |gvimrc|.
8454 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8455 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8456 where 40 is the time in msec.
8457 Does not work on the Amiga, you always get a screen flash.
8458 Also see 'errorbells'.
8459
8460 *'warn'* *'nowarn'*
8461'warn' boolean (default on)
8462 global
8463 Give a warning message when a shell command is used while the buffer
8464 has been changed.
8465
8466 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8467'weirdinvert' 'wiv' boolean (default off)
8468 global
8469 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008470 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 It is provided for backwards compatibility with version 4.x.
8472 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8473 vice versa. Has no effect when the GUI is running.
8474
8475 *'whichwrap'* *'ww'*
8476'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8477 global
8478 {not in Vi}
8479 Allow specified keys that move the cursor left/right to move to the
8480 previous/next line when the cursor is on the first/last character in
8481 the line. Concatenate characters to allow this for these keys:
8482 char key mode ~
8483 b <BS> Normal and Visual
8484 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008485 h "h" Normal and Visual (not recommended)
8486 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 < <Left> Normal and Visual
8488 > <Right> Normal and Visual
8489 ~ "~" Normal
8490 [ <Left> Insert and Replace
8491 ] <Right> Insert and Replace
8492 For example: >
8493 :set ww=<,>,[,]
8494< allows wrap only when cursor keys are used.
8495 When the movement keys are used in combination with a delete or change
8496 operator, the <EOL> also counts for a character. This makes "3h"
8497 different from "3dh" when the cursor crosses the end of a line. This
8498 is also true for "x" and "X", because they do the same as "dl" and
8499 "dh". If you use this, you may also want to use the mapping
8500 ":map <BS> X" to make backspace delete the character in front of the
8501 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008502 When 'l' is included and it is used after an operator at the end of a
8503 line then it will not move to the next line. This makes "dl", "cl",
8504 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 NOTE: This option is set to the Vi default value when 'compatible' is
8506 set and to the Vim default value when 'compatible' is reset.
8507
8508 *'wildchar'* *'wc'*
8509'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8510 global
8511 {not in Vi}
8512 Character you have to type to start wildcard expansion in the
8513 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008514 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 The character is not recognized when used inside a macro. See
8516 'wildcharm' for that.
8517 Although 'wc' is a number option, you can set it to a special key: >
8518 :set wc=<Esc>
8519< NOTE: This option is set to the Vi default value when 'compatible' is
8520 set and to the Vim default value when 'compatible' is reset.
8521
8522 *'wildcharm'* *'wcm'*
8523'wildcharm' 'wcm' number (default: none (0))
8524 global
8525 {not in Vi}
8526 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008527 recognized when used inside a macro. You can find "spare" command-line
8528 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 you'll never actually type 'wildcharm', just use it in mappings that
8530 automatically invoke completion mode, e.g.: >
8531 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008532 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533< Then after typing :ss you can use CTRL-P & CTRL-N.
8534
8535 *'wildignore'* *'wig'*
8536'wildignore' 'wig' string (default "")
8537 global
8538 {not in Vi}
8539 {not available when compiled without the |+wildignore|
8540 feature}
8541 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008542 patterns is ignored when expanding |wildcards|, completing file or
8543 directory names, and influences the result of |expand()|, |glob()| and
8544 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8546 Also see 'suffixes'.
8547 Example: >
8548 :set wildignore=*.o,*.obj
8549< The use of |:set+=| and |:set-=| is preferred when adding or removing
8550 a pattern from the list. This avoids problems when a future version
8551 uses another default.
8552
Bram Moolenaar94950a92010-12-02 16:01:29 +01008553
Bram Moolenaar81af9252010-12-10 20:35:50 +01008554 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008555'wildignorecase' 'wic' boolean (default off)
8556 global
8557 {not in Vi}
8558 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008559 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008560 Does not apply when the shell is used to expand wildcards, which
8561 happens when there are special characters.
8562
8563
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008565'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 global
8567 {not in Vi}
8568 {not available if compiled without the |+wildmenu|
8569 feature}
8570 When 'wildmenu' is on, command-line completion operates in an enhanced
8571 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8572 the possible matches are shown just above the command line, with the
8573 first match highlighted (overwriting the status line, if there is
8574 one). Keys that show the previous/next match, such as <Tab> or
8575 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8576 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8577 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008578 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 If there are more matches than can fit in the line, a ">" is shown on
8580 the right and/or a "<" is shown on the left. The status line scrolls
8581 as needed.
8582 The "wildmenu" mode is abandoned when a key is hit that is not used
8583 for selecting a completion.
8584 While the "wildmenu" is active the following keys have special
8585 meanings:
8586
8587 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8588 <Down> - in filename/menu name completion: move into a
8589 subdirectory or submenu.
8590 <CR> - in menu completion, when the cursor is just after a
8591 dot: move into a submenu.
8592 <Up> - in filename/menu name completion: move up into
8593 parent directory or parent menu.
8594
8595 This makes the menus accessible from the console |console-menus|.
8596
8597 If you prefer the <Left> and <Right> keys to move the cursor instead
8598 of selecting a different match, use this: >
8599 :cnoremap <Left> <Space><BS><Left>
8600 :cnoremap <Right> <Space><BS><Right>
8601<
8602 The "WildMenu" highlighting is used for displaying the current match
8603 |hl-WildMenu|.
8604
8605 *'wildmode'* *'wim'*
8606'wildmode' 'wim' string (Vim default: "full")
8607 global
8608 {not in Vi}
8609 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008610 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008611 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 first part specifies the behavior for the first use of 'wildchar',
8613 The second part for the second use, etc.
8614 These are the possible values for each part:
8615 "" Complete only the first match.
8616 "full" Complete the next full match. After the last match,
8617 the original string is used and then the first match
8618 again.
8619 "longest" Complete till longest common string. If this doesn't
8620 result in a longer string, use the next part.
8621 "longest:full" Like "longest", but also start 'wildmenu' if it is
8622 enabled.
8623 "list" When more than one match, list all matches.
8624 "list:full" When more than one match, list all matches and
8625 complete first match.
8626 "list:longest" When more than one match, list all matches and
8627 complete till longest common string.
8628 When there is only a single match, it is fully completed in all cases.
8629
8630 Examples: >
8631 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008632< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633 :set wildmode=longest,full
8634< Complete longest common string, then each full match >
8635 :set wildmode=list:full
8636< List all matches and complete each full match >
8637 :set wildmode=list,full
8638< List all matches without completing, then each full match >
8639 :set wildmode=longest,list
8640< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008641 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008642
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008643 *'wildoptions'* *'wop'*
8644'wildoptions' 'wop' string (default "")
8645 global
8646 {not in Vi}
8647 {not available when compiled without the |+wildignore|
8648 feature}
8649 A list of words that change how command line completion is done.
8650 Currently only one word is allowed:
8651 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008652 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008653 is displayed per line. Often used tag kinds are:
8654 d #define
8655 f function
8656 Also see |cmdline-completion|.
8657
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 *'winaltkeys'* *'wak'*
8659'winaltkeys' 'wak' string (default "menu")
8660 global
8661 {not in Vi}
8662 {only used in Win32, Motif, GTK and Photon GUI}
8663 Some GUI versions allow the access to menu entries by using the ALT
8664 key in combination with a character that appears underlined in the
8665 menu. This conflicts with the use of the ALT key for mappings and
8666 entering special characters. This option tells what to do:
8667 no Don't use ALT keys for menus. ALT key combinations can be
8668 mapped, but there is no automatic handling. This can then be
8669 done with the |:simalt| command.
8670 yes ALT key handling is done by the windowing system. ALT key
8671 combinations cannot be mapped.
8672 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008673 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008674 keys can be mapped.
8675 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8676 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008677 This option is not used for <F10>; on Win32 and with GTK <F10> will
8678 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008679
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008680 *'window'* *'wi'*
8681'window' 'wi' number (default screen height - 1)
8682 global
8683 Window height. Do not confuse this with the height of the Vim window,
8684 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008685 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8686 value is smaller than 'lines' minus one. The screen will scroll
8687 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008688 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8689 in a much smarter way, taking care of wrapping lines.
8690 When resizing the Vim window, the value is smaller than 1 or more than
8691 or equal to 'lines' it will be set to 'lines' minus 1.
8692 {Vi also uses the option to specify the number of displayed lines}
8693
Bram Moolenaar071d4272004-06-13 20:20:40 +00008694 *'winheight'* *'wh'* *E591*
8695'winheight' 'wh' number (default 1)
8696 global
8697 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008698 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008699 feature}
8700 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008701 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008702 focus goes to a window that is smaller, its size is increased, at the
8703 cost of the height of other windows.
8704 Set 'winheight' to a small number for normal editing.
8705 Set it to 999 to make the current window fill most of the screen.
8706 Other windows will be only 'winminheight' high. This has the drawback
8707 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8708 to create only two windows, set the option after startup is done,
8709 using the |VimEnter| event: >
8710 au VimEnter * set winheight=999
8711< Minimum value is 1.
8712 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 height of the current window.
8714 'winheight' applies to the current window. Use 'winminheight' to set
8715 the minimal height for other windows.
8716
8717 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8718'winfixheight' 'wfh' boolean (default off)
8719 local to window
8720 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008721 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008722 feature}
8723 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008724 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8725 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008726 The height may be changed anyway when running out of room.
8727
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008728 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8729'winfixwidth' 'wfw' boolean (default off)
8730 local to window
8731 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008732 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008733 feature}
8734 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008735 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008736 The width may be changed anyway when running out of room.
8737
Bram Moolenaar071d4272004-06-13 20:20:40 +00008738 *'winminheight'* *'wmh'*
8739'winminheight' 'wmh' number (default 1)
8740 global
8741 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008742 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008743 feature}
8744 The minimal height of a window, when it's not the current window.
8745 This is a hard minimum, windows will never become smaller.
8746 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8747 status bar) if necessary. They will return to at least one line when
8748 they become active (since the cursor has to have somewhere to go.)
8749 Use 'winheight' to set the minimal height of the current window.
8750 This option is only checked when making a window smaller. Don't use a
8751 large number, it will cause errors when opening more than a few
8752 windows. A value of 0 to 3 is reasonable.
8753
8754 *'winminwidth'* *'wmw'*
8755'winminwidth' 'wmw' number (default 1)
8756 global
8757 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008758 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 feature}
8760 The minimal width of a window, when it's not the current window.
8761 This is a hard minimum, windows will never become smaller.
8762 When set to zero, windows may be "squashed" to zero columns (i.e. just
8763 a vertical separator) if necessary. They will return to at least one
8764 line when they become active (since the cursor has to have somewhere
8765 to go.)
8766 Use 'winwidth' to set the minimal width of the current window.
8767 This option is only checked when making a window smaller. Don't use a
8768 large number, it will cause errors when opening more than a few
8769 windows. A value of 0 to 12 is reasonable.
8770
8771 *'winwidth'* *'wiw'* *E592*
8772'winwidth' 'wiw' number (default 20)
8773 global
8774 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008775 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 feature}
8777 Minimal number of columns for the current window. This is not a hard
8778 minimum, Vim will use fewer columns if there is not enough room. If
8779 the current window is smaller, its size is increased, at the cost of
8780 the width of other windows. Set it to 999 to make the current window
8781 always fill the screen. Set it to a small number for normal editing.
8782 The width is not adjusted after one of the commands to change the
8783 width of the current window.
8784 'winwidth' applies to the current window. Use 'winminwidth' to set
8785 the minimal width for other windows.
8786
8787 *'wrap'* *'nowrap'*
8788'wrap' boolean (default on)
8789 local to window
8790 {not in Vi}
8791 This option changes how text is displayed. It doesn't change the text
8792 in the buffer, see 'textwidth' for that.
8793 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008794 displaying continues on the next line. When off lines will not wrap
8795 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 moved to a part that is not shown, the screen will scroll
8797 horizontally.
8798 The line will be broken in the middle of a word if necessary. See
8799 'linebreak' to get the break at a word boundary.
8800 To make scrolling horizontally a bit more useful, try this: >
8801 :set sidescroll=5
8802 :set listchars+=precedes:<,extends:>
8803< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008804 This option can't be set from a |modeline| when the 'diff' option is
8805 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008806
8807 *'wrapmargin'* *'wm'*
8808'wrapmargin' 'wm' number (default 0)
8809 local to buffer
8810 Number of characters from the right window border where wrapping
8811 starts. When typing text beyond this limit, an <EOL> will be inserted
8812 and inserting continues on the next line.
8813 Options that add a margin, such as 'number' and 'foldcolumn', cause
8814 the text width to be further reduced. This is Vi compatible.
8815 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008816 This option is set to 0 when 'paste' is set and restored when 'paste'
8817 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8819 and less usefully}
8820
8821 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8822'wrapscan' 'ws' boolean (default on) *E384* *E385*
8823 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008824 Searches wrap around the end of the file. Also applies to |]s| and
8825 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826
8827 *'write'* *'nowrite'*
8828'write' boolean (default on)
8829 global
8830 {not in Vi}
8831 Allows writing files. When not set, writing a file is not allowed.
8832 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008833 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 argument. Filtering text is still possible, even though this requires
8835 writing a temporary file.
8836
8837 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8838'writeany' 'wa' boolean (default off)
8839 global
8840 Allows writing to any file with no need for "!" override.
8841
8842 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8843'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8844 otherwise)
8845 global
8846 {not in Vi}
8847 Make a backup before overwriting a file. The backup is removed after
8848 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008849 also on.
8850 WARNING: Switching this option off means that when Vim fails to write
8851 your buffer correctly and then, for whatever reason, Vim exits, you
8852 lose both the original file and what you were writing. Only reset
8853 this option if your file system is almost full and it makes the write
8854 fail (and make sure not to exit Vim until the write was successful).
8855 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 When the 'backupskip' pattern matches, a backup is not made anyway.
8857 NOTE: This option is set to the default value when 'compatible' is
8858 set.
8859
8860 *'writedelay'* *'wd'*
8861'writedelay' 'wd' number (default 0)
8862 global
8863 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008864 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008865 screen. When non-zero, characters are sent to the terminal one by
8866 one. For MS-DOS pcterm this does not work. For debugging purposes.
8867
8868 vim:tw=78:ts=8:ft=help:norl: