blob: 91c864d02f64a65bfe04a52147642ff7eb7e296f [file] [log] [blame]
Bram Moolenaar214641f2017-03-05 17:04:09 +01001*options.txt* For Vim version 8.0. Last change: 2017 Mar 05
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
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
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 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.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
730
731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
732'autochdir' 'acd' boolean (default off)
733 global
734 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
746 {not in Vi}
747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
769 {not in Vi}
770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {small difference from Vi: After the indent is deleted when typing
802 <Esc> or <CR>, the cursor position when moving up or down is after the
803 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
804
805 *'autoread'* *'ar'* *'noautoread'* *'noar'*
806'autoread' 'ar' boolean (default off)
807 global or local to buffer |global-local|
808 {not in Vi}
809 When a file has been detected to have been changed outside of Vim and
810 it has not been changed inside of Vim, automatically read it again.
811 When the file has been deleted this is not done. |timestamp|
812 If this option has a local value, use this command to switch back to
813 using the global value: >
814 :set autoread<
815<
816 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
817'autowrite' 'aw' boolean (default off)
818 global
819 Write the contents of the file, if it has been modified, on each
820 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000821 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
823 Note that for some commands the 'autowrite' option is not used, see
824 'autowriteall' for that.
825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
829 {not in Vi}
830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
832 Setting this option also implies that Vim behaves like 'autowrite' has
833 been set.
834
835 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200836'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 global
838 {not in Vi}
839 When set to "dark", Vim will try to use colors that look good on a
840 dark background. When set to "light", Vim will try to use colors that
841 look good on a light background. Any other value is illegal.
842 Vim tries to set the default value according to the terminal used.
843 This will not always be correct.
844 Setting this option does not change the background color, it tells Vim
845 what the background color looks like. For changing the background
846 color, see |:hi-normal|.
847
848 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000850 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 setting 'background' will cause the color scheme to be reloaded. If
853 the color scheme adjusts to the value of 'background' this will work.
854 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 When setting 'background' to the default value with: >
858 :set background&
859< Vim will guess the value. In the GUI this should work correctly,
860 in other cases Vim might not be able to guess the right value.
861
862 When starting the GUI, the default value for 'background' will be
863 "light". When the value is not set in the .gvimrc, and Vim detects
864 that the background is actually quite dark, 'background' is set to
865 "dark". But this happens only AFTER the .gvimrc file has been read
866 (because the window needs to be opened to find the actual background
867 color). To get around this, force the GUI window to be opened by
868 putting a ":gui" command in the .gvimrc file, before where the value
869 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870
871 For MS-DOS, Windows and OS/2 the default is "dark".
872 For other systems "dark" is used when 'term' is "linux",
873 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
874 background. Otherwise the default is "light".
875
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 Normally this option would be set in the .vimrc file. Possibly
877 depending on the terminal name. Example: >
878 :if &term == "pcterm"
879 : set background=dark
880 :endif
881< When this option is set, the default settings for the highlight groups
882 will change. To use other settings, place ":highlight" commands AFTER
883 the setting of the 'background' option.
884 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
885 to select the colors for syntax highlighting. After changing this
886 option, you must load syntax.vim again to see the result. This can be
887 done with ":syntax on".
888
889 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200890'backspace' 'bs' string (default "", set to "indent,eol,start"
891 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 global
893 {not in Vi}
894 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
895 mode. This is a list of items, separated by commas. Each item allows
896 a way to backspace over something:
897 value effect ~
898 indent allow backspacing over autoindent
899 eol allow backspacing over line breaks (join lines)
900 start allow backspacing over the start of insert; CTRL-W and CTRL-U
901 stop once at the start of insert.
902
903 When the value is empty, Vi compatible backspacing is used.
904
905 For backwards compatibility with version 5.4 and earlier:
906 value effect ~
907 0 same as ":set backspace=" (Vi compatible)
908 1 same as ":set backspace=indent,eol"
909 2 same as ":set backspace=indent,eol,start"
910
911 See |:fixdel| if your <BS> or <Del> key does not do what you want.
912 NOTE: This option is set to "" when 'compatible' is set.
913
914 *'backup'* *'bk'* *'nobackup'* *'nobk'*
915'backup' 'bk' boolean (default off)
916 global
917 {not in Vi}
918 Make a backup before overwriting a file. Leave it around after the
919 file has been successfully written. If you do not want to keep the
920 backup file, but you do want a backup while the file is being
921 written, reset this option and set the 'writebackup' option (this is
922 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 |backup-table| for more explanations.
925 When the 'backupskip' pattern matches, a backup is not made anyway.
926 When 'patchmode' is set, the backup may be renamed to become the
927 oldest version of a file.
928 NOTE: This option is reset when 'compatible' is set.
929
930 *'backupcopy'* *'bkc'*
931'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 {not in Vi}
934 When writing a file and a backup is made, this option tells how it's
935 done. This is a comma separated list of words.
936
937 The main values are:
938 "yes" make a copy of the file and overwrite the original one
939 "no" rename the file and write a new one
940 "auto" one of the previous, what works best
941
942 Extra values that can be combined with the ones above are:
943 "breaksymlink" always break symlinks when writing
944 "breakhardlink" always break hardlinks when writing
945
946 Making a copy and overwriting the original file:
947 - Takes extra time to copy the file.
948 + When the file has special attributes, is a (hard/symbolic) link or
949 has a resource fork, all this is preserved.
950 - When the file is a link the backup will have the name of the link,
951 not of the real file.
952
953 Renaming the file and writing a new one:
954 + It's fast.
955 - Sometimes not all attributes of the file can be copied to the new
956 file.
957 - When the file is a link the new file will not be a link.
958
959 The "auto" value is the middle way: When Vim sees that renaming file
960 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000961 the file is not a link) that is used. When problems are expected, a
962 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 The "breaksymlink" and "breakhardlink" values can be used in
965 combination with any of "yes", "no" and "auto". When included, they
966 force Vim to always break either symbolic or hard links by doing
967 exactly what the "no" option does, renaming the original file to
968 become the backup and writing a new file in its place. This can be
969 useful for example in source trees where all the files are symbolic or
970 hard links and any changes should stay in the local source tree, not
971 be propagated back to the original source.
972 *crontab*
973 One situation where "no" and "auto" will cause problems: A program
974 that opens a file, invokes Vim to edit that file, and then tests if
975 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000976 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 example.
978
979 When a copy is made, the original file is truncated and then filled
980 with the new text. This means that protection bits, owner and
981 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 group of the backup is set to the group of the original file. If this
984 fails, the protection bits for the group are made the same as for
985 others.
986
987 When the file is renamed this is the other way around: The backup has
988 the same attributes of the original file, and the newly written file
989 is owned by the current user. When the file was a (hard/symbolic)
990 link, the new file will not! That's why the "auto" value doesn't
991 rename when the file is a link. The owner and group of the newly
992 written file will be set to the same ones as the original file, but
993 the system may refuse to do this. In that case the "auto" value will
994 again not rename the file.
995
996 *'backupdir'* *'bdir'*
997'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100998 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 for Unix: ".,~/tmp,~/")
1000 global
1001 {not in Vi}
1002 List of directories for the backup file, separated with commas.
1003 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001004 where this is possible. The directory must exist, Vim will not
1005 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001006 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 impossible!). Writing may fail because of this.
1008 - A directory "." means to put the backup file in the same directory
1009 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001010 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 put the backup file relative to where the edited file is. The
1012 leading "." is replaced with the path name of the edited file.
1013 ("." inside a directory name has no special meaning).
1014 - Spaces after the comma are ignored, other spaces are considered part
1015 of the directory name. To have a space at the start of a directory
1016 name, precede it with a backslash.
1017 - To include a comma in a directory name precede it with a backslash.
1018 - A directory name may end in an '/'.
1019 - Environment variables are expanded |:set_env|.
1020 - Careful with '\' characters, type one before a space, type two to
1021 get one in the option (see |option-backslash|), for example: >
1022 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1023< - For backwards compatibility with Vim version 3.0 a '>' at the start
1024 of the option is removed.
1025 See also 'backup' and 'writebackup' options.
1026 If you want to hide your backup files on Unix, consider this value: >
1027 :set backupdir=./.backup,~/.backup,.,/tmp
1028< You must create a ".backup" directory in each directory and in your
1029 home directory for this to work properly.
1030 The use of |:set+=| and |:set-=| is preferred when adding or removing
1031 directories from the list. This avoids problems when a future version
1032 uses another default.
1033 This option cannot be set from a |modeline| or in the |sandbox|, for
1034 security reasons.
1035
1036 *'backupext'* *'bex'* *E589*
1037'backupext' 'bex' string (default "~", for VMS: "_")
1038 global
1039 {not in Vi}
1040 String which is appended to a file name to make the name of the
1041 backup file. The default is quite unusual, because this avoids
1042 accidentally overwriting existing files with a backup file. You might
1043 prefer using ".bak", but make sure that you don't have files with
1044 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001045 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001047 If you like to keep a lot of backups, you could use a BufWritePre
1048 autocommand to change 'backupext' just before writing the file to
1049 include a timestamp. >
1050 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1051< Use 'backupdir' to put the backup in a different directory.
1052
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 *'backupskip'* *'bsk'*
1054'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1055 global
1056 {not in Vi}
1057 {not available when compiled without the |+wildignore|
1058 feature}
1059 A list of file patterns. When one of the patterns matches with the
1060 name of the file which is written, no backup file is created. Both
1061 the specified file name and the full path name of the file are used.
1062 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1063 Watch out for special characters, see |option-backslash|.
1064 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001065 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001066
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001067 WARNING: Not having a backup file means that when Vim fails to write
1068 your buffer correctly and then, for whatever reason, Vim exits, you
1069 lose both the original file and what you were writing. Only disable
1070 backups if you don't care about losing the file.
1071
Bram Moolenaar02467872007-05-06 13:22:01 +00001072 Note that environment variables are not expanded. If you want to use
1073 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001074 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001075
1076< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001077 backup would be made by renaming the original file crontab won't see
1078 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079
1080 *'balloondelay'* *'bdlay'*
1081'balloondelay' 'bdlay' number (default: 600)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
1085 feature}
1086 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1087
1088 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1089'ballooneval' 'beval' boolean (default off)
1090 global
1091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001093 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 Switch on the |balloon-eval| functionality.
1095
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096 *'balloonexpr'* *'bexpr'*
1097'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001098 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001099 {not in Vi}
1100 {only available when compiled with the |+balloon_eval|
1101 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001102 Expression for text to show in evaluation balloon. It is only used
1103 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001104
1105 v:beval_bufnr number of the buffer in which balloon is going to show
1106 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001107 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001108 v:beval_lnum line number
1109 v:beval_col column number (byte index)
1110 v:beval_text word under or after the mouse pointer
1111
1112 The evaluation of the expression must not have side effects!
1113 Example: >
1114 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001115 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001116 \', column ' . v:beval_col .
1117 \ ' of file ' . bufname(v:beval_bufnr) .
1118 \ ' on word "' . v:beval_text . '"'
1119 endfunction
1120 set bexpr=MyBalloonExpr()
1121 set ballooneval
1122<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001123 Also see |balloon_show()|, can be used if the content of the balloon
1124 is to be fetched asynchronously.
1125
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126 NOTE: The balloon is displayed only if the cursor is on a text
1127 character. If the result of evaluating 'balloonexpr' is not empty,
1128 Vim does not try to send a message to an external debugger (Netbeans
1129 or Sun Workshop).
1130
Bram Moolenaar30b65812012-07-12 22:01:11 +02001131 The expression will be evaluated in the |sandbox| when set from a
1132 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001133
1134 It is not allowed to change text or jump to another window while
1135 evaluating 'balloonexpr' |textlock|.
1136
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001137 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001138 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001139< When they are supported "\n" characters will start a new line. If the
1140 expression evaluates to a |List| this is equal to using each List item
1141 as a string and putting "\n" in between them.
1142
Bram Moolenaar165bc692015-07-21 17:53:25 +02001143 *'belloff'* *'bo'*
1144'belloff' 'bo' string (default "")
1145 global
1146 {not in Vi}
1147 Specifies for which events the bell will not be rung. It is a comma
1148 separated list of items. For each item that is present, the bell
1149 will be silenced. This is most useful to specify specific events in
1150 insert mode to be silenced.
1151
1152 item meaning when present ~
1153 all All events.
1154 backspace When hitting <BS> or <Del> and deleting results in an
1155 error.
1156 cursor Fail to move around using the cursor keys or
1157 <PageUp>/<PageDown> in |Insert-mode|.
1158 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1159 |i_CTRL-X_CTRL-T|.
1160 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1161 |i_CTRL-E|.
1162 ctrlg Unknown Char after <C-G> in Insert mode.
1163 error Other Error occurred (e.g. try to join last line)
1164 (mostly used in |Normal-mode| or |Cmdline-mode|).
1165 esc hitting <Esc> in |Normal-mode|.
1166 ex In |Visual-mode|, hitting |Q| results in an error.
1167 hangul Error occurred when using hangul input.
1168 insertmode Pressing <Esc> in 'insertmode'.
1169 lang Calling the beep module for Lua/Mzscheme/TCL.
1170 mess No output available for |g<|.
1171 showmatch Error occurred for 'showmatch' function.
1172 operator Empty region error |cpo-E|.
1173 register Unknown register after <C-R> in |Insert-mode|.
1174 shell Bell from shell output |:!|.
1175 spell Error happened on spell suggest.
1176 wildmode More matches in |cmdline-completion| available
1177 (depends on the 'wildmode' setting).
1178
1179 This is most useful, to fine tune when in insert mode the bell should
1180 be rung. For normal mode and ex commands, the bell is often rung to
1181 indicate that an error occurred. It can be silenced by adding the
1182 "error" keyword.
1183
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1185'binary' 'bin' boolean (default off)
1186 local to buffer
1187 {not in Vi}
1188 This option should be set before editing a binary file. You can also
1189 use the |-b| Vim argument. When this option is switched on a few
1190 options will be changed (also when it already was on):
1191 'textwidth' will be set to 0
1192 'wrapmargin' will be set to 0
1193 'modeline' will be off
1194 'expandtab' will be off
1195 Also, 'fileformat' and 'fileformats' options will not be used, the
1196 file is read and written like 'fileformat' was "unix" (a single <NL>
1197 separates lines).
1198 The 'fileencoding' and 'fileencodings' options will not be used, the
1199 file is read without conversion.
1200 NOTE: When you start editing a(nother) file while the 'bin' option is
1201 on, settings from autocommands may change the settings again (e.g.,
1202 'textwidth'), causing trouble when editing. You might want to set
1203 'bin' again when the file has been loaded.
1204 The previous values of these options are remembered and restored when
1205 'bin' is switched from on to off. Each buffer has its own set of
1206 saved option values.
1207 To edit a file with 'binary' set you can use the |++bin| argument.
1208 This avoids you have to do ":set bin", which would have effect for all
1209 files you edit.
1210 When writing a file the <EOL> for the last line is only written if
1211 there was one in the original file (normally Vim appends an <EOL> to
1212 the last line if there is none; this would make the file longer). See
1213 the 'endofline' option.
1214
1215 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1216'bioskey' 'biosk' boolean (default on)
1217 global
1218 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001219 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 *'bomb'* *'nobomb'*
1222'bomb' boolean (default off)
1223 local to buffer
1224 {not in Vi}
1225 {only available when compiled with the |+multi_byte|
1226 feature}
1227 When writing a file and the following conditions are met, a BOM (Byte
1228 Order Mark) is prepended to the file:
1229 - this option is on
1230 - the 'binary' option is off
1231 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1232 endian variants.
1233 Some applications use the BOM to recognize the encoding of the file.
1234 Often used for UCS-2 files on MS-Windows. For other applications it
1235 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001236 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1238 check for the presence of the BOM is done and 'bomb' set accordingly.
1239 Unless 'binary' is set, it is removed from the first line, so that you
1240 don't see it when editing. When you don't change the options, the BOM
1241 will be restored when writing the file.
1242
1243 *'breakat'* *'brk'*
1244'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1245 global
1246 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001247 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 feature}
1249 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001250 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1251 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001253 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001254'breakindent' 'bri' boolean (default off)
1255 local to window
1256 {not in Vi}
1257 {not available when compiled without the |+linebreak|
1258 feature}
1259 Every wrapped line will continue visually indented (same amount of
1260 space as the beginning of that line), thus preserving horizontal blocks
1261 of text.
1262
1263 *'breakindentopt'* *'briopt'*
1264'breakindentopt' 'briopt' string (default empty)
1265 local to window
1266 {not in Vi}
1267 {not available when compiled without the |+linebreak|
1268 feature}
1269 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001270 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001271 min:{n} Minimum text width that will be kept after
1272 applying 'breakindent', even if the resulting
1273 text should normally be narrower. This prevents
1274 text indented almost to the right window border
1275 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001276 shift:{n} After applying 'breakindent', the wrapped line's
1277 beginning will be shifted by the given number of
1278 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001279 indentation (negative) or emphasizing the line
1280 continuation (positive).
1281 sbr Display the 'showbreak' value before applying the
1282 additional indent.
1283 The default value for min is 20 and shift is 0.
1284
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001286'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001288 {not in Vi} {only for Motif, Athena, GTK, Mac and
1289 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001291 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001292 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 buffer Use the directory of the related buffer.
1294 current Use the current directory.
1295 {path} Use the specified directory
1296
1297 *'bufhidden'* *'bh'*
1298'bufhidden' 'bh' string (default: "")
1299 local to buffer
1300 {not in Vi}
1301 {not available when compiled without the |+quickfix|
1302 feature}
1303 This option specifies what happens when a buffer is no longer
1304 displayed in a window:
1305 <empty> follow the global 'hidden' option
1306 hide hide the buffer (don't unload it), also when 'hidden'
1307 is not set
1308 unload unload the buffer, also when 'hidden' is set or using
1309 |:hide|
1310 delete delete the buffer from the buffer list, also when
1311 'hidden' is set or using |:hide|, like using
1312 |:bdelete|
1313 wipe wipe out the buffer from the buffer list, also when
1314 'hidden' is set or using |:hide|, like using
1315 |:bwipeout|
1316
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001317 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001318 are lost without a warning. Also, these values may break autocommands
1319 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 This option is used together with 'buftype' and 'swapfile' to specify
1321 special kinds of buffers. See |special-buffers|.
1322
1323 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1324'buflisted' 'bl' boolean (default: on)
1325 local to buffer
1326 {not in Vi}
1327 When this option is set, the buffer shows up in the buffer list. If
1328 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1329 This option is reset by Vim for buffers that are only used to remember
1330 a file name or marks. Vim sets it when starting to edit a buffer.
1331 But not when moving to a buffer with ":buffer".
1332
1333 *'buftype'* *'bt'* *E382*
1334'buftype' 'bt' string (default: "")
1335 local to buffer
1336 {not in Vi}
1337 {not available when compiled without the |+quickfix|
1338 feature}
1339 The value of this option specifies the type of a buffer:
1340 <empty> normal buffer
1341 nofile buffer which is not related to a file and will not be
1342 written
1343 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001344 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001345 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001346 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001348 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001349 help help buffer (you are not supposed to set this
1350 manually)
1351
1352 This option is used together with 'bufhidden' and 'swapfile' to
1353 specify special kinds of buffers. See |special-buffers|.
1354
1355 Be careful with changing this option, it can have many side effects!
1356
Bram Moolenaar280f1262006-01-30 00:14:18 +00001357 A "quickfix" buffer is only used for the error list and the location
1358 list. This value is set by the |:cwindow| and |:lwindow| commands and
1359 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360
1361 "nofile" and "nowrite" buffers are similar:
1362 both: The buffer is not to be written to disk, ":w" doesn't
1363 work (":w filename" does work though).
1364 both: The buffer is never considered to be |'modified'|.
1365 There is no warning when the changes will be lost, for
1366 example when you quit Vim.
1367 both: A swap file is only created when using too much memory
1368 (when 'swapfile' has been reset there is never a swap
1369 file).
1370 nofile only: The buffer name is fixed, it is not handled like a
1371 file name. It is not modified in response to a |:cd|
1372 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001373 both: When using ":e bufname" and already editing "bufname"
1374 the buffer is made empty and autocommands are
1375 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001376 *E676*
1377 "acwrite" implies that the buffer name is not related to a file, like
1378 "nofile", but it will be written. Thus, in contrast to "nofile" and
1379 "nowrite", ":w" does work and a modified buffer can't be abandoned
1380 without saving. For writing there must be matching |BufWriteCmd|,
1381 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382
1383 *'casemap'* *'cmp'*
1384'casemap' 'cmp' string (default: "internal,keepascii")
1385 global
1386 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001387 {only available when compiled with the |+multi_byte|
1388 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001389 Specifies details about changing the case of letters. It may contain
1390 these words, separated by a comma:
1391 internal Use internal case mapping functions, the current
1392 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001393 matters when 'encoding' is a Unicode encoding,
1394 "latin1" or "iso-8859-15". When "internal" is
1395 omitted, the towupper() and towlower() system library
1396 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1398 case mapping, the current locale is not effective.
1399 This probably only matters for Turkish.
1400
1401 *'cdpath'* *'cd'* *E344* *E346*
1402'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1403 global
1404 {not in Vi}
1405 {not available when compiled without the
1406 |+file_in_path| feature}
1407 This is a list of directories which will be searched when using the
1408 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001409 for has a relative path, not an absolute part starting with "/", "./"
1410 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 The 'cdpath' option's value has the same form and semantics as
1412 |'path'|. Also see |file-searching|.
1413 The default value is taken from $CDPATH, with a "," prepended to look
1414 in the current directory first.
1415 If the default value taken from $CDPATH is not what you want, include
1416 a modified version of the following command in your vimrc file to
1417 override it: >
1418 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1419< This option cannot be set from a |modeline| or in the |sandbox|, for
1420 security reasons.
1421 (parts of 'cdpath' can be passed to the shell to expand file names).
1422
1423 *'cedit'*
1424'cedit' string (Vi default: "", Vim default: CTRL-F)
1425 global
1426 {not in Vi}
1427 {not available when compiled without the |+vertsplit|
1428 feature}
1429 The key used in Command-line Mode to open the command-line window.
1430 The default is CTRL-F when 'compatible' is off.
1431 Only non-printable keys are allowed.
1432 The key can be specified as a single character, but it is difficult to
1433 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001434 :exe "set cedit=\<C-Y>"
1435 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436< |Nvi| also has this option, but it only uses the first character.
1437 See |cmdwin|.
1438
1439 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1440'charconvert' 'ccv' string (default "")
1441 global
1442 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001443 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 {not in Vi}
1445 An expression that is used for character encoding conversion. It is
1446 evaluated when a file that is to be read or has been written has a
1447 different encoding from what is desired.
1448 'charconvert' is not used when the internal iconv() function is
1449 supported and is able to do the conversion. Using iconv() is
1450 preferred, because it is much faster.
1451 'charconvert' is not used when reading stdin |--|, because there is no
1452 file to convert from. You will have to save the text in a file first.
1453 The expression must return zero or an empty string for success,
1454 non-zero for failure.
1455 The possible encoding names encountered are in 'encoding'.
1456 Additionally, names given in 'fileencodings' and 'fileencoding' are
1457 used.
1458 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1459 is done internally by Vim, 'charconvert' is not used for this.
1460 'charconvert' is also used to convert the viminfo file, if the 'c'
1461 flag is present in 'viminfo'. Also used for Unicode conversion.
1462 Example: >
1463 set charconvert=CharConvert()
1464 fun CharConvert()
1465 system("recode "
1466 \ . v:charconvert_from . ".." . v:charconvert_to
1467 \ . " <" . v:fname_in . " >" v:fname_out)
1468 return v:shell_error
1469 endfun
1470< The related Vim variables are:
1471 v:charconvert_from name of the current encoding
1472 v:charconvert_to name of the desired encoding
1473 v:fname_in name of the input file
1474 v:fname_out name of the output file
1475 Note that v:fname_in and v:fname_out will never be the same.
1476 Note that v:charconvert_from and v:charconvert_to may be different
1477 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1478 Encryption is not done by Vim when using 'charconvert'. If you want
1479 to encrypt the file after conversion, 'charconvert' should take care
1480 of this.
1481 This option cannot be set from a |modeline| or in the |sandbox|, for
1482 security reasons.
1483
1484 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1485'cindent' 'cin' boolean (default off)
1486 local to buffer
1487 {not in Vi}
1488 {not available when compiled without the |+cindent|
1489 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001490 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 that trigger reindenting in insert mode and 'cinoptions' to set your
1492 preferred indent style.
1493 If 'indentexpr' is not empty, it overrules 'cindent'.
1494 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1495 the "=" operator indents using this algorithm rather than calling an
1496 external program.
1497 See |C-indenting|.
1498 When you don't like the way 'cindent' works, try the 'smartindent'
1499 option or 'indentexpr'.
1500 This option is not used when 'paste' is set.
1501 NOTE: This option is reset when 'compatible' is set.
1502
1503 *'cinkeys'* *'cink'*
1504'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1505 local to buffer
1506 {not in Vi}
1507 {not available when compiled without the |+cindent|
1508 feature}
1509 A list of keys that, when typed in Insert mode, cause reindenting of
1510 the current line. Only used if 'cindent' is on and 'indentexpr' is
1511 empty.
1512 For the format of this option see |cinkeys-format|.
1513 See |C-indenting|.
1514
1515 *'cinoptions'* *'cino'*
1516'cinoptions' 'cino' string (default "")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+cindent|
1520 feature}
1521 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1522 program. See |cinoptions-values| for the values of this option, and
1523 |C-indenting| for info on C indenting in general.
1524
1525
1526 *'cinwords'* *'cinw'*
1527'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1528 local to buffer
1529 {not in Vi}
1530 {not available when compiled without both the
1531 |+cindent| and the |+smartindent| features}
1532 These keywords start an extra indent in the next line when
1533 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1534 an appropriate place (inside {}).
1535 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1536 matter, include the keyword both the uppercase and lowercase:
1537 "if,If,IF".
1538
1539 *'clipboard'* *'cb'*
1540'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1541 for X-windows, "" otherwise)
1542 global
1543 {not in Vi}
1544 {only in GUI versions or when the |+xterm_clipboard|
1545 feature is included}
1546 This option is a list of comma separated names.
1547 These names are recognized:
1548
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001549 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 unnamed When included, Vim will use the clipboard register '*'
1551 for all yank, delete, change and put operations which
1552 would normally go to the unnamed register. When a
1553 register is explicitly specified, it will always be
1554 used regardless of whether "unnamed" is in 'clipboard'
1555 or not. The clipboard register can always be
1556 explicitly accessed using the "* notation. Also see
1557 |gui-clipboard|.
1558
Bram Moolenaar30b65812012-07-12 22:01:11 +02001559 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001560 unnamedplus A variant of the "unnamed" flag which uses the
1561 clipboard register '+' (|quoteplus|) instead of
1562 register '*' for all yank, delete, change and put
1563 operations which would normally go to the unnamed
1564 register. When "unnamed" is also included to the
1565 option, yank operations (but not delete, change or
1566 put) will additionally copy the text into register
1567 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001568 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001569 Availability can be checked with: >
1570 if has('unnamedplus')
1571<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001572 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001573 autoselect Works like the 'a' flag in 'guioptions': If present,
1574 then whenever Visual mode is started, or the Visual
1575 area extended, Vim tries to become the owner of the
1576 windowing system's global selection or put the
1577 selected text on the clipboard used by the selection
1578 register "*. See |guioptions_a| and |quotestar| for
1579 details. When the GUI is active, the 'a' flag in
1580 'guioptions' is used, when the GUI is not active, this
1581 "autoselect" flag is used.
1582 Also applies to the modeless selection.
1583
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001584 *clipboard-autoselectplus*
1585 autoselectplus Like "autoselect" but using the + register instead of
1586 the * register. Compare to the 'P' flag in
1587 'guioptions'.
1588
1589 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 autoselectml Like "autoselect", but for the modeless selection
1591 only. Compare to the 'A' flag in 'guioptions'.
1592
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001593 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001594 html When the clipboard contains HTML, use this when
1595 pasting. When putting text on the clipboard, mark it
1596 as HTML. This works to copy rendered HTML from
1597 Firefox, paste it as raw HTML in Vim, select the HTML
1598 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001599 You probably want to add this only temporarily,
1600 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001601 Only supported for GTK version 2 and later.
1602 Only available with the |+multi_byte| feature.
1603
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001604 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 exclude:{pattern}
1606 Defines a pattern that is matched against the name of
1607 the terminal 'term'. If there is a match, no
1608 connection will be made to the X server. This is
1609 useful in this situation:
1610 - Running Vim in a console.
1611 - $DISPLAY is set to start applications on another
1612 display.
1613 - You do not want to connect to the X server in the
1614 console, but do want this in a terminal emulator.
1615 To never connect to the X server use: >
1616 exclude:.*
1617< This has the same effect as using the |-X| argument.
1618 Note that when there is no connection to the X server
1619 the window title won't be restored and the clipboard
1620 cannot be accessed.
1621 The value of 'magic' is ignored, {pattern} is
1622 interpreted as if 'magic' was on.
1623 The rest of the option value will be used for
1624 {pattern}, this must be the last entry.
1625
1626 *'cmdheight'* *'ch'*
1627'cmdheight' 'ch' number (default 1)
1628 global
1629 {not in Vi}
1630 Number of screen lines to use for the command-line. Helps avoiding
1631 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001632 The value of this option is stored with the tab page, so that each tab
1633 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634
1635 *'cmdwinheight'* *'cwh'*
1636'cmdwinheight' 'cwh' number (default 7)
1637 global
1638 {not in Vi}
1639 {not available when compiled without the |+vertsplit|
1640 feature}
1641 Number of screen lines to use for the command-line window. |cmdwin|
1642
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001643 *'colorcolumn'* *'cc'*
1644'colorcolumn' 'cc' string (default "")
1645 local to window
1646 {not in Vi}
1647 {not available when compiled without the |+syntax|
1648 feature}
1649 'colorcolumn' is a comma separated list of screen columns that are
1650 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1651 text. Will make screen redrawing slower.
1652 The screen column can be an absolute number, or a number preceded with
1653 '+' or '-', which is added to or subtracted from 'textwidth'. >
1654
1655 :set cc=+1 " highlight column after 'textwidth'
1656 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1657 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1658<
1659 When 'textwidth' is zero then the items with '-' and '+' are not used.
1660 A maximum of 256 columns are highlighted.
1661
Bram Moolenaar071d4272004-06-13 20:20:40 +00001662 *'columns'* *'co'* *E594*
1663'columns' 'co' number (default 80 or terminal width)
1664 global
1665 {not in Vi}
1666 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001667 initialization and does not have to be set by hand. Also see
1668 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 When Vim is running in the GUI or in a resizable window, setting this
1670 option will cause the window size to be changed. When you only want
1671 to use the size for the GUI, put the command in your |gvimrc| file.
1672 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001673 number of columns of the display, the display may be messed up. For
1674 the GUI it is always possible and Vim limits the number of columns to
1675 what fits on the screen. You can use this command to get the widest
1676 window possible: >
1677 :set columns=9999
1678< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679
1680 *'comments'* *'com'* *E524* *E525*
1681'comments' 'com' string (default
1682 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1683 local to buffer
1684 {not in Vi}
1685 {not available when compiled without the |+comments|
1686 feature}
1687 A comma separated list of strings that can start a comment line. See
1688 |format-comments|. See |option-backslash| about using backslashes to
1689 insert a space.
1690
1691 *'commentstring'* *'cms'* *E537*
1692'commentstring' 'cms' string (default "/*%s*/")
1693 local to buffer
1694 {not in Vi}
1695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
1705 {not in Vi}
1706 This option has the effect of making Vim either more Vi-compatible, or
1707 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001708
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001710 other options are also changed as a side effect.
1711 NOTE: Setting or resetting this option can have a lot of unexpected
1712 effects: Mappings are interpreted in another way, undo behaves
1713 differently, etc. If you set this option in your vimrc file, you
1714 should probably put it at the very start.
1715
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 By default this option is on and the Vi defaults are used for the
1717 options. This default was chosen for those people who want to use Vim
1718 just like Vi, and don't even (want to) know about the 'compatible'
1719 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001720 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001721 this option is switched off, and all options that have not been
1722 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001723 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001724 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001725 happen for the system-wide vimrc or gvimrc file, nor for a file given
1726 with the |-u| argument). Also see |compatible-default| and
1727 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 You can also set this option with the "-C" argument, and reset it with
1729 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001730 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731
Bram Moolenaar214641f2017-03-05 17:04:09 +01001732 When this option is set, numerous other options are set to make Vim as
1733 Vi-compatible as possible. When this option is unset, various options
1734 are set to make Vim more useful. The table below lists all the
1735 options affected.
1736 The {?} column indicates when the options are affected:
1737 + Means that the option is set to the value given in {set value} when
1738 'compatible' is set.
1739 & Means that the option is set to the value given in {set value} when
1740 'compatible' is set AND is set to its Vim default value when
1741 'compatible' is unset.
1742 - Means the option is NOT changed when setting 'compatible' but IS
1743 set to its Vim default when 'compatible' is unset.
1744 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746 option ? set value effect
1747
1748 'allowrevins' + off no CTRL-_ command
1749 'antialias' + off don't use antialiased fonts
1750 'arabic' + off reset arabic-related options
1751 'arabicshape' + on correct character shapes
1752 'backspace' + "" normal backspace
1753 'backup' + off no backup file
1754 'backupcopy' & Unix: "yes" backup file is a copy
1755 else: "auto" copy or rename backup file
1756 'balloonexpr' + "" text to show in evaluation balloon
1757 'breakindent' + off don't indent when wrapping lines
1758 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1759 'cindent' + off no C code indentation
1760 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1761 'copyindent' + off don't copy indent structure
1762 'cpoptions' & (all flags) Vi-compatible flags
1763 'cscopepathcomp'+ 0 don't show directories in tags list
1764 'cscoperelative'+ off
1765 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 'cscopetagorder' 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001767 'cscopeverbose' + off see |cscopeverbose|
1768 'delcombine' + off unicode: delete whole char combination
1769 'digraph' + off no digraphs
1770 'esckeys' & off no <Esc>-keys in Insert mode
1771 'expandtab' + off tabs not expanded to spaces
1772 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001774 'formatexpr' + "" use 'formatprg' for auto-formatting
1775 'formatoptions' & "vt" Vi compatible formatting
1776 'gdefault' + off no default 'g' flag for ":s"
1777 'history' & 0 no commandline history
1778 'hkmap' + off no Hebrew keyboard mapping
1779 'hkmapp' + off no phonetic Hebrew keyboard mapping
1780 'hlsearch' + off no highlighting of search matches
1781 'incsearch' + off no incremental searching
1782 'indentexpr' + "" no indenting by expression
1783 'insertmode' + off do not start in Insert mode
1784 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001786 'joinspaces' + on insert 2 spaces after period
1787 'modeline' & off no modelines
1788 'more' & off no pauses in listings
1789 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1790 'numberwidth' & 8 min number of columns for line number
1791 'preserveindent'+ off don't preserve current indent structure
1792 when changing it
1793 'revins' + off no reverse insert
1794 'ruler' + off no ruler
1795 'scrolljump' + 1 no jump scroll
1796 'scrolloff' + 0 no scroll offset
1797 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1798 'shiftround' + off indent not rounded to shiftwidth
1799 'shortmess' & "" no shortening of messages
1800 'showcmd' & off command characters not shown
1801 'showmode' & off current mode not shown
1802 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1803 'smartcase' + off no automatic ignore case switch
1804 'smartindent' + off no smart indentation
1805 'smarttab' + off no smart tab size
1806 'softtabstop' + 0 tabs are always 'tabstop' positions
1807 'startofline' + on goto startofline with some commands
1808 'tagcase' & "followic" 'ignorecase' when searching tags file
1809 'tagrelative' & off tag file names are not relative
1810 'termguicolors' + off don't use highlight-(guifg|guibg)
1811 'textauto' & off no automatic textmode detection
1812 'textwidth' + 0 no automatic line wrap
1813 'tildeop' + off tilde is not an operator
1814 'ttimeout' + off no terminal timeout
1815 'undofile' + off don't use an undo file
1816 'viminfo' - {unchanged} {set vim default only on resetting 'cp'}
1817 'virtualedit' + "" cursor can only be placed on characters
1818 'whichwrap' & "" left-right movements don't wrap
1819 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822
1823 *'complete'* *'cpt'* *E535*
1824'complete' 'cpt' string (default: ".,w,b,u,t,i")
1825 local to buffer
1826 {not in Vi}
1827 This option specifies how keyword completion |ins-completion| works
1828 when CTRL-P or CTRL-N are used. It is also used for whole-line
1829 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1830 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001831 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 w scan buffers from other windows
1833 b scan other loaded buffers that are in the buffer list
1834 u scan the unloaded buffers that are in the buffer list
1835 U scan the buffers that are not in the buffer list
1836 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001837 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 k{dict} scan the file {dict}. Several "k" flags can be given,
1839 patterns are valid too. For example: >
1840 :set cpt=k/usr/dict/*,k~/spanish
1841< s scan the files given with the 'thesaurus' option
1842 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1843 are valid too.
1844 i scan current and included files
1845 d scan current and included files for defined name or macro
1846 |i_CTRL-X_CTRL-D|
1847 ] tag completion
1848 t same as "]"
1849
1850 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1851 not executed, this may lead to unexpected completions from some files
1852 (gzipped files for example). Unloaded buffers are not scanned for
1853 whole-line completion.
1854
1855 The default is ".,w,b,u,t,i", which means to scan:
1856 1. the current buffer
1857 2. buffers in other windows
1858 3. other loaded buffers
1859 4. unloaded buffers
1860 5. tags
1861 6. included files
1862
1863 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001864 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1865 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001867 *'completefunc'* *'cfu'*
1868'completefunc' 'cfu' string (default: empty)
1869 local to buffer
1870 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001871 {not available when compiled without the |+eval|
1872 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001873 This option specifies a function to be used for Insert mode completion
1874 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001875 See |complete-functions| for an explanation of how the function is
1876 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001877 This option cannot be set from a |modeline| or in the |sandbox|, for
1878 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001879
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001880 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001881'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001882 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001883 {not available when compiled without the
1884 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001885 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001886 A comma separated list of options for Insert mode completion
1887 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001888
1889 menu Use a popup menu to show the possible completions. The
1890 menu is only shown when there is more than one match and
1891 sufficient colors are available. |ins-completion-menu|
1892
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001893 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001894 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001895 match, e.g., what file it comes from.
1896
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001897 longest Only insert the longest common text of the matches. If
1898 the menu is displayed you can use CTRL-L to add more
1899 characters. Whether case is ignored depends on the kind
1900 of completion. For buffer text the 'ignorecase' option is
1901 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001902
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001903 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001904 completion in the preview window. Only works in
1905 combination with "menu" or "menuone".
1906
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001907 noinsert Do not insert any text for a match until the user selects
1908 a match from the menu. Only works in combination with
1909 "menu" or "menuone". No effect if "longest" is present.
1910
1911 noselect Do not select a match in the menu, force the user to
1912 select one from the menu. Only works in combination with
1913 "menu" or "menuone".
1914
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001915
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001916 *'concealcursor'* *'cocu'*
1917'concealcursor' 'cocu' string (default: "")
1918 local to window
1919 {not in Vi}
1920 {not available when compiled without the |+conceal|
1921 feature}
1922 Sets the modes in which text in the cursor line can also be concealed.
1923 When the current mode is listed then concealing happens just like in
1924 other lines.
1925 n Normal mode
1926 v Visual mode
1927 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001928 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001929
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001930 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001931 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001932 are moving around text is concealed, but when starting to insert text
1933 or selecting a Visual area the concealed text is displayed, so that
1934 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001935 Keep in mind that the cursor position is not always where it's
1936 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001937
1938
1939'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001940 number (default 0)
1941 local to window
1942 {not in Vi}
1943 {not available when compiled without the |+conceal|
1944 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001945 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1946 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001947
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001948 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001949 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001950 1 Each block of concealed text is replaced with one
1951 character. If the syntax item does not have a custom
1952 replacement character defined (see |:syn-cchar|) the
1953 character defined in 'listchars' is used (default is a
1954 space).
1955 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001956 2 Concealed text is completely hidden unless it has a
1957 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001958 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001959 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001960
Bram Moolenaara7781e02010-07-19 20:13:22 +02001961 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962 edit and copy the text. This can be changed with the 'concealcursor'
1963 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001964
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1966'confirm' 'cf' boolean (default off)
1967 global
1968 {not in Vi}
1969 When 'confirm' is on, certain operations that would normally
1970 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1971 instead raise a |dialog| asking if you wish to save the current
1972 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1973 If 'confirm' is off you can still activate confirmation for one
1974 command only (this is most useful in mappings) with the |:confirm|
1975 command.
1976 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1977
1978 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1979'conskey' 'consk' boolean (default off)
1980 global
1981 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001982 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983
1984 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1985'copyindent' 'ci' boolean (default off)
1986 local to buffer
1987 {not in Vi}
1988 Copy the structure of the existing lines indent when autoindenting a
1989 new line. Normally the new indent is reconstructed by a series of
1990 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1991 in which case only spaces are used). Enabling this option makes the
1992 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001993 existing line. 'expandtab' has no effect on these characters, a Tab
1994 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 line, the remaining space is filled in the normal manner.
1996 NOTE: 'copyindent' is reset when 'compatible' is set.
1997 Also see 'preserveindent'.
1998
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001999 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000'cpoptions' 'cpo' string (Vim default: "aABceFs",
2001 Vi default: all flags)
2002 global
2003 {not in Vi}
2004 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002005 this indicates Vi-compatible behavior. This is used for things where
2006 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 'cpoptions' stands for "compatible-options".
2008 Commas can be added for readability.
2009 To avoid problems with flags that are added in the future, use the
2010 "+=" and "-=" feature of ":set" |add-option-flags|.
2011 NOTE: This option is set to the Vi default value when 'compatible' is
2012 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002013 NOTE: This option is set to the POSIX default value at startup when
2014 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002015 variable exists |posix|. This means Vim tries to behave like the
2016 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017
2018 contains behavior ~
2019 *cpo-a*
2020 a When included, a ":read" command with a file name
2021 argument will set the alternate file name for the
2022 current window.
2023 *cpo-A*
2024 A When included, a ":write" command with a file name
2025 argument will set the alternate file name for the
2026 current window.
2027 *cpo-b*
2028 b "\|" in a ":map" command is recognized as the end of
2029 the map command. The '\' is included in the mapping,
2030 the text after the '|' is interpreted as the next
2031 command. Use a CTRL-V instead of a backslash to
2032 include the '|' in the mapping. Applies to all
2033 mapping, abbreviation, menu and autocmd commands.
2034 See also |map_bar|.
2035 *cpo-B*
2036 B A backslash has no special meaning in mappings,
2037 abbreviations and the "to" part of the menu commands.
2038 Remove this flag to be able to use a backslash like a
2039 CTRL-V. For example, the command ":map X \<Esc>"
2040 results in X being mapped to:
2041 'B' included: "\^[" (^[ is a real <Esc>)
2042 'B' excluded: "<Esc>" (5 characters)
2043 ('<' excluded in both cases)
2044 *cpo-c*
2045 c Searching continues at the end of any match at the
2046 cursor position, but not further than the start of the
2047 next line. When not present searching continues
2048 one character from the cursor position. With 'c'
2049 "abababababab" only gets three matches when repeating
2050 "/abab", without 'c' there are five matches.
2051 *cpo-C*
2052 C Do not concatenate sourced lines that start with a
2053 backslash. See |line-continuation|.
2054 *cpo-d*
2055 d Using "./" in the 'tags' option doesn't mean to use
2056 the tags file relative to the current file, but the
2057 tags file in the current directory.
2058 *cpo-D*
2059 D Can't use CTRL-K to enter a digraph after Normal mode
2060 commands with a character argument, like |r|, |f| and
2061 |t|.
2062 *cpo-e*
2063 e When executing a register with ":@r", always add a
2064 <CR> to the last line, also when the register is not
2065 linewise. If this flag is not present, the register
2066 is not linewise and the last line does not end in a
2067 <CR>, then the last line is put on the command-line
2068 and can be edited before hitting <CR>.
2069 *cpo-E*
2070 E It is an error when using "y", "d", "c", "g~", "gu" or
2071 "gU" on an Empty region. The operators only work when
2072 at least one character is to be operate on. Example:
2073 This makes "y0" fail in the first column.
2074 *cpo-f*
2075 f When included, a ":read" command with a file name
2076 argument will set the file name for the current buffer,
2077 if the current buffer doesn't have a file name yet.
2078 *cpo-F*
2079 F When included, a ":write" command with a file name
2080 argument will set the file name for the current
2081 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002082 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 *cpo-g*
2084 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002085 *cpo-H*
2086 H When using "I" on a line with only blanks, insert
2087 before the last blank. Without this flag insert after
2088 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 *cpo-i*
2090 i When included, interrupting the reading of a file will
2091 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002092 *cpo-I*
2093 I When moving the cursor up or down just after inserting
2094 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 *cpo-j*
2096 j When joining lines, only add two spaces after a '.',
2097 not after '!' or '?'. Also see 'joinspaces'.
2098 *cpo-J*
2099 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002100 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 white space.
2102 *cpo-k*
2103 k Disable the recognition of raw key codes in
2104 mappings, abbreviations, and the "to" part of menu
2105 commands. For example, if <Key> sends ^[OA (where ^[
2106 is <Esc>), the command ":map X ^[OA" results in X
2107 being mapped to:
2108 'k' included: "^[OA" (3 characters)
2109 'k' excluded: "<Key>" (one key code)
2110 Also see the '<' flag below.
2111 *cpo-K*
2112 K Don't wait for a key code to complete when it is
2113 halfway a mapping. This breaks mapping <F1><F1> when
2114 only part of the second <F1> has been read. It
2115 enables cancelling the mapping by typing <F1><Esc>.
2116 *cpo-l*
2117 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002118 literally, only "\]", "\^", "\-" and "\\" are special.
2119 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2121 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002122 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 *cpo-L*
2124 L When the 'list' option is set, 'wrapmargin',
2125 'textwidth', 'softtabstop' and Virtual Replace mode
2126 (see |gR|) count a <Tab> as two characters, instead of
2127 the normal behavior of a <Tab>.
2128 *cpo-m*
2129 m When included, a showmatch will always wait half a
2130 second. When not included, a showmatch will wait half
2131 a second or until a character is typed. |'showmatch'|
2132 *cpo-M*
2133 M When excluded, "%" matching will take backslashes into
2134 account. Thus in "( \( )" and "\( ( \)" the outer
2135 parenthesis match. When included "%" ignores
2136 backslashes, which is Vi compatible.
2137 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002138 n When included, the column used for 'number' and
2139 'relativenumber' will also be used for text of wrapped
2140 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 *cpo-o*
2142 o Line offset to search command is not remembered for
2143 next search.
2144 *cpo-O*
2145 O Don't complain if a file is being overwritten, even
2146 when it didn't exist when editing it. This is a
2147 protection against a file unexpectedly created by
2148 someone else. Vi didn't complain about this.
2149 *cpo-p*
2150 p Vi compatible Lisp indenting. When not present, a
2151 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002152 *cpo-P*
2153 P When included, a ":write" command that appends to a
2154 file will set the file name for the current buffer, if
2155 the current buffer doesn't have a file name yet and
2156 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002157 *cpo-q*
2158 q When joining multiple lines leave the cursor at the
2159 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 *cpo-r*
2161 r Redo ("." command) uses "/" to repeat a search
2162 command, instead of the actually used search string.
2163 *cpo-R*
2164 R Remove marks from filtered lines. Without this flag
2165 marks are kept like |:keepmarks| was used.
2166 *cpo-s*
2167 s Set buffer options when entering the buffer for the
2168 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002169 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 set when the buffer is created.
2171 *cpo-S*
2172 S Set buffer options always when entering a buffer
2173 (except 'readonly', 'fileformat', 'filetype' and
2174 'syntax'). This is the (most) Vi compatible setting.
2175 The options are set to the values in the current
2176 buffer. When you change an option and go to another
2177 buffer, the value is copied. Effectively makes the
2178 buffer options global to all buffers.
2179
2180 's' 'S' copy buffer options
2181 no no when buffer created
2182 yes no when buffer first entered (default)
2183 X yes each time when buffer entered (vi comp.)
2184 *cpo-t*
2185 t Search pattern for the tag command is remembered for
2186 "n" command. Otherwise Vim only puts the pattern in
2187 the history for search pattern, but doesn't change the
2188 last used search pattern.
2189 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 *cpo-v*
2192 v Backspaced characters remain visible on the screen in
2193 Insert mode. Without this flag the characters are
2194 erased from the screen right away. With this flag the
2195 screen newly typed text overwrites backspaced
2196 characters.
2197 *cpo-w*
2198 w When using "cw" on a blank character, only change one
2199 character and not all blanks until the start of the
2200 next word.
2201 *cpo-W*
2202 W Don't overwrite a readonly file. When omitted, ":w!"
2203 overwrites a readonly file, if possible.
2204 *cpo-x*
2205 x <Esc> on the command-line executes the command-line.
2206 The default in Vim is to abandon the command-line,
2207 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002208 *cpo-X*
2209 X When using a count with "R" the replaced text is
2210 deleted only once. Also when repeating "R" with "."
2211 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 *cpo-y*
2213 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002214 *cpo-Z*
2215 Z When using "w!" while the 'readonly' option is set,
2216 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 *cpo-!*
2218 ! When redoing a filter command, use the last used
2219 external command, whatever it was. Otherwise the last
2220 used -filter- command is used.
2221 *cpo-$*
2222 $ When making a change to one line, don't redisplay the
2223 line, but put a '$' at the end of the changed text.
2224 The changed text will be overwritten when you type the
2225 new text. The line is redisplayed if you type any
2226 command that moves the cursor from the insertion
2227 point.
2228 *cpo-%*
2229 % Vi-compatible matching is done for the "%" command.
2230 Does not recognize "#if", "#endif", etc.
2231 Does not recognize "/*" and "*/".
2232 Parens inside single and double quotes are also
2233 counted, causing a string that contains a paren to
2234 disturb the matching. For example, in a line like
2235 "if (strcmp("foo(", s))" the first paren does not
2236 match the last one. When this flag is not included,
2237 parens inside single and double quotes are treated
2238 specially. When matching a paren outside of quotes,
2239 everything inside quotes is ignored. When matching a
2240 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002241 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002242 This flag is also used for other features, such as
2243 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002244 *cpo--*
2245 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002246 it would go above the first line or below the last
2247 line. Without it the cursor moves to the first or
2248 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002249 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002250 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002251 *cpo-+*
2252 + When included, a ":write file" command will reset the
2253 'modified' flag of the buffer, even though the buffer
2254 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002255 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 * Use ":*" in the same way as ":@". When not included,
2257 ":*" is an alias for ":'<,'>", select the Visual area.
2258 *cpo-<*
2259 < Disable the recognition of special key codes in |<>|
2260 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002261 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 ":map X <Tab>" results in X being mapped to:
2263 '<' included: "<Tab>" (5 characters)
2264 '<' excluded: "^I" (^I is a real <Tab>)
2265 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002266 *cpo->*
2267 > When appending to a register, put a line break before
2268 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002269 *cpo-;*
2270 ; When using |,| or |;| to repeat the last |t| search
2271 and the cursor is right in front of the searched
2272 character, the cursor won't move. When not included,
2273 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002274 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002275
2276 POSIX flags. These are not included in the Vi default value, except
2277 when $VIM_POSIX was set on startup. |posix|
2278
2279 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002280 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002281 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002282 *cpo-&*
2283 & When ":preserve" was used keep the swap file when
2284 exiting normally while this buffer is still loaded.
2285 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002286 *cpo-\*
2287 \ Backslash in a [] range in a search pattern is taken
2288 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002289 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2290 '\' excluded: "/[ \-]" finds <Space> and '-'
2291 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002292 *cpo-/*
2293 / When "%" is used as the replacement string in a |:s|
2294 command, use the previous replacement string. |:s%|
2295 *cpo-{*
2296 { The |{| and |}| commands also stop at a "{" character
2297 at the start of a line.
2298 *cpo-.*
2299 . The ":chdir" and ":cd" commands fail if the current
2300 buffer is modified, unless ! is used. Vim doesn't
2301 need this, since it remembers the full path of an
2302 opened file.
2303 *cpo-bar*
2304 | The value of the $LINES and $COLUMNS environment
2305 variables overrule the terminal size values obtained
2306 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002307
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002309 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002310'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002311 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002312 {not in Vi}
2313 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002314 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002315 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002316 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002317 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002318 blowfish Blowfish method. Medium strong encryption but it has
2319 an implementation flaw. Requires Vim 7.3 or later,
2320 files can NOT be read by Vim 7.2 and older. This adds
2321 a "seed" to the file, every time you write the file
2322 the encrypted bytes will be different.
2323 *blowfish2*
2324 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002325 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002326 and older. This adds a "seed" to the file, every time
2327 you write the file the encrypted bytes will be
2328 different. The whole undo file is encrypted, not just
2329 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002330
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002331 You should use "blowfish2", also to re-encrypt older files.
2332
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002333 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002334 to the detected method of the file being read. Thus if you write it
2335 without changing 'cryptmethod' the same method will be used.
2336 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002337 explicitly write it, you don't get a warning unless there are other
2338 modifications. Also see |:X|.
2339
2340 When setting the global value to an empty string, it will end up with
2341 the value "zip". When setting the local value to an empty string the
2342 buffer will use the global value.
2343
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002344 When a new encryption method is added in a later version of Vim, and
2345 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002346 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002347
2348
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 *'cscopepathcomp'* *'cspc'*
2350'cscopepathcomp' 'cspc' number (default 0)
2351 global
2352 {not available when compiled without the |+cscope|
2353 feature}
2354 {not in Vi}
2355 Determines how many components of the path to show in a list of tags.
2356 See |cscopepathcomp|.
2357
2358 *'cscopeprg'* *'csprg'*
2359'cscopeprg' 'csprg' string (default "cscope")
2360 global
2361 {not available when compiled without the |+cscope|
2362 feature}
2363 {not in Vi}
2364 Specifies the command to execute cscope. See |cscopeprg|.
2365 This option cannot be set from a |modeline| or in the |sandbox|, for
2366 security reasons.
2367
2368 *'cscopequickfix'* *'csqf'*
2369'cscopequickfix' 'csqf' string (default "")
2370 global
2371 {not available when compiled without the |+cscope|
2372 or |+quickfix| features}
2373 {not in Vi}
2374 Specifies whether to use quickfix window to show cscope results.
2375 See |cscopequickfix|.
2376
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002377 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002378'cscoperelative' 'csre' boolean (default off)
2379 global
2380 {not available when compiled without the |+cscope|
2381 feature}
2382 {not in Vi}
2383 In the absence of a prefix (-P) for cscope. setting this option enables
2384 to use the basename of cscope.out path as the prefix.
2385 See |cscoperelative|.
2386
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2388'cscopetag' 'cst' boolean (default off)
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
2392 {not in Vi}
2393 Use cscope for tag commands. See |cscope-options|.
2394 NOTE: This option is reset when 'compatible' is set.
2395
2396 *'cscopetagorder'* *'csto'*
2397'cscopetagorder' 'csto' number (default 0)
2398 global
2399 {not available when compiled without the |+cscope|
2400 feature}
2401 {not in Vi}
2402 Determines the order in which ":cstag" performs a search. See
2403 |cscopetagorder|.
2404 NOTE: This option is set to 0 when 'compatible' is set.
2405
2406 *'cscopeverbose'* *'csverb'*
2407 *'nocscopeverbose'* *'nocsverb'*
2408'cscopeverbose' 'csverb' boolean (default off)
2409 global
2410 {not available when compiled without the |+cscope|
2411 feature}
2412 {not in Vi}
2413 Give messages when adding a cscope database. See |cscopeverbose|.
2414 NOTE: This option is reset when 'compatible' is set.
2415
Bram Moolenaar860cae12010-06-05 23:22:07 +02002416 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2417'cursorbind' 'crb' boolean (default off)
2418 local to window
2419 {not in Vi}
2420 {not available when compiled without the |+cursorbind|
2421 feature}
2422 When this option is set, as the cursor in the current
2423 window moves other cursorbound windows (windows that also have
2424 this option set) move their cursors to the corresponding line and
2425 column. This option is useful for viewing the
2426 differences between two versions of a file (see 'diff'); in diff mode,
2427 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002428 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002429
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002430
2431 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2432'cursorcolumn' 'cuc' boolean (default off)
2433 local to window
2434 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002435 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002436 feature}
2437 Highlight the screen column of the cursor with CursorColumn
2438 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2439 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002440 If you only want the highlighting in the current window you can use
2441 these autocommands: >
2442 au WinLeave * set nocursorline nocursorcolumn
2443 au WinEnter * set cursorline cursorcolumn
2444<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002445
2446 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2447'cursorline' 'cul' boolean (default off)
2448 local to window
2449 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002450 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002451 feature}
2452 Highlight the screen line of the cursor with CursorLine
2453 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2454 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002455 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002456 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002457
2458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 *'debug'*
2460'debug' string (default "")
2461 global
2462 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002463 These values can be used:
2464 msg Error messages that would otherwise be omitted will be given
2465 anyway.
2466 throw Error messages that would otherwise be omitted will be given
2467 anyway and also throw an exception and set |v:errmsg|.
2468 beep A message will be given when otherwise only a beep would be
2469 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002470 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002471 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2472 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473
2474 *'define'* *'def'*
2475'define' 'def' string (default "^\s*#\s*define")
2476 global or local to buffer |global-local|
2477 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002478 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 pattern, just like for the "/" command. This option is used for the
2480 commands like "[i" and "[d" |include-search|. The 'isident' option is
2481 used to recognize the defined name after the match:
2482 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2483 See |option-backslash| about inserting backslashes to include a space
2484 or backslash.
2485 The default value is for C programs. For C++ this value would be
2486 useful, to include const type declarations: >
2487 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2488< When using the ":set" command, you need to double the backslashes!
2489
2490 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2491'delcombine' 'deco' boolean (default off)
2492 global
2493 {not in Vi}
2494 {only available when compiled with the |+multi_byte|
2495 feature}
2496 If editing Unicode and this option is set, backspace and Normal mode
2497 "x" delete each combining character on its own. When it is off (the
2498 default) the character along with its combining characters are
2499 deleted.
2500 Note: When 'delcombine' is set "xx" may work different from "2x"!
2501
2502 This is useful for Arabic, Hebrew and many other languages where one
2503 may have combining characters overtop of base characters, and want
2504 to remove only the combining ones.
2505
2506 *'dictionary'* *'dict'*
2507'dictionary' 'dict' string (default "")
2508 global or local to buffer |global-local|
2509 {not in Vi}
2510 List of file names, separated by commas, that are used to lookup words
2511 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2512 contain a list of words. This can be one word per line, or several
2513 words per line, separated by non-keyword characters (white space is
2514 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002515 When this option is empty, or an entry "spell" is present, spell
2516 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002517 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 after a comma are ignored, otherwise spaces are included in the file
2519 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002520 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 Where to find a list of words?
2522 - On FreeBSD, there is the file "/usr/share/dict/words".
2523 - In the Simtel archive, look in the "msdos/linguist" directory.
2524 - In "miscfiles" of the GNU collection.
2525 The use of |:set+=| and |:set-=| is preferred when adding or removing
2526 directories from the list. This avoids problems when a future version
2527 uses another default.
2528 Backticks cannot be used in this option for security reasons.
2529
2530 *'diff'* *'nodiff'*
2531'diff' boolean (default off)
2532 local to window
2533 {not in Vi}
2534 {not available when compiled without the |+diff|
2535 feature}
2536 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002537 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538
2539 *'dex'* *'diffexpr'*
2540'diffexpr' 'dex' string (default "")
2541 global
2542 {not in Vi}
2543 {not available when compiled without the |+diff|
2544 feature}
2545 Expression which is evaluated to obtain an ed-style diff file from two
2546 versions of a file. See |diff-diffexpr|.
2547 This option cannot be set from a |modeline| or in the |sandbox|, for
2548 security reasons.
2549
2550 *'dip'* *'diffopt'*
2551'diffopt' 'dip' string (default "filler")
2552 global
2553 {not in Vi}
2554 {not available when compiled without the |+diff|
2555 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002556 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 All are optional. Items must be separated by a comma.
2558
2559 filler Show filler lines, to keep the text
2560 synchronized with a window that has inserted
2561 lines at the same position. Mostly useful
2562 when windows are side-by-side and 'scrollbind'
2563 is set.
2564
2565 context:{n} Use a context of {n} lines between a change
2566 and a fold that contains unchanged lines.
2567 When omitted a context of six lines is used.
2568 See |fold-diff|.
2569
2570 icase Ignore changes in case of text. "a" and "A"
2571 are considered the same. Adds the "-i" flag
2572 to the "diff" command if 'diffexpr' is empty.
2573
2574 iwhite Ignore changes in amount of white space. Adds
2575 the "-b" flag to the "diff" command if
2576 'diffexpr' is empty. Check the documentation
2577 of the "diff" command for what this does
2578 exactly. It should ignore adding trailing
2579 white space, but not leading white space.
2580
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002581 horizontal Start diff mode with horizontal splits (unless
2582 explicitly specified otherwise).
2583
2584 vertical Start diff mode with vertical splits (unless
2585 explicitly specified otherwise).
2586
2587 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2588 starting diff mode. Without this 2 is used.
2589
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 Examples: >
2591
2592 :set diffopt=filler,context:4
2593 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002594 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595<
2596 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2597'digraph' 'dg' boolean (default off)
2598 global
2599 {not in Vi}
2600 {not available when compiled without the |+digraphs|
2601 feature}
2602 Enable the entering of digraphs in Insert mode with {char1} <BS>
2603 {char2}. See |digraphs|.
2604 NOTE: This option is reset when 'compatible' is set.
2605
2606 *'directory'* *'dir'*
2607'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002608 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 for Unix: ".,~/tmp,/var/tmp,/tmp")
2610 global
2611 List of directory names for the swap file, separated with commas.
2612 - The swap file will be created in the first directory where this is
2613 possible.
2614 - Empty means that no swap file will be used (recovery is
2615 impossible!).
2616 - A directory "." means to put the swap file in the same directory as
2617 the edited file. On Unix, a dot is prepended to the file name, so
2618 it doesn't show in a directory listing. On MS-Windows the "hidden"
2619 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002620 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 put the swap file relative to where the edited file is. The leading
2622 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002623 - For Unix and Win32, if a directory ends in two path separators "//"
2624 or "\\", the swap file name will be built from the complete path to
2625 the file with all path separators substituted to percent '%' signs.
2626 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002627 On Win32, when a separating comma is following, you must use "//",
2628 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002629 - Spaces after the comma are ignored, other spaces are considered part
2630 of the directory name. To have a space at the start of a directory
2631 name, precede it with a backslash.
2632 - To include a comma in a directory name precede it with a backslash.
2633 - A directory name may end in an ':' or '/'.
2634 - Environment variables are expanded |:set_env|.
2635 - Careful with '\' characters, type one before a space, type two to
2636 get one in the option (see |option-backslash|), for example: >
2637 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2638< - For backwards compatibility with Vim version 3.0 a '>' at the start
2639 of the option is removed.
2640 Using "." first in the list is recommended. This means that editing
2641 the same file twice will result in a warning. Using "/tmp" on Unix is
2642 discouraged: When the system crashes you lose the swap file.
2643 "/var/tmp" is often not cleared when rebooting, thus is a better
2644 choice than "/tmp". But it can contain a lot of files, your swap
2645 files get lost in the crowd. That is why a "tmp" directory in your
2646 home directory is tried first.
2647 The use of |:set+=| and |:set-=| is preferred when adding or removing
2648 directories from the list. This avoids problems when a future version
2649 uses another default.
2650 This option cannot be set from a |modeline| or in the |sandbox|, for
2651 security reasons.
2652 {Vi: directory to put temp file in, defaults to "/tmp"}
2653
2654 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002655'display' 'dy' string (default "", set to "truncate" in
2656 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 global
2658 {not in Vi}
2659 Change the way text is displayed. This is comma separated list of
2660 flags:
2661 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002662 in a window will be displayed. "@@@" is put in the
2663 last columns of the last screen line to indicate the
2664 rest of the line is not displayed.
2665 truncate Like "lastline", but "@@@" is displayed in the first
2666 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 uhex Show unprintable characters hexadecimal as <xx>
2668 instead of using ^C and ~C.
2669
Bram Moolenaard0796902016-09-16 20:02:31 +02002670 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002671 doesn't fit is replaced with "@" lines.
2672
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 *'eadirection'* *'ead'*
2674'eadirection' 'ead' string (default "both")
2675 global
2676 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002677 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 feature}
2679 Tells when the 'equalalways' option applies:
2680 ver vertically, width of windows is not affected
2681 hor horizontally, height of windows is not affected
2682 both width and height of windows is affected
2683
2684 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2685'edcompatible' 'ed' boolean (default off)
2686 global
2687 Makes the 'g' and 'c' flags of the ":substitute" command to be
2688 toggled each time the flag is given. See |complex-change|. See
2689 also 'gdefault' option.
2690 Switching this option on is discouraged!
2691
Bram Moolenaar03413f42016-04-12 21:07:15 +02002692 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002693'emoji' 'emo' boolean (default: on)
2694 global
2695 {not in Vi}
2696 {only available when compiled with the |+multi_byte|
2697 feature}
2698 When on all Unicode emoji characters are considered to be full width.
2699
2700
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 *'encoding'* *'enc'* *E543*
2702'encoding' 'enc' string (default: "latin1" or value from $LANG)
2703 global
2704 {only available when compiled with the |+multi_byte|
2705 feature}
2706 {not in Vi}
2707 Sets the character encoding used inside Vim. It applies to text in
2708 the buffers, registers, Strings in expressions, text stored in the
2709 viminfo file, etc. It sets the kind of characters which Vim can work
2710 with. See |encoding-names| for the possible values.
2711
2712 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002713 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002715 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716
Bram Moolenaar865242e2010-07-14 21:12:05 +02002717 This option cannot be set from a |modeline|. It would most likely
2718 corrupt the text.
2719
Bram Moolenaar3df01732017-02-17 22:47:16 +01002720 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2721 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 'encoding', "utf-8" is the natural choice for the environment and
2723 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002724 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 versions, and to avoid changing the encoding of newly created files
2726 without your knowledge (in case 'fileencodings' is empty).
2727
2728 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002729 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 iconv() or as specified with 'charconvert'.
2731
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002732 If you need to know whether 'encoding' is a multi-byte encoding, you
2733 can use: >
2734 if has("multi_byte_encoding")
2735<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 Normally 'encoding' will be equal to your current locale. This will
2737 be the default if Vim recognizes your environment settings. If
2738 'encoding' is not set to the current locale, 'termencoding' must be
2739 set to convert typed and displayed text. See |encoding-table|.
2740
2741 When you set this option, it fires the |EncodingChanged| autocommand
2742 event so that you can set up fonts if necessary.
2743
2744 When the option is set, the value is converted to lowercase. Thus
2745 you can set it with uppercase values too. Underscores are translated
2746 to '-' signs.
2747 When the encoding is recognized, it is changed to the standard name.
2748 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2749 "iso-8859-2" and "utf8" becomes "utf-8".
2750
2751 Note: "latin1" is also used when the encoding could not be detected.
2752 This only works when editing files in the same encoding! When the
2753 actual character set is not latin1, make sure 'fileencoding' and
2754 'fileencodings' are empty. When conversion is needed, switch to using
2755 utf-8.
2756
2757 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2758 You don't notice this while editing, but it does matter for the
2759 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2760 setting 'encoding' to one of these values instead of utf-8 only has
2761 effect for encoding used for files when 'fileencoding' is empty.
2762
Bram Moolenaar661b1822005-07-28 22:36:45 +00002763 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2764 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765
2766 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2767'endofline' 'eol' boolean (default on)
2768 local to buffer
2769 {not in Vi}
2770 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002771 is on, or 'fixeol' option is off, no <EOL> will be written for the
2772 last line in the file. This option is automatically set or reset when
2773 starting to edit a new file, depending on whether file has an <EOL>
2774 for the last line in the file. Normally you don't have to set or
2775 reset this option.
2776 When 'binary' is off and 'fixeol' is on the value is not used when
2777 writing the file. When 'binary' is on or 'fixeol' is off it is used
2778 to remember the presence of a <EOL> for the last line in the file, so
2779 that when you write the file the situation from the original file can
2780 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
2782 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2783'equalalways' 'ea' boolean (default on)
2784 global
2785 {not in Vi}
2786 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002787 splitting or closing a window. This also happens the moment the
2788 option is switched on. When off, splitting a window will reduce the
2789 size of the current window and leave the other windows the same. When
2790 closing a window the extra lines are given to the window next to it
2791 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 When mixing vertically and horizontally split windows, a minimal size
2793 is computed and some windows may be larger if there is room. The
2794 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002795 Changing the height and width of a window can be avoided by setting
2796 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002797 If a window size is specified when creating a new window sizes are
2798 currently not equalized (it's complicated, but may be implemented in
2799 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 *'equalprg'* *'ep'*
2802'equalprg' 'ep' string (default "")
2803 global or local to buffer |global-local|
2804 {not in Vi}
2805 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002806 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002807 or 'indentexpr'. When Vim was compiled without internal formatting,
2808 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002809 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 about including spaces and backslashes.
2811 This option cannot be set from a |modeline| or in the |sandbox|, for
2812 security reasons.
2813
2814 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2815'errorbells' 'eb' boolean (default off)
2816 global
2817 Ring the bell (beep or screen flash) for error messages. This only
2818 makes a difference for error messages, the bell will be used always
2819 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002820 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002821 screen flash or do nothing. See 'belloff' to finetune when to ring the
2822 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823
2824 *'errorfile'* *'ef'*
2825'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2826 others: "errors.err")
2827 global
2828 {not in Vi}
2829 {not available when compiled without the |+quickfix|
2830 feature}
2831 Name of the errorfile for the QuickFix mode (see |:cf|).
2832 When the "-q" command-line argument is used, 'errorfile' is set to the
2833 following argument. See |-q|.
2834 NOT used for the ":make" command. See 'makeef' for that.
2835 Environment variables are expanded |:set_env|.
2836 See |option-backslash| about including spaces and backslashes.
2837 This option cannot be set from a |modeline| or in the |sandbox|, for
2838 security reasons.
2839
2840 *'errorformat'* *'efm'*
2841'errorformat' 'efm' string (default is very long)
2842 global or local to buffer |global-local|
2843 {not in Vi}
2844 {not available when compiled without the |+quickfix|
2845 feature}
2846 Scanf-like description of the format for the lines in the error file
2847 (see |errorformat|).
2848
2849 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2850'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2851 global
2852 {not in Vi}
2853 Function keys that start with an <Esc> are recognized in Insert
2854 mode. When this option is off, the cursor and function keys cannot be
2855 used in Insert mode if they start with an <Esc>. The advantage of
2856 this is that the single <Esc> is recognized immediately, instead of
2857 after one second. Instead of resetting this option, you might want to
2858 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2859 when 'esckeys' is off, you can still map anything, but the cursor keys
2860 won't work by default.
2861 NOTE: This option is set to the Vi default value when 'compatible' is
2862 set and to the Vim default value when 'compatible' is reset.
2863
2864 *'eventignore'* *'ei'*
2865'eventignore' 'ei' string (default "")
2866 global
2867 {not in Vi}
2868 {not available when compiled without the |+autocmd|
2869 feature}
2870 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002871 When set to "all" or when "all" is one of the items, all autocommand
2872 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 Otherwise this is a comma separated list of event names. Example: >
2874 :set ei=WinEnter,WinLeave
2875<
2876 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2877'expandtab' 'et' boolean (default off)
2878 local to buffer
2879 {not in Vi}
2880 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2883 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002884 This option is reset when the 'paste' option is set and restored when
2885 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 NOTE: This option is reset when 'compatible' is set.
2887
2888 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2889'exrc' 'ex' boolean (default off)
2890 global
2891 {not in Vi}
2892 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002893 directory.
2894
2895 Setting this option is a potential security leak. E.g., consider
2896 unpacking a package or fetching files from github, a .vimrc in there
2897 might be a trojan horse. BETTER NOT SET THIS OPTION!
2898 Instead, define an autocommand in your .vimrc to set options for a
2899 matching directory.
2900
2901 If you do switch this option on you should also consider setting the
2902 'secure' option (see |initialization|).
2903 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 This option cannot be set from a |modeline| or in the |sandbox|, for
2905 security reasons.
2906
2907 *'fileencoding'* *'fenc'* *E213*
2908'fileencoding' 'fenc' string (default: "")
2909 local to buffer
2910 {only available when compiled with the |+multi_byte|
2911 feature}
2912 {not in Vi}
2913 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002914
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002916 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 When 'fileencoding' is empty, the same value as 'encoding' will be
2918 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002919 No error will be given when the value is set, only when it is used,
2920 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002921 Conversion will also be done when 'encoding' and 'fileencoding' are
2922 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2923 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002925 'encoding' is "utf-8" or another Unicode encoding, conversion
2926 is most likely done in a way that the reverse conversion
2927 results in the same text. When 'encoding' is not "utf-8" some
2928 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 See 'encoding' for the possible values. Additionally, values may be
2931 specified that can be handled by the converter, see
2932 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002933
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 When reading a file 'fileencoding' will be set from 'fileencodings'.
2935 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002936 'fileencoding', use the |++enc| argument. One exception: when
2937 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002938 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2941 When the option is set, the value is converted to lowercase. Thus
2942 you can set it with uppercase values too. '_' characters are
2943 replaced with '-'. If a name is recognized from the list for
2944 'encoding', it is replaced by the standard name. For example
2945 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002946
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 When this option is set, after starting to edit a file, the 'modified'
2948 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002949
2950 Keep in mind that changing 'fenc' from a modeline happens
2951 AFTER the text has been read, thus it applies to when the file will be
2952 written. If you do set 'fenc' in a modeline, you might want to set
2953 'nomodified' to avoid not being able to ":q".
2954
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 This option can not be changed when 'modifiable' is off.
2956
2957 *'fe'*
2958 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002959 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 old short name was 'fe', which is no longer used.
2961
2962 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002963'fileencodings' 'fencs' string (default: "ucs-bom",
2964 "ucs-bom,utf-8,default,latin1" when
2965 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 global
2967 {only available when compiled with the |+multi_byte|
2968 feature}
2969 {not in Vi}
2970 This is a list of character encodings considered when starting to edit
2971 an existing file. When a file is read, Vim tries to use the first
2972 mentioned character encoding. If an error is detected, the next one
2973 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 an empty string, which means the value of 'encoding' is used.
2976 WARNING: Conversion can cause loss of information! When
2977 'encoding' is "utf-8" (or one of the other Unicode variants)
2978 conversion is most likely done in a way that the reverse
2979 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002980 "utf-8" some non-ASCII characters may be lost! You can use
2981 the |++bad| argument to specify what is done with characters
2982 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 For an empty file or a file with only ASCII characters most encodings
2984 will work and the first entry of 'fileencodings' will be used (except
2985 "ucs-bom", which requires the BOM to be present). If you prefer
2986 another encoding use an BufReadPost autocommand event to test if your
2987 preferred encoding is to be used. Example: >
2988 au BufReadPost * if search('\S', 'w') == 0 |
2989 \ set fenc=iso-2022-jp | endif
2990< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2991 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002992 When the |++enc| argument is used then the value of 'fileencodings' is
2993 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002994 Note that 'fileencodings' is not used for a new file, the global value
2995 of 'fileencoding' is used instead. You can set it with: >
2996 :setglobal fenc=iso-8859-2
2997< This means that a non-existing file may get a different encoding than
2998 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 The special value "ucs-bom" can be used to check for a Unicode BOM
3000 (Byte Order Mark) at the start of the file. It must not be preceded
3001 by "utf-8" or another Unicode encoding for this to work properly.
3002 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3003 because Vim cannot detect an error, thus the encoding is always
3004 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003005 The special value "default" can be used for the encoding from the
3006 environment. This is the default value for 'encoding'. It is useful
3007 when 'encoding' is set to "utf-8" and your environment uses a
3008 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003009 When 'encoding' is "utf-8" and a file contains an illegal byte
3010 sequence it won't be recognized as UTF-8. You can use the |8g8|
3011 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 WRONG VALUES: WHAT'S WRONG:
3013 latin1,utf-8 "latin1" will always be used
3014 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3015 file
3016 cp1250,latin1 "cp1250" will always be used
3017 If 'fileencodings' is empty, 'fileencoding' is not modified.
3018 See 'fileencoding' for the possible values.
3019 Setting this option does not have an effect until the next time a file
3020 is read.
3021
3022 *'fileformat'* *'ff'*
3023'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3024 Unix default: "unix",
3025 Macintosh default: "mac")
3026 local to buffer
3027 {not in Vi}
3028 This gives the <EOL> of the current buffer, which is used for
3029 reading/writing the buffer from/to a file:
3030 dos <CR> <NL>
3031 unix <NL>
3032 mac <CR>
3033 When "dos" is used, CTRL-Z at the end of a file is ignored.
3034 See |file-formats| and |file-read|.
3035 For the character encoding of the file see 'fileencoding'.
3036 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003037 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 This option is set automatically when starting to edit a file and
3039 'fileformats' is not empty and 'binary' is off.
3040 When this option is set, after starting to edit a file, the 'modified'
3041 option is set, because the file would be different when written.
3042 This option can not be changed when 'modifiable' is off.
3043 For backwards compatibility: When this option is set to "dos",
3044 'textmode' is set, otherwise 'textmode' is reset.
3045
3046 *'fileformats'* *'ffs'*
3047'fileformats' 'ffs' string (default:
3048 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3049 Vim Unix: "unix,dos",
3050 Vim Mac: "mac,unix,dos",
3051 Vi Cygwin: "unix,dos",
3052 Vi others: "")
3053 global
3054 {not in Vi}
3055 This gives the end-of-line (<EOL>) formats that will be tried when
3056 starting to edit a new buffer and when reading a file into an existing
3057 buffer:
3058 - When empty, the format defined with 'fileformat' will be used
3059 always. It is not set automatically.
3060 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003061 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 'fileformats' name will be used when a file is read into an existing
3063 buffer, no matter what 'fileformat' for that buffer is set to.
3064 - When more than one name is present, separated by commas, automatic
3065 <EOL> detection will be done when reading a file. When starting to
3066 edit a file, a check is done for the <EOL>:
3067 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3068 'fileformat' is set to "dos".
3069 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003072 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3073 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003074 This means that "mac" is only chosen when:
3075 "unix" is not present or no <NL> is found in the file, and
3076 "dos" is not present or no <CR><NL> is found in the file.
3077 Except: if "unix" was chosen, but there is a <CR> before
3078 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003079 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 4. If 'fileformat' is still not set, the first name from
3081 'fileformats' is used.
3082 When reading a file into an existing buffer, the same is done, but
3083 this happens like 'fileformat' has been set appropriately for that
3084 file only, the option is not changed.
3085 When 'binary' is set, the value of 'fileformats' is not used.
3086
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003087 When Vim starts up with an empty buffer the first item is used. You
3088 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3091 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3092 done:
3093 - When 'fileformats' is empty, there is no automatic detection. Dos
3094 format will be used.
3095 - When 'fileformats' is set to one or more names, automatic detection
3096 is done. This is based on the first <NL> in the file: If there is a
3097 <CR> in front of it, Dos format is used, otherwise Unix format is
3098 used.
3099 Also see |file-formats|.
3100 For backwards compatibility: When this option is set to an empty
3101 string or one format (no comma is included), 'textauto' is reset,
3102 otherwise 'textauto' is set.
3103 NOTE: This option is set to the Vi default value when 'compatible' is
3104 set and to the Vim default value when 'compatible' is reset.
3105
Bram Moolenaarbf884932013-04-05 22:26:15 +02003106 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3107'fileignorecase' 'fic' boolean (default on for systems where case in file
3108 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003109 global
3110 {not in Vi}
3111 When set case is ignored when using file names and directories.
3112 See 'wildignorecase' for only ignoring case when doing completion.
3113
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 *'filetype'* *'ft'*
3115'filetype' 'ft' string (default: "")
3116 local to buffer
3117 {not in Vi}
3118 {not available when compiled without the |+autocmd|
3119 feature}
3120 When this option is set, the FileType autocommand event is triggered.
3121 All autocommands that match with the value of this option will be
3122 executed. Thus the value of 'filetype' is used in place of the file
3123 name.
3124 Otherwise this option does not always reflect the current file type.
3125 This option is normally set when the file type is detected. To enable
3126 this use the ":filetype on" command. |:filetype|
3127 Setting this option to a different value is most useful in a modeline,
3128 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003129 Example, for in an IDL file:
3130 /* vim: set filetype=idl : */ ~
3131 |FileType| |filetypes|
3132 When a dot appears in the value then this separates two filetype
3133 names. Example:
3134 /* vim: set filetype=c.doxygen : */ ~
3135 This will use the "c" filetype first, then the "doxygen" filetype.
3136 This works both for filetype plugins and for syntax files. More than
3137 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 This option is not copied to another buffer, independent of the 's' or
3139 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003140 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141
3142 *'fillchars'* *'fcs'*
3143'fillchars' 'fcs' string (default "vert:|,fold:-")
3144 global
3145 {not in Vi}
3146 {not available when compiled without the |+windows|
3147 and |+folding| features}
3148 Characters to fill the statuslines and vertical separators.
3149 It is a comma separated list of items:
3150
3151 item default Used for ~
3152 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003153 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 vert:c '|' vertical separators |:vsplit|
3155 fold:c '-' filling 'foldtext'
3156 diff:c '-' deleted lines of the 'diff' option
3157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003158 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003159 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 otherwise.
3161
3162 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003163 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164< This is similar to the default, except that these characters will also
3165 be used when there is highlighting.
3166
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003167 for "stl" and "stlnc" only single-byte values are supported.
3168
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 The highlighting used for these items:
3170 item highlight group ~
3171 stl:c StatusLine |hl-StatusLine|
3172 stlnc:c StatusLineNC |hl-StatusLineNC|
3173 vert:c VertSplit |hl-VertSplit|
3174 fold:c Folded |hl-Folded|
3175 diff:c DiffDelete |hl-DiffDelete|
3176
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003177 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3178'fixendofline' 'fixeol' boolean (default on)
3179 local to buffer
3180 {not in Vi}
3181 When writing a file and this option is on, <EOL> at the end of file
3182 will be restored if missing. Turn this option off if you want to
3183 preserve the situation from the original file.
3184 When the 'binary' option is set the value of this option doesn't
3185 matter.
3186 See the 'endofline' option.
3187
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3189'fkmap' 'fk' boolean (default off) *E198*
3190 global
3191 {not in Vi}
3192 {only available when compiled with the |+rightleft|
3193 feature}
3194 When on, the keyboard is mapped for the Farsi character set.
3195 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003196 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
3198 *'foldclose'* *'fcl'*
3199'foldclose' 'fcl' string (default "")
3200 global
3201 {not in Vi}
3202 {not available when compiled without the |+folding|
3203 feature}
3204 When set to "all", a fold is closed when the cursor isn't in it and
3205 its level is higher than 'foldlevel'. Useful if you want folds to
3206 automatically close when moving out of them.
3207
3208 *'foldcolumn'* *'fdc'*
3209'foldcolumn' 'fdc' number (default 0)
3210 local to window
3211 {not in Vi}
3212 {not available when compiled without the |+folding|
3213 feature}
3214 When non-zero, a column with the specified width is shown at the side
3215 of the window which indicates open and closed folds. The maximum
3216 value is 12.
3217 See |folding|.
3218
3219 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3220'foldenable' 'fen' boolean (default on)
3221 local to window
3222 {not in Vi}
3223 {not available when compiled without the |+folding|
3224 feature}
3225 When off, all folds are open. This option can be used to quickly
3226 switch between showing all text unfolded and viewing the text with
3227 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003228 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 'foldenable' is off.
3230 This option is set by commands that create a new fold or close a fold.
3231 See |folding|.
3232
3233 *'foldexpr'* *'fde'*
3234'foldexpr' 'fde' string (default: "0")
3235 local to window
3236 {not in Vi}
3237 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003238 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003240 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003241
Bram Moolenaar30b65812012-07-12 22:01:11 +02003242 The expression will be evaluated in the |sandbox| if set from a
3243 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003244 This option can't be set from a |modeline| when the 'diff' option is
3245 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003246
3247 It is not allowed to change text or jump to another window while
3248 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249
3250 *'foldignore'* *'fdi'*
3251'foldignore' 'fdi' string (default: "#")
3252 local to window
3253 {not in Vi}
3254 {not available when compiled without the |+folding|
3255 feature}
3256 Used only when 'foldmethod' is "indent". Lines starting with
3257 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003258 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 The default "#" works well for C programs. See |fold-indent|.
3260
3261 *'foldlevel'* *'fdl'*
3262'foldlevel' 'fdl' number (default: 0)
3263 local to window
3264 {not in Vi}
3265 {not available when compiled without the |+folding|
3266 feature}
3267 Sets the fold level: Folds with a higher level will be closed.
3268 Setting this option to zero will close all folds. Higher numbers will
3269 close fewer folds.
3270 This option is set by commands like |zm|, |zM| and |zR|.
3271 See |fold-foldlevel|.
3272
3273 *'foldlevelstart'* *'fdls'*
3274'foldlevelstart' 'fdls' number (default: -1)
3275 global
3276 {not in Vi}
3277 {not available when compiled without the |+folding|
3278 feature}
3279 Sets 'foldlevel' when starting to edit another buffer in a window.
3280 Useful to always start editing with all folds closed (value zero),
3281 some folds closed (one) or no folds closed (99).
3282 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003283 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 ignores this option and closes all folds.
3285 It is also done before BufReadPre autocommands, to allow an autocmd to
3286 overrule the 'foldlevel' value for specific files.
3287 When the value is negative, it is not used.
3288
3289 *'foldmarker'* *'fmr'* *E536*
3290'foldmarker' 'fmr' string (default: "{{{,}}}")
3291 local to window
3292 {not in Vi}
3293 {not available when compiled without the |+folding|
3294 feature}
3295 The start and end marker used when 'foldmethod' is "marker". There
3296 must be one comma, which separates the start and end marker. The
3297 marker is a literal string (a regular expression would be too slow).
3298 See |fold-marker|.
3299
3300 *'foldmethod'* *'fdm'*
3301'foldmethod' 'fdm' string (default: "manual")
3302 local to window
3303 {not in Vi}
3304 {not available when compiled without the |+folding|
3305 feature}
3306 The kind of folding used for the current window. Possible values:
3307 |fold-manual| manual Folds are created manually.
3308 |fold-indent| indent Lines with equal indent form a fold.
3309 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3310 |fold-marker| marker Markers are used to specify folds.
3311 |fold-syntax| syntax Syntax highlighting items specify folds.
3312 |fold-diff| diff Fold text that is not changed.
3313
3314 *'foldminlines'* *'fml'*
3315'foldminlines' 'fml' number (default: 1)
3316 local to window
3317 {not in Vi}
3318 {not available when compiled without the |+folding|
3319 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003320 Sets the number of screen lines above which a fold can be displayed
3321 closed. Also for manually closed folds. With the default value of
3322 one a fold can only be closed if it takes up two or more screen lines.
3323 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003324 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 "zc" to close a fold, which is displayed open because it's smaller
3326 than 'foldminlines', a following "zc" may close a containing fold.
3327
3328 *'foldnestmax'* *'fdn'*
3329'foldnestmax' 'fdn' number (default: 20)
3330 local to window
3331 {not in Vi}
3332 {not available when compiled without the |+folding|
3333 feature}
3334 Sets the maximum nesting of folds for the "indent" and "syntax"
3335 methods. This avoids that too many folds will be created. Using more
3336 than 20 doesn't work, because the internal limit is 20.
3337
3338 *'foldopen'* *'fdo'*
3339'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3340 search,tag,undo")
3341 global
3342 {not in Vi}
3343 {not available when compiled without the |+folding|
3344 feature}
3345 Specifies for which type of commands folds will be opened, if the
3346 command moves the cursor into a closed fold. It is a comma separated
3347 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003348 NOTE: When the command is part of a mapping this option is not used.
3349 Add the |zv| command to the mapping to get the same effect.
3350 (rationale: the mapping may want to control opening folds itself)
3351
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 item commands ~
3353 all any
3354 block "(", "{", "[[", "[{", etc.
3355 hor horizontal movements: "l", "w", "fx", etc.
3356 insert any command in Insert mode
3357 jump far jumps: "G", "gg", etc.
3358 mark jumping to a mark: "'m", CTRL-O, etc.
3359 percent "%"
3360 quickfix ":cn", ":crew", ":make", etc.
3361 search search for a pattern: "/", "n", "*", "gd", etc.
3362 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003363 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 tag jumping to a tag: ":ta", CTRL-T, etc.
3365 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 When a movement command is used for an operator (e.g., "dl" or "y%")
3367 this option is not used. This means the operator will include the
3368 whole closed fold.
3369 Note that vertical movements are not here, because it would make it
3370 very difficult to move onto a closed fold.
3371 In insert mode the folds containing the cursor will always be open
3372 when text is inserted.
3373 To close folds you can re-apply 'foldlevel' with the |zx| command or
3374 set the 'foldclose' option to "all".
3375
3376 *'foldtext'* *'fdt'*
3377'foldtext' 'fdt' string (default: "foldtext()")
3378 local to window
3379 {not in Vi}
3380 {not available when compiled without the |+folding|
3381 feature}
3382 An expression which is used to specify the text displayed for a closed
3383 fold. See |fold-foldtext|.
3384
Bram Moolenaar30b65812012-07-12 22:01:11 +02003385 The expression will be evaluated in the |sandbox| if set from a
3386 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003387
3388 It is not allowed to change text or jump to another window while
3389 evaluating 'foldtext' |textlock|.
3390
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003391 *'formatexpr'* *'fex'*
3392'formatexpr' 'fex' string (default "")
3393 local to buffer
3394 {not in Vi}
3395 {not available when compiled without the |+eval|
3396 feature}
3397 Expression which is evaluated to format a range of lines for the |gq|
3398 operator or automatic formatting (see 'formatoptions'). When this
3399 option is empty 'formatprg' is used.
3400
3401 The |v:lnum| variable holds the first line to be formatted.
3402 The |v:count| variable holds the number of lines to be formatted.
3403 The |v:char| variable holds the character that is going to be
3404 inserted if the expression is being evaluated due to
3405 automatic formatting. This can be empty. Don't insert
3406 it yet!
3407
3408 Example: >
3409 :set formatexpr=mylang#Format()
3410< This will invoke the mylang#Format() function in the
3411 autoload/mylang.vim file in 'runtimepath'. |autoload|
3412
3413 The expression is also evaluated when 'textwidth' is set and adding
3414 text beyond that limit. This happens under the same conditions as
3415 when internal formatting is used. Make sure the cursor is kept in the
3416 same spot relative to the text then! The |mode()| function will
3417 return "i" or "R" in this situation.
3418
3419 When the expression evaluates to non-zero Vim will fall back to using
3420 the internal format mechanism.
3421
3422 The expression will be evaluated in the |sandbox| when set from a
3423 modeline, see |sandbox-option|. That stops the option from working,
3424 since changing the buffer text is not allowed.
3425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 *'formatoptions'* *'fo'*
3427'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3428 local to buffer
3429 {not in Vi}
3430 This is a sequence of letters which describes how automatic
3431 formatting is to be done. See |fo-table|. When the 'paste' option is
3432 on, no formatting is done (like 'formatoptions' is empty). Commas can
3433 be inserted for readability.
3434 To avoid problems with flags that are added in the future, use the
3435 "+=" and "-=" feature of ":set" |add-option-flags|.
3436 NOTE: This option is set to the Vi default value when 'compatible' is
3437 set and to the Vim default value when 'compatible' is reset.
3438
Bram Moolenaar86b68352004-12-27 21:59:20 +00003439 *'formatlistpat'* *'flp'*
3440'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3441 local to buffer
3442 {not in Vi}
3443 A pattern that is used to recognize a list header. This is used for
3444 the "n" flag in 'formatoptions'.
3445 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003446 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003447 while still checking more characters. There must be a character
3448 following the pattern, when it matches the whole line it is handled
3449 like there is no match.
3450 The default recognizes a number, followed by an optional punctuation
3451 character and white space.
3452
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 *'formatprg'* *'fp'*
3454'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003455 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 {not in Vi}
3457 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003458 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003460 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003461 If the 'formatexpr' option is not empty it will be used instead.
3462 Otherwise, if 'formatprg' option is an empty string, the internal
3463 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003464 Environment variables are expanded |:set_env|. See |option-backslash|
3465 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003466 This option cannot be set from a |modeline| or in the |sandbox|, for
3467 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468
Bram Moolenaard94464e2015-11-02 15:28:18 +01003469 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003470'fsync' 'fs' boolean (default on)
3471 global
3472 {not in Vi}
3473 When on, the library function fsync() will be called after writing a
3474 file. This will flush a file to disk, ensuring that it is safely
3475 written even on filesystems which do metadata-only journaling. This
3476 will force the harddrive to spin up on Linux systems running in laptop
3477 mode, so it may be undesirable in some situations. Be warned that
3478 turning this off increases the chances of data loss after a crash. On
3479 systems without an fsync() implementation, this variable is always
3480 off.
3481 Also see 'swapsync' for controlling fsync() on swap files.
3482
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3484'gdefault' 'gd' boolean (default off)
3485 global
3486 {not in Vi}
3487 When on, the ":substitute" flag 'g' is default on. This means that
3488 all matches in a line are substituted instead of one. When a 'g' flag
3489 is given to a ":substitute" command, this will toggle the substitution
3490 of all or one match. See |complex-change|.
3491
3492 command 'gdefault' on 'gdefault' off ~
3493 :s/// subst. all subst. one
3494 :s///g subst. one subst. all
3495 :s///gg subst. all subst. one
3496
3497 NOTE: This option is reset when 'compatible' is set.
3498
3499 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003500'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 global
3502 {not in Vi}
3503 Format to recognize for the ":grep" command output.
3504 This is a scanf-like string that uses the same format as the
3505 'errorformat' option: see |errorformat|.
3506
3507 *'grepprg'* *'gp'*
3508'grepprg' 'gp' string (default "grep -n ",
3509 Unix: "grep -n $* /dev/null",
3510 Win32: "findstr /n" or "grep -n",
3511 VMS: "SEARCH/NUMBERS ")
3512 global or local to buffer |global-local|
3513 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003514 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 and '#' characters, which are expanded like when used in a command-
3516 line. The placeholder "$*" is allowed to specify where the arguments
3517 will be included. Environment variables are expanded |:set_env|. See
3518 |option-backslash| about including spaces and backslashes.
3519 When your "grep" accepts the "-H" argument, use this to make ":grep"
3520 also work well with a single file: >
3521 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003522< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003523 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3524 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003525 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 apply equally to 'grepprg'.
3527 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3528 otherwise it's "grep -n".
3529 This option cannot be set from a |modeline| or in the |sandbox|, for
3530 security reasons.
3531
3532 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3533'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3534 ve:ver35-Cursor,
3535 o:hor50-Cursor,
3536 i-ci:ver25-Cursor/lCursor,
3537 r-cr:hor20-Cursor/lCursor,
3538 sm:block-Cursor
3539 -blinkwait175-blinkoff150-blinkon175",
3540 for MS-DOS and Win32 console:
3541 "n-v-c:block,o:hor50,i-ci:hor15,
3542 r-cr:hor30,sm:block")
3543 global
3544 {not in Vi}
3545 {only available when compiled with GUI enabled, and
3546 for MS-DOS and Win32 console}
3547 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003548 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 the height of the cursor can be changed. This can be done by
3550 specifying a block cursor, or a percentage for a vertical or
3551 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003552 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3553 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003555 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 mode-list and an argument-list:
3557 mode-list:argument-list,mode-list:argument-list,..
3558 The mode-list is a dash separated list of these modes:
3559 n Normal mode
3560 v Visual mode
3561 ve Visual mode with 'selection' "exclusive" (same as 'v',
3562 if not specified)
3563 o Operator-pending mode
3564 i Insert mode
3565 r Replace mode
3566 c Command-line Normal (append) mode
3567 ci Command-line Insert mode
3568 cr Command-line Replace mode
3569 sm showmatch in Insert mode
3570 a all modes
3571 The argument-list is a dash separated list of these arguments:
3572 hor{N} horizontal bar, {N} percent of the character height
3573 ver{N} vertical bar, {N} percent of the character width
3574 block block cursor, fills the whole character
3575 [only one of the above three should be present]
3576 blinkwait{N} *cursor-blinking*
3577 blinkon{N}
3578 blinkoff{N}
3579 blink times for cursor: blinkwait is the delay before
3580 the cursor starts blinking, blinkon is the time that
3581 the cursor is shown and blinkoff is the time that the
3582 cursor is not shown. The times are in msec. When one
3583 of the numbers is zero, there is no blinking. The
3584 default is: "blinkwait700-blinkon400-blinkoff250".
3585 These numbers are used for a missing entry. This
3586 means that blinking is enabled by default. To switch
3587 blinking off you can use "blinkon0". The cursor only
3588 blinks when Vim is waiting for input, not while
3589 executing a command.
3590 To make the cursor blink in an xterm, see
3591 |xterm-blink|.
3592 {group-name}
3593 a highlight group name, that sets the color and font
3594 for the cursor
3595 {group-name}/{group-name}
3596 Two highlight group names, the first is used when
3597 no language mappings are used, the other when they
3598 are. |language-mapping|
3599
3600 Examples of parts:
3601 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3602 block cursor with colors from the "nCursor"
3603 highlight group
3604 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3605 In Insert and Command-line Insert mode, use a
3606 30% vertical bar cursor with colors from the
3607 "iCursor" highlight group. Blink a bit
3608 faster.
3609
3610 The 'a' mode is different. It will set the given argument-list for
3611 all modes. It does not reset anything to defaults. This can be used
3612 to do a common setting for all modes. For example, to switch off
3613 blinking: "a:blinkon0"
3614
3615 Examples of cursor highlighting: >
3616 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3617 :highlight Cursor gui=NONE guifg=bg guibg=fg
3618<
3619 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003620 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621'guifont' 'gfn' string (default "")
3622 global
3623 {not in Vi}
3624 {only available when compiled with GUI enabled}
3625 This is a list of fonts which will be used for the GUI version of Vim.
3626 In its simplest form the value is just one font name. When
3627 the font cannot be found you will get an error message. To try other
3628 font names a list can be specified, font names separated with commas.
3629 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003630
Bram Moolenaar05159a02005-02-26 23:04:13 +00003631 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3632 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003633
Bram Moolenaar3df01732017-02-17 22:47:16 +01003634 Note: As to the GTK GUIs, no error is given against any invalid names,
3635 and the first element of the list is always picked up and made use of.
3636 This is because, instead of identifying a given name with a font, the
3637 GTK GUIs use it to construct a pattern and try to look up a font which
3638 best matches the pattern among available fonts, and this way, the
3639 matching never fails. An invalid name doesn't matter because a number
3640 of font properties other than name will do to get the matching done.
3641
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 Spaces after a comma are ignored. To include a comma in a font name
3643 precede it with a backslash. Setting an option requires an extra
3644 backslash before a space and a backslash. See also
3645 |option-backslash|. For example: >
3646 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003647< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003649
3650 If none of the fonts can be loaded, Vim will keep the current setting.
3651 If an empty font list is given, Vim will try using other resource
3652 settings (for X, it will use the Vim.font resource), and finally it
3653 will try some builtin default which should always be there ("7x13" in
3654 the case of X). The font names given should be "normal" fonts. Vim
3655 will try to find the related bold and italic fonts.
3656
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003657 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003658 :set guifont=*
3659< will bring up a font requester, where you can pick the font you want.
3660
3661 The font name depends on the GUI used. See |setting-guifont| for a
3662 way to set 'guifont' for various systems.
3663
Bram Moolenaar3df01732017-02-17 22:47:16 +01003664 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003666< That's all. XLFDs are not used. For Chinese this is reported to work
3667 well: >
3668 if has("gui_gtk2")
3669 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3670 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3671 endif
3672<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003673 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3674
Bram Moolenaar05159a02005-02-26 23:04:13 +00003675 For Mac OSX you can use something like this: >
3676 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003677< Also see 'macatsui', it can help fix display problems.
3678 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003680 width). An exception is GTK: all fonts are accepted, but mono-spaced
3681 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003682
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 To preview a font on X11, you might be able to use the "xfontsel"
3684 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003685
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 For the Win32 GUI *E244* *E245*
3687 - takes these options in the font name:
3688 hXX - height is XX (points, can be floating-point)
3689 wXX - width is XX (points, can be floating-point)
3690 b - bold
3691 i - italic
3692 u - underline
3693 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003694 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3696 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3697 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003698 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003699 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003700 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003701 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003702 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703
3704 Use a ':' to separate the options.
3705 - A '_' can be used in the place of a space, so you don't need to use
3706 backslashes to escape the spaces.
3707 - Examples: >
3708 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3709 :set guifont=Andale_Mono:h7.5:w4.5
3710< See also |font-sizes|.
3711
3712 *'guifontset'* *'gfs'*
3713 *E250* *E252* *E234* *E597* *E598*
3714'guifontset' 'gfs' string (default "")
3715 global
3716 {not in Vi}
3717 {only available when compiled with GUI enabled and
3718 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003719 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 When not empty, specifies two (or more) fonts to be used. The first
3721 one for normal English, the second one for your special language. See
3722 |xfontset|.
3723 Setting this option also means that all font names will be handled as
3724 a fontset name. Also the ones used for the "font" argument of the
3725 |:highlight| command.
3726 The fonts must match with the current locale. If fonts for the
3727 character sets that the current locale uses are not included, setting
3728 'guifontset' will fail.
3729 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3730 the comma-separated names are alternative names, one of which will be
3731 used. In 'guifontset' the whole string is one fontset name,
3732 including the commas. It is not possible to specify alternative
3733 fontset names.
3734 This example works on many X11 systems: >
3735 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3736<
3737 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3738'guifontwide' 'gfw' string (default "")
3739 global
3740 {not in Vi}
3741 {only available when compiled with GUI enabled}
3742 When not empty, specifies a comma-separated list of fonts to be used
3743 for double-width characters. The first font that can be loaded is
3744 used.
3745 Note: The size of these fonts must be exactly twice as wide as the one
3746 specified with 'guifont' and the same height.
3747
Bram Moolenaar3df01732017-02-17 22:47:16 +01003748 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749
3750 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3751 'guifontset' is empty or invalid.
3752 When 'guifont' is set and a valid font is found in it and
3753 'guifontwide' is empty Vim will attempt to find a matching
3754 double-width font and set 'guifontwide' to it.
3755
Bram Moolenaar3df01732017-02-17 22:47:16 +01003756 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757
3758 If set and valid, 'guifontwide' is always used for double width
3759 characters, even if 'encoding' is not set to "utf-8".
3760 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003761 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 font for characters not available in 'guifont'. Thus you do not need
3763 to set 'guifontwide' at all unless you want to override the choice
3764 made by Pango/Xft.
3765
Bram Moolenaar0f272122013-01-23 18:37:40 +01003766 Windows +multibyte only: *guifontwide_win_mbyte*
3767
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003768 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003769
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 *'guiheadroom'* *'ghr'*
3771'guiheadroom' 'ghr' number (default 50)
3772 global
3773 {not in Vi} {only for GTK and X11 GUI}
3774 The number of pixels subtracted from the screen height when fitting
3775 the GUI window on the screen. Set this before the GUI is started,
3776 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003777 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 lines will be left for window decorations and other items on the
3779 screen. Set it to a negative value to allow windows taller than the
3780 screen.
3781
3782 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003783'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3784 removed in |defaults.vim|),
3785 "aegimrLtT" (GTK, Motif and Athena),
3786 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 global
3788 {not in Vi}
3789 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003790 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 sequence of letters which describes what components and options of the
3792 GUI should be used.
3793 To avoid problems with flags that are added in the future, use the
3794 "+=" and "-=" feature of ":set" |add-option-flags|.
3795
3796 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003797 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 'a' Autoselect: If present, then whenever VISUAL mode is started,
3799 or the Visual area extended, Vim tries to become the owner of
3800 the windowing system's global selection. This means that the
3801 Visually highlighted text is available for pasting into other
3802 applications as well as into Vim itself. When the Visual mode
3803 ends, possibly due to an operation on the text, or when an
3804 application wants to paste the selection, the highlighted text
3805 is automatically yanked into the "* selection register.
3806 Thus the selection is still available for pasting into other
3807 applications after the VISUAL mode has ended.
3808 If not present, then Vim won't become the owner of the
3809 windowing system's global selection unless explicitly told to
3810 by a yank or delete operation for the "* register.
3811 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003812 *'go-P'*
3813 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003814 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003815 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003816 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 applies to the modeless selection.
3818
3819 'guioptions' autoselect Visual autoselect modeless ~
3820 "" - -
3821 "a" yes yes
3822 "A" - yes
3823 "aA" yes yes
3824
Bram Moolenaar02467872007-05-06 13:22:01 +00003825 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'c' Use console dialogs instead of popup dialogs for simple
3827 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003828 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003829 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003830 'guitablabel' can be used to change the text in the labels.
3831 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003832 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003833 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003834 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'f' Foreground: Don't use fork() to detach the GUI from the shell
3836 where it was started. Use this for programs that wait for the
3837 editor to finish (e.g., an e-mail program). Alternatively you
3838 can use "gvim -f" or ":gui -f" to start the GUI in the
3839 foreground. |gui-fork|
3840 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003841 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003842 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3844 corner of the window. It's black&white on non-GTK, because of
3845 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003846 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003848 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003849 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003851 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 file is sourced the system menu has already been loaded; the
3853 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003854 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'g' Grey menu items: Make menu items that are not active grey. If
3856 'g' is not included inactive menu items are not shown at all.
3857 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003858 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 't' Include tearoff menu items. Currently only works for Win32,
3860 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003861 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003862 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003863 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003864 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003866 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 'R' Right-hand scrollbar is present when there is a vertically
3868 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003869 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003871 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 'L' Left-hand scrollbar is present when there is a vertically
3873 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003874 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3876 the longest visible line, or on the cursor line if the 'h'
3877 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003878 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 'h' Limit horizontal scrollbar size to the length of the cursor
3880 line. Reduces computations. |gui-horiz-scroll|
3881
3882 And yes, you may even have scrollbars on the left AND the right if
3883 you really want to :-). See |gui-scrollbars| for more information.
3884
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003885 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 'v' Use a vertical button layout for dialogs. When not included,
3887 a horizontal layout is preferred, but when it doesn't fit a
3888 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003889 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'p' Use Pointer callbacks for X11 GUI. This is required for some
3891 window managers. If the cursor is not blinking or hollow at
3892 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003893 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003895 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003896 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897
Bram Moolenaar02467872007-05-06 13:22:01 +00003898
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 *'guipty'* *'noguipty'*
3900'guipty' boolean (default on)
3901 global
3902 {not in Vi}
3903 {only available when compiled with GUI enabled}
3904 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3905 I/O to/from shell commands. See |gui-pty|.
3906
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003907 *'guitablabel'* *'gtl'*
3908'guitablabel' 'gtl' string (default empty)
3909 global
3910 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003911 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003912 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003913 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003914 pages line. When empty and when the result is empty Vim will use a
3915 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003916
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003917 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003918 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003919 The expression will be evaluated in the |sandbox| when set from a
3920 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003921
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003922 Only used when the GUI tab pages line is displayed. 'e' must be
3923 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3924 used.
3925
Bram Moolenaar57657d82006-04-21 22:12:41 +00003926 *'guitabtooltip'* *'gtt'*
3927'guitabtooltip' 'gtt' string (default empty)
3928 global
3929 {not in Vi}
3930 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003931 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003932 When nonempty describes the text to use in a tooltip for the GUI tab
3933 pages line. When empty Vim will use a default tooltip.
3934 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003935 You can include a line break. Simplest method is to use |:let|: >
3936 :let &guitabtooltip = "line one\nline two"
3937<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003938
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 *'helpfile'* *'hf'*
3940'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3941 (others) "$VIMRUNTIME/doc/help.txt")
3942 global
3943 {not in Vi}
3944 Name of the main help file. All distributed help files should be
3945 placed together in one directory. Additionally, all "doc" directories
3946 in 'runtimepath' will be used.
3947 Environment variables are expanded |:set_env|. For example:
3948 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 spaces and backslashes.
3951 This option cannot be set from a |modeline| or in the |sandbox|, for
3952 security reasons.
3953
3954 *'helpheight'* *'hh'*
3955'helpheight' 'hh' number (default 20)
3956 global
3957 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003958 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 feature}
3960 Minimal initial height of the help window when it is opened with the
3961 ":help" command. The initial height of the help window is half of the
3962 current window, or (when the 'ea' option is on) the same as other
3963 windows. When the height is less than 'helpheight', the height is
3964 set to 'helpheight'. Set to zero to disable.
3965
3966 *'helplang'* *'hlg'*
3967'helplang' 'hlg' string (default: messages language or empty)
3968 global
3969 {only available when compiled with the |+multi_lang|
3970 feature}
3971 {not in Vi}
3972 Comma separated list of languages. Vim will use the first language
3973 for which the desired help can be found. The English help will always
3974 be used as a last resort. You can add "en" to prefer English over
3975 another language, but that will only find tags that exist in that
3976 language and not in the English help.
3977 Example: >
3978 :set helplang=de,it
3979< This will first search German, then Italian and finally English help
3980 files.
3981 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3982 try to find the tag in the current language before using this option.
3983 See |help-translated|.
3984
3985 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3986'hidden' 'hid' boolean (default off)
3987 global
3988 {not in Vi}
3989 When off a buffer is unloaded when it is |abandon|ed. When on a
3990 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3991 displayed in another window, it does not become hidden, of course.
3992 The commands that move through the buffer list sometimes make a buffer
3993 hidden although the 'hidden' option is off: When the buffer is
3994 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003995 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003996 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 This option is set for one command with ":hide {command}" |:hide|.
3998 WARNING: It's easy to forget that you have changes in hidden buffers.
3999 Think twice when using ":q!" or ":qa!".
4000
4001 *'highlight'* *'hl'*
4002'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004003 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4004 d:Directory,e:ErrorMsg,i:IncSearch,
4005 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4006 N:CursorLineNr,r:Question,s:StatusLine,
4007 S:StatusLineNC,c:VertSplit,t:Title,
4008 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4009 F:FoldColumn,A:DiffAdd,C:DiffChange,
4010 D:DiffDelete,T:DiffText,>:SignColumn,
4011 B:SpellBad,P:SpellCap,R:SpellRare,
4012 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004013 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 global
4015 {not in Vi}
4016 This option can be used to set highlighting mode for various
4017 occasions. It is a comma separated list of character pairs. The
4018 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004019 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004021 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4022 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 characters from 'showbreak'
4024 |hl-Directory| d directories in CTRL-D listing and other special
4025 things in listings
4026 |hl-ErrorMsg| e error messages
4027 h (obsolete, ignored)
4028 |hl-IncSearch| i 'incsearch' highlighting
4029 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4030 |hl-MoreMsg| m |more-prompt|
4031 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004032 |hl-LineNr| n line number for ":number" and ":#" commands, and
4033 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004034 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4035 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 |hl-Question| r |hit-enter| prompt and yes/no questions
4037 |hl-StatusLine| s status line of current window |status-line|
4038 |hl-StatusLineNC| S status lines of not-current windows
4039 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4040 |hl-VertSplit| c column used to separate vertically split windows
4041 |hl-Visual| v Visual mode
4042 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4043 Selection" Only X11 Gui's |gui-x11| and
4044 |xterm-clipboard|.
4045 |hl-WarningMsg| w warning messages
4046 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4047 |hl-Folded| f line used for closed folds
4048 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004049 |hl-DiffAdd| A added line in diff mode
4050 |hl-DiffChange| C changed line in diff mode
4051 |hl-DiffDelete| D deleted line in diff mode
4052 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004054 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004055 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004056 |hl-SpellRare| R rare word |spell|
4057 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004058 |hl-Conceal| - the placeholders used for concealed characters
4059 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004060 |hl-Pmenu| + popup menu normal line
4061 |hl-PmenuSel| = popup menu normal line
4062 |hl-PmenuSbar| x popup menu scrollbar
4063 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064
4065 The display modes are:
4066 r reverse (termcap entry "mr" and "me")
4067 i italic (termcap entry "ZH" and "ZR")
4068 b bold (termcap entry "md" and "me")
4069 s standout (termcap entry "so" and "se")
4070 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004071 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072 n no highlighting
4073 - no highlighting
4074 : use a highlight group
4075 The default is used for occasions that are not included.
4076 If you want to change what the display modes do, see |dos-colors|
4077 for an example.
4078 When using the ':' display mode, this must be followed by the name of
4079 a highlight group. A highlight group can be used to define any type
4080 of highlighting, including using color. See |:highlight| on how to
4081 define one. The default uses a different group for each occasion.
4082 See |highlight-default| for the default highlight groups.
4083
4084 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4085'hlsearch' 'hls' boolean (default off)
4086 global
4087 {not in Vi}
4088 {not available when compiled without the
4089 |+extra_search| feature}
4090 When there is a previous search pattern, highlight all its matches.
4091 The type of highlighting used can be set with the 'l' occasion in the
4092 'highlight' option. This uses the "Search" highlight group by
4093 default. Note that only the matching text is highlighted, any offsets
4094 are not applied.
4095 See also: 'incsearch' and |:match|.
4096 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004097 off with |:nohlsearch|. This does not change the option value, as
4098 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004099 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 When the search pattern can match an end-of-line, Vim will try to
4101 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004102 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004104 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004105 You can specify whether the highlight status is restored on startup
4106 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 NOTE: This option is reset when 'compatible' is set.
4108
4109 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004110'history' 'hi' number (Vim default: 50, Vi default: 0,
4111 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 global
4113 {not in Vi}
4114 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004115 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004117 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 NOTE: This option is set to the Vi default value when 'compatible' is
4119 set and to the Vim default value when 'compatible' is reset.
4120
4121 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4122'hkmap' 'hk' boolean (default off)
4123 global
4124 {not in Vi}
4125 {only available when compiled with the |+rightleft|
4126 feature}
4127 When on, the keyboard is mapped for the Hebrew character set.
4128 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4129 toggle this option. See |rileft.txt|.
4130 NOTE: This option is reset when 'compatible' is set.
4131
4132 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4133'hkmapp' 'hkp' boolean (default off)
4134 global
4135 {not in Vi}
4136 {only available when compiled with the |+rightleft|
4137 feature}
4138 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4139 This is useful if you have a non-Hebrew keyboard.
4140 See |rileft.txt|.
4141 NOTE: This option is reset when 'compatible' is set.
4142
4143 *'icon'* *'noicon'*
4144'icon' boolean (default off, on when title can be restored)
4145 global
4146 {not in Vi}
4147 {not available when compiled without the |+title|
4148 feature}
4149 When on, the icon text of the window will be set to the value of
4150 'iconstring' (if it is not empty), or to the name of the file
4151 currently being edited. Only the last part of the name is used.
4152 Overridden by the 'iconstring' option.
4153 Only works if the terminal supports setting window icons (currently
4154 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4155 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4156 builtin termcap).
4157 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004158 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004160 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161
4162 *'iconstring'*
4163'iconstring' string (default "")
4164 global
4165 {not in Vi}
4166 {not available when compiled without the |+title|
4167 feature}
4168 When this option is not empty, it will be used for the icon text of
4169 the window. This happens only when the 'icon' option is on.
4170 Only works if the terminal supports setting window icon text
4171 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4172 Does not work for MS Windows.
4173 When Vim was compiled with HAVE_X11 defined, the original icon will be
4174 restored if possible |X11|.
4175 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004176 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 'titlestring' for example settings.
4178 {not available when compiled without the |+statusline| feature}
4179
4180 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4181'ignorecase' 'ic' boolean (default off)
4182 global
4183 Ignore case in search patterns. Also used when searching in the tags
4184 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004185 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 Can be overruled by using "\c" or "\C" in the pattern, see
4187 |/ignorecase|.
4188
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004189 *'imactivatefunc'* *'imaf'*
4190'imactivatefunc' 'imaf' string (default "")
4191 global
4192 {not in Vi}
4193 {only available when compiled with |+xim| and
4194 |+GUI_GTK|}
4195 This option specifies a function that will be called to
4196 activate/inactivate Input Method.
4197
4198 Example: >
4199 function ImActivateFunc(active)
4200 if a:active
4201 ... do something
4202 else
4203 ... do something
4204 endif
4205 " return value is not used
4206 endfunction
4207 set imactivatefunc=ImActivateFunc
4208<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 *'imactivatekey'* *'imak'*
4210'imactivatekey' 'imak' string (default "")
4211 global
4212 {not in Vi}
4213 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004214 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 Specifies the key that your Input Method in X-Windows uses for
4216 activation. When this is specified correctly, vim can fully control
4217 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4218 You can't use this option to change the activation key, the option
4219 tells Vim what the key is.
4220 Format:
4221 [MODIFIER_FLAG-]KEY_STRING
4222
4223 These characters can be used for MODIFIER_FLAG (case is ignored):
4224 S Shift key
4225 L Lock key
4226 C Control key
4227 1 Mod1 key
4228 2 Mod2 key
4229 3 Mod3 key
4230 4 Mod4 key
4231 5 Mod5 key
4232 Combinations are allowed, for example "S-C-space" or "SC-space" are
4233 both shift+ctrl+space.
4234 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4235
4236 Example: >
4237 :set imactivatekey=S-space
4238< "S-space" means shift+space. This is the activation key for kinput2 +
4239 canna (Japanese), and ami (Korean).
4240
4241 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4242'imcmdline' 'imc' boolean (default off)
4243 global
4244 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004245 {only available when compiled with the |+xim|,
4246 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 When set the Input Method is always on when starting to edit a command
4248 line, unless entering a search pattern (see 'imsearch' for that).
4249 Setting this option is useful when your input method allows entering
4250 English characters directly, e.g., when it's used to type accented
4251 characters with dead keys.
4252
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004253 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4255 global
4256 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004257 {only available when compiled with the |+xim|,
4258 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 When set the Input Method is never used. This is useful to disable
4260 the IM when it doesn't work properly.
4261 Currently this option is on by default for SGI/IRIX machines. This
4262 may change in later releases.
4263
4264 *'iminsert'* *'imi'*
4265'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4266 local to buffer
4267 {not in Vi}
4268 Specifies whether :lmap or an Input Method (IM) is to be used in
4269 Insert mode. Valid values:
4270 0 :lmap is off and IM is off
4271 1 :lmap is ON and IM is off
4272 2 :lmap is off and IM is ON
4273 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4274 or |global-ime|.
4275 To always reset the option to zero when leaving Insert mode with <Esc>
4276 this can be used: >
4277 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4278< This makes :lmap and IM turn off automatically when leaving Insert
4279 mode.
4280 Note that this option changes when using CTRL-^ in Insert mode
4281 |i_CTRL-^|.
4282 The value is set to 1 when setting 'keymap' to a valid keymap name.
4283 It is also used for the argument of commands like "r" and "f".
4284 The value 0 may not work correctly with Athena and Motif with some XIM
4285 methods. Use 'imdisable' to disable XIM then.
4286
4287 *'imsearch'* *'ims'*
4288'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4289 local to buffer
4290 {not in Vi}
4291 Specifies whether :lmap or an Input Method (IM) is to be used when
4292 entering a search pattern. Valid values:
4293 -1 the value of 'iminsert' is used, makes it look like
4294 'iminsert' is also used when typing a search pattern
4295 0 :lmap is off and IM is off
4296 1 :lmap is ON and IM is off
4297 2 :lmap is off and IM is ON
4298 Note that this option changes when using CTRL-^ in Command-line mode
4299 |c_CTRL-^|.
4300 The value is set to 1 when it is not -1 and setting the 'keymap'
4301 option to a valid keymap name.
4302 The value 0 may not work correctly with Athena and Motif with some XIM
4303 methods. Use 'imdisable' to disable XIM then.
4304
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004305 *'imstatusfunc'* *'imsf'*
4306'imstatusfunc' 'imsf' string (default "")
4307 global
4308 {not in Vi}
4309 {only available when compiled with |+xim| and
4310 |+GUI_GTK|}
4311 This option specifies a function that is called to obtain the status
4312 of Input Method. It must return a positive number when IME is active.
4313
4314 Example: >
4315 function ImStatusFunc()
4316 let is_active = ...do something
4317 return is_active ? 1 : 0
4318 endfunction
4319 set imstatusfunc=ImStatusFunc
4320<
4321 NOTE: This function is invoked very often. Keep it fast.
4322
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 *'include'* *'inc'*
4324'include' 'inc' string (default "^\s*#\s*include")
4325 global or local to buffer |global-local|
4326 {not in Vi}
4327 {not available when compiled without the
4328 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004329 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 pattern, just like for the "/" command (See |pattern|). The default
4331 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004332 "]I", "[d", etc.
4333 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004334 comes after the matched pattern. But if "\zs" appears in the pattern
4335 then the text matched from "\zs" to the end, or until "\ze" if it
4336 appears, is used as the file name. Use this to include characters
4337 that are not in 'isfname', such as a space. You can then use
4338 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004339 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340
4341 *'includeexpr'* *'inex'*
4342'includeexpr' 'inex' string (default "")
4343 local to buffer
4344 {not in Vi}
4345 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004346 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004348 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 :set includeexpr=substitute(v:fname,'\\.','/','g')
4350< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004351
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004353 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 Also used for |<cfile>|.
4355
Bram Moolenaar30b65812012-07-12 22:01:11 +02004356 The expression will be evaluated in the |sandbox| when set from a
4357 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004358
4359 It is not allowed to change text or jump to another window while
4360 evaluating 'includeexpr' |textlock|.
4361
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004363'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4364 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 global
4366 {not in Vi}
4367 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004368 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004369 While typing a search command, show where the pattern, as it was typed
4370 so far, matches. The matched string is highlighted. If the pattern
4371 is invalid or not found, nothing is shown. The screen will be updated
4372 often, this is only useful on fast terminals.
4373 Note that the match will be shown, but the cursor will return to its
4374 original position when no match is found and when pressing <Esc>. You
4375 still need to finish the search command with <Enter> to move the
4376 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004377 You can use the CTRL-G and CTRL-T keys to move to the next and
4378 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004379 When compiled with the |+reltime| feature Vim only searches for about
4380 half a second. With a complicated pattern and/or a lot of text the
4381 match may not be found. This is to avoid that Vim hangs while you
4382 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004383 The highlighting can be set with the 'i' flag in 'highlight'.
4384 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004385 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004386 to the command line. If 'ignorecase' and 'smartcase' are set and the
4387 command line has no uppercase characters, the added character is
4388 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004389 CTRL-R CTRL-W can be used to add the word at the end of the current
4390 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 NOTE: This option is reset when 'compatible' is set.
4392
4393 *'indentexpr'* *'inde'*
4394'indentexpr' 'inde' string (default "")
4395 local to buffer
4396 {not in Vi}
4397 {not available when compiled without the |+cindent|
4398 or |+eval| features}
4399 Expression which is evaluated to obtain the proper indent for a line.
4400 It is used when a new line is created, for the |=| operator and
4401 in Insert mode as specified with the 'indentkeys' option.
4402 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004403 'smartindent' indenting. When 'lisp' is set, this option is
4404 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 When 'paste' is set this option is not used for indenting.
4406 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004407 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 when the expression is evaluated (but it may be moved around).
4409 The expression must return the number of spaces worth of indent. It
4410 can return "-1" to keep the current indent (this means 'autoindent' is
4411 used for the indent).
4412 Functions useful for computing the indent are |indent()|, |cindent()|
4413 and |lispindent()|.
4414 The evaluation of the expression must not have side effects! It must
4415 not change the text, jump to another window, etc. Afterwards the
4416 cursor position is always restored, thus the cursor may be moved.
4417 Normally this option would be set to call a function: >
4418 :set indentexpr=GetMyIndent()
4419< Error messages will be suppressed, unless the 'debug' option contains
4420 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004421 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 NOTE: This option is made empty when 'compatible' is set.
4423
Bram Moolenaar30b65812012-07-12 22:01:11 +02004424 The expression will be evaluated in the |sandbox| when set from a
4425 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004426
4427 It is not allowed to change text or jump to another window while
4428 evaluating 'indentexpr' |textlock|.
4429
4430
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 *'indentkeys'* *'indk'*
4432'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4433 local to buffer
4434 {not in Vi}
4435 {not available when compiled without the |+cindent|
4436 feature}
4437 A list of keys that, when typed in Insert mode, cause reindenting of
4438 the current line. Only happens if 'indentexpr' isn't empty.
4439 The format is identical to 'cinkeys', see |indentkeys-format|.
4440 See |C-indenting| and |indent-expression|.
4441
4442 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4443'infercase' 'inf' boolean (default off)
4444 local to buffer
4445 {not in Vi}
4446 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004447 'ignorecase' is also on, the case of the match is adjusted depending
4448 on the typed text. If the typed text contains a lowercase letter
4449 where the match has an upper case letter, the completed part is made
4450 lowercase. If the typed text has no lowercase letters and the match
4451 has a lowercase letter where the typed text has an uppercase letter,
4452 and there is a letter before it, the completed part is made uppercase.
4453 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454
4455 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4456'insertmode' 'im' boolean (default off)
4457 global
4458 {not in Vi}
4459 Makes Vim work in a way that Insert mode is the default mode. Useful
4460 if you want to use Vim as a modeless editor. Used for |evim|.
4461 These Insert mode commands will be useful:
4462 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004463 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004464 this is a mapping, it is executed as if 'insertmode' was off.
4465 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004467 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4468 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469
4470 These items change when 'insertmode' is set:
4471 - when starting to edit of a file, Vim goes to Insert mode.
4472 - <Esc> in Insert mode is a no-op and beeps.
4473 - <Esc> in Normal mode makes Vim go to Insert mode.
4474 - CTRL-L in Insert mode is a command, it is not inserted.
4475 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4476 However, when <Esc> is used inside a mapping, it behaves like
4477 'insertmode' was not set. This was done to be able to use the same
4478 mappings with 'insertmode' set or not set.
4479 When executing commands with |:normal| 'insertmode' is not used.
4480
4481 NOTE: This option is reset when 'compatible' is set.
4482
4483 *'isfname'* *'isf'*
4484'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4485 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4486 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4487 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4488 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4489 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4490 global
4491 {not in Vi}
4492 The characters specified by this option are included in file names and
4493 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004494 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 Multi-byte characters 256 and above are always included, only the
4496 characters up to 255 are specified with this option.
4497 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004498 Think twice before adding white space to this option. Although a
4499 space may appear inside a file name, the effect will be that Vim
4500 doesn't know where a file name starts or ends when doing completion.
4501 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502
4503 Note that on systems using a backslash as path separator, Vim tries to
4504 do its best to make it work as you would expect. That is a bit
4505 tricky, since Vi originally used the backslash to escape special
4506 characters. Vim will not remove a backslash in front of a normal file
4507 name character on these systems, but it will on Unix and alikes. The
4508 '&' and '^' are not included by default, because these are special for
4509 cmd.exe.
4510
4511 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004512 Each part can be a single character number or a range. A range is two
4513 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 decimal number between 0 and 255 or the ASCII character itself (does
4515 not work for digits). Example:
4516 "_,-,128-140,#-43" (include '_' and '-' and the range
4517 128 to 140 and '#' to 43)
4518 If a part starts with '^', the following character number or range
4519 will be excluded from the option. The option is interpreted from left
4520 to right. Put the excluded character after the range where it is
4521 included. To include '^' itself use it as the last character of the
4522 option or the end of a range. Example:
4523 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4524 If the character is '@', all characters where isalpha() returns TRUE
4525 are included. Normally these are the characters a to z and A to Z,
4526 plus accented characters. To include '@' itself use "@-@". Examples:
4527 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004528 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 "a-z,A-Z,@-@" All letters plus the '@' character.
4530 A comma can be included by using it where a character number is
4531 expected. Example:
4532 "48-57,,,_" Digits, comma and underscore.
4533 A comma can be excluded by prepending a '^'. Example:
4534 " -~,^,,9" All characters from space to '~', excluding
4535 comma, plus <Tab>.
4536 See |option-backslash| about including spaces and backslashes.
4537
4538 *'isident'* *'isi'*
4539'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4540 "@,48-57,_,128-167,224-235"
4541 otherwise: "@,48-57,_,192-255")
4542 global
4543 {not in Vi}
4544 The characters given by this option are included in identifiers.
4545 Identifiers are used in recognizing environment variables and after a
4546 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004547 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548 option.
4549 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004550 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4552
4553 *'iskeyword'* *'isk'*
4554'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4555 "@,48-57,_,128-167,224-235"
4556 otherwise: "@,48-57,_,192-255"
4557 Vi default: "@,48-57,_")
4558 local to buffer
4559 {not in Vi}
4560 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004561 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 'isfname' for a description of the format of this option. For C
4563 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4564 For a help file it is set to all non-blank printable characters except
4565 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4566 command).
4567 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004568 This option also influences syntax highlighting, unless the syntax
4569 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 NOTE: This option is set to the Vi default value when 'compatible' is
4571 set and to the Vim default value when 'compatible' is reset.
4572
4573 *'isprint'* *'isp'*
4574'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4575 "@,~-255"; otherwise: "@,161-255")
4576 global
4577 {not in Vi}
4578 The characters given by this option are displayed directly on the
4579 screen. It is also used for "\p" in a |pattern|. The characters from
4580 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4581 even when they are not included in 'isprint' or excluded. See
4582 'isfname' for a description of the format of this option.
4583
4584 Non-printable characters are displayed with two characters:
4585 0 - 31 "^@" - "^_"
4586 32 - 126 always single characters
4587 127 "^?"
4588 128 - 159 "~@" - "~_"
4589 160 - 254 "| " - "|~"
4590 255 "~?"
4591 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4592 displayed as <xx>, with the hexadecimal value of the byte.
4593 When 'display' contains "uhex" all unprintable characters are
4594 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004595 The SpecialKey highlighting will be used for unprintable characters.
4596 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
4598 Multi-byte characters 256 and above are always included, only the
4599 characters up to 255 are specified with this option. When a character
4600 is printable but it is not available in the current font, a
4601 replacement character will be shown.
4602 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4603 There is no option to specify these characters.
4604
4605 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4606'joinspaces' 'js' boolean (default on)
4607 global
4608 {not in Vi}
4609 Insert two spaces after a '.', '?' and '!' with a join command.
4610 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4611 Otherwise only one space is inserted.
4612 NOTE: This option is set when 'compatible' is set.
4613
4614 *'key'*
4615'key' string (default "")
4616 local to buffer
4617 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004618 {only available when compiled with the |+cryptv|
4619 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004621 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004622 Careful: Do not set the key value by hand, someone might see the typed
4623 key. Use the |:X| command. But you can make 'key' empty: >
4624 :set key=
4625< It is not possible to get the value of this option with ":set key" or
4626 "echo &key". This is to avoid showing it to someone who shouldn't
4627 know. It also means you cannot see it yourself once you have set it,
4628 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004629 You can use "&key" in an expression to detect whether encryption is
4630 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631
4632 *'keymap'* *'kmp'* *E544*
4633'keymap' 'kmp' string (default "")
4634 local to buffer
4635 {not in Vi}
4636 {only available when compiled with the |+keymap|
4637 feature}
4638 Name of a keyboard mapping. See |mbyte-keymap|.
4639 Setting this option to a valid keymap name has the side effect of
4640 setting 'iminsert' to one, so that the keymap becomes effective.
4641 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004642 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643
4644 *'keymodel'* *'km'*
4645'keymodel' 'km' string (default "")
4646 global
4647 {not in Vi}
4648 List of comma separated words, which enable special things that keys
4649 can do. These values can be used:
4650 startsel Using a shifted special key starts selection (either
4651 Select mode or Visual mode, depending on "key" being
4652 present in 'selectmode').
4653 stopsel Using a not-shifted special key stops selection.
4654 Special keys in this context are the cursor keys, <End>, <Home>,
4655 <PageUp> and <PageDown>.
4656 The 'keymodel' option is set by the |:behave| command.
4657
4658 *'keywordprg'* *'kp'*
4659'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004660 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 global or local to buffer |global-local|
4662 {not in Vi}
4663 Program to use for the |K| command. Environment variables are
4664 expanded |:set_env|. ":help" may be used to access the Vim internal
4665 help. (Note that previously setting the global option to the empty
4666 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004667 When the first character is ":", the command is invoked as a Vim
4668 Ex command prefixed with [count].
4669 When "man", "man -s" or an Ex command is used, Vim will automatically
4670 translate a count for the "K" command and pass it as the first
4671 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 See |option-backslash| about including spaces and backslashes.
4673 Example: >
4674 :set keywordprg=man\ -s
4675< This option cannot be set from a |modeline| or in the |sandbox|, for
4676 security reasons.
4677
4678 *'langmap'* *'lmap'* *E357* *E358*
4679'langmap' 'lmap' string (default "")
4680 global
4681 {not in Vi}
4682 {only available when compiled with the |+langmap|
4683 feature}
4684 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004685 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004686 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 care of translating these special characters to the original meaning
4688 of the key. This means you don't have to change the keyboard mode to
4689 be able to execute Normal mode commands.
4690 This is the opposite of the 'keymap' option, where characters are
4691 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004692 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004693 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004694 This option cannot be set from a |modeline| or in the |sandbox|, for
4695 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004697 Example (for Greek, in UTF-8): *greek* >
4698 :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 +00004699< Example (exchanges meaning of z and y for commands): >
4700 :set langmap=zy,yz,ZY,YZ
4701<
4702 The 'langmap' option is a list of parts, separated with commas. Each
4703 part can be in one of two forms:
4704 1. A list of pairs. Each pair is a "from" character immediately
4705 followed by the "to" character. Examples: "aA", "aAbBcC".
4706 2. A list of "from" characters, a semi-colon and a list of "to"
4707 characters. Example: "abc;ABC"
4708 Example: "aA,fgh;FGH,cCdDeE"
4709 Special characters need to be preceded with a backslash. These are
4710 ";", ',' and backslash itself.
4711
4712 This will allow you to activate vim actions without having to switch
4713 back and forth between the languages. Your language characters will
4714 be understood as normal vim English characters (according to the
4715 langmap mappings) in the following cases:
4716 o Normal/Visual mode (commands, buffer/register names, user mappings)
4717 o Insert/Replace Mode: Register names after CTRL-R
4718 o Insert/Replace Mode: Mappings
4719 Characters entered in Command-line mode will NOT be affected by
4720 this option. Note that this option can be changed at any time
4721 allowing to switch between mappings for different languages/encodings.
4722 Use a mapping to avoid having to type it each time!
4723
4724 *'langmenu'* *'lm'*
4725'langmenu' 'lm' string (default "")
4726 global
4727 {not in Vi}
4728 {only available when compiled with the |+menu| and
4729 |+multi_lang| features}
4730 Language to use for menu translation. Tells which file is loaded
4731 from the "lang" directory in 'runtimepath': >
4732 "lang/menu_" . &langmenu . ".vim"
4733< (without the spaces). For example, to always use the Dutch menus, no
4734 matter what $LANG is set to: >
4735 :set langmenu=nl_NL.ISO_8859-1
4736< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004737 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 If your $LANG is set to a non-English language but you do want to use
4739 the English menus: >
4740 :set langmenu=none
4741< This option must be set before loading menus, switching on filetype
4742 detection or syntax highlighting. Once the menus are defined setting
4743 this option has no effect. But you could do this: >
4744 :source $VIMRUNTIME/delmenu.vim
4745 :set langmenu=de_DE.ISO_8859-1
4746 :source $VIMRUNTIME/menu.vim
4747< Warning: This deletes all menus that you defined yourself!
4748
Bram Moolenaard94464e2015-11-02 15:28:18 +01004749 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004750'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004751 global
4752 {not in Vi}
4753 {only available when compiled with the |+langmap|
4754 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004755 This is just like 'langremap' but with the value inverted. It only
4756 exists for backwards compatibility. When setting 'langremap' then
4757 'langnoremap' is set to the inverted value, and the other way around.
4758
4759 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4760'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4761 global
4762 {not in Vi}
4763 {only available when compiled with the |+langmap|
4764 feature}
4765 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004766 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004767 'langmap' disables some of your mappings, try resetting this option.
4768 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004769 that works for you to avoid mappings to break.
4770
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 *'laststatus'* *'ls'*
4772'laststatus' 'ls' number (default 1)
4773 global
4774 {not in Vi}
4775 The value of this option influences when the last window will have a
4776 status line:
4777 0: never
4778 1: only if there are at least two windows
4779 2: always
4780 The screen looks nicer with a status line if you have several
4781 windows, but it takes another screen line. |status-line|
4782
4783 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4784'lazyredraw' 'lz' boolean (default off)
4785 global
4786 {not in Vi}
4787 When this option is set, the screen will not be redrawn while
4788 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004789 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 update use |:redraw|.
4791
4792 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4793'linebreak' 'lbr' boolean (default off)
4794 local to window
4795 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004796 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004798 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 than at the last character that fits on the screen. Unlike
4800 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004801 it only affects the way the file is displayed, not its contents.
4802 If 'breakindent' is set, line is visually indented. Then, the value
4803 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004804 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 Note that <Tab> characters after an <EOL> are mostly not displayed
4806 with the right amount of white space.
4807
4808 *'lines'* *E593*
4809'lines' number (default 24 or terminal height)
4810 global
4811 Number of lines of the Vim window.
4812 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004813 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 When Vim is running in the GUI or in a resizable window, setting this
4815 option will cause the window size to be changed. When you only want
4816 to use the size for the GUI, put the command in your |gvimrc| file.
4817 Vim limits the number of lines to what fits on the screen. You can
4818 use this command to get the tallest window possible: >
4819 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004820< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004821 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 When you set this option and Vim is unable to change the physical
4823 number of lines of the display, the display may be messed up.
4824
4825 *'linespace'* *'lsp'*
4826'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4827 global
4828 {not in Vi}
4829 {only in the GUI}
4830 Number of pixel lines inserted between characters. Useful if the font
4831 uses the full character cell height, making lines touch each other.
4832 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004833 With some fonts there can be too much room between lines (to have
4834 space for ascents and descents). Then it makes sense to set
4835 'linespace' to a negative value. This may cause display problems
4836 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
4838 *'lisp'* *'nolisp'*
4839'lisp' boolean (default off)
4840 local to buffer
4841 {not available when compiled without the |+lispindent|
4842 feature}
4843 Lisp mode: When <Enter> is typed in insert mode set the indent for
4844 the next line to Lisp standards (well, sort of). Also happens with
4845 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4846 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4847 better. Also see 'lispwords'.
4848 The '-' character is included in keyword characters. Redefines the
4849 "=" operator to use this same indentation algorithm rather than
4850 calling an external program if 'equalprg' is empty.
4851 This option is not used when 'paste' is set.
4852 {Vi: Does it a little bit differently}
4853
4854 *'lispwords'* *'lw'*
4855'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004856 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 {not in Vi}
4858 {not available when compiled without the |+lispindent|
4859 feature}
4860 Comma separated list of words that influence the Lisp indenting.
4861 |'lisp'|
4862
4863 *'list'* *'nolist'*
4864'list' boolean (default off)
4865 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004866 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4867 line. Useful to see the difference between tabs and spaces and for
4868 trailing blanks. Further changed by the 'listchars' option.
4869
4870 The cursor is displayed at the start of the space a Tab character
4871 occupies, not at the end as usual in Normal mode. To get this cursor
4872 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004873 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004874<
4875 Note that list mode will also affect formatting (set with 'textwidth'
4876 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 changing the way tabs are displayed.
4878
4879 *'listchars'* *'lcs'*
4880'listchars' 'lcs' string (default "eol:$")
4881 global
4882 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004883 Strings to use in 'list' mode and for the |:list| command. It is a
4884 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004885 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 eol:c Character to show at the end of each line. When
4887 omitted, there is no extra character at the end of the
4888 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004889 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004890 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004892 fill the space that the tab normally occupies.
4893 "tab:>-" will show a tab that takes four spaces as
4894 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004895 *lcs-space*
4896 space:c Character to show for a space. When omitted, spaces
4897 are left blank.
4898 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004899 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004900 trailing spaces are blank. Overrides the "space"
4901 setting for trailing spaces.
4902 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903 extends:c Character to show in the last column, when 'wrap' is
4904 off and the line continues beyond the right of the
4905 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004906 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 precedes:c Character to show in the first column, when 'wrap'
4908 is off and there is text preceding the character
4909 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004910 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004911 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004912 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004913 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004914 nbsp:c Character to show for a non-breakable space character
4915 (0xA0 (160 decimal) and U+202F). Left blank when
4916 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004918 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004920 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
4922 Examples: >
4923 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004924 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 :set lcs=extends:>,precedes:<
4926< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004927 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004928 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929
4930 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4931'loadplugins' 'lpl' boolean (default on)
4932 global
4933 {not in Vi}
4934 When on the plugin scripts are loaded when starting up |load-plugins|.
4935 This option can be reset in your |vimrc| file to disable the loading
4936 of plugins.
4937 Note that using the "-u NONE" and "--noplugin" command line arguments
4938 reset this option. |-u| |--noplugin|
4939
Bram Moolenaard94464e2015-11-02 15:28:18 +01004940 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004941'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004942 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004943 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004944 {only available when compiled with the |+lua/dyn|
4945 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004946 Specifies the name of the Lua shared library. The default is
4947 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004948 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004949 This option cannot be set from a |modeline| or in the |sandbox|, for
4950 security reasons.
4951
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004952 *'macatsui'* *'nomacatsui'*
4953'macatsui' boolean (default on)
4954 global
4955 {only available in Mac GUI version}
4956 This is a workaround for when drawing doesn't work properly. When set
4957 and compiled with multi-byte support ATSUI text drawing is used. When
4958 not set ATSUI text drawing is not used. Switch this option off when
4959 you experience drawing problems. In a future version the problems may
4960 be solved and this option becomes obsolete. Therefore use this method
4961 to unset it: >
4962 if exists('&macatsui')
4963 set nomacatsui
4964 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004965< Another option to check if you have drawing problems is
4966 'termencoding'.
4967
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 *'magic'* *'nomagic'*
4969'magic' boolean (default on)
4970 global
4971 Changes the special characters that can be used in search patterns.
4972 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004973 WARNING: Switching this option off most likely breaks plugins! That
4974 is because many patterns assume it's on and will fail when it's off.
4975 Only switch it off when working with old Vi scripts. In any other
4976 situation write patterns that work when 'magic' is on. Include "\M"
4977 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978
4979 *'makeef'* *'mef'*
4980'makeef' 'mef' string (default: "")
4981 global
4982 {not in Vi}
4983 {not available when compiled without the |+quickfix|
4984 feature}
4985 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4986 and the |:grep| command.
4987 When it is empty, an internally generated temp file will be used.
4988 When "##" is included, it is replaced by a number to make the name
4989 unique. This makes sure that the ":make" command doesn't overwrite an
4990 existing file.
4991 NOT used for the ":cf" command. See 'errorfile' for that.
4992 Environment variables are expanded |:set_env|.
4993 See |option-backslash| about including spaces and backslashes.
4994 This option cannot be set from a |modeline| or in the |sandbox|, for
4995 security reasons.
4996
4997 *'makeprg'* *'mp'*
4998'makeprg' 'mp' string (default "make", VMS: "MMS")
4999 global or local to buffer |global-local|
5000 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005001 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005002 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5003 which are expanded to the current and alternate file name. Use |::S|
5004 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005005 Environment variables are expanded |:set_env|. See |option-backslash|
5006 about including spaces and backslashes.
5007 Note that a '|' must be escaped twice: once for ":set" and once for
5008 the interpretation of a command. When you use a filter called
5009 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 :set makeprg=gmake\ \\\|\ myfilter
5011< The placeholder "$*" can be given (even multiple times) to specify
5012 where the arguments will be included, for example: >
5013 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5014< This option cannot be set from a |modeline| or in the |sandbox|, for
5015 security reasons.
5016
5017 *'matchpairs'* *'mps'*
5018'matchpairs' 'mps' string (default "(:),{:},[:]")
5019 local to buffer
5020 {not in Vi}
5021 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005022 other.
5023 Only character pairs are allowed that are different, thus you cannot
5024 jump between two double quotes.
5025 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005026 The pairs must be separated by a comma. Example for including '<' and
5027 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 :set mps+=<:>
5029
5030< A more exotic example, to jump between the '=' and ';' in an
5031 assignment, useful for languages like C and Java: >
5032 :au FileType c,cpp,java set mps+==:;
5033
5034< For a more advanced way of using "%", see the matchit.vim plugin in
5035 the $VIMRUNTIME/macros directory. |add-local-help|
5036
5037 *'matchtime'* *'mat'*
5038'matchtime' 'mat' number (default 5)
5039 global
5040 {not in Vi}{in Nvi}
5041 Tenths of a second to show the matching paren, when 'showmatch' is
5042 set. Note that this is not in milliseconds, like other options that
5043 set a time. This is to be compatible with Nvi.
5044
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005045 *'maxcombine'* *'mco'*
5046'maxcombine' 'mco' number (default 2)
5047 global
5048 {not in Vi}
5049 {only available when compiled with the |+multi_byte|
5050 feature}
5051 The maximum number of combining characters supported for displaying.
5052 Only used when 'encoding' is "utf-8".
5053 The default is OK for most languages. Hebrew may require 4.
5054 Maximum value is 6.
5055 Even when this option is set to 2 you can still edit text with more
5056 combining characters, you just can't see them. Use |g8| or |ga|.
5057 See |mbyte-combining|.
5058
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 *'maxfuncdepth'* *'mfd'*
5060'maxfuncdepth' 'mfd' number (default 100)
5061 global
5062 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005063 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005064 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 Maximum depth of function calls for user functions. This normally
5066 catches endless recursion. When using a recursive function with
5067 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5068 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005069 Increasing this limit above 200 also changes the maximum for Ex
5070 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 See also |:function|.
5072
5073 *'maxmapdepth'* *'mmd'* *E223*
5074'maxmapdepth' 'mmd' number (default 1000)
5075 global
5076 {not in Vi}
5077 Maximum number of times a mapping is done without resulting in a
5078 character to be used. This normally catches endless mappings, like
5079 ":map x y" with ":map y x". It still does not catch ":map g wg",
5080 because the 'w' is used before the next mapping is done. See also
5081 |key-mapping|.
5082
5083 *'maxmem'* *'mm'*
5084'maxmem' 'mm' number (default between 256 to 5120 (system
5085 dependent) or half the amount of memory
5086 available)
5087 global
5088 {not in Vi}
5089 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5090 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005091 other memory to be freed. The maximum usable value is about 2000000.
5092 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005094 *'maxmempattern'* *'mmp'*
5095'maxmempattern' 'mmp' number (default 1000)
5096 global
5097 {not in Vi}
5098 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005099 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005100 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005101 When Vim runs into the limit it gives an error message and mostly
5102 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005103 Running into the limit often means that the pattern is very
5104 inefficient or too complex. This may already happen with the pattern
5105 "\(.\)*" on a very long line. ".*" works much better.
5106 Vim may run out of memory before hitting the 'maxmempattern' limit.
5107
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 *'maxmemtot'* *'mmt'*
5109'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5110 dependent) or half the amount of memory
5111 available)
5112 global
5113 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005114 Maximum amount of memory in Kbyte to use for all buffers together.
5115 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005116 without a limit.
5117 On 64 bit machines higher values might work. But hey, do you really
5118 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005119 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005120 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005121 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122
5123 *'menuitems'* *'mis'*
5124'menuitems' 'mis' number (default 25)
5125 global
5126 {not in Vi}
5127 {not available when compiled without the |+menu|
5128 feature}
5129 Maximum number of items to use in a menu. Used for menus that are
5130 generated from a list of items, e.g., the Buffers menu. Changing this
5131 option has no direct effect, the menu must be refreshed first.
5132
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005133 *'mkspellmem'* *'msm'*
5134'mkspellmem' 'msm' string (default "460000,2000,500")
5135 global
5136 {not in Vi}
5137 {not available when compiled without the |+syntax|
5138 feature}
5139 Parameters for |:mkspell|. This tunes when to start compressing the
5140 word tree. Compression can be slow when there are many words, but
5141 it's needed to avoid running out of memory. The amount of memory used
5142 per word depends very much on how similar the words are, that's why
5143 this tuning is complicated.
5144
5145 There are three numbers, separated by commas:
5146 {start},{inc},{added}
5147
5148 For most languages the uncompressed word tree fits in memory. {start}
5149 gives the amount of memory in Kbyte that can be used before any
5150 compression is done. It should be a bit smaller than the amount of
5151 memory that is available to Vim.
5152
5153 When going over the {start} limit the {inc} number specifies the
5154 amount of memory in Kbyte that can be allocated before another
5155 compression is done. A low number means compression is done after
5156 less words are added, which is slow. A high number means more memory
5157 will be allocated.
5158
5159 After doing compression, {added} times 1024 words can be added before
5160 the {inc} limit is ignored and compression is done when any extra
5161 amount of memory is needed. A low number means there is a smaller
5162 chance of hitting the {inc} limit, less memory is used but it's
5163 slower.
5164
5165 The languages for which these numbers are important are Italian and
5166 Hungarian. The default works for when you have about 512 Mbyte. If
5167 you have 1 Gbyte you could use: >
5168 :set mkspellmem=900000,3000,800
5169< If you have less than 512 Mbyte |:mkspell| may fail for some
5170 languages, no matter what you set 'mkspellmem' to.
5171
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005173'modeline' 'ml' boolean (Vim default: on (off for root),
5174 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 local to buffer
5176 *'modelines'* *'mls'*
5177'modelines' 'mls' number (default 5)
5178 global
5179 {not in Vi}
5180 If 'modeline' is on 'modelines' gives the number of lines that is
5181 checked for set commands. If 'modeline' is off or 'modelines' is zero
5182 no lines are checked. See |modeline|.
5183 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5184 set and to the Vim default value when 'compatible' is reset.
5185
5186 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5187'modifiable' 'ma' boolean (default on)
5188 local to buffer
5189 {not in Vi} *E21*
5190 When off the buffer contents cannot be changed. The 'fileformat' and
5191 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005192 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193
5194 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5195'modified' 'mod' boolean (default off)
5196 local to buffer
5197 {not in Vi}
5198 When on, the buffer is considered to be modified. This option is set
5199 when:
5200 1. A change was made to the text since it was last written. Using the
5201 |undo| command to go back to the original text will reset the
5202 option. But undoing changes that were made before writing the
5203 buffer will set the option again, since the text is different from
5204 when it was written.
5205 2. 'fileformat' or 'fileencoding' is different from its original
5206 value. The original value is set when the buffer is read or
5207 written. A ":set nomodified" command also resets the original
5208 values to the current values and the 'modified' option will be
5209 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005210 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005211 This option is not set when a change is made to the buffer as the
5212 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5213 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5214 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5216 will be ignored.
5217
5218 *'more'* *'nomore'*
5219'more' boolean (Vim default: on, Vi default: off)
5220 global
5221 {not in Vi}
5222 When on, listings pause when the whole screen is filled. You will get
5223 the |more-prompt|. When this option is off there are no pauses, the
5224 listing continues until finished.
5225 NOTE: This option is set to the Vi default value when 'compatible' is
5226 set and to the Vim default value when 'compatible' is reset.
5227
5228 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005229'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5230 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 global
5232 {not in Vi}
5233 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005234 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5235 sysmouse and Linux console with gpm). For using the mouse in the
5236 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 The mouse can be enabled for different modes:
5238 n Normal mode
5239 v Visual mode
5240 i Insert mode
5241 c Command-line mode
5242 h all previous modes when editing a help file
5243 a all previous modes
5244 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 Normally you would enable the mouse in all four modes with: >
5246 :set mouse=a
5247< When the mouse is not enabled, the GUI will still use the mouse for
5248 modeless selection. This doesn't move the text cursor.
5249
5250 See |mouse-using|. Also see |'clipboard'|.
5251
5252 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005253 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 the mouse buttons can still be used by keeping the shift key pressed.
5255 Also see the 'clipboard' option.
5256
5257 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5258'mousefocus' 'mousef' boolean (default off)
5259 global
5260 {not in Vi}
5261 {only works in the GUI}
5262 The window that the mouse pointer is on is automatically activated.
5263 When changing the window layout or window focus in another way, the
5264 mouse pointer is moved to the window with keyboard focus. Off is the
5265 default because it makes using the pull down menus a little goofy, as
5266 a pointer transit may activate a window unintentionally.
5267
5268 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5269'mousehide' 'mh' boolean (default on)
5270 global
5271 {not in Vi}
5272 {only works in the GUI}
5273 When on, the mouse pointer is hidden when characters are typed.
5274 The mouse pointer is restored when the mouse is moved.
5275
5276 *'mousemodel'* *'mousem'*
5277'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5278 global
5279 {not in Vi}
5280 Sets the model to use for the mouse. The name mostly specifies what
5281 the right mouse button is used for:
5282 extend Right mouse button extends a selection. This works
5283 like in an xterm.
5284 popup Right mouse button pops up a menu. The shifted left
5285 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005286 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 popup_setpos Like "popup", but the cursor will be moved to the
5288 position where the mouse was clicked, and thus the
5289 selected operation will act upon the clicked object.
5290 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005291 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 course, that right clicking outside a selection will
5293 end Visual mode.
5294 Overview of what button does what for each model:
5295 mouse extend popup(_setpos) ~
5296 left click place cursor place cursor
5297 left drag start selection start selection
5298 shift-left search word extend selection
5299 right click extend selection popup menu (place cursor)
5300 right drag extend selection -
5301 middle click paste paste
5302
5303 In the "popup" model the right mouse button produces a pop-up menu.
5304 You need to define this first, see |popup-menu|.
5305
5306 Note that you can further refine the meaning of buttons with mappings.
5307 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5308 selection (because that's handled in the GUI code directly).
5309
5310 The 'mousemodel' option is set by the |:behave| command.
5311
5312 *'mouseshape'* *'mouses'* *E547*
5313'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005314 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 global
5316 {not in Vi}
5317 {only available when compiled with the |+mouseshape|
5318 feature}
5319 This option tells Vim what the mouse pointer should look like in
5320 different modes. The option is a comma separated list of parts, much
5321 like used for 'guicursor'. Each part consist of a mode/location-list
5322 and an argument-list:
5323 mode-list:shape,mode-list:shape,..
5324 The mode-list is a dash separated list of these modes/locations:
5325 In a normal window: ~
5326 n Normal mode
5327 v Visual mode
5328 ve Visual mode with 'selection' "exclusive" (same as 'v',
5329 if not specified)
5330 o Operator-pending mode
5331 i Insert mode
5332 r Replace mode
5333
5334 Others: ~
5335 c appending to the command-line
5336 ci inserting in the command-line
5337 cr replacing in the command-line
5338 m at the 'Hit ENTER' or 'More' prompts
5339 ml idem, but cursor in the last line
5340 e any mode, pointer below last window
5341 s any mode, pointer on a status line
5342 sd any mode, while dragging a status line
5343 vs any mode, pointer on a vertical separator line
5344 vd any mode, while dragging a vertical separator line
5345 a everywhere
5346
5347 The shape is one of the following:
5348 avail name looks like ~
5349 w x arrow Normal mouse pointer
5350 w x blank no pointer at all (use with care!)
5351 w x beam I-beam
5352 w x updown up-down sizing arrows
5353 w x leftright left-right sizing arrows
5354 w x busy The system's usual busy pointer
5355 w x no The system's usual 'no input' pointer
5356 x udsizing indicates up-down resizing
5357 x lrsizing indicates left-right resizing
5358 x crosshair like a big thin +
5359 x hand1 black hand
5360 x hand2 white hand
5361 x pencil what you write with
5362 x question big ?
5363 x rightup-arrow arrow pointing right-up
5364 w x up-arrow arrow pointing up
5365 x <number> any X11 pointer number (see X11/cursorfont.h)
5366
5367 The "avail" column contains a 'w' if the shape is available for Win32,
5368 x for X11.
5369 Any modes not specified or shapes not available use the normal mouse
5370 pointer.
5371
5372 Example: >
5373 :set mouseshape=s:udsizing,m:no
5374< will make the mouse turn to a sizing arrow over the status lines and
5375 indicate no input when the hit-enter prompt is displayed (since
5376 clicking the mouse has no effect in this state.)
5377
5378 *'mousetime'* *'mouset'*
5379'mousetime' 'mouset' number (default 500)
5380 global
5381 {not in Vi}
5382 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5383 time in msec between two mouse clicks for the second click to be
5384 recognized as a multi click.
5385
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005386 *'mzquantum'* *'mzq'*
5387'mzquantum' 'mzq' number (default 100)
5388 global
5389 {not in Vi}
5390 {not available when compiled without the |+mzscheme|
5391 feature}
5392 The number of milliseconds between polls for MzScheme threads.
5393 Negative or zero value means no thread scheduling.
5394
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005396'nrformats' 'nf' string (default "bin,octal,hex",
5397 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 local to buffer
5399 {not in Vi}
5400 This defines what bases Vim will consider for numbers when using the
5401 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5402 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005403 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005405 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005406 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005408 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 considered to be hexadecimal. Example: Using CTRL-X on
5410 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005411 bin If included, numbers starting with "0b" or "0B" will be
5412 considered to be binary. Example: Using CTRL-X on
5413 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 Numbers which simply begin with a digit in the range 1-9 are always
5415 considered decimal. This also happens for numbers that are not
5416 recognized as octal or hex.
5417
5418 *'number'* *'nu'* *'nonumber'* *'nonu'*
5419'number' 'nu' boolean (default off)
5420 local to window
5421 Print the line number in front of each line. When the 'n' option is
5422 excluded from 'cpoptions' a wrapped line will not use the column of
5423 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005424 The 'numberwidth' option can be used to set the room used for the line
5425 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 When a long, wrapped line doesn't start with the first character, '-'
5427 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005428 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5429 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005430 *number_relativenumber*
5431 The 'relativenumber' option changes the displayed number to be
5432 relative to the cursor. Together with 'number' there are these
5433 four combinations (cursor in line 3):
5434
Bram Moolenaar3848e002016-03-19 18:42:29 +01005435 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005436 'nornu' 'nornu' 'rnu' 'rnu'
5437
5438 |apple | 1 apple | 2 apple | 2 apple
5439 |pear | 2 pear | 1 pear | 1 pear
5440 |nobody | 3 nobody | 0 nobody |3 nobody
5441 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005443 *'numberwidth'* *'nuw'*
5444'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5445 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005446 {not in Vi}
5447 {only available when compiled with the |+linebreak|
5448 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005449 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005450 when the 'number' or 'relativenumber' option is set or printing lines
5451 with a line number. Since one space is always between the number and
5452 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005453 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005454 fit the highest line number in the buffer respectively the number of
5455 rows in the window, depending on whether 'number' or 'relativenumber'
5456 is set. Thus with the Vim default of 4 there is room for a line number
5457 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005458 The minimum value is 1, the maximum value is 10.
5459 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5460
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005461 *'omnifunc'* *'ofu'*
5462'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005463 local to buffer
5464 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005465 {not available when compiled without the |+eval|
5466 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005467 This option specifies a function to be used for Insert mode omni
5468 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005469 See |complete-functions| for an explanation of how the function is
5470 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005471 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005472 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005473 This option cannot be set from a |modeline| or in the |sandbox|, for
5474 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005475
5476
Bram Moolenaar02467872007-05-06 13:22:01 +00005477 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005478'opendevice' 'odev' boolean (default off)
5479 global
5480 {not in Vi}
5481 {only for MS-DOS, MS-Windows and OS/2}
5482 Enable reading and writing from devices. This may get Vim stuck on a
5483 device that can be opened but doesn't actually do the I/O. Therefore
5484 it is off by default.
5485 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5486 result in editing a device.
5487
5488
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005489 *'operatorfunc'* *'opfunc'*
5490'operatorfunc' 'opfunc' string (default: empty)
5491 global
5492 {not in Vi}
5493 This option specifies a function to be called by the |g@| operator.
5494 See |:map-operator| for more info and an example.
5495
5496 This option cannot be set from a |modeline| or in the |sandbox|, for
5497 security reasons.
5498
5499
Bram Moolenaar251e1912011-06-19 05:09:16 +02005500 *'osfiletype'* *'oft'*
5501'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 local to buffer
5503 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005504 This option was supported on RISC OS, which has been removed.
5505
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005507 *'packpath'* *'pp'*
5508'packpath' 'pp' string (default: see 'runtimepath')
5509 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005510 Directories used to find packages. See |packages|.
5511
5512
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005514'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 global
5516 Specifies the nroff macros that separate paragraphs. These are pairs
5517 of two letters (see |object-motions|).
5518
5519 *'paste'* *'nopaste'*
5520'paste' boolean (default off)
5521 global
5522 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005523 Put Vim in Paste mode. This is useful if you want to cut or copy
5524 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 unexpected effects.
5526 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005527 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 knows about pasting and will mostly do the right thing without 'paste'
5529 being set. The same is true for a terminal where Vim handles the
5530 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005531 This option is reset when starting the GUI. Thus if you set it in
5532 your .vimrc it will work in a terminal, but not in the GUI. Setting
5533 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5534 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 When the 'paste' option is switched on (also when it was already on):
5536 - mapping in Insert mode and Command-line mode is disabled
5537 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005539 - 'expandtab' is reset
5540 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 - 'revins' is reset
5542 - 'ruler' is reset
5543 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005544 - 'smartindent' is reset
5545 - 'smarttab' is reset
5546 - 'softtabstop' is set to 0
5547 - 'textwidth' is set to 0
5548 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005551 - 'indentexpr'
5552 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 NOTE: When you start editing another file while the 'paste' option is
5554 on, settings from the modelines or autocommands may change the
5555 settings again, causing trouble when pasting text. You might want to
5556 set the 'paste' option again.
5557 When the 'paste' option is reset the mentioned options are restored to
5558 the value before the moment 'paste' was switched from off to on.
5559 Resetting 'paste' before ever setting it does not have any effect.
5560 Since mapping doesn't work while 'paste' is active, you need to use
5561 the 'pastetoggle' option to toggle the 'paste' option with some key.
5562
5563 *'pastetoggle'* *'pt'*
5564'pastetoggle' 'pt' string (default "")
5565 global
5566 {not in Vi}
5567 When non-empty, specifies the key sequence that toggles the 'paste'
5568 option. This is like specifying a mapping: >
5569 :map {keys} :set invpaste<CR>
5570< Where {keys} is the value of 'pastetoggle'.
5571 The difference is that it will work even when 'paste' is set.
5572 'pastetoggle' works in Insert mode and Normal mode, but not in
5573 Command-line mode.
5574 Mappings are checked first, thus overrule 'pastetoggle'. However,
5575 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5576 this: >
5577 :map <F10> :set paste<CR>
5578 :map <F11> :set nopaste<CR>
5579 :imap <F10> <C-O>:set paste<CR>
5580 :imap <F11> <nop>
5581 :set pastetoggle=<F11>
5582< This will make <F10> start paste mode and <F11> stop paste mode.
5583 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5584 mode everything is inserted literally, except the 'pastetoggle' key
5585 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005586 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587
5588 *'pex'* *'patchexpr'*
5589'patchexpr' 'pex' string (default "")
5590 global
5591 {not in Vi}
5592 {not available when compiled without the |+diff|
5593 feature}
5594 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005595 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596
Bram Moolenaardbc28022014-07-26 13:40:44 +02005597 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598'patchmode' 'pm' string (default "")
5599 global
5600 {not in Vi}
5601 When non-empty the oldest version of a file is kept. This can be used
5602 to keep the original version of a file if you are changing files in a
5603 source distribution. Only the first time that a file is written a
5604 copy of the original file will be kept. The name of the copy is the
5605 name of the original file with the string in the 'patchmode' option
5606 appended. This option should start with a dot. Use a string like
5607 ".org". 'backupdir' must not be empty for this to work (Detail: The
5608 backup file is renamed to the patchmode file after the new file has
5609 been successfully written, that's why it must be possible to write a
5610 backup file). If there was no file to be backed up, an empty file is
5611 created.
5612 When the 'backupskip' pattern matches, a patchmode file is not made.
5613 Using 'patchmode' for compressed files appends the extension at the
5614 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5615 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005616 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005618 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619'path' 'pa' string (default on Unix: ".,/usr/include,,"
5620 on OS/2: ".,/emx/include,,"
5621 other systems: ".,,")
5622 global or local to buffer |global-local|
5623 {not in Vi}
5624 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005625 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5626 provided that the file being searched for has a relative path (not
5627 starting with "/", "./" or "../"). The directories in the 'path'
5628 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 - Use commas to separate directory names: >
5630 :set path=.,/usr/local/include,/usr/include
5631< - Spaces can also be used to separate directory names (for backwards
5632 compatibility with version 3.0). To have a space in a directory
5633 name, precede it with an extra backslash, and escape the space: >
5634 :set path=.,/dir/with\\\ space
5635< - To include a comma in a directory name precede it with an extra
5636 backslash: >
5637 :set path=.,/dir/with\\,comma
5638< - To search relative to the directory of the current file, use: >
5639 :set path=.
5640< - To search in the current directory use an empty string between two
5641 commas: >
5642 :set path=,,
5643< - A directory name may end in a ':' or '/'.
5644 - Environment variables are expanded |:set_env|.
5645 - When using |netrw.vim| URLs can be used. For example, adding
5646 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005647 - Search upwards and downwards in a directory tree using "*", "**" and
5648 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 {not available when compiled without the |+path_extra| feature}
5650 - Careful with '\' characters, type two to get one in the option: >
5651 :set path=.,c:\\include
5652< Or just use '/' instead: >
5653 :set path=.,c:/include
5654< Don't forget "." or files won't even be found in the same directory as
5655 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005656 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 it is something like 256 or 1024 characters.
5658 You can check if all the include files are found, using the value of
5659 'path', see |:checkpath|.
5660 The use of |:set+=| and |:set-=| is preferred when adding or removing
5661 directories from the list. This avoids problems when a future version
5662 uses another default. To remove the current directory use: >
5663 :set path-=
5664< To add the current directory use: >
5665 :set path+=
5666< To use an environment variable, you probably need to replace the
5667 separator. Here is an example to append $INCL, in which directory
5668 names are separated with a semi-colon: >
5669 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5670< Replace the ';' with a ':' or whatever separator is used. Note that
5671 this doesn't work when $INCL contains a comma or white space.
5672
Bram Moolenaard94464e2015-11-02 15:28:18 +01005673 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005674'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005675 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005676 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005677 {only available when compiled with the |+perl/dyn|
5678 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005679 Specifies the name of the Perl shared library. The default is
5680 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005681 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005682 This option cannot be set from a |modeline| or in the |sandbox|, for
5683 security reasons.
5684
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5686'preserveindent' 'pi' boolean (default off)
5687 local to buffer
5688 {not in Vi}
5689 When changing the indent of the current line, preserve as much of the
5690 indent structure as possible. Normally the indent is replaced by a
5691 series of tabs followed by spaces as required (unless |'expandtab'| is
5692 enabled, in which case only spaces are used). Enabling this option
5693 means the indent will preserve as many existing characters as possible
5694 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005695 'expandtab' does not apply to the preserved white space, a Tab remains
5696 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 NOTE: When using ">>" multiple times the resulting indent is a mix of
5698 tabs and spaces. You might not like this.
5699 NOTE: 'preserveindent' is reset when 'compatible' is set.
5700 Also see 'copyindent'.
5701 Use |:retab| to clean up white space.
5702
5703 *'previewheight'* *'pvh'*
5704'previewheight' 'pvh' number (default 12)
5705 global
5706 {not in Vi}
5707 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005708 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 Default height for a preview window. Used for |:ptag| and associated
5710 commands. Used for |CTRL-W_}| when no count is given.
5711
5712 *'previewwindow'* *'nopreviewwindow'*
5713 *'pvw'* *'nopvw'* *E590*
5714'previewwindow' 'pvw' boolean (default off)
5715 local to window
5716 {not in Vi}
5717 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005718 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005719 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 set. It's normally not set directly, but by using one of the commands
5721 |:ptag|, |:pedit|, etc.
5722
5723 *'printdevice'* *'pdev'*
5724'printdevice' 'pdev' string (default empty)
5725 global
5726 {not in Vi}
5727 {only available when compiled with the |+printer|
5728 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005729 The name of the printer to be used for |:hardcopy|.
5730 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005731 This option cannot be set from a |modeline| or in the |sandbox|, for
5732 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733
Bram Moolenaar8299df92004-07-10 09:47:34 +00005734 *'printencoding'* *'penc'*
5735'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 global
5737 {not in Vi}
5738 {only available when compiled with the |+printer|
5739 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005740 Sets the character encoding used when printing.
5741 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
5743 *'printexpr'* *'pexpr'*
5744'printexpr' 'pexpr' String (default: see below)
5745 global
5746 {not in Vi}
5747 {only available when compiled with the |+printer|
5748 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005749 Expression used to print the PostScript produced with |:hardcopy|.
5750 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005751 This option cannot be set from a |modeline| or in the |sandbox|, for
5752 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753
Bram Moolenaar8299df92004-07-10 09:47:34 +00005754 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755'printfont' 'pfn' string (default "courier")
5756 global
5757 {not in Vi}
5758 {only available when compiled with the |+printer|
5759 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005760 The name of the font that will be used for |:hardcopy|.
5761 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762
5763 *'printheader'* *'pheader'*
5764'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5765 global
5766 {not in Vi}
5767 {only available when compiled with the |+printer|
5768 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005769 The format of the header produced in |:hardcopy| output.
5770 See |pheader-option|.
5771
5772 *'printmbcharset'* *'pmbcs'*
5773'printmbcharset' 'pmbcs' string (default "")
5774 global
5775 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005776 {only available when compiled with the |+printer|,
5777 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005778 The CJK character set to be used for CJK output from |:hardcopy|.
5779 See |pmbcs-option|.
5780
5781 *'printmbfont'* *'pmbfn'*
5782'printmbfont' 'pmbfn' string (default "")
5783 global
5784 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005785 {only available when compiled with the |+printer|,
5786 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005787 List of font names to be used for CJK output from |:hardcopy|.
5788 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789
5790 *'printoptions'* *'popt'*
5791'printoptions' 'popt' string (default "")
5792 global
5793 {not in Vi}
5794 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005795 List of items that control the format of the output of |:hardcopy|.
5796 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005798 *'prompt'* *'noprompt'*
5799'prompt' boolean (default on)
5800 global
5801 When on a ":" prompt is used in Ex mode.
5802
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005803 *'pumheight'* *'ph'*
5804'pumheight' 'ph' number (default 0)
5805 global
5806 {not available when compiled without the
5807 |+insert_expand| feature}
5808 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005809 Determines the maximum number of items to show in the popup menu for
5810 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005811 |ins-completion-menu|.
5812
Bram Moolenaard94464e2015-11-02 15:28:18 +01005813 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005814'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005815 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005816 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005817 {only available when compiled with the |+python/dyn|
5818 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005819 Specifies the name of the Python 2.x shared library. The default is
5820 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005821 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005822 This option cannot be set from a |modeline| or in the |sandbox|, for
5823 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005824
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005825 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005826'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005827 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005828 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005829 {only available when compiled with the |+python3/dyn|
5830 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005831 Specifies the name of the Python 3 shared library. The default is
5832 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005833 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005834 This option cannot be set from a |modeline| or in the |sandbox|, for
5835 security reasons.
5836
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005837 *'pyxversion'* *'pyx'*
5838'pyxversion' 'pyx' number (default depends on the build)
5839 global
5840 {not in Vi}
5841 {only available when compiled with the |+python| or
5842 the |+python3| feature}
5843 Specifies the python version used for pyx* functions and commands
5844 |python_x|. The default value is as follows:
5845
5846 Compiled with Default ~
5847 |+python| and |+python3| 0
5848 only |+python| 2
5849 only |+python3| 3
5850
5851 Available values are 0, 2 and 3.
5852 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5853 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5854 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5855 to 2 if Python 2 is available.
5856 See also: |has-pythonx|
5857
5858 If Vim is compiled with only |+python| or |+python3| setting
5859 'pyxversion' has no effect. The pyx* functions and commands are
5860 always the same as the compiled version.
5861
5862 This option cannot be set from a |modeline| or in the |sandbox|, for
5863 security reasons.
5864
Bram Moolenaar677ee682005-01-27 14:41:15 +00005865 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005866'quoteescape' 'qe' string (default "\")
5867 local to buffer
5868 {not in Vi}
5869 The characters that are used to escape quotes in a string. Used for
5870 objects like a', a" and a` |a'|.
5871 When one of the characters in this option is found inside a string,
5872 the following character will be skipped. The default value makes the
5873 text "foo\"bar\\" considered to be one string.
5874
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5876'readonly' 'ro' boolean (default off)
5877 local to buffer
5878 If on, writes fail unless you use a '!'. Protects you from
5879 accidentally overwriting a file. Default on when Vim is started
5880 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005881 When using ":w!" the 'readonly' option is reset for the current
5882 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005884 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005885 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005887 *'redrawtime'* *'rdt'*
5888'redrawtime' 'rdt' number (default 2000)
5889 global
5890 {not in Vi}
5891 {only available when compiled with the |+reltime|
5892 feature}
5893 The time in milliseconds for redrawing the display. This applies to
5894 searching for patterns for 'hlsearch' and |:match| highlighting.
5895 When redrawing takes more than this many milliseconds no further
5896 matches will be highlighted. This is used to avoid that Vim hangs
5897 when using a very complicated pattern.
5898
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005899 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005900'regexpengine' 're' number (default 0)
5901 global
5902 {not in Vi}
5903 This selects the default regexp engine. |two-engines|
5904 The possible values are:
5905 0 automatic selection
5906 1 old engine
5907 2 NFA engine
5908 Note that when using the NFA engine and the pattern contains something
5909 that is not supported the pattern will not match. This is only useful
5910 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005911 Using automatic selection enables Vim to switch the engine, if the
5912 default engine becomes too costly. E.g., when the NFA engine uses too
5913 many states. This should prevent Vim from hanging on a combination of
5914 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005915
Bram Moolenaar64486672010-05-16 15:46:46 +02005916 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5917'relativenumber' 'rnu' boolean (default off)
5918 local to window
5919 {not in Vi}
5920 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005921 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005922 precede some vertical motion commands (e.g. j k + -) with, without
5923 having to calculate it yourself. Especially useful in combination with
5924 other commands (e.g. y d c < > gq gw =).
5925 When the 'n' option is excluded from 'cpoptions' a wrapped
5926 line will not use the column of line numbers (this is the default when
5927 'compatible' isn't set).
5928 The 'numberwidth' option can be used to set the room used for the line
5929 number.
5930 When a long, wrapped line doesn't start with the first character, '-'
5931 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005932 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5933 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005934
5935 The number in front of the cursor line also depends on the value of
5936 'number', see |number_relativenumber| for all combinations of the two
5937 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005938
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939 *'remap'* *'noremap'*
5940'remap' boolean (default on)
5941 global
5942 Allows for mappings to work recursively. If you do not want this for
5943 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005944 NOTE: To avoid portability problems with Vim scripts, always keep
5945 this option at the default "on". Only switch it off when working with
5946 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005948 *'renderoptions'* *'rop'*
5949'renderoptions' 'rop' string (default: empty)
5950 global
5951 {not in Vi}
5952 {only available when compiled with GUI and DIRECTX on
5953 MS-Windows}
5954 Select a text renderer and set its options. The options depend on the
5955 renderer.
5956
5957 Syntax: >
5958 set rop=type:{renderer}(,{name}:{value})*
5959<
5960 Currently, only one optional renderer is available.
5961
5962 render behavior ~
5963 directx Vim will draw text using DirectX (DirectWrite). It makes
5964 drawn glyphs more beautiful than default GDI.
5965 It requires 'encoding' is "utf-8", and only works on
5966 MS-Windows Vista or newer version.
5967
5968 Options:
5969 name meaning type value ~
5970 gamma gamma float 1.0 - 2.2 (maybe)
5971 contrast enhancedContrast float (unknown)
5972 level clearTypeLevel float (unknown)
5973 geom pixelGeometry int 0 - 2 (see below)
5974 renmode renderingMode int 0 - 6 (see below)
5975 taamode textAntialiasMode int 0 - 3 (see below)
5976
5977 See this URL for detail:
5978 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5979
5980 For geom: structure of a device pixel.
5981 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5982 1 - DWRITE_PIXEL_GEOMETRY_RGB
5983 2 - DWRITE_PIXEL_GEOMETRY_BGR
5984
5985 See this URL for detail:
5986 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5987
5988 For renmode: method of rendering glyphs.
5989 0 - DWRITE_RENDERING_MODE_DEFAULT
5990 1 - DWRITE_RENDERING_MODE_ALIASED
5991 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5992 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5993 4 - DWRITE_RENDERING_MODE_NATURAL
5994 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5995 6 - DWRITE_RENDERING_MODE_OUTLINE
5996
5997 See this URL for detail:
5998 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5999
6000 For taamode: antialiasing mode used for drawing text.
6001 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6002 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6003 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6004 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6005
6006 See this URL for detail:
6007 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6008
6009 Example: >
6010 set encoding=utf-8
6011 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6012 set rop=type:directx
6013<
6014 If select a raster font (Courier, Terminal or FixedSys) to
6015 'guifont', it fallbacks to be drawn by GDI automatically.
6016
6017 Other render types are currently not supported.
6018
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 *'report'*
6020'report' number (default 2)
6021 global
6022 Threshold for reporting number of lines changed. When the number of
6023 changed lines is more than 'report' a message will be given for most
6024 ":" commands. If you want it always, set 'report' to 0.
6025 For the ":substitute" command the number of substitutions is used
6026 instead of the number of lines.
6027
6028 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6029'restorescreen' 'rs' boolean (default on)
6030 global
6031 {not in Vi} {only in Windows 95/NT console version}
6032 When set, the screen contents is restored when exiting Vim. This also
6033 happens when executing external commands.
6034
6035 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6036 options in your .vimrc. To disable restoring:
6037 set t_ti= t_te=
6038 To enable restoring (for an xterm):
6039 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6040 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6041
6042 *'revins'* *'ri'* *'norevins'* *'nori'*
6043'revins' 'ri' boolean (default off)
6044 global
6045 {not in Vi}
6046 {only available when compiled with the |+rightleft|
6047 feature}
6048 Inserting characters in Insert mode will work backwards. See "typing
6049 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6050 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006051 NOTE: This option is reset when 'compatible' is set.
6052 This option is reset when 'paste' is set and restored when 'paste' is
6053 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054
6055 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6056'rightleft' 'rl' boolean (default off)
6057 local to window
6058 {not in Vi}
6059 {only available when compiled with the |+rightleft|
6060 feature}
6061 When on, display orientation becomes right-to-left, i.e., characters
6062 that are stored in the file appear from the right to the left.
6063 Using this option, it is possible to edit files for languages that
6064 are written from the right to the left such as Hebrew and Arabic.
6065 This option is per window, so it is possible to edit mixed files
6066 simultaneously, or to view the same file in both ways (this is
6067 useful whenever you have a mixed text file with both right-to-left
6068 and left-to-right strings so that both sets are displayed properly
6069 in different windows). Also see |rileft.txt|.
6070
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006071 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072'rightleftcmd' 'rlc' string (default "search")
6073 local to window
6074 {not in Vi}
6075 {only available when compiled with the |+rightleft|
6076 feature}
6077 Each word in this option enables the command line editing to work in
6078 right-to-left mode for a group of commands:
6079
6080 search "/" and "?" commands
6081
6082 This is useful for languages such as Hebrew, Arabic and Farsi.
6083 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6084
Bram Moolenaard94464e2015-11-02 15:28:18 +01006085 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006086'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006087 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006088 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006089 {only available when compiled with the |+ruby/dyn|
6090 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006091 Specifies the name of the Ruby shared library. The default is
6092 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006093 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006094 This option cannot be set from a |modeline| or in the |sandbox|, for
6095 security reasons.
6096
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006098'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 global
6100 {not in Vi}
6101 {not available when compiled without the
6102 |+cmdline_info| feature}
6103 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006104 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 text in the file is shown on the far right:
6106 Top first line is visible
6107 Bot last line is visible
6108 All first and last line are visible
6109 45% relative position in the file
6110 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006111 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006113 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 this option takes precedence over 'ruler' and 'rulerformat'
6115 If the number of characters displayed is different from the number of
6116 bytes in the text (e.g., for a TAB or a multi-byte character), both
6117 the text column (byte number) and the screen column are shown,
6118 separated with a dash.
6119 For an empty line "0-1" is shown.
6120 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006121 This option is reset when 'paste' is set and restored when 'paste' is
6122 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 If you don't want to see the ruler all the time but want to know where
6124 you are, use "g CTRL-G" |g_CTRL-G|.
6125 NOTE: This option is reset when 'compatible' is set.
6126
6127 *'rulerformat'* *'ruf'*
6128'rulerformat' 'ruf' string (default empty)
6129 global
6130 {not in Vi}
6131 {not available when compiled without the |+statusline|
6132 feature}
6133 When this option is not empty, it determines the content of the ruler
6134 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006135 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 The default ruler width is 17 characters. To make the ruler 15
6137 characters wide, put "%15(" at the start and "%)" at the end.
6138 Example: >
6139 :set rulerformat=%15(%c%V\ %p%%%)
6140<
6141 *'runtimepath'* *'rtp'* *vimfiles*
6142'runtimepath' 'rtp' string (default:
6143 Unix: "$HOME/.vim,
6144 $VIM/vimfiles,
6145 $VIMRUNTIME,
6146 $VIM/vimfiles/after,
6147 $HOME/.vim/after"
6148 Amiga: "home:vimfiles,
6149 $VIM/vimfiles,
6150 $VIMRUNTIME,
6151 $VIM/vimfiles/after,
6152 home:vimfiles/after"
6153 PC, OS/2: "$HOME/vimfiles,
6154 $VIM/vimfiles,
6155 $VIMRUNTIME,
6156 $VIM/vimfiles/after,
6157 $HOME/vimfiles/after"
6158 Macintosh: "$VIM:vimfiles,
6159 $VIMRUNTIME,
6160 $VIM:vimfiles:after"
6161 RISC-OS: "Choices:vimfiles,
6162 $VIMRUNTIME,
6163 Choices:vimfiles/after"
6164 VMS: "sys$login:vimfiles,
6165 $VIM/vimfiles,
6166 $VIMRUNTIME,
6167 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006168 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169 global
6170 {not in Vi}
6171 This is a list of directories which will be searched for runtime
6172 files:
6173 filetype.vim filetypes by file name |new-filetype|
6174 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006175 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 colors/ color scheme files |:colorscheme|
6177 compiler/ compiler files |:compiler|
6178 doc/ documentation |write-local-help|
6179 ftplugin/ filetype plugins |write-filetype-plugin|
6180 indent/ indent scripts |indent-expression|
6181 keymap/ key mapping files |mbyte-keymap|
6182 lang/ menu translations |:menutrans|
6183 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006184 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 plugin/ plugin scripts |write-plugin|
6186 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006187 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 syntax/ syntax files |mysyntaxfile|
6189 tutor/ files for vimtutor |tutor|
6190
6191 And any other file searched for with the |:runtime| command.
6192
6193 The defaults for most systems are setup to search five locations:
6194 1. In your home directory, for your personal preferences.
6195 2. In a system-wide Vim directory, for preferences from the system
6196 administrator.
6197 3. In $VIMRUNTIME, for files distributed with Vim.
6198 *after-directory*
6199 4. In the "after" directory in the system-wide Vim directory. This is
6200 for the system administrator to overrule or add to the distributed
6201 defaults (rarely needed)
6202 5. In the "after" directory in your home directory. This is for
6203 personal preferences to overrule or add to the distributed defaults
6204 or system-wide settings (rarely needed).
6205
Bram Moolenaard0796902016-09-16 20:02:31 +02006206 More entries are added when using |packages|. If it gets very long
6207 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6208 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006209
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6211 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 wildcards.
6214 See |:runtime|.
6215 Example: >
6216 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6217< This will use the directory "~/vimruntime" first (containing your
6218 personal Vim runtime files), then "/mygroup/vim" (shared between a
6219 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6220 files).
6221 You probably should always include $VIMRUNTIME somewhere, to use the
6222 distributed runtime files. You can put a directory before $VIMRUNTIME
6223 to find files which replace a distributed runtime files. You can put
6224 a directory after $VIMRUNTIME to find files which add to distributed
6225 runtime files.
6226 This option cannot be set from a |modeline| or in the |sandbox|, for
6227 security reasons.
6228
6229 *'scroll'* *'scr'*
6230'scroll' 'scr' number (default: half the window height)
6231 local to window
6232 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6233 set to half the number of lines in the window when the window size
6234 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006235 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006236 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6237 the number of screen lines instead of file lines, makes a difference
6238 when lines wrap}
6239
6240 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6241'scrollbind' 'scb' boolean (default off)
6242 local to window
6243 {not in Vi}
6244 {not available when compiled without the |+scrollbind|
6245 feature}
6246 See also |scroll-binding|. When this option is set, the current
6247 window scrolls as other scrollbind windows (windows that also have
6248 this option set) scroll. This option is useful for viewing the
6249 differences between two versions of a file, see 'diff'.
6250 See |'scrollopt'| for options that determine how this option should be
6251 interpreted.
6252 This option is mostly reset when splitting a window to edit another
6253 file. This means that ":split | edit file" results in two windows
6254 with scroll-binding, but ":split file" does not.
6255
6256 *'scrolljump'* *'sj'*
6257'scrolljump' 'sj' number (default 1)
6258 global
6259 {not in Vi}
6260 Minimal number of lines to scroll when the cursor gets off the
6261 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6262 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006263 When set to a negative number from -1 to -100 this is used as the
6264 percentage of the window height. Thus -50 scrolls half the window
6265 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 NOTE: This option is set to 1 when 'compatible' is set.
6267
6268 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006269'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 global
6271 {not in Vi}
6272 Minimal number of screen lines to keep above and below the cursor.
6273 This will make some context visible around where you are working. If
6274 you set it to a very large value (999) the cursor line will always be
6275 in the middle of the window (except at the start or end of the file or
6276 when long lines wrap).
6277 For scrolling horizontally see 'sidescrolloff'.
6278 NOTE: This option is set to 0 when 'compatible' is set.
6279
6280 *'scrollopt'* *'sbo'*
6281'scrollopt' 'sbo' string (default "ver,jump")
6282 global
6283 {not available when compiled without the |+scrollbind|
6284 feature}
6285 {not in Vi}
6286 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006287 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6288 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 The following words are available:
6290 ver Bind vertical scrolling for 'scrollbind' windows
6291 hor Bind horizontal scrolling for 'scrollbind' windows
6292 jump Applies to the offset between two windows for vertical
6293 scrolling. This offset is the difference in the first
6294 displayed line of the bound windows. When moving
6295 around in a window, another 'scrollbind' window may
6296 reach a position before the start or after the end of
6297 the buffer. The offset is not changed though, when
6298 moving back the 'scrollbind' window will try to scroll
6299 to the desired position when possible.
6300 When now making that window the current one, two
6301 things can be done with the relative offset:
6302 1. When "jump" is not included, the relative offset is
6303 adjusted for the scroll position in the new current
6304 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006305 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 2. When "jump" is included, the other windows are
6307 scrolled to keep the same relative offset. When
6308 going back to the other window, it still uses the
6309 same relative offset.
6310 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006311 When 'diff' mode is active there always is vertical scroll binding,
6312 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313
6314 *'sections'* *'sect'*
6315'sections' 'sect' string (default "SHNHH HUnhsh")
6316 global
6317 Specifies the nroff macros that separate sections. These are pairs of
6318 two letters (See |object-motions|). The default makes a section start
6319 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6320
6321 *'secure'* *'nosecure'* *E523*
6322'secure' boolean (default off)
6323 global
6324 {not in Vi}
6325 When on, ":autocmd", shell and write commands are not allowed in
6326 ".vimrc" and ".exrc" in the current directory and map commands are
6327 displayed. Switch it off only if you know that you will not run into
6328 problems, or when the 'exrc' option is off. On Unix this option is
6329 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006330 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 'secure' at the end of your ~/.vimrc then.
6332 This option cannot be set from a |modeline| or in the |sandbox|, for
6333 security reasons.
6334
6335 *'selection'* *'sel'*
6336'selection' 'sel' string (default "inclusive")
6337 global
6338 {not in Vi}
6339 This option defines the behavior of the selection. It is only used
6340 in Visual and Select mode.
6341 Possible values:
6342 value past line inclusive ~
6343 old no yes
6344 inclusive yes yes
6345 exclusive yes no
6346 "past line" means that the cursor is allowed to be positioned one
6347 character past the line.
6348 "inclusive" means that the last character of the selection is included
6349 in an operation. For example, when "x" is used to delete the
6350 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006351 When "old" is used and 'virtualedit' allows the cursor to move past
6352 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 Note that when "exclusive" is used and selecting from the end
6354 backwards, you cannot include the last character of a line, when
6355 starting in Normal mode and 'virtualedit' empty.
6356
6357 The 'selection' option is set by the |:behave| command.
6358
6359 *'selectmode'* *'slm'*
6360'selectmode' 'slm' string (default "")
6361 global
6362 {not in Vi}
6363 This is a comma separated list of words, which specifies when to start
6364 Select mode instead of Visual mode, when a selection is started.
6365 Possible values:
6366 mouse when using the mouse
6367 key when using shifted special keys
6368 cmd when using "v", "V" or CTRL-V
6369 See |Select-mode|.
6370 The 'selectmode' option is set by the |:behave| command.
6371
6372 *'sessionoptions'* *'ssop'*
6373'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006374 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 global
6376 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006377 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 feature}
6379 Changes the effect of the |:mksession| command. It is a comma
6380 separated list of words. Each word enables saving and restoring
6381 something:
6382 word save and restore ~
6383 blank empty windows
6384 buffers hidden and unloaded buffers, not just those in windows
6385 curdir the current directory
6386 folds manually created folds, opened/closed folds and local
6387 fold options
6388 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006389 and contain at least one lowercase letter. Only
6390 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 help the help window
6392 localoptions options and mappings local to a window or buffer (not
6393 global values for local options)
6394 options all options and mappings (also global values for local
6395 options)
6396 resize size of the Vim window: 'lines' and 'columns'
6397 sesdir the directory in which the session file is located
6398 will become the current directory (useful with
6399 projects accessed over a network from different
6400 systems)
6401 slash backslashes in file names replaced with forward
6402 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006403 tabpages all tab pages; without this only the current tab page
6404 is restored, so that you can make a session for each
6405 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 unix with Unix end-of-line format (single <NL>), even when
6407 on Windows or DOS
6408 winpos position of the whole Vim window
6409 winsize window sizes
6410
6411 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006412 When neither "curdir" nor "sesdir" is included, file names are stored
6413 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 "slash" and "unix" are useful on Windows when sharing session files
6415 with Unix. The Unix version of Vim cannot source dos format scripts,
6416 but the Windows version of Vim can source unix format scripts.
6417
6418 *'shell'* *'sh'* *E91*
6419'shell' 'sh' string (default $SHELL or "sh",
6420 MS-DOS and Win32: "command.com" or
6421 "cmd.exe", OS/2: "cmd")
6422 global
6423 Name of the shell to use for ! and :! commands. When changing the
6424 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6425 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006426 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 See |option-backslash| about including spaces and backslashes.
6428 Environment variables are expanded |:set_env|.
6429 If the name of the shell contains a space, you might need to enclose
6430 it in quotes. Example: >
6431 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6432< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006433 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 "-f" is not inside the quotes, because it is not part of the command
6435 name. And Vim automagically recognizes the backslashes that are path
6436 separators.
6437 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6438 variable to change the way external commands are executed. See the
6439 libc.inf file of DJGPP.
6440 Under MS-Windows, when the executable ends in ".com" it must be
6441 included. Thus setting the shell to "command.com" or "4dos.com"
6442 works, but "command" and "4dos" do not work for all commands (e.g.,
6443 filtering).
6444 For unknown reasons, when using "4dos.com" the current directory is
6445 changed to "C:\". To avoid this set 'shell' like this: >
6446 :set shell=command.com\ /c\ 4dos
6447< This option cannot be set from a |modeline| or in the |sandbox|, for
6448 security reasons.
6449
6450 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006451'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006452 MS-DOS and Win32, when 'shell' does not
6453 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 global
6455 {not in Vi}
6456 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6457 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6458 systems, the default is set according to the value of 'shell', to
6459 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006460 OS/2 (EMX figures this out itself).
6461 On Unix it can have more than one flag. Each white space separated
6462 part is passed as an argument to the shell command.
6463 See |option-backslash| about including spaces and backslashes.
6464 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'shellpipe'* *'sp'*
6469'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6470 global
6471 {not in Vi}
6472 {not available when compiled without the |+quickfix|
6473 feature}
6474 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 including spaces and backslashes.
6477 The name of the temporary file can be represented by "%s" if necessary
6478 (the file name is appended automatically if no %s appears in the value
6479 of this option).
6480 For the Amiga and MS-DOS the default is ">". The output is directly
6481 saved in a file and not echoed to the screen.
6482 For Unix the default it "| tee". The stdout of the compiler is saved
6483 in a file and echoed to the screen. If the 'shell' option is "csh" or
6484 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006485 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6486 default becomes "2>&1| tee". This means that stderr is also included.
6487 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6488 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 The initialization of this option is done after reading the ".vimrc"
6490 and the other initializations, so that when the 'shell' option is set
6491 there, the 'shellpipe' option changes automatically, unless it was
6492 explicitly set before.
6493 When 'shellpipe' is set to an empty string, no redirection of the
6494 ":make" output will be done. This is useful if you use a 'makeprg'
6495 that writes to 'makeef' by itself. If you want no piping, but do
6496 want to include the 'makeef', set 'shellpipe' to a single space.
6497 Don't forget to precede the space with a backslash: ":set sp=\ ".
6498 In the future pipes may be used for filtering and this option will
6499 become obsolete (at least for Unix).
6500 This option cannot be set from a |modeline| or in the |sandbox|, for
6501 security reasons.
6502
6503 *'shellquote'* *'shq'*
6504'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6505 contains "sh" somewhere: "\"")
6506 global
6507 {not in Vi}
6508 Quoting character(s), put around the command passed to the shell, for
6509 the "!" and ":!" commands. The redirection is kept outside of the
6510 quoting. See 'shellxquote' to include the redirection. It's
6511 probably not useful to set both options.
6512 This is an empty string by default. Only known to be useful for
6513 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6514 or bash, where it should be "\"". The default is adjusted according
6515 the value of 'shell', to reduce the need to set this option by the
6516 user. See |dos-shell|.
6517 This option cannot be set from a |modeline| or in the |sandbox|, for
6518 security reasons.
6519
6520 *'shellredir'* *'srr'*
6521'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6522 global
6523 {not in Vi}
6524 String to be used to put the output of a filter command in a temporary
6525 file. See also |:!|. See |option-backslash| about including spaces
6526 and backslashes.
6527 The name of the temporary file can be represented by "%s" if necessary
6528 (the file name is appended automatically if no %s appears in the value
6529 of this option).
6530 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6531 or "zsh" during initializations, the default becomes ">&". If the
6532 'shell' option is "sh", "ksh" or "bash" the default becomes
6533 ">%s 2>&1". This means that stderr is also included.
6534 For Win32, the Unix checks are done and additionally "cmd" is checked
6535 for, which makes the default ">%s 2>&1". Also, the same names with
6536 ".exe" appended are checked for.
6537 The initialization of this option is done after reading the ".vimrc"
6538 and the other initializations, so that when the 'shell' option is set
6539 there, the 'shellredir' option changes automatically unless it was
6540 explicitly set before.
6541 In the future pipes may be used for filtering and this option will
6542 become obsolete (at least for Unix).
6543 This option cannot be set from a |modeline| or in the |sandbox|, for
6544 security reasons.
6545
6546 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6547'shellslash' 'ssl' boolean (default off)
6548 global
6549 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6550 When set, a forward slash is used when expanding file names. This is
6551 useful when a Unix-like shell is used instead of command.com or
6552 cmd.exe. Backward slashes can still be typed, but they are changed to
6553 forward slashes by Vim.
6554 Note that setting or resetting this option has no effect for some
6555 existing file names, thus this option needs to be set before opening
6556 any file for best results. This might change in the future.
6557 'shellslash' only works when a backslash can be used as a path
6558 separator. To test if this is so use: >
6559 if exists('+shellslash')
6560<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006561 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6562'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6563 global
6564 {not in Vi}
6565 When on, use temp files for shell commands. When off use a pipe.
6566 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006567 Currently a pipe is only supported on Unix and MS-Windows 2K and
6568 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006569 :if has("filterpipe")
6570< The advantage of using a pipe is that nobody can read the temp file
6571 and the 'shell' command does not need to support redirection.
6572 The advantage of using a temp file is that the file type and encoding
6573 can be detected.
6574 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6575 |FilterWritePost| autocommands event are not triggered when
6576 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006577 The `system()` function does not respect this option and always uses
6578 temp files.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006579
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 *'shelltype'* *'st'*
6581'shelltype' 'st' number (default 0)
6582 global
6583 {not in Vi} {only for the Amiga}
6584 On the Amiga this option influences the way how the commands work
6585 which use a shell.
6586 0 and 1: always use the shell
6587 2 and 3: use the shell only to filter lines
6588 4 and 5: use shell only for ':sh' command
6589 When not using the shell, the command is executed directly.
6590
6591 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6592 1 and 3: use "shell cmd" to start external commands
6593
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006594 *'shellxescape'* *'sxe'*
6595'shellxescape' 'sxe' string (default: "";
6596 for MS-DOS and MS-Windows: "\"&|<>()@^")
6597 global
6598 {not in Vi}
6599 When 'shellxquote' is set to "(" then the characters listed in this
6600 option will be escaped with a '^' character. This makes it possible
6601 to execute most external commands with cmd.exe.
6602
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 *'shellxquote'* *'sxq'*
6604'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006605 for Win32, when 'shell' is cmd.exe: "("
6606 for Win32, when 'shell' contains "sh"
6607 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 for Unix, when using system(): "\"")
6609 global
6610 {not in Vi}
6611 Quoting character(s), put around the command passed to the shell, for
6612 the "!" and ":!" commands. Includes the redirection. See
6613 'shellquote' to exclude the redirection. It's probably not useful
6614 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006615 When the value is '(' then ')' is appended. When the value is '"('
6616 then ')"' is appended.
6617 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006618 This is an empty string by default on most systems, but is known to be
6619 useful for on Win32 version, either for cmd.exe which automatically
6620 strips off the first and last quote on a command, or 3rd-party shells
6621 such as the MKS Korn Shell or bash, where it should be "\"". The
6622 default is adjusted according the value of 'shell', to reduce the need
6623 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 This option cannot be set from a |modeline| or in the |sandbox|, for
6625 security reasons.
6626
6627 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6628'shiftround' 'sr' boolean (default off)
6629 global
6630 {not in Vi}
6631 Round indent to multiple of 'shiftwidth'. Applies to > and <
6632 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6633 a multiple of 'shiftwidth' (this is Vi compatible).
6634 NOTE: This option is reset when 'compatible' is set.
6635
6636 *'shiftwidth'* *'sw'*
6637'shiftwidth' 'sw' number (default 8)
6638 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006639 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006641 When zero the 'ts' value will be used. Use the |shiftwidth()|
6642 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643
6644 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006645'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6646 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 global
6648 {not in Vi}
6649 This option helps to avoid all the |hit-enter| prompts caused by file
6650 messages, for example with CTRL-G, and to avoid some other messages.
6651 It is a list of flags:
6652 flag meaning when present ~
6653 f use "(3 of 5)" instead of "(file 3 of 5)"
6654 i use "[noeol]" instead of "[Incomplete last line]"
6655 l use "999L, 888C" instead of "999 lines, 888 characters"
6656 m use "[+]" instead of "[Modified]"
6657 n use "[New]" instead of "[New File]"
6658 r use "[RO]" instead of "[readonly]"
6659 w use "[w]" instead of "written" for file write message
6660 and "[a]" instead of "appended" for ':w >> file' command
6661 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6662 "[unix format]" and "[mac]" instead of "[mac format]".
6663 a all of the above abbreviations
6664
6665 o overwrite message for writing a file with subsequent message
6666 for reading a file (useful for ":wn" or when 'autowrite' on)
6667 O message for reading a file overwrites any previous message.
6668 Also for quickfix message (e.g., ":cn").
6669 s don't give "search hit BOTTOM, continuing at TOP" or "search
6670 hit TOP, continuing at BOTTOM" messages
6671 t truncate file message at the start if it is too long to fit
6672 on the command-line, "<" will appear in the left most column.
6673 Ignored in Ex mode.
6674 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006675 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 Ignored in Ex mode.
6677 W don't give "written" or "[w]" when writing a file
6678 A don't give the "ATTENTION" message when an existing swap file
6679 is found.
6680 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006681 c don't give |ins-completion-menu| messages. For example,
6682 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6683 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006684 q use "recording" instead of "recording @a"
6685 F don't give the file info when editing a file, like `:silent`
6686 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687
6688 This gives you the opportunity to avoid that a change between buffers
6689 requires you to hit <Enter>, but still gives as useful a message as
6690 possible for the space available. To get the whole message that you
6691 would have got with 'shm' empty, use ":file!"
6692 Useful values:
6693 shm= No abbreviation of message.
6694 shm=a Abbreviation, but no loss of information.
6695 shm=at Abbreviation, and truncate message when necessary.
6696
6697 NOTE: This option is set to the Vi default value when 'compatible' is
6698 set and to the Vim default value when 'compatible' is reset.
6699
6700 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6701'shortname' 'sn' boolean (default off)
6702 local to buffer
6703 {not in Vi, not in MS-DOS versions}
6704 Filenames are assumed to be 8 characters plus one extension of 3
6705 characters. Multiple dots in file names are not allowed. When this
6706 option is on, dots in file names are replaced with underscores when
6707 adding an extension (".~" or ".swp"). This option is not available
6708 for MS-DOS, because then it would always be on. This option is useful
6709 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6710 or crossdos. When running the Win32 GUI version under Win32s, this
6711 option is always on by default.
6712
6713 *'showbreak'* *'sbr'* *E595*
6714'showbreak' 'sbr' string (default "")
6715 global
6716 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006717 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 feature}
6719 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006720 values are "> " or "+++ ": >
6721 :set showbreak=>\
6722< Note the backslash to escape the trailing space. It's easier like
6723 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006724 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006725< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006726 comma (in a future version the comma might be used to separate the
6727 part that is shown at the end and at the start of a line).
6728 The characters are highlighted according to the '@' flag in
6729 'highlight'.
6730 Note that tabs after the showbreak will be displayed differently.
6731 If you want the 'showbreak' to appear in between line numbers, add the
6732 "n" flag to 'cpoptions'.
6733
6734 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006735'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6736 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 global
6738 {not in Vi}
6739 {not available when compiled without the
6740 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006741 Show (partial) command in the last line of the screen. Set this
6742 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 In Visual mode the size of the selected area is shown:
6744 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006745 If the number of bytes is different it is also displayed: "2-6"
6746 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006748 - When selecting a block, the size in screen characters:
6749 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 NOTE: This option is set to the Vi default value when 'compatible' is
6751 set and to the Vim default value when 'compatible' is reset.
6752
6753 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6754'showfulltag' 'sft' boolean (default off)
6755 global
6756 {not in Vi}
6757 When completing a word in insert mode (see |ins-completion|) from the
6758 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006759 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 matched a C function, you can see a template for what arguments are
6761 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006762 Note that this doesn't work well together with having "longest" in
6763 'completeopt', because the completion from the search pattern may not
6764 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765
6766 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6767'showmatch' 'sm' boolean (default off)
6768 global
6769 When a bracket is inserted, briefly jump to the matching one. The
6770 jump is only done if the match can be seen on the screen. The time to
6771 show the match can be set with 'matchtime'.
6772 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006773 seen or not).
6774 This option is reset when 'paste' is set and restored when 'paste' is
6775 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 When the 'm' flag is not included in 'cpoptions', typing a character
6777 will immediately move the cursor back to where it belongs.
6778 See the "sm" field in 'guicursor' for setting the cursor shape and
6779 blinking when showing the match.
6780 The 'matchpairs' option can be used to specify the characters to show
6781 matches for. 'rightleft' and 'revins' are used to look for opposite
6782 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006783 Also see the matchparen plugin for highlighting the match when moving
6784 around |pi_paren.txt|.
6785 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786
6787 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6788'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6789 global
6790 If in Insert, Replace or Visual mode put a message on the last line.
6791 Use the 'M' flag in 'highlight' to set the type of highlighting for
6792 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006793 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 doesn't mean XIM is really active, especially when 'imactivatekey' is
6795 not set.
6796 NOTE: This option is set to the Vi default value when 'compatible' is
6797 set and to the Vim default value when 'compatible' is reset.
6798
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006799 *'showtabline'* *'stal'*
6800'showtabline' 'stal' number (default 1)
6801 global
6802 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006803 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006804 feature}
6805 The value of this option specifies when the line with tab page labels
6806 will be displayed:
6807 0: never
6808 1: only if there are at least two tab pages
6809 2: always
6810 This is both for the GUI and non-GUI implementation of the tab pages
6811 line.
6812 See |tab-page| for more information about tab pages.
6813
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 *'sidescroll'* *'ss'*
6815'sidescroll' 'ss' number (default 0)
6816 global
6817 {not in Vi}
6818 The minimal number of columns to scroll horizontally. Used only when
6819 the 'wrap' option is off and the cursor is moved off of the screen.
6820 When it is zero the cursor will be put in the middle of the screen.
6821 When using a slow terminal set it to a large number or 0. When using
6822 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6823 commands.
6824
6825 *'sidescrolloff'* *'siso'*
6826'sidescrolloff' 'siso' number (default 0)
6827 global
6828 {not in Vi}
6829 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006830 right of the cursor if 'nowrap' is set. Setting this option to a
6831 value greater than 0 while having |'sidescroll'| also at a non-zero
6832 value makes some context visible in the line you are scrolling in
6833 horizontally (except at beginning of the line). Setting this option
6834 to a large value (like 999) has the effect of keeping the cursor
6835 horizontally centered in the window, as long as one does not come too
6836 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 NOTE: This option is set to 0 when 'compatible' is set.
6838
6839 Example: Try this together with 'sidescroll' and 'listchars' as
6840 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006841 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842
6843 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6844 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006845<
6846 *'signcolumn'* *'scl'*
6847'signcolumn' 'scl' string (default "auto")
6848 local to window
6849 {not in Vi}
6850 {not available when compiled without the |+signs|
6851 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006852 Whether or not to draw the signcolumn. Valid values are:
6853 "auto" only when there is a sign to display
6854 "no" never
6855 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856
6857
6858 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6859'smartcase' 'scs' boolean (default off)
6860 global
6861 {not in Vi}
6862 Override the 'ignorecase' option if the search pattern contains upper
6863 case characters. Only used when the search pattern is typed and
6864 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006865 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6867 recalling the search pattern from history and hitting <Enter>.
6868 NOTE: This option is reset when 'compatible' is set.
6869
6870 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6871'smartindent' 'si' boolean (default off)
6872 local to buffer
6873 {not in Vi}
6874 {not available when compiled without the
6875 |+smartindent| feature}
6876 Do smart autoindenting when starting a new line. Works for C-like
6877 programs, but can also be used for other languages. 'cindent' does
6878 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006879 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006880 setting 'si' has no effect. 'indentexpr' is a more advanced
6881 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 Normally 'autoindent' should also be on when using 'smartindent'.
6883 An indent is automatically inserted:
6884 - After a line ending in '{'.
6885 - After a line starting with a keyword from 'cinwords'.
6886 - Before a line starting with '}' (only with the "O" command).
6887 When typing '}' as the first character in a new line, that line is
6888 given the same indent as the matching '{'.
6889 When typing '#' as the first character in a new line, the indent for
6890 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006891 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6893 When using the ">>" command, lines starting with '#' are not shifted
6894 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006895 NOTE: 'smartindent' is reset when 'compatible' is set.
6896 This option is reset when 'paste' is set and restored when 'paste' is
6897 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898
6899 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6900'smarttab' 'sta' boolean (default off)
6901 global
6902 {not in Vi}
6903 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006904 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6905 <BS> will delete a 'shiftwidth' worth of space at the start of the
6906 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006907 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006908 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6909 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006910 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006912 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006913 This option is reset when 'paste' is set and restored when 'paste' is
6914 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 NOTE: This option is reset when 'compatible' is set.
6916
6917 *'softtabstop'* *'sts'*
6918'softtabstop' 'sts' number (default 0)
6919 local to buffer
6920 {not in Vi}
6921 Number of spaces that a <Tab> counts for while performing editing
6922 operations, like inserting a <Tab> or using <BS>. It "feels" like
6923 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6924 used. This is useful to keep the 'ts' setting at its standard value
6925 of 8, while being able to edit like it is set to 'sts'. However,
6926 commands like "x" still work on the actual characters.
6927 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006928 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006929 'softtabstop' is set to 0 when the 'paste' option is set and restored
6930 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6932 spaces is minimized by using <Tab>s.
6933 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6934 set.
6935 NOTE: This option is set to 0 when 'compatible' is set.
6936
Bram Moolenaar217ad922005-03-20 22:37:15 +00006937 *'spell'* *'nospell'*
6938'spell' boolean (default off)
6939 local to window
6940 {not in Vi}
6941 {not available when compiled without the |+syntax|
6942 feature}
6943 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006944 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006945
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006946 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006947'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006948 local to buffer
6949 {not in Vi}
6950 {not available when compiled without the |+syntax|
6951 feature}
6952 Pattern to locate the end of a sentence. The following word will be
6953 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006954 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006955 When this check is not wanted make this option empty.
6956 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006957 Be careful with special characters, see |option-backslash| about
6958 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006959 To set this option automatically depending on the language, see
6960 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006961
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006962 *'spellfile'* *'spf'*
6963'spellfile' 'spf' string (default empty)
6964 local to buffer
6965 {not in Vi}
6966 {not available when compiled without the |+syntax|
6967 feature}
6968 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006969 commands. It must end in ".{encoding}.add". You need to include the
6970 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006971 *E765*
6972 It may also be a comma separated list of names. A count before the
6973 |zg| and |zw| commands can be used to access each. This allows using
6974 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006975 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006976 you: Using the first directory in 'runtimepath' that is writable. If
6977 there is no "spell" directory yet it will be created. For the file
6978 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006979 ignoring the region.
6980 The resulting ".spl" file will be used for spell checking, it does not
6981 have to appear in 'spelllang'.
6982 Normally one file is used for all regions, but you can add the region
6983 name if you want to. However, it will then only be used when
6984 'spellfile' is set to it, for entries in 'spelllang' only files
6985 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006986 This option cannot be set from a |modeline| or in the |sandbox|, for
6987 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006988
Bram Moolenaar217ad922005-03-20 22:37:15 +00006989 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006990'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006991 local to buffer
6992 {not in Vi}
6993 {not available when compiled without the |+syntax|
6994 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006995 A comma separated list of word list names. When the 'spell' option is
6996 on spellchecking will be done for these languages. Example: >
6997 set spelllang=en_us,nl,medical
6998< This means US English, Dutch and medical words are recognized. Words
6999 that are not recognized will be highlighted.
7000 The word list name must not include a comma or dot. Using a dash is
7001 recommended to separate the two letter language name from a
7002 specification. Thus "en-rare" is used for rare English words.
7003 A region name must come last and have the form "_xx", where "xx" is
7004 the two-letter, lower case region name. You can use more than one
7005 region by listing them: "en_us,en_ca" supports both US and Canadian
7006 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007007 Britain. (Note: currently en_au and en_nz dictionaries are older than
7008 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007009 If the name "cjk" is included East Asian characters are excluded from
7010 spell checking. This is useful when editing text that also has Asian
7011 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007012 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007013 As a special case the name of a .spl file can be given as-is. The
7014 first "_xx" in the name is removed and used as the region name
7015 (_xx is an underscore, two letters and followed by a non-letter).
7016 This is mainly for testing purposes. You must make sure the correct
7017 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007018 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007019 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7020 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007021 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007022
Bram Moolenaar98692072006-02-04 00:57:42 +00007023 If the |spellfile.vim| plugin is active and you use a language name
7024 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7025 will ask you if you want to download the file.
7026
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007027 After this option has been set successfully, Vim will source the files
7028 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007029 up to the first comma, dot or underscore.
7030 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007031
7032
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007033 *'spellsuggest'* *'sps'*
7034'spellsuggest' 'sps' string (default "best")
7035 global
7036 {not in Vi}
7037 {not available when compiled without the |+syntax|
7038 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007039 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007040 the |spellsuggest()| function. This is a comma-separated list of
7041 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007042
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007043 best Internal method that works best for English. Finds
7044 changes like "fast" and uses a bit of sound-a-like
7045 scoring to improve the ordering.
7046
7047 double Internal method that uses two methods and mixes the
7048 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007049 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007050 word. That only works when the language specifies
7051 sound folding. Can be slow and doesn't always give
7052 better results.
7053
7054 fast Internal method that only checks for simple changes:
7055 character inserts/deletes/swaps. Works well for
7056 simple typing mistakes.
7057
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007058 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007059 Not used for |spellsuggest()|. The number of
7060 suggestions is never more than the value of 'lines'
7061 minus two.
7062
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007063 file:{filename} Read file {filename}, which must have two columns,
7064 separated by a slash. The first column contains the
7065 bad word, the second column the suggested good word.
7066 Example:
7067 theribal/terrible ~
7068 Use this for common mistakes that do not appear at the
7069 top of the suggestion list with the internal methods.
7070 Lines without a slash are ignored, use this for
7071 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007072 The word in the second column must be correct,
7073 otherwise it will not be used. Add the word to an
7074 ".add" file if it is currently flagged as a spelling
7075 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007076 The file is used for all languages.
7077
7078 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7079 trouble with spaces. |v:val| holds the badly spelled
7080 word. The expression must evaluate to a List of
7081 Lists, each with a suggestion and a score.
7082 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007083 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007084 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007085 internal methods use. A lower score is better.
7086 This may invoke |spellsuggest()| if you temporarily
7087 set 'spellsuggest' to exclude the "expr:" part.
7088 Errors are silently ignored, unless you set the
7089 'verbose' option to a non-zero value.
7090
7091 Only one of "best", "double" or "fast" may be used. The others may
7092 appear several times in any order. Example: >
7093 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7094<
7095 This option cannot be set from a |modeline| or in the |sandbox|, for
7096 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007097
7098
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7100'splitbelow' 'sb' boolean (default off)
7101 global
7102 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007103 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 feature}
7105 When on, splitting a window will put the new window below the current
7106 one. |:split|
7107
7108 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7109'splitright' 'spr' boolean (default off)
7110 global
7111 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007112 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 feature}
7114 When on, splitting a window will put the new window right of the
7115 current one. |:vsplit|
7116
7117 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7118'startofline' 'sol' boolean (default on)
7119 global
7120 {not in Vi}
7121 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007122 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007124 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 with a linewise operator, with "%" with a count and to buffer changing
7126 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7127 only has a line number, e.g., ":25" or ":+".
7128 In case of buffer changing commands the cursor is placed at the column
7129 where it was the last time the buffer was edited.
7130 NOTE: This option is set when 'compatible' is set.
7131
Bram Moolenaar00654022011-02-25 14:42:19 +01007132 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007134 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 {not in Vi}
7136 {not available when compiled without the |+statusline|
7137 feature}
7138 When nonempty, this option determines the content of the status line.
7139 Also see |status-line|.
7140
7141 The option consists of printf style '%' items interspersed with
7142 normal text. Each status line item is of the form:
7143 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007144 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007145 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146
Bram Moolenaar238a5642006-02-21 22:12:05 +00007147 When the option starts with "%!" then it is used as an expression,
7148 evaluated and the result is used as the option value. Example: >
7149 :set statusline=%!MyStatusLine()
7150< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007151 Note that the "%!" expression is evaluated in the context of the
7152 current window and buffer, while %{} items are evaluated in the
7153 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007154
7155 When there is error while evaluating the option then it will be made
7156 empty to avoid further errors. Otherwise screen updating would loop.
7157
Bram Moolenaar071d4272004-06-13 20:20:40 +00007158 Note that the only effect of 'ruler' when this option is set (and
7159 'laststatus' is 2) is controlling the output of |CTRL-G|.
7160
7161 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007162 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007164 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 minwid Minimum width of the item, padding as set by '-' & '0'.
7166 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007167 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 on the left for text items. Numeric items will be
7169 shifted down to maxwid-2 digits followed by '>'number
7170 where number is the amount of missing digits, much like
7171 an exponential notation.
7172 item A one letter code as described below.
7173
7174 Following is a description of the possible statusline items. The
7175 second character in "item" is the type:
7176 N for number
7177 S for string
7178 F for flags as described below
7179 - not applicable
7180
7181 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007182 f S Path to the file in the buffer, as typed or relative to current
7183 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 F S Full path to the file in the buffer.
7185 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007186 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007188 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007190 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007192 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007194 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7196 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007197 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7199 being used: "<keymap>"
7200 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007201 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 B N As above, in hexadecimal.
7203 o N Byte number in file of byte under cursor, first byte is 1.
7204 Mnemonic: Offset from start of file (with one added)
7205 {not available when compiled without |+byte_offset| feature}
7206 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007207 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 l N Line number.
7209 L N Number of lines in buffer.
7210 c N Column number.
7211 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007212 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 p N Percentage through file in lines as in |CTRL-G|.
7214 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007215 percentage described for 'ruler'. Always 3 in length, unless
7216 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007217 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007219 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007220 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 ( - Start of item group. Can be used for setting the width and
7222 alignment of a section. Must be followed by %) somewhere.
7223 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007224 T N For 'tabline': start of tab page N label. Use %T after the last
7225 label. This information is used for mouse clicks.
7226 X N For 'tabline': start of close tab N label. Use %X after the
7227 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7228 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 < - Where to truncate line if too long. Default is at the start.
7230 No width fields allowed.
7231 = - Separation point between left and right aligned items.
7232 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007233 # - Set highlight group. The name must follow and then a # again.
7234 Thus use %#HLname# for highlight group HLname. The same
7235 highlighting is used, also for the statusline of non-current
7236 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007238 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 The difference between User{N} and StatusLine will be applied
7240 to StatusLineNC for the statusline of non-current windows.
7241 The number N must be between 1 and 9. See |hl-User1..9|
7242
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007243 When displaying a flag, Vim removes the leading comma, if any, when
7244 that flag comes right after plaintext. This will make a nice display
7245 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246
Bram Moolenaar582fd852005-03-28 20:58:01 +00007247 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 not set) and a minwid is not set for the group, the whole group will
7249 become empty. This will make a group like the following disappear
7250 completely from the statusline when none of the flags are set. >
7251 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007252< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 Beware that an expression is evaluated each and every time the status
7254 line is displayed. The current buffer and current window will be set
7255 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007256 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007258 real current buffer.
7259
Bram Moolenaar30b65812012-07-12 22:01:11 +02007260 The 'statusline' option will be evaluated in the |sandbox| if set from
7261 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007262
7263 It is not allowed to change text or jump to another window while
7264 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265
7266 If the statusline is not updated when you want it (e.g., after setting
7267 a variable that's used in an expression), you can force an update by
7268 setting an option without changing its value. Example: >
7269 :let &ro = &ro
7270
7271< A result of all digits is regarded a number for display purposes.
7272 Otherwise the result is taken as flag text and applied to the rules
7273 described above.
7274
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007275 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7277 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7278
7279 Examples:
7280 Emulate standard status line with 'ruler' set >
7281 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7282< Similar, but add ASCII value of char under the cursor (like "ga") >
7283 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7284< Display byte count and byte value, modified flag in red. >
7285 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7286 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7287< Display a ,GZ flag if a compressed file is loaded >
7288 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7289< In the |:autocmd|'s: >
7290 :let b:gzflag = 1
7291< And: >
7292 :unlet b:gzflag
7293< And define this function: >
7294 :function VarExists(var, val)
7295 : if exists(a:var) | return a:val | else | return '' | endif
7296 :endfunction
7297<
7298 *'suffixes'* *'su'*
7299'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7300 global
7301 {not in Vi}
7302 Files with these suffixes get a lower priority when multiple files
7303 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007304 suffixes. Spaces after the comma are ignored. A dot is also seen as
7305 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 separator, precede it with a backslash (see |option-backslash| about
7307 including spaces and backslashes).
7308 See 'wildignore' for completely ignoring files.
7309 The use of |:set+=| and |:set-=| is preferred when adding or removing
7310 suffixes from the list. This avoids problems when a future version
7311 uses another default.
7312
7313 *'suffixesadd'* *'sua'*
7314'suffixesadd' 'sua' string (default "")
7315 local to buffer
7316 {not in Vi}
7317 {not available when compiled without the
7318 |+file_in_path| feature}
7319 Comma separated list of suffixes, which are used when searching for a
7320 file for the "gf", "[I", etc. commands. Example: >
7321 :set suffixesadd=.java
7322<
7323 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7324'swapfile' 'swf' boolean (default on)
7325 local to buffer
7326 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007327 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 swapfile is not wanted for a specific buffer. For example, with
7329 confidential information that even root must not be able to access.
7330 Careful: All text will be in memory:
7331 - Don't use this for big files.
7332 - Recovery will be impossible!
7333 A swapfile will only be present when |'updatecount'| is non-zero and
7334 'swapfile' is set.
7335 When 'swapfile' is reset, the swap file for the current buffer is
7336 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7337 non-zero, a swap file is immediately created.
7338 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007339 If you want to open a new buffer without creating a swap file for it,
7340 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341
7342 This option is used together with 'bufhidden' and 'buftype' to
7343 specify special kinds of buffers. See |special-buffers|.
7344
7345 *'swapsync'* *'sws'*
7346'swapsync' 'sws' string (default "fsync")
7347 global
7348 {not in Vi}
7349 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007350 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 When this option is empty parts of the swap file may be in memory and
7352 not written to disk. When the system crashes you may lose more work.
7353 On Unix the system does a sync now and then without Vim asking for it,
7354 so the disadvantage of setting this option off is small. On some
7355 systems the swap file will not be written at all. For a unix system
7356 setting it to "sync" will use the sync() call instead of the default
7357 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007358 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007359
7360 *'switchbuf'* *'swb'*
7361'switchbuf' 'swb' string (default "")
7362 global
7363 {not in Vi}
7364 This option controls the behavior when switching between buffers.
7365 Possible values (comma separated list):
7366 useopen If included, jump to the first open window that
7367 contains the specified buffer (if there is one).
7368 Otherwise: Do not examine other windows.
7369 This setting is checked with |quickfix| commands, when
7370 jumping to errors (":cc", ":cn", "cp", etc.). It is
7371 also used in all buffer related split commands, for
7372 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007373 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007374 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007376 a buffer for a |quickfix| command that display errors.
7377 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007378 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007379 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007380 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007382 *'synmaxcol'* *'smc'*
7383'synmaxcol' 'smc' number (default 3000)
7384 local to buffer
7385 {not in Vi}
7386 {not available when compiled without the |+syntax|
7387 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007388 Maximum column in which to search for syntax items. In long lines the
7389 text after this column is not highlighted and following lines may not
7390 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007391 This helps to avoid very slow redrawing for an XML file that is one
7392 long line.
7393 Set to zero to remove the limit.
7394
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 *'syntax'* *'syn'*
7396'syntax' 'syn' string (default empty)
7397 local to buffer
7398 {not in Vi}
7399 {not available when compiled without the |+syntax|
7400 feature}
7401 When this option is set, the syntax with this name is loaded, unless
7402 syntax highlighting has been switched off with ":syntax off".
7403 Otherwise this option does not always reflect the current syntax (the
7404 b:current_syntax variable does).
7405 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007406 not automatically recognized. Example, in an IDL file:
7407 /* vim: set syntax=idl : */ ~
7408 When a dot appears in the value then this separates two filetype
7409 names. Example:
7410 /* vim: set syntax=c.doxygen : */ ~
7411 This will use the "c" syntax first, then the "doxygen" syntax.
7412 Note that the second one must be prepared to be loaded as an addition,
7413 otherwise it will be skipped. More than one dot may appear.
7414 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 :set syntax=OFF
7416< To switch syntax highlighting on according to the current value of the
7417 'filetype' option: >
7418 :set syntax=ON
7419< What actually happens when setting the 'syntax' option is that the
7420 Syntax autocommand event is triggered with the value as argument.
7421 This option is not copied to another buffer, independent of the 's' or
7422 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007423 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007425 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007426'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007427 global
7428 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007429 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007430 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007431 When nonempty, this option determines the content of the tab pages
7432 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007433 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007434
7435 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007436 option and only when there is no GUI tab line. When 'e' is in
7437 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007438 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007439
7440 The value is evaluated like with 'statusline'. You can use
7441 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007442 the text to be displayed. Use "%1T" for the first label, "%2T" for
7443 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007444
7445 Keep in mind that only one of the tab pages is the current one, others
7446 are invisible and you can't jump to their windows.
7447
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007448
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007449 *'tabpagemax'* *'tpm'*
7450'tabpagemax' 'tpm' number (default 10)
7451 global
7452 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007453 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007454 feature}
7455 Maximum number of tab pages to be opened by the |-p| command line
7456 argument or the ":tab all" command. |tabpage|
7457
7458
7459 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460'tabstop' 'ts' number (default 8)
7461 local to buffer
7462 Number of spaces that a <Tab> in the file counts for. Also see
7463 |:retab| command, and 'softtabstop' option.
7464
7465 Note: Setting 'tabstop' to any other value than 8 can make your file
7466 appear wrong in many places (e.g., when printing it).
7467
7468 There are four main ways to use tabs in Vim:
7469 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7470 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007471 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 behave like a tab appears every 4 (or 3) characters.
7473 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7474 'expandtab'. This way you will always insert spaces. The
7475 formatting will never be messed up when 'tabstop' is changed.
7476 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007477 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 works when using Vim to edit the file.
7479 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7480 'noexpandtab'. This should then work (for initial indents only)
7481 for any tabstop setting that people use. It might be nice to have
7482 tabs after the first non-blank inserted as spaces if you do this
7483 though. Otherwise aligned comments will be wrong when 'tabstop' is
7484 changed.
7485
7486 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7487'tagbsearch' 'tbs' boolean (default on)
7488 global
7489 {not in Vi}
7490 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007491 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 searching makes searching for a tag a LOT faster, but a linear search
7493 will find more tags if the tags file wasn't properly sorted.
7494 Vim normally assumes that your tags files are sorted, or indicate that
7495 they are not sorted. Only when this is not the case does the
7496 'tagbsearch' option need to be switched off.
7497
7498 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007499 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 certain files, or retry all files with a linear search. When
7501 'tagbsearch' is off, only a linear search is done.
7502
7503 Linear searching is done anyway, for one file, when Vim finds a line
7504 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007505 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506< [The whitespace before and after the '0' must be a single <Tab>]
7507
7508 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007509 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 instead of a normal tag name, a retry is done with a linear search.
7511 Tags in unsorted tags files, and matches with different case will only
7512 be found in the retry.
7513
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007514 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007515 linear search can be avoided when case is ignored. Use a value of '2'
7516 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7517 sorted with the -f switch to "sort" in most unices, as in the command:
7518 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7519 (at least 5.5) the --sort=foldcase switch can be used for this as
7520 well. Note that case must be folded to uppercase for this to work.
7521
7522 By default, tag searches are case-sensitive. Case is ignored when
7523 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7524 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007525 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7526 'tagcase' is "smart", and the pattern contains only lowercase
7527 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528
7529 When 'tagbsearch' is off, tags searching is slower when a full match
7530 exists, but faster when no full match exists. Tags in unsorted tags
7531 files may only be found with 'tagbsearch' off.
7532 When the tags file is not sorted, or sorted in a wrong way (not on
7533 ASCII byte value), 'tagbsearch' should be off, or the line given above
7534 must be included in the tags file.
7535 This option doesn't affect commands that find all matching tags (e.g.,
7536 command-line completion and ":help").
7537 {Vi: always uses binary search in some versions}
7538
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007539 *'tagcase'* *'tc'*
7540'tagcase' 'tc' string (default "followic")
7541 global or local to buffer |global-local|
7542 {not in Vi}
7543 This option specifies how case is handled when searching the tags
7544 file:
7545 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007546 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007547 ignore Ignore case
7548 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007549 smart Ignore case unless an upper case letter is used
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007550
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 *'taglength'* *'tl'*
7552'taglength' 'tl' number (default 0)
7553 global
7554 If non-zero, tags are significant up to this number of characters.
7555
7556 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7557'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7558 global
7559 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007560 If on and using a tags file in another directory, file names in that
7561 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 NOTE: This option is set to the Vi default value when 'compatible' is
7563 set and to the Vim default value when 'compatible' is reset.
7564
7565 *'tags'* *'tag'* *E433*
7566'tags' 'tag' string (default "./tags,tags", when compiled with
7567 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7568 global or local to buffer |global-local|
7569 Filenames for the tag command, separated by spaces or commas. To
7570 include a space or comma in a file name, precede it with a backslash
7571 (see |option-backslash| about including spaces and backslashes).
7572 When a file name starts with "./", the '.' is replaced with the path
7573 of the current file. But only when the 'd' flag is not included in
7574 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7575 |tags-option|.
7576 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007577 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7578 find all files named "tags" below "/lib". The filename itself cannot
7579 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7580 files called "tags?". {not available when compiled without the
7581 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007582 The |tagfiles()| function can be used to get a list of the file names
7583 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007584 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7585 files are also supported. They are automatically recognized. The
7586 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7587 differences are ignored (MS-Windows). |emacs-tags|
7588 The use of |:set+=| and |:set-=| is preferred when adding or removing
7589 file names from the list. This avoids problems when a future version
7590 uses another default.
7591 {Vi: default is "tags /usr/lib/tags"}
7592
7593 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7594'tagstack' 'tgst' boolean (default on)
7595 global
7596 {not in all versions of Vi}
7597 When on, the |tagstack| is used normally. When off, a ":tag" or
7598 ":tselect" command with an argument will not push the tag onto the
7599 tagstack. A following ":tag" without an argument, a ":pop" command or
7600 any other command that uses the tagstack will use the unmodified
7601 tagstack, but does change the pointer to the active entry.
7602 Resetting this option is useful when using a ":tag" command in a
7603 mapping which should not change the tagstack.
7604
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007605 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007606'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007607 global
7608 {not in Vi}
7609 {only available when compiled with the |+tcl/dyn|
7610 feature}
7611 Specifies the name of the Tcl shared library. The default is
7612 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007613 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007614 This option cannot be set from a |modeline| or in the |sandbox|, for
7615 security reasons.
7616
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 *'term'* *E529* *E530* *E531*
7618'term' string (default is $TERM, if that fails:
7619 in the GUI: "builtin_gui"
7620 on Amiga: "amiga"
7621 on BeOS: "beos-ansi"
7622 on Mac: "mac-ansi"
7623 on MiNT: "vt52"
7624 on MS-DOS: "pcterm"
7625 on OS/2: "os2ansi"
7626 on Unix: "ansi"
7627 on VMS: "ansi"
7628 on Win 32: "win32")
7629 global
7630 Name of the terminal. Used for choosing the terminal control
7631 characters. Environment variables are expanded |:set_env|.
7632 For example: >
7633 :set term=$TERM
7634< See |termcap|.
7635
7636 *'termbidi'* *'tbidi'*
7637 *'notermbidi'* *'notbidi'*
7638'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7639 global
7640 {not in Vi}
7641 {only available when compiled with the |+arabic|
7642 feature}
7643 The terminal is in charge of Bi-directionality of text (as specified
7644 by Unicode). The terminal is also expected to do the required shaping
7645 that some languages (such as Arabic) require.
7646 Setting this option implies that 'rightleft' will not be set when
7647 'arabic' is set and the value of 'arabicshape' will be ignored.
7648 Note that setting 'termbidi' has the immediate effect that
7649 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7650 This option is reset when the GUI is started.
7651 For further details see |arabic.txt|.
7652
7653 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007654'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 Macintosh GUI: "macroman")
7656 global
7657 {only available when compiled with the |+multi_byte|
7658 feature}
7659 {not in Vi}
7660 Encoding used for the terminal. This specifies what character
7661 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007662 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007663 display). Except for the Mac when 'macatsui' is off, then
7664 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007666 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7668 Any attempts to set a different value will be rejected, and an error
7669 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007670 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 because the Win32 system always passes Unicode characters.
7672 When empty, the same encoding is used as for the 'encoding' option.
7673 This is the normal value.
7674 Not all combinations for 'termencoding' and 'encoding' are valid. See
7675 |encoding-table|.
7676 The value for this option must be supported by internal conversions or
7677 iconv(). When this is not possible no conversion will be done and you
7678 will probably experience problems with non-ASCII characters.
7679 Example: You are working with the locale set to euc-jp (Japanese) and
7680 want to edit a UTF-8 file: >
7681 :let &termencoding = &encoding
7682 :set encoding=utf-8
7683< You need to do this when your system has no locale support for UTF-8.
7684
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007685 *'termguicolors'* *'tgc'*
7686'termguicolors' 'tgc' boolean (default off)
7687 global
7688 {not in Vi}
7689 {not available when compiled without the
7690 |+termguicolors| feature}
7691 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7692 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7693 compatible terminal.
7694 If setting this option does not work (produces a colorless UI)
7695 reading |xterm-true-color| might help.
7696
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 *'terse'* *'noterse'*
7698'terse' boolean (default off)
7699 global
7700 When set: Add 's' flag to 'shortmess' option (this makes the message
7701 for a search that hits the start or end of the file not being
7702 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7703 shortens a lot of messages}
7704
7705 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7706'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7707 global
7708 {not in Vi}
7709 This option is obsolete. Use 'fileformats'.
7710 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7711 set to the default value for the current system. When 'textauto' is
7712 reset, 'fileformats' is made empty.
7713 NOTE: This option is set to the Vi default value when 'compatible' is
7714 set and to the Vim default value when 'compatible' is reset.
7715
7716 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7717'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7718 others: default off)
7719 local to buffer
7720 {not in Vi}
7721 This option is obsolete. Use 'fileformat'.
7722 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7723 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7724 "unix".
7725
7726 *'textwidth'* *'tw'*
7727'textwidth' 'tw' number (default 0)
7728 local to buffer
7729 {not in Vi}
7730 Maximum width of text that is being inserted. A longer line will be
7731 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007732 this.
7733 'textwidth' is set to 0 when the 'paste' option is set and restored
7734 when 'paste' is reset.
7735 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007737 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 NOTE: This option is set to 0 when 'compatible' is set.
7739
7740 *'thesaurus'* *'tsr'*
7741'thesaurus' 'tsr' string (default "")
7742 global or local to buffer |global-local|
7743 {not in Vi}
7744 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007745 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 the file should contain words with similar meaning, separated by
7747 non-keyword characters (white space is preferred). Maximum line
7748 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007749 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007750 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007751 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007752 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753 after a comma are ignored, otherwise spaces are included in the file
7754 name. See |option-backslash| about using backslashes.
7755 The use of |:set+=| and |:set-=| is preferred when adding or removing
7756 directories from the list. This avoids problems when a future version
7757 uses another default.
7758 Backticks cannot be used in this option for security reasons.
7759
7760 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7761'tildeop' 'top' boolean (default off)
7762 global
7763 {not in Vi}
7764 When on: The tilde command "~" behaves like an operator.
7765 NOTE: This option is reset when 'compatible' is set.
7766
7767 *'timeout'* *'to'* *'notimeout'* *'noto'*
7768'timeout' 'to' boolean (default on)
7769 global
7770 *'ttimeout'* *'nottimeout'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007771'ttimeout' boolean (default off, set in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 global
7773 {not in Vi}
7774 These two options together determine the behavior when part of a
7775 mapped key sequence or keyboard code has been received:
7776
7777 'timeout' 'ttimeout' action ~
7778 off off do not time out
7779 on on or off time out on :mappings and key codes
7780 off on time out on key codes
7781
7782 If both options are off, Vim will wait until either the complete
7783 mapping or key sequence has been received, or it is clear that there
7784 is no mapping or key sequence for the received characters. For
7785 example: if you have mapped "vl" and Vim has received 'v', the next
7786 character is needed to see if the 'v' is followed by an 'l'.
7787 When one of the options is on, Vim will wait for about 1 second for
7788 the next character to arrive. After that the already received
7789 characters are interpreted as single characters. The waiting time can
7790 be changed with the 'timeoutlen' option.
7791 On slow terminals or very busy systems timing out may cause
7792 malfunctioning cursor keys. If both options are off, Vim waits
7793 forever after an entered <Esc> if there are key codes that start
7794 with <Esc>. You will have to type <Esc> twice. If you do not have
7795 problems with key codes, but would like to have :mapped key
7796 sequences not timing out in 1 second, set the 'ttimeout' option and
7797 reset the 'timeout' option.
7798
7799 NOTE: 'ttimeout' is reset when 'compatible' is set.
7800
7801 *'timeoutlen'* *'tm'*
7802'timeoutlen' 'tm' number (default 1000)
7803 global
7804 {not in all versions of Vi}
7805 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007806'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 global
7808 {not in Vi}
7809 The time in milliseconds that is waited for a key code or mapped key
7810 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7811 when part of a command has been typed.
7812 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7813 different timeout value for key codes is desired set 'ttimeoutlen' to
7814 a non-negative number.
7815
7816 ttimeoutlen mapping delay key code delay ~
7817 < 0 'timeoutlen' 'timeoutlen'
7818 >= 0 'timeoutlen' 'ttimeoutlen'
7819
7820 The timeout only happens when the 'timeout' and 'ttimeout' options
7821 tell so. A useful setting would be >
7822 :set timeout timeoutlen=3000 ttimeoutlen=100
7823< (time out on mapping after three seconds, time out on key codes after
7824 a tenth of a second).
7825
7826 *'title'* *'notitle'*
7827'title' boolean (default off, on when title can be restored)
7828 global
7829 {not in Vi}
7830 {not available when compiled without the |+title|
7831 feature}
7832 When on, the title of the window will be set to the value of
7833 'titlestring' (if it is not empty), or to:
7834 filename [+=-] (path) - VIM
7835 Where:
7836 filename the name of the file being edited
7837 - indicates the file cannot be modified, 'ma' off
7838 + indicates the file was modified
7839 = indicates the file is read-only
7840 =+ indicates the file is read-only and modified
7841 (path) is the path of the file being edited
7842 - VIM the server name |v:servername| or "VIM"
7843 Only works if the terminal supports setting window titles
7844 (currently Amiga console, Win32 console, all GUI versions and
7845 terminals with a non- empty 't_ts' option - these are Unix xterm and
7846 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7847 *X11*
7848 When Vim was compiled with HAVE_X11 defined, the original title will
7849 be restored if possible. The output of ":version" will include "+X11"
7850 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7851 works for the icon name |'icon'|.
7852 But: When Vim was started with the |-X| argument, restoring the title
7853 will not work (except in the GUI).
7854 If the title cannot be restored, it is set to the value of 'titleold'.
7855 You might want to restore the title outside of Vim then.
7856 When using an xterm from a remote machine you can use this command:
7857 rsh machine_name xterm -display $DISPLAY &
7858 then the WINDOWID environment variable should be inherited and the
7859 title of the window should change back to what it should be after
7860 exiting Vim.
7861
7862 *'titlelen'*
7863'titlelen' number (default 85)
7864 global
7865 {not in Vi}
7866 {not available when compiled without the |+title|
7867 feature}
7868 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007869 title. When the title is longer, only the end of the path name is
7870 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007871 Using a percentage makes this adapt to the width of the window. But
7872 it won't work perfectly, because the actual number of characters
7873 available also depends on the font used and other things in the title
7874 bar. When 'titlelen' is zero the full path is used. Otherwise,
7875 values from 1 to 30000 percent can be used.
7876 'titlelen' is also used for the 'titlestring' option.
7877
7878 *'titleold'*
7879'titleold' string (default "Thanks for flying Vim")
7880 global
7881 {not in Vi}
7882 {only available when compiled with the |+title|
7883 feature}
7884 This option will be used for the window title when exiting Vim if the
7885 original title cannot be restored. Only happens if 'title' is on or
7886 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007887 This option cannot be set from a |modeline| or in the |sandbox|, for
7888 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 *'titlestring'*
7890'titlestring' string (default "")
7891 global
7892 {not in Vi}
7893 {not available when compiled without the |+title|
7894 feature}
7895 When this option is not empty, it will be used for the title of the
7896 window. This happens only when the 'title' option is on.
7897 Only works if the terminal supports setting window titles (currently
7898 Amiga console, Win32 console, all GUI versions and terminals with a
7899 non-empty 't_ts' option).
7900 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007901 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 When this option contains printf-style '%' items, they will be
7903 expanded according to the rules used for 'statusline'.
7904 Example: >
7905 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7906 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7907< The value of 'titlelen' is used to align items in the middle or right
7908 of the available space.
7909 Some people prefer to have the file name first: >
7910 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7911< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007912 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 separating space only when needed.
7914 NOTE: Use of special characters in 'titlestring' may cause the display
7915 to be garbled (e.g., when it contains a CR or NL character).
7916 {not available when compiled without the |+statusline| feature}
7917
7918 *'toolbar'* *'tb'*
7919'toolbar' 'tb' string (default "icons,tooltips")
7920 global
7921 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7922 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007923 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 possible values are:
7925 icons Toolbar buttons are shown with icons.
7926 text Toolbar buttons shown with text.
7927 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007928 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 tooltips Tooltips are active for toolbar buttons.
7930 Tooltips refer to the popup help text which appears after the mouse
7931 cursor is placed over a toolbar button for a brief moment.
7932
7933 If you want the toolbar to be shown with icons as well as text, do the
7934 following: >
7935 :set tb=icons,text
7936< Motif and Athena cannot display icons and text at the same time. They
7937 will show icons if both are requested.
7938
7939 If none of the strings specified in 'toolbar' are valid or if
7940 'toolbar' is empty, this option is ignored. If you want to disable
7941 the toolbar, you need to set the 'guioptions' option. For example: >
7942 :set guioptions-=T
7943< Also see |gui-toolbar|.
7944
7945 *'toolbariconsize'* *'tbis'*
7946'toolbariconsize' 'tbis' string (default "small")
7947 global
7948 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01007949 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007951 tiny Use tiny icons.
7952 small Use small icons (default).
7953 medium Use medium-sized icons.
7954 large Use large icons.
7955 huge Use even larger icons.
7956 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007958 the current theme. Common dimensions are giant=48x48, huge=32x32,
7959 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960
7961 If 'toolbariconsize' is empty, the global default size as determined
7962 by user preferences or the current theme is used.
7963
7964 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7965'ttybuiltin' 'tbi' boolean (default on)
7966 global
7967 {not in Vi}
7968 When on, the builtin termcaps are searched before the external ones.
7969 When off the builtin termcaps are searched after the external ones.
7970 When this option is changed, you should set the 'term' option next for
7971 the change to take effect, for example: >
7972 :set notbi term=$TERM
7973< See also |termcap|.
7974 Rationale: The default for this option is "on", because the builtin
7975 termcap entries are generally better (many systems contain faulty
7976 xterm entries...).
7977
7978 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7979'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7980 sun-cmd, screen, rxvt, dtterm or
7981 iris-ansi; also on when running Vim in
7982 a DOS console)
7983 global
7984 {not in Vi}
7985 Indicates a fast terminal connection. More characters will be sent to
7986 the screen for redrawing, instead of using insert/delete line
7987 commands. Improves smoothness of redrawing when there are multiple
7988 windows and the terminal does not support a scrolling region.
7989 Also enables the extra writing of characters at the end of each screen
7990 line for lines that wrap. This helps when using copy/paste with the
7991 mouse in an xterm and other terminals.
7992
7993 *'ttymouse'* *'ttym'*
7994'ttymouse' 'ttym' string (default depends on 'term')
7995 global
7996 {not in Vi}
7997 {only in Unix and VMS, doesn't work in the GUI; not
7998 available when compiled without |+mouse|}
7999 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008000 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 *xterm-mouse*
8002 xterm xterm-like mouse handling. The mouse generates
8003 "<Esc>[Mscr", where "scr" is three bytes:
8004 "s" = button state
8005 "c" = column plus 33
8006 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008007 This only works up to 223 columns! See "dec",
8008 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 xterm2 Works like "xterm", but with the xterm reporting the
8010 mouse position while the mouse is dragged. This works
8011 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008012 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 work. See below for how Vim detects this
8014 automatically.
8015 *netterm-mouse*
8016 netterm NetTerm mouse handling. The mouse generates
8017 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8018 for the row and column.
8019 *dec-mouse*
8020 dec DEC terminal mouse handling. The mouse generates a
8021 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008022 This is also available for an Xterm, if it was
8023 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 *jsbterm-mouse*
8025 jsbterm JSB term mouse handling.
8026 *pterm-mouse*
8027 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008028 *urxvt-mouse*
8029 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008030 The mouse works only if the terminal supports this
8031 encoding style, but it does not have 223 columns limit
8032 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008033 *sgr-mouse*
8034 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008035 mouse reporting. The mouse works even in columns
8036 beyond 223. This option is backward compatible with
8037 "xterm2" because it can also decode "xterm2" style
8038 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039
8040 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008041 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8042 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8044 recognized, if enabled at compile time. DEC terminal mouse codes
8045 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008046 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8047 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008049 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8050 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8051 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008052 Additionally, if vim is compiled with the |+termresponse| feature and
8053 |t_RV| is set to the escape sequence to request the xterm version
8054 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008056 from 95 to 276. The "sgr" value will be set if the xterm version is
8057 277 or highter.
8058 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8059 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 :set t_RV=
8061<
8062 *'ttyscroll'* *'tsl'*
8063'ttyscroll' 'tsl' number (default 999)
8064 global
8065 Maximum number of lines to scroll the screen. If there are more lines
8066 to scroll the window is redrawn. For terminals where scrolling is
8067 very slow and redrawing is not slow this can be set to a small number,
8068 e.g., 3, to speed up displaying.
8069
8070 *'ttytype'* *'tty'*
8071'ttytype' 'tty' string (default from $TERM)
8072 global
8073 Alias for 'term', see above.
8074
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008075 *'undodir'* *'udir'*
8076'undodir' 'udir' string (default ".")
8077 global
8078 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008079 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008080 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008081 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008082 "." means using the directory of the file. The undo file name for
8083 "file.txt" is ".file.txt.un~".
8084 For other directories the file name is the full path of the edited
8085 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008086 When writing: The first directory that exists is used. "." always
8087 works, no directories after "." will be used for writing.
8088 When reading all entries are tried to find an undo file. The first
8089 undo file that exists is used. When it cannot be read an error is
8090 given, no further entry is used.
8091 See |undo-persistence|.
8092
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008093 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008094'undofile' 'udf' boolean (default off)
8095 local to buffer
8096 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008097 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008098 When on, Vim automatically saves undo history to an undo file when
8099 writing a buffer to a file, and restores undo history from the same
8100 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008101 The directory where the undo file is stored is specified by 'undodir'.
8102 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008103 The undo file is not read when 'undoreload' causes the buffer from
8104 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008105 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008106
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 *'undolevels'* *'ul'*
8108'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8109 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008110 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008111 {not in Vi}
8112 Maximum number of changes that can be undone. Since undo information
8113 is kept in memory, higher numbers will cause more memory to be used
8114 (nevertheless, a single change can use an unlimited amount of memory).
8115 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8116 itself: >
8117 set ul=0
8118< But you can also get Vi compatibility by including the 'u' flag in
8119 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008120 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008121 Set to -1 for no undo at all. You might want to do this only for the
8122 current buffer: >
8123 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008125
8126 The local value is set to -123456 when the global value is to be used.
8127
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008128 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008130 *'undoreload'* *'ur'*
8131'undoreload' 'ur' number (default 10000)
8132 global
8133 {not in Vi}
8134 Save the whole buffer for undo when reloading it. This applies to the
8135 ":e!" command and reloading for when the buffer changed outside of
8136 Vim. |FileChangedShell|
8137 The save only happens when this options is negative or when the number
8138 of lines is smaller than the value of this option.
8139 Set this option to zero to disable undo for a reload.
8140
8141 When saving undo for a reload, any undo file is not read.
8142
8143 Note that this causes the whole buffer to be stored in memory. Set
8144 this option to a lower value if you run out of memory.
8145
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 *'updatecount'* *'uc'*
8147'updatecount' 'uc' number (default: 200)
8148 global
8149 {not in Vi}
8150 After typing this many characters the swap file will be written to
8151 disk. When zero, no swap file will be created at all (see chapter on
8152 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8153 Vim with the "-n" option, see |startup|. When editing in readonly
8154 mode this option will be initialized to 10000.
8155 The swapfile can be disabled per buffer with |'swapfile'|.
8156 When 'updatecount' is set from zero to non-zero, swap files are
8157 created for all buffers that have 'swapfile' set. When 'updatecount'
8158 is set to zero, existing swap files are not deleted.
8159 Also see |'swapsync'|.
8160 This option has no meaning in buffers where |'buftype'| is "nofile"
8161 or "nowrite".
8162
8163 *'updatetime'* *'ut'*
8164'updatetime' 'ut' number (default 4000)
8165 global
8166 {not in Vi}
8167 If this many milliseconds nothing is typed the swap file will be
8168 written to disk (see |crash-recovery|). Also used for the
8169 |CursorHold| autocommand event.
8170
8171 *'verbose'* *'vbs'*
8172'verbose' 'vbs' number (default 0)
8173 global
8174 {not in Vi, although some versions have a boolean
8175 verbose option}
8176 When bigger than zero, Vim will give messages about what it is doing.
8177 Currently, these messages are given:
8178 >= 1 When the viminfo file is read or written.
8179 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008180 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008181 >= 8 Files for which a group of autocommands is executed.
8182 >= 9 Every executed autocommand.
8183 >= 12 Every executed function.
8184 >= 13 When an exception is thrown, caught, finished, or discarded.
8185 >= 14 Anything pending in a ":finally" clause.
8186 >= 15 Every executed Ex command (truncated at 200 characters).
8187
8188 This option can also be set with the "-V" argument. See |-V|.
8189 This option is also set by the |:verbose| command.
8190
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008191 When the 'verbosefile' option is set then the verbose messages are not
8192 displayed.
8193
8194 *'verbosefile'* *'vfile'*
8195'verbosefile' 'vfile' string (default empty)
8196 global
8197 {not in Vi}
8198 When not empty all messages are written in a file with this name.
8199 When the file exists messages are appended.
8200 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008201 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008202 Setting 'verbosefile' to a new value is like making it empty first.
8203 The difference with |:redir| is that verbose messages are not
8204 displayed when 'verbosefile' is set.
8205
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 *'viewdir'* *'vdir'*
8207'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8208 "$VIM/vimfiles/view",
8209 for Unix: "~/.vim/view",
8210 for Macintosh: "$VIM:vimfiles:view"
8211 for VMS: "sys$login:vimfiles/view"
8212 for RiscOS: "Choices:vimfiles/view")
8213 global
8214 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008215 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 feature}
8217 Name of the directory where to store files for |:mkview|.
8218 This option cannot be set from a |modeline| or in the |sandbox|, for
8219 security reasons.
8220
8221 *'viewoptions'* *'vop'*
8222'viewoptions' 'vop' string (default: "folds,options,cursor")
8223 global
8224 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008225 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226 feature}
8227 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008228 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 word save and restore ~
8230 cursor cursor position in file and in window
8231 folds manually created folds, opened/closed folds and local
8232 fold options
8233 options options and mappings local to a window or buffer (not
8234 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008235 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 slash backslashes in file names replaced with forward
8237 slashes
8238 unix with Unix end-of-line format (single <NL>), even when
8239 on Windows or DOS
8240
8241 "slash" and "unix" are useful on Windows when sharing view files
8242 with Unix. The Unix version of Vim cannot source dos format scripts,
8243 but the Windows version of Vim can source unix format scripts.
8244
8245 *'viminfo'* *'vi'* *E526* *E527* *E528*
8246'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008247 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8248 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8249 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 global
8251 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008252 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 feature}
8254 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008255 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 separated list of parameters, each consisting of a single character
8257 identifying the particular parameter, followed by a number or string
8258 which specifies the value of that parameter. If a particular
8259 character is left out, then the default value is used for that
8260 parameter. The following is a list of the identifying characters and
8261 the effect of their value.
8262 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008263 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008264 ! When included, save and restore global variables that start
8265 with an uppercase letter, and don't contain a lowercase
8266 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008267 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008268 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008269 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 " Maximum number of lines saved for each register. Old name of
8271 the '<' item, with the disadvantage that you need to put a
8272 backslash before the ", otherwise it will be recognized as the
8273 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008274 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 % When included, save and restore the buffer list. If Vim is
8276 started with a file name argument, the buffer list is not
8277 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008278 buffer list is restored from the viminfo file. Quickfix
8279 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8280 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008281 When followed by a number, the number specifies the maximum
8282 number of buffers that are stored. Without a number all
8283 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008284 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 ' Maximum number of previously edited files for which the marks
8286 are remembered. This parameter must always be included when
8287 'viminfo' is non-empty.
8288 Including this item also means that the |jumplist| and the
8289 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008290 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008292 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 patterns are also saved. When not included, the value of
8294 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008295 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008297 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008298 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008299 < Maximum number of lines saved for each register. If zero then
8300 registers are not saved. When not included, all lines are
8301 saved. '"' is the old name for this item.
8302 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008303 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008304 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008305 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008306 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 c When included, convert the text in the viminfo file from the
8308 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008309 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008310 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 f Whether file marks need to be stored. If zero, file marks ('0
8312 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008313 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008315 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 h Disable the effect of 'hlsearch' when loading the viminfo
8317 file. When not included, it depends on whether ":nohlsearch"
8318 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008319 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008320 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008321 the 'n'. Must be at the end of the option! If the "-i"
8322 argument was given when starting Vim, that file name overrides
8323 the one given here with 'viminfo'. Environment variables are
8324 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008325 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 r Removable media. The argument is a string (up to the next
8327 ','). This parameter can be given several times. Each
8328 specifies the start of a path for which no marks will be
8329 stored. This is to avoid removable media. For MS-DOS you
8330 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8331 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8332 ignored. Maximum length of each 'r' argument is 50
8333 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008334 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 s Maximum size of an item in Kbyte. If zero then registers are
8336 not saved. Currently only applies to registers. The default
8337 "s10" will exclude registers with more than 10 Kbyte of text.
8338 Also see the '<' item above: line count limit.
8339
8340 Example: >
8341 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8342<
8343 '50 Marks will be remembered for the last 50 files you
8344 edited.
8345 <1000 Contents of registers (up to 1000 lines each) will be
8346 remembered.
8347 s100 Registers with more than 100 Kbyte text are skipped.
8348 :0 Command-line history will not be saved.
8349 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8350 no / Since '/' is not specified, the default will be used,
8351 that is, save all of the search history, and also the
8352 previous search and substitute patterns.
8353 no % The buffer list will not be saved nor read back.
8354 no h 'hlsearch' highlighting will be restored.
8355
8356 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8357 load the contents of the file, this is not done automatically.
8358
8359 This option cannot be set from a |modeline| or in the |sandbox|, for
8360 security reasons.
8361
8362 *'virtualedit'* *'ve'*
8363'virtualedit' 've' string (default "")
8364 global
8365 {not in Vi}
8366 {not available when compiled without the
8367 |+virtualedit| feature}
8368 A comma separated list of these words:
8369 block Allow virtual editing in Visual block mode.
8370 insert Allow virtual editing in Insert mode.
8371 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008372 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008373
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008375 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 of the line. Useful for selecting a rectangle in Visual mode and
8377 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008378 "onemore" is not the same, it will only allow moving the cursor just
8379 after the last character of the line. This makes some commands more
8380 consistent. Previously the cursor was always past the end of the line
8381 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008382 break some plugins or Vim scripts. For example because |l| can move
8383 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008384 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008385 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008386 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008387 It doesn't make sense to combine "all" with "onemore", but you will
8388 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389
8390 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8391'visualbell' 'vb' boolean (default off)
8392 global
8393 {not in Vi}
8394 Use visual bell instead of beeping. The terminal code to display the
8395 visual bell is given with 't_vb'. When no beep or flash is wanted,
8396 use ":set vb t_vb=".
8397 Note: When the GUI starts, 't_vb' is reset to its default value. You
8398 might want to set it again in your |gvimrc|.
8399 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8400 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8401 where 40 is the time in msec.
8402 Does not work on the Amiga, you always get a screen flash.
8403 Also see 'errorbells'.
8404
8405 *'warn'* *'nowarn'*
8406'warn' boolean (default on)
8407 global
8408 Give a warning message when a shell command is used while the buffer
8409 has been changed.
8410
8411 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8412'weirdinvert' 'wiv' boolean (default off)
8413 global
8414 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008415 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 It is provided for backwards compatibility with version 4.x.
8417 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8418 vice versa. Has no effect when the GUI is running.
8419
8420 *'whichwrap'* *'ww'*
8421'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8422 global
8423 {not in Vi}
8424 Allow specified keys that move the cursor left/right to move to the
8425 previous/next line when the cursor is on the first/last character in
8426 the line. Concatenate characters to allow this for these keys:
8427 char key mode ~
8428 b <BS> Normal and Visual
8429 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008430 h "h" Normal and Visual (not recommended)
8431 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008432 < <Left> Normal and Visual
8433 > <Right> Normal and Visual
8434 ~ "~" Normal
8435 [ <Left> Insert and Replace
8436 ] <Right> Insert and Replace
8437 For example: >
8438 :set ww=<,>,[,]
8439< allows wrap only when cursor keys are used.
8440 When the movement keys are used in combination with a delete or change
8441 operator, the <EOL> also counts for a character. This makes "3h"
8442 different from "3dh" when the cursor crosses the end of a line. This
8443 is also true for "x" and "X", because they do the same as "dl" and
8444 "dh". If you use this, you may also want to use the mapping
8445 ":map <BS> X" to make backspace delete the character in front of the
8446 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008447 When 'l' is included and it is used after an operator at the end of a
8448 line then it will not move to the next line. This makes "dl", "cl",
8449 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 NOTE: This option is set to the Vi default value when 'compatible' is
8451 set and to the Vim default value when 'compatible' is reset.
8452
8453 *'wildchar'* *'wc'*
8454'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8455 global
8456 {not in Vi}
8457 Character you have to type to start wildcard expansion in the
8458 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008459 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 The character is not recognized when used inside a macro. See
8461 'wildcharm' for that.
8462 Although 'wc' is a number option, you can set it to a special key: >
8463 :set wc=<Esc>
8464< NOTE: This option is set to the Vi default value when 'compatible' is
8465 set and to the Vim default value when 'compatible' is reset.
8466
8467 *'wildcharm'* *'wcm'*
8468'wildcharm' 'wcm' number (default: none (0))
8469 global
8470 {not in Vi}
8471 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008472 recognized when used inside a macro. You can find "spare" command-line
8473 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008474 you'll never actually type 'wildcharm', just use it in mappings that
8475 automatically invoke completion mode, e.g.: >
8476 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008477 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478< Then after typing :ss you can use CTRL-P & CTRL-N.
8479
8480 *'wildignore'* *'wig'*
8481'wildignore' 'wig' string (default "")
8482 global
8483 {not in Vi}
8484 {not available when compiled without the |+wildignore|
8485 feature}
8486 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008487 patterns is ignored when expanding |wildcards|, completing file or
8488 directory names, and influences the result of |expand()|, |glob()| and
8489 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8491 Also see 'suffixes'.
8492 Example: >
8493 :set wildignore=*.o,*.obj
8494< The use of |:set+=| and |:set-=| is preferred when adding or removing
8495 a pattern from the list. This avoids problems when a future version
8496 uses another default.
8497
Bram Moolenaar94950a92010-12-02 16:01:29 +01008498
Bram Moolenaar81af9252010-12-10 20:35:50 +01008499 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008500'wildignorecase' 'wic' boolean (default off)
8501 global
8502 {not in Vi}
8503 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008504 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008505 Does not apply when the shell is used to expand wildcards, which
8506 happens when there are special characters.
8507
8508
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008510'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 global
8512 {not in Vi}
8513 {not available if compiled without the |+wildmenu|
8514 feature}
8515 When 'wildmenu' is on, command-line completion operates in an enhanced
8516 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8517 the possible matches are shown just above the command line, with the
8518 first match highlighted (overwriting the status line, if there is
8519 one). Keys that show the previous/next match, such as <Tab> or
8520 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8521 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8522 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008523 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 If there are more matches than can fit in the line, a ">" is shown on
8525 the right and/or a "<" is shown on the left. The status line scrolls
8526 as needed.
8527 The "wildmenu" mode is abandoned when a key is hit that is not used
8528 for selecting a completion.
8529 While the "wildmenu" is active the following keys have special
8530 meanings:
8531
8532 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8533 <Down> - in filename/menu name completion: move into a
8534 subdirectory or submenu.
8535 <CR> - in menu completion, when the cursor is just after a
8536 dot: move into a submenu.
8537 <Up> - in filename/menu name completion: move up into
8538 parent directory or parent menu.
8539
8540 This makes the menus accessible from the console |console-menus|.
8541
8542 If you prefer the <Left> and <Right> keys to move the cursor instead
8543 of selecting a different match, use this: >
8544 :cnoremap <Left> <Space><BS><Left>
8545 :cnoremap <Right> <Space><BS><Right>
8546<
8547 The "WildMenu" highlighting is used for displaying the current match
8548 |hl-WildMenu|.
8549
8550 *'wildmode'* *'wim'*
8551'wildmode' 'wim' string (Vim default: "full")
8552 global
8553 {not in Vi}
8554 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008555 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008556 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008557 first part specifies the behavior for the first use of 'wildchar',
8558 The second part for the second use, etc.
8559 These are the possible values for each part:
8560 "" Complete only the first match.
8561 "full" Complete the next full match. After the last match,
8562 the original string is used and then the first match
8563 again.
8564 "longest" Complete till longest common string. If this doesn't
8565 result in a longer string, use the next part.
8566 "longest:full" Like "longest", but also start 'wildmenu' if it is
8567 enabled.
8568 "list" When more than one match, list all matches.
8569 "list:full" When more than one match, list all matches and
8570 complete first match.
8571 "list:longest" When more than one match, list all matches and
8572 complete till longest common string.
8573 When there is only a single match, it is fully completed in all cases.
8574
8575 Examples: >
8576 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008577< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008578 :set wildmode=longest,full
8579< Complete longest common string, then each full match >
8580 :set wildmode=list:full
8581< List all matches and complete each full match >
8582 :set wildmode=list,full
8583< List all matches without completing, then each full match >
8584 :set wildmode=longest,list
8585< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008586 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008587
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008588 *'wildoptions'* *'wop'*
8589'wildoptions' 'wop' string (default "")
8590 global
8591 {not in Vi}
8592 {not available when compiled without the |+wildignore|
8593 feature}
8594 A list of words that change how command line completion is done.
8595 Currently only one word is allowed:
8596 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008597 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008598 is displayed per line. Often used tag kinds are:
8599 d #define
8600 f function
8601 Also see |cmdline-completion|.
8602
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 *'winaltkeys'* *'wak'*
8604'winaltkeys' 'wak' string (default "menu")
8605 global
8606 {not in Vi}
8607 {only used in Win32, Motif, GTK and Photon GUI}
8608 Some GUI versions allow the access to menu entries by using the ALT
8609 key in combination with a character that appears underlined in the
8610 menu. This conflicts with the use of the ALT key for mappings and
8611 entering special characters. This option tells what to do:
8612 no Don't use ALT keys for menus. ALT key combinations can be
8613 mapped, but there is no automatic handling. This can then be
8614 done with the |:simalt| command.
8615 yes ALT key handling is done by the windowing system. ALT key
8616 combinations cannot be mapped.
8617 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008618 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008619 keys can be mapped.
8620 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8621 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008622 This option is not used for <F10>; on Win32 and with GTK <F10> will
8623 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008624
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008625 *'window'* *'wi'*
8626'window' 'wi' number (default screen height - 1)
8627 global
8628 Window height. Do not confuse this with the height of the Vim window,
8629 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008630 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8631 value is smaller than 'lines' minus one. The screen will scroll
8632 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008633 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8634 in a much smarter way, taking care of wrapping lines.
8635 When resizing the Vim window, the value is smaller than 1 or more than
8636 or equal to 'lines' it will be set to 'lines' minus 1.
8637 {Vi also uses the option to specify the number of displayed lines}
8638
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 *'winheight'* *'wh'* *E591*
8640'winheight' 'wh' number (default 1)
8641 global
8642 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008643 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008644 feature}
8645 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008646 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008647 focus goes to a window that is smaller, its size is increased, at the
8648 cost of the height of other windows.
8649 Set 'winheight' to a small number for normal editing.
8650 Set it to 999 to make the current window fill most of the screen.
8651 Other windows will be only 'winminheight' high. This has the drawback
8652 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8653 to create only two windows, set the option after startup is done,
8654 using the |VimEnter| event: >
8655 au VimEnter * set winheight=999
8656< Minimum value is 1.
8657 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008658 height of the current window.
8659 'winheight' applies to the current window. Use 'winminheight' to set
8660 the minimal height for other windows.
8661
8662 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8663'winfixheight' 'wfh' boolean (default off)
8664 local to window
8665 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008666 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 feature}
8668 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008669 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8670 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 The height may be changed anyway when running out of room.
8672
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008673 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8674'winfixwidth' 'wfw' boolean (default off)
8675 local to window
8676 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008677 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008678 feature}
8679 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008680 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008681 The width may be changed anyway when running out of room.
8682
Bram Moolenaar071d4272004-06-13 20:20:40 +00008683 *'winminheight'* *'wmh'*
8684'winminheight' 'wmh' number (default 1)
8685 global
8686 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008687 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008688 feature}
8689 The minimal height of a window, when it's not the current window.
8690 This is a hard minimum, windows will never become smaller.
8691 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8692 status bar) if necessary. They will return to at least one line when
8693 they become active (since the cursor has to have somewhere to go.)
8694 Use 'winheight' to set the minimal height of the current window.
8695 This option is only checked when making a window smaller. Don't use a
8696 large number, it will cause errors when opening more than a few
8697 windows. A value of 0 to 3 is reasonable.
8698
8699 *'winminwidth'* *'wmw'*
8700'winminwidth' 'wmw' number (default 1)
8701 global
8702 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008703 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 feature}
8705 The minimal width of a window, when it's not the current window.
8706 This is a hard minimum, windows will never become smaller.
8707 When set to zero, windows may be "squashed" to zero columns (i.e. just
8708 a vertical separator) if necessary. They will return to at least one
8709 line when they become active (since the cursor has to have somewhere
8710 to go.)
8711 Use 'winwidth' to set the minimal width of the current window.
8712 This option is only checked when making a window smaller. Don't use a
8713 large number, it will cause errors when opening more than a few
8714 windows. A value of 0 to 12 is reasonable.
8715
8716 *'winwidth'* *'wiw'* *E592*
8717'winwidth' 'wiw' number (default 20)
8718 global
8719 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008720 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008721 feature}
8722 Minimal number of columns for the current window. This is not a hard
8723 minimum, Vim will use fewer columns if there is not enough room. If
8724 the current window is smaller, its size is increased, at the cost of
8725 the width of other windows. Set it to 999 to make the current window
8726 always fill the screen. Set it to a small number for normal editing.
8727 The width is not adjusted after one of the commands to change the
8728 width of the current window.
8729 'winwidth' applies to the current window. Use 'winminwidth' to set
8730 the minimal width for other windows.
8731
8732 *'wrap'* *'nowrap'*
8733'wrap' boolean (default on)
8734 local to window
8735 {not in Vi}
8736 This option changes how text is displayed. It doesn't change the text
8737 in the buffer, see 'textwidth' for that.
8738 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008739 displaying continues on the next line. When off lines will not wrap
8740 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741 moved to a part that is not shown, the screen will scroll
8742 horizontally.
8743 The line will be broken in the middle of a word if necessary. See
8744 'linebreak' to get the break at a word boundary.
8745 To make scrolling horizontally a bit more useful, try this: >
8746 :set sidescroll=5
8747 :set listchars+=precedes:<,extends:>
8748< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008749 This option can't be set from a |modeline| when the 'diff' option is
8750 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751
8752 *'wrapmargin'* *'wm'*
8753'wrapmargin' 'wm' number (default 0)
8754 local to buffer
8755 Number of characters from the right window border where wrapping
8756 starts. When typing text beyond this limit, an <EOL> will be inserted
8757 and inserting continues on the next line.
8758 Options that add a margin, such as 'number' and 'foldcolumn', cause
8759 the text width to be further reduced. This is Vi compatible.
8760 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008761 This option is set to 0 when 'paste' is set and restored when 'paste'
8762 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8764 and less usefully}
8765
8766 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8767'wrapscan' 'ws' boolean (default on) *E384* *E385*
8768 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008769 Searches wrap around the end of the file. Also applies to |]s| and
8770 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771
8772 *'write'* *'nowrite'*
8773'write' boolean (default on)
8774 global
8775 {not in Vi}
8776 Allows writing files. When not set, writing a file is not allowed.
8777 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008778 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 argument. Filtering text is still possible, even though this requires
8780 writing a temporary file.
8781
8782 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8783'writeany' 'wa' boolean (default off)
8784 global
8785 Allows writing to any file with no need for "!" override.
8786
8787 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8788'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8789 otherwise)
8790 global
8791 {not in Vi}
8792 Make a backup before overwriting a file. The backup is removed after
8793 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008794 also on.
8795 WARNING: Switching this option off means that when Vim fails to write
8796 your buffer correctly and then, for whatever reason, Vim exits, you
8797 lose both the original file and what you were writing. Only reset
8798 this option if your file system is almost full and it makes the write
8799 fail (and make sure not to exit Vim until the write was successful).
8800 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008801 When the 'backupskip' pattern matches, a backup is not made anyway.
8802 NOTE: This option is set to the default value when 'compatible' is
8803 set.
8804
8805 *'writedelay'* *'wd'*
8806'writedelay' 'wd' number (default 0)
8807 global
8808 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008809 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 screen. When non-zero, characters are sent to the terminal one by
8811 one. For MS-DOS pcterm this does not work. For debugging purposes.
8812
8813 vim:tw=78:ts=8:ft=help:norl: