blob: c6fc4242847a54a7e294876d6a2ec21a5a33e660 [file] [log] [blame]
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02001*options.txt* For Vim version 8.0. Last change: 2017 May 08
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram 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).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
735 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200736 {only available when compiled with it, use
737 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000738 When on, Vim will change the current working directory whenever you
739 open a file, switch buffers, delete a buffer or open/close a window.
740 It will change to the directory containing the file which was opened
741 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000742 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
745'arabic' 'arab' boolean (default off)
746 local to window
747 {not in Vi}
748 {only available when compiled with the |+arabic|
749 feature}
750 This option can be set to start editing Arabic text.
751 Setting this option will:
752 - Set the 'rightleft' option, unless 'termbidi' is set.
753 - Set the 'arabicshape' option, unless 'termbidi' is set.
754 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
755 between typing English and Arabic key mapping.
756 - Set the 'delcombine' option
757 Note that 'encoding' must be "utf-8" for working with Arabic text.
758
759 Resetting this option will:
760 - Reset the 'rightleft' option.
761 - Disable the use of 'keymap' (without changing its value).
762 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200763 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100764 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 Also see |arabic.txt|.
766
767 *'arabicshape'* *'arshape'*
768 *'noarabicshape'* *'noarshape'*
769'arabicshape' 'arshape' boolean (default on)
770 global
771 {not in Vi}
772 {only available when compiled with the |+arabic|
773 feature}
774 When on and 'termbidi' is off, the required visual character
775 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200776 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777 one which encompasses:
778 a) the changing/morphing of characters based on their location
779 within a word (initial, medial, final and stand-alone).
780 b) the enabling of the ability to compose characters
781 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100782 When disabled the display shows each character's true stand-alone
783 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Arabic is a complex language which requires other settings, for
785 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100786 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787
788 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
789'autoindent' 'ai' boolean (default off)
790 local to buffer
791 Copy indent from current line when starting a new line (typing <CR>
792 in Insert mode or when using the "o" or "O" command). If you do not
793 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000794 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
795 to another line has the same effect, unless the 'I' flag is included
796 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000797 When autoindent is on, formatting (with the "gq" command or when you
798 reach 'textwidth' in Insert mode) uses the indentation of the first
799 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 When 'smartindent' or 'cindent' is on the indent is changed in
801 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200802 The 'autoindent' option is reset when the 'paste' option is set and
803 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000804 {small difference from Vi: After the indent is deleted when typing
805 <Esc> or <CR>, the cursor position when moving up or down is after the
806 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
807
808 *'autoread'* *'ar'* *'noautoread'* *'noar'*
809'autoread' 'ar' boolean (default off)
810 global or local to buffer |global-local|
811 {not in Vi}
812 When a file has been detected to have been changed outside of Vim and
813 it has not been changed inside of Vim, automatically read it again.
814 When the file has been deleted this is not done. |timestamp|
815 If this option has a local value, use this command to switch back to
816 using the global value: >
817 :set autoread<
818<
819 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
820'autowrite' 'aw' boolean (default off)
821 global
822 Write the contents of the file, if it has been modified, on each
823 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000824 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
826 Note that for some commands the 'autowrite' option is not used, see
827 'autowriteall' for that.
828
829 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
830'autowriteall' 'awa' boolean (default off)
831 global
832 {not in Vi}
833 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
834 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
835 Setting this option also implies that Vim behaves like 'autowrite' has
836 been set.
837
838 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200839'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 global
841 {not in Vi}
842 When set to "dark", Vim will try to use colors that look good on a
843 dark background. When set to "light", Vim will try to use colors that
844 look good on a light background. Any other value is illegal.
845 Vim tries to set the default value according to the terminal used.
846 This will not always be correct.
847 Setting this option does not change the background color, it tells Vim
848 what the background color looks like. For changing the background
849 color, see |:hi-normal|.
850
851 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000852 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000853 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100854 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 setting 'background' will cause the color scheme to be reloaded. If
856 the color scheme adjusts to the value of 'background' this will work.
857 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100858 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859
860 When setting 'background' to the default value with: >
861 :set background&
862< Vim will guess the value. In the GUI this should work correctly,
863 in other cases Vim might not be able to guess the right value.
864
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200865 When the t_BG option is set, Vim will use it to request the background
866 color from the terminal. If the returned RGB value is dark/light and
867 'background' is not dark/light, 'background' will be set and the
868 screen is redrawn. This may have side effects, make t_BG empty in
869 your .vimrc if you suspect this problem.
870
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 When starting the GUI, the default value for 'background' will be
872 "light". When the value is not set in the .gvimrc, and Vim detects
873 that the background is actually quite dark, 'background' is set to
874 "dark". But this happens only AFTER the .gvimrc file has been read
875 (because the window needs to be opened to find the actual background
876 color). To get around this, force the GUI window to be opened by
877 putting a ":gui" command in the .gvimrc file, before where the value
878 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200879
880 For MS-DOS, Windows and OS/2 the default is "dark".
881 For other systems "dark" is used when 'term' is "linux",
882 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
883 background. Otherwise the default is "light".
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
902 {not in Vi}
903 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
904 mode. This is a list of items, separated by commas. Each item allows
905 a way to backspace over something:
906 value effect ~
907 indent allow backspacing over autoindent
908 eol allow backspacing over line breaks (join lines)
909 start allow backspacing over the start of insert; CTRL-W and CTRL-U
910 stop once at the start of insert.
911
912 When the value is empty, Vi compatible backspacing is used.
913
914 For backwards compatibility with version 5.4 and earlier:
915 value effect ~
916 0 same as ":set backspace=" (Vi compatible)
917 1 same as ":set backspace=indent,eol"
918 2 same as ":set backspace=indent,eol,start"
919
920 See |:fixdel| if your <BS> or <Del> key does not do what you want.
921 NOTE: This option is set to "" when 'compatible' is set.
922
923 *'backup'* *'bk'* *'nobackup'* *'nobk'*
924'backup' 'bk' boolean (default off)
925 global
926 {not in Vi}
927 Make a backup before overwriting a file. Leave it around after the
928 file has been successfully written. If you do not want to keep the
929 backup file, but you do want a backup while the file is being
930 written, reset this option and set the 'writebackup' option (this is
931 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000932 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 |backup-table| for more explanations.
934 When the 'backupskip' pattern matches, a backup is not made anyway.
935 When 'patchmode' is set, the backup may be renamed to become the
936 oldest version of a file.
937 NOTE: This option is reset when 'compatible' is set.
938
939 *'backupcopy'* *'bkc'*
940'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200941 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 {not in Vi}
943 When writing a file and a backup is made, this option tells how it's
944 done. This is a comma separated list of words.
945
946 The main values are:
947 "yes" make a copy of the file and overwrite the original one
948 "no" rename the file and write a new one
949 "auto" one of the previous, what works best
950
951 Extra values that can be combined with the ones above are:
952 "breaksymlink" always break symlinks when writing
953 "breakhardlink" always break hardlinks when writing
954
955 Making a copy and overwriting the original file:
956 - Takes extra time to copy the file.
957 + When the file has special attributes, is a (hard/symbolic) link or
958 has a resource fork, all this is preserved.
959 - When the file is a link the backup will have the name of the link,
960 not of the real file.
961
962 Renaming the file and writing a new one:
963 + It's fast.
964 - Sometimes not all attributes of the file can be copied to the new
965 file.
966 - When the file is a link the new file will not be a link.
967
968 The "auto" value is the middle way: When Vim sees that renaming file
969 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000970 the file is not a link) that is used. When problems are expected, a
971 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972
973 The "breaksymlink" and "breakhardlink" values can be used in
974 combination with any of "yes", "no" and "auto". When included, they
975 force Vim to always break either symbolic or hard links by doing
976 exactly what the "no" option does, renaming the original file to
977 become the backup and writing a new file in its place. This can be
978 useful for example in source trees where all the files are symbolic or
979 hard links and any changes should stay in the local source tree, not
980 be propagated back to the original source.
981 *crontab*
982 One situation where "no" and "auto" will cause problems: A program
983 that opens a file, invokes Vim to edit that file, and then tests if
984 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000985 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 example.
987
988 When a copy is made, the original file is truncated and then filled
989 with the new text. This means that protection bits, owner and
990 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000991 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 group of the backup is set to the group of the original file. If this
993 fails, the protection bits for the group are made the same as for
994 others.
995
996 When the file is renamed this is the other way around: The backup has
997 the same attributes of the original file, and the newly written file
998 is owned by the current user. When the file was a (hard/symbolic)
999 link, the new file will not! That's why the "auto" value doesn't
1000 rename when the file is a link. The owner and group of the newly
1001 written file will be set to the same ones as the original file, but
1002 the system may refuse to do this. In that case the "auto" value will
1003 again not rename the file.
1004
Bram Moolenaar036986f2017-03-16 17:41:02 +01001005 NOTE: This option is set to the Vi default value when 'compatible' is
1006 set and to the Vim default value when 'compatible' is reset.
1007
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 *'backupdir'* *'bdir'*
1009'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001010 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 for Unix: ".,~/tmp,~/")
1012 global
1013 {not in Vi}
1014 List of directories for the backup file, separated with commas.
1015 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001016 where this is possible. The directory must exist, Vim will not
1017 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001018 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 impossible!). Writing may fail because of this.
1020 - A directory "." means to put the backup file in the same directory
1021 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001022 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001023 put the backup file relative to where the edited file is. The
1024 leading "." is replaced with the path name of the edited file.
1025 ("." inside a directory name has no special meaning).
1026 - Spaces after the comma are ignored, other spaces are considered part
1027 of the directory name. To have a space at the start of a directory
1028 name, precede it with a backslash.
1029 - To include a comma in a directory name precede it with a backslash.
1030 - A directory name may end in an '/'.
1031 - Environment variables are expanded |:set_env|.
1032 - Careful with '\' characters, type one before a space, type two to
1033 get one in the option (see |option-backslash|), for example: >
1034 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1035< - For backwards compatibility with Vim version 3.0 a '>' at the start
1036 of the option is removed.
1037 See also 'backup' and 'writebackup' options.
1038 If you want to hide your backup files on Unix, consider this value: >
1039 :set backupdir=./.backup,~/.backup,.,/tmp
1040< You must create a ".backup" directory in each directory and in your
1041 home directory for this to work properly.
1042 The use of |:set+=| and |:set-=| is preferred when adding or removing
1043 directories from the list. This avoids problems when a future version
1044 uses another default.
1045 This option cannot be set from a |modeline| or in the |sandbox|, for
1046 security reasons.
1047
1048 *'backupext'* *'bex'* *E589*
1049'backupext' 'bex' string (default "~", for VMS: "_")
1050 global
1051 {not in Vi}
1052 String which is appended to a file name to make the name of the
1053 backup file. The default is quite unusual, because this avoids
1054 accidentally overwriting existing files with a backup file. You might
1055 prefer using ".bak", but make sure that you don't have files with
1056 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001057 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001059 If you like to keep a lot of backups, you could use a BufWritePre
1060 autocommand to change 'backupext' just before writing the file to
1061 include a timestamp. >
1062 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1063< Use 'backupdir' to put the backup in a different directory.
1064
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 *'backupskip'* *'bsk'*
1066'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1067 global
1068 {not in Vi}
1069 {not available when compiled without the |+wildignore|
1070 feature}
1071 A list of file patterns. When one of the patterns matches with the
1072 name of the file which is written, no backup file is created. Both
1073 the specified file name and the full path name of the file are used.
1074 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1075 Watch out for special characters, see |option-backslash|.
1076 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001077 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001078
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001079 WARNING: Not having a backup file means that when Vim fails to write
1080 your buffer correctly and then, for whatever reason, Vim exits, you
1081 lose both the original file and what you were writing. Only disable
1082 backups if you don't care about losing the file.
1083
Bram Moolenaar02467872007-05-06 13:22:01 +00001084 Note that environment variables are not expanded. If you want to use
1085 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001086 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001087
1088< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001089 backup would be made by renaming the original file crontab won't see
1090 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001091
1092 *'balloondelay'* *'bdlay'*
1093'balloondelay' 'bdlay' number (default: 600)
1094 global
1095 {not in Vi}
1096 {only available when compiled with the |+balloon_eval|
1097 feature}
1098 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1099
1100 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1101'ballooneval' 'beval' boolean (default off)
1102 global
1103 {not in Vi}
1104 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001105 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 Switch on the |balloon-eval| functionality.
1107
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001108 *'balloonexpr'* *'bexpr'*
1109'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001110 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001111 {not in Vi}
1112 {only available when compiled with the |+balloon_eval|
1113 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001114 Expression for text to show in evaluation balloon. It is only used
1115 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001116
1117 v:beval_bufnr number of the buffer in which balloon is going to show
1118 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001119 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 v:beval_lnum line number
1121 v:beval_col column number (byte index)
1122 v:beval_text word under or after the mouse pointer
1123
1124 The evaluation of the expression must not have side effects!
1125 Example: >
1126 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001127 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128 \', column ' . v:beval_col .
1129 \ ' of file ' . bufname(v:beval_bufnr) .
1130 \ ' on word "' . v:beval_text . '"'
1131 endfunction
1132 set bexpr=MyBalloonExpr()
1133 set ballooneval
1134<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001135 Also see |balloon_show()|, can be used if the content of the balloon
1136 is to be fetched asynchronously.
1137
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 NOTE: The balloon is displayed only if the cursor is on a text
1139 character. If the result of evaluating 'balloonexpr' is not empty,
1140 Vim does not try to send a message to an external debugger (Netbeans
1141 or Sun Workshop).
1142
Bram Moolenaar30b65812012-07-12 22:01:11 +02001143 The expression will be evaluated in the |sandbox| when set from a
1144 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001145
1146 It is not allowed to change text or jump to another window while
1147 evaluating 'balloonexpr' |textlock|.
1148
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001149 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001150 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001151< When they are supported "\n" characters will start a new line. If the
1152 expression evaluates to a |List| this is equal to using each List item
1153 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001154 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001155
Bram Moolenaar165bc692015-07-21 17:53:25 +02001156 *'belloff'* *'bo'*
1157'belloff' 'bo' string (default "")
1158 global
1159 {not in Vi}
1160 Specifies for which events the bell will not be rung. It is a comma
1161 separated list of items. For each item that is present, the bell
1162 will be silenced. This is most useful to specify specific events in
1163 insert mode to be silenced.
1164
1165 item meaning when present ~
1166 all All events.
1167 backspace When hitting <BS> or <Del> and deleting results in an
1168 error.
1169 cursor Fail to move around using the cursor keys or
1170 <PageUp>/<PageDown> in |Insert-mode|.
1171 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1172 |i_CTRL-X_CTRL-T|.
1173 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1174 |i_CTRL-E|.
1175 ctrlg Unknown Char after <C-G> in Insert mode.
1176 error Other Error occurred (e.g. try to join last line)
1177 (mostly used in |Normal-mode| or |Cmdline-mode|).
1178 esc hitting <Esc> in |Normal-mode|.
1179 ex In |Visual-mode|, hitting |Q| results in an error.
1180 hangul Error occurred when using hangul input.
1181 insertmode Pressing <Esc> in 'insertmode'.
1182 lang Calling the beep module for Lua/Mzscheme/TCL.
1183 mess No output available for |g<|.
1184 showmatch Error occurred for 'showmatch' function.
1185 operator Empty region error |cpo-E|.
1186 register Unknown register after <C-R> in |Insert-mode|.
1187 shell Bell from shell output |:!|.
1188 spell Error happened on spell suggest.
1189 wildmode More matches in |cmdline-completion| available
1190 (depends on the 'wildmode' setting).
1191
Bram Moolenaar036986f2017-03-16 17:41:02 +01001192 This is most useful to fine tune when in Insert mode the bell should
1193 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001194 indicate that an error occurred. It can be silenced by adding the
1195 "error" keyword.
1196
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1198'binary' 'bin' boolean (default off)
1199 local to buffer
1200 {not in Vi}
1201 This option should be set before editing a binary file. You can also
1202 use the |-b| Vim argument. When this option is switched on a few
1203 options will be changed (also when it already was on):
1204 'textwidth' will be set to 0
1205 'wrapmargin' will be set to 0
1206 'modeline' will be off
1207 'expandtab' will be off
1208 Also, 'fileformat' and 'fileformats' options will not be used, the
1209 file is read and written like 'fileformat' was "unix" (a single <NL>
1210 separates lines).
1211 The 'fileencoding' and 'fileencodings' options will not be used, the
1212 file is read without conversion.
1213 NOTE: When you start editing a(nother) file while the 'bin' option is
1214 on, settings from autocommands may change the settings again (e.g.,
1215 'textwidth'), causing trouble when editing. You might want to set
1216 'bin' again when the file has been loaded.
1217 The previous values of these options are remembered and restored when
1218 'bin' is switched from on to off. Each buffer has its own set of
1219 saved option values.
1220 To edit a file with 'binary' set you can use the |++bin| argument.
1221 This avoids you have to do ":set bin", which would have effect for all
1222 files you edit.
1223 When writing a file the <EOL> for the last line is only written if
1224 there was one in the original file (normally Vim appends an <EOL> to
1225 the last line if there is none; this would make the file longer). See
1226 the 'endofline' option.
1227
1228 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1229'bioskey' 'biosk' boolean (default on)
1230 global
1231 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001232 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233
1234 *'bomb'* *'nobomb'*
1235'bomb' boolean (default off)
1236 local to buffer
1237 {not in Vi}
1238 {only available when compiled with the |+multi_byte|
1239 feature}
1240 When writing a file and the following conditions are met, a BOM (Byte
1241 Order Mark) is prepended to the file:
1242 - this option is on
1243 - the 'binary' option is off
1244 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1245 endian variants.
1246 Some applications use the BOM to recognize the encoding of the file.
1247 Often used for UCS-2 files on MS-Windows. For other applications it
1248 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001249 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1251 check for the presence of the BOM is done and 'bomb' set accordingly.
1252 Unless 'binary' is set, it is removed from the first line, so that you
1253 don't see it when editing. When you don't change the options, the BOM
1254 will be restored when writing the file.
1255
1256 *'breakat'* *'brk'*
1257'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1258 global
1259 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001260 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 feature}
1262 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001263 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1264 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001266 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001267'breakindent' 'bri' boolean (default off)
1268 local to window
1269 {not in Vi}
1270 {not available when compiled without the |+linebreak|
1271 feature}
1272 Every wrapped line will continue visually indented (same amount of
1273 space as the beginning of that line), thus preserving horizontal blocks
1274 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001275 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276
1277 *'breakindentopt'* *'briopt'*
1278'breakindentopt' 'briopt' string (default empty)
1279 local to window
1280 {not in Vi}
1281 {not available when compiled without the |+linebreak|
1282 feature}
1283 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001284 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001285 min:{n} Minimum text width that will be kept after
1286 applying 'breakindent', even if the resulting
1287 text should normally be narrower. This prevents
1288 text indented almost to the right window border
1289 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001290 shift:{n} After applying 'breakindent', the wrapped line's
1291 beginning will be shifted by the given number of
1292 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001293 indentation (negative) or emphasizing the line
1294 continuation (positive).
1295 sbr Display the 'showbreak' value before applying the
1296 additional indent.
1297 The default value for min is 20 and shift is 0.
1298
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001300'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001302 {not in Vi} {only for Motif, Athena, GTK, Mac and
1303 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001305 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001306 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 buffer Use the directory of the related buffer.
1308 current Use the current directory.
1309 {path} Use the specified directory
1310
1311 *'bufhidden'* *'bh'*
1312'bufhidden' 'bh' string (default: "")
1313 local to buffer
1314 {not in Vi}
1315 {not available when compiled without the |+quickfix|
1316 feature}
1317 This option specifies what happens when a buffer is no longer
1318 displayed in a window:
1319 <empty> follow the global 'hidden' option
1320 hide hide the buffer (don't unload it), also when 'hidden'
1321 is not set
1322 unload unload the buffer, also when 'hidden' is set or using
1323 |:hide|
1324 delete delete the buffer from the buffer list, also when
1325 'hidden' is set or using |:hide|, like using
1326 |:bdelete|
1327 wipe wipe out the buffer from the buffer list, also when
1328 'hidden' is set or using |:hide|, like using
1329 |:bwipeout|
1330
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001331 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001332 are lost without a warning. Also, these values may break autocommands
1333 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 This option is used together with 'buftype' and 'swapfile' to specify
1335 special kinds of buffers. See |special-buffers|.
1336
1337 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1338'buflisted' 'bl' boolean (default: on)
1339 local to buffer
1340 {not in Vi}
1341 When this option is set, the buffer shows up in the buffer list. If
1342 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1343 This option is reset by Vim for buffers that are only used to remember
1344 a file name or marks. Vim sets it when starting to edit a buffer.
1345 But not when moving to a buffer with ":buffer".
1346
1347 *'buftype'* *'bt'* *E382*
1348'buftype' 'bt' string (default: "")
1349 local to buffer
1350 {not in Vi}
1351 {not available when compiled without the |+quickfix|
1352 feature}
1353 The value of this option specifies the type of a buffer:
1354 <empty> normal buffer
1355 nofile buffer which is not related to a file and will not be
1356 written
1357 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001358 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001359 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001360 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001362 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 help help buffer (you are not supposed to set this
1364 manually)
1365
1366 This option is used together with 'bufhidden' and 'swapfile' to
1367 specify special kinds of buffers. See |special-buffers|.
1368
1369 Be careful with changing this option, it can have many side effects!
1370
Bram Moolenaar280f1262006-01-30 00:14:18 +00001371 A "quickfix" buffer is only used for the error list and the location
1372 list. This value is set by the |:cwindow| and |:lwindow| commands and
1373 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374
1375 "nofile" and "nowrite" buffers are similar:
1376 both: The buffer is not to be written to disk, ":w" doesn't
1377 work (":w filename" does work though).
1378 both: The buffer is never considered to be |'modified'|.
1379 There is no warning when the changes will be lost, for
1380 example when you quit Vim.
1381 both: A swap file is only created when using too much memory
1382 (when 'swapfile' has been reset there is never a swap
1383 file).
1384 nofile only: The buffer name is fixed, it is not handled like a
1385 file name. It is not modified in response to a |:cd|
1386 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001387 both: When using ":e bufname" and already editing "bufname"
1388 the buffer is made empty and autocommands are
1389 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001390 *E676*
1391 "acwrite" implies that the buffer name is not related to a file, like
1392 "nofile", but it will be written. Thus, in contrast to "nofile" and
1393 "nowrite", ":w" does work and a modified buffer can't be abandoned
1394 without saving. For writing there must be matching |BufWriteCmd|,
1395 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396
1397 *'casemap'* *'cmp'*
1398'casemap' 'cmp' string (default: "internal,keepascii")
1399 global
1400 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001401 {only available when compiled with the |+multi_byte|
1402 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 Specifies details about changing the case of letters. It may contain
1404 these words, separated by a comma:
1405 internal Use internal case mapping functions, the current
1406 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001407 matters when 'encoding' is a Unicode encoding,
1408 "latin1" or "iso-8859-15". When "internal" is
1409 omitted, the towupper() and towlower() system library
1410 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001411 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1412 case mapping, the current locale is not effective.
1413 This probably only matters for Turkish.
1414
1415 *'cdpath'* *'cd'* *E344* *E346*
1416'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1417 global
1418 {not in Vi}
1419 {not available when compiled without the
1420 |+file_in_path| feature}
1421 This is a list of directories which will be searched when using the
1422 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001423 for has a relative path, not an absolute part starting with "/", "./"
1424 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 The 'cdpath' option's value has the same form and semantics as
1426 |'path'|. Also see |file-searching|.
1427 The default value is taken from $CDPATH, with a "," prepended to look
1428 in the current directory first.
1429 If the default value taken from $CDPATH is not what you want, include
1430 a modified version of the following command in your vimrc file to
1431 override it: >
1432 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1433< This option cannot be set from a |modeline| or in the |sandbox|, for
1434 security reasons.
1435 (parts of 'cdpath' can be passed to the shell to expand file names).
1436
1437 *'cedit'*
1438'cedit' string (Vi default: "", Vim default: CTRL-F)
1439 global
1440 {not in Vi}
1441 {not available when compiled without the |+vertsplit|
1442 feature}
1443 The key used in Command-line Mode to open the command-line window.
1444 The default is CTRL-F when 'compatible' is off.
1445 Only non-printable keys are allowed.
1446 The key can be specified as a single character, but it is difficult to
1447 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001448 :exe "set cedit=\<C-Y>"
1449 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450< |Nvi| also has this option, but it only uses the first character.
1451 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is set to the Vim default value when 'compatible'
1453 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1456'charconvert' 'ccv' string (default "")
1457 global
1458 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001459 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 {not in Vi}
1461 An expression that is used for character encoding conversion. It is
1462 evaluated when a file that is to be read or has been written has a
1463 different encoding from what is desired.
1464 'charconvert' is not used when the internal iconv() function is
1465 supported and is able to do the conversion. Using iconv() is
1466 preferred, because it is much faster.
1467 'charconvert' is not used when reading stdin |--|, because there is no
1468 file to convert from. You will have to save the text in a file first.
1469 The expression must return zero or an empty string for success,
1470 non-zero for failure.
1471 The possible encoding names encountered are in 'encoding'.
1472 Additionally, names given in 'fileencodings' and 'fileencoding' are
1473 used.
1474 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1475 is done internally by Vim, 'charconvert' is not used for this.
1476 'charconvert' is also used to convert the viminfo file, if the 'c'
1477 flag is present in 'viminfo'. Also used for Unicode conversion.
1478 Example: >
1479 set charconvert=CharConvert()
1480 fun CharConvert()
1481 system("recode "
1482 \ . v:charconvert_from . ".." . v:charconvert_to
1483 \ . " <" . v:fname_in . " >" v:fname_out)
1484 return v:shell_error
1485 endfun
1486< The related Vim variables are:
1487 v:charconvert_from name of the current encoding
1488 v:charconvert_to name of the desired encoding
1489 v:fname_in name of the input file
1490 v:fname_out name of the output file
1491 Note that v:fname_in and v:fname_out will never be the same.
1492 Note that v:charconvert_from and v:charconvert_to may be different
1493 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1494 Encryption is not done by Vim when using 'charconvert'. If you want
1495 to encrypt the file after conversion, 'charconvert' should take care
1496 of this.
1497 This option cannot be set from a |modeline| or in the |sandbox|, for
1498 security reasons.
1499
1500 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1501'cindent' 'cin' boolean (default off)
1502 local to buffer
1503 {not in Vi}
1504 {not available when compiled without the |+cindent|
1505 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001506 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 that trigger reindenting in insert mode and 'cinoptions' to set your
1508 preferred indent style.
1509 If 'indentexpr' is not empty, it overrules 'cindent'.
1510 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1511 the "=" operator indents using this algorithm rather than calling an
1512 external program.
1513 See |C-indenting|.
1514 When you don't like the way 'cindent' works, try the 'smartindent'
1515 option or 'indentexpr'.
1516 This option is not used when 'paste' is set.
1517 NOTE: This option is reset when 'compatible' is set.
1518
1519 *'cinkeys'* *'cink'*
1520'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1521 local to buffer
1522 {not in Vi}
1523 {not available when compiled without the |+cindent|
1524 feature}
1525 A list of keys that, when typed in Insert mode, cause reindenting of
1526 the current line. Only used if 'cindent' is on and 'indentexpr' is
1527 empty.
1528 For the format of this option see |cinkeys-format|.
1529 See |C-indenting|.
1530
1531 *'cinoptions'* *'cino'*
1532'cinoptions' 'cino' string (default "")
1533 local to buffer
1534 {not in Vi}
1535 {not available when compiled without the |+cindent|
1536 feature}
1537 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1538 program. See |cinoptions-values| for the values of this option, and
1539 |C-indenting| for info on C indenting in general.
1540
1541
1542 *'cinwords'* *'cinw'*
1543'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1544 local to buffer
1545 {not in Vi}
1546 {not available when compiled without both the
1547 |+cindent| and the |+smartindent| features}
1548 These keywords start an extra indent in the next line when
1549 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1550 an appropriate place (inside {}).
1551 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1552 matter, include the keyword both the uppercase and lowercase:
1553 "if,If,IF".
1554
1555 *'clipboard'* *'cb'*
1556'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1557 for X-windows, "" otherwise)
1558 global
1559 {not in Vi}
1560 {only in GUI versions or when the |+xterm_clipboard|
1561 feature is included}
1562 This option is a list of comma separated names.
1563 These names are recognized:
1564
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001565 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 unnamed When included, Vim will use the clipboard register '*'
1567 for all yank, delete, change and put operations which
1568 would normally go to the unnamed register. When a
1569 register is explicitly specified, it will always be
1570 used regardless of whether "unnamed" is in 'clipboard'
1571 or not. The clipboard register can always be
1572 explicitly accessed using the "* notation. Also see
1573 |gui-clipboard|.
1574
Bram Moolenaar30b65812012-07-12 22:01:11 +02001575 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001576 unnamedplus A variant of the "unnamed" flag which uses the
1577 clipboard register '+' (|quoteplus|) instead of
1578 register '*' for all yank, delete, change and put
1579 operations which would normally go to the unnamed
1580 register. When "unnamed" is also included to the
1581 option, yank operations (but not delete, change or
1582 put) will additionally copy the text into register
1583 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001584 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001585 Availability can be checked with: >
1586 if has('unnamedplus')
1587<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001588 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 autoselect Works like the 'a' flag in 'guioptions': If present,
1590 then whenever Visual mode is started, or the Visual
1591 area extended, Vim tries to become the owner of the
1592 windowing system's global selection or put the
1593 selected text on the clipboard used by the selection
1594 register "*. See |guioptions_a| and |quotestar| for
1595 details. When the GUI is active, the 'a' flag in
1596 'guioptions' is used, when the GUI is not active, this
1597 "autoselect" flag is used.
1598 Also applies to the modeless selection.
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-autoselectplus*
1601 autoselectplus Like "autoselect" but using the + register instead of
1602 the * register. Compare to the 'P' flag in
1603 'guioptions'.
1604
1605 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 autoselectml Like "autoselect", but for the modeless selection
1607 only. Compare to the 'A' flag in 'guioptions'.
1608
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001609 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 html When the clipboard contains HTML, use this when
1611 pasting. When putting text on the clipboard, mark it
1612 as HTML. This works to copy rendered HTML from
1613 Firefox, paste it as raw HTML in Vim, select the HTML
1614 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001615 You probably want to add this only temporarily,
1616 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001617 Only supported for GTK version 2 and later.
1618 Only available with the |+multi_byte| feature.
1619
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001620 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 exclude:{pattern}
1622 Defines a pattern that is matched against the name of
1623 the terminal 'term'. If there is a match, no
1624 connection will be made to the X server. This is
1625 useful in this situation:
1626 - Running Vim in a console.
1627 - $DISPLAY is set to start applications on another
1628 display.
1629 - You do not want to connect to the X server in the
1630 console, but do want this in a terminal emulator.
1631 To never connect to the X server use: >
1632 exclude:.*
1633< This has the same effect as using the |-X| argument.
1634 Note that when there is no connection to the X server
1635 the window title won't be restored and the clipboard
1636 cannot be accessed.
1637 The value of 'magic' is ignored, {pattern} is
1638 interpreted as if 'magic' was on.
1639 The rest of the option value will be used for
1640 {pattern}, this must be the last entry.
1641
1642 *'cmdheight'* *'ch'*
1643'cmdheight' 'ch' number (default 1)
1644 global
1645 {not in Vi}
1646 Number of screen lines to use for the command-line. Helps avoiding
1647 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001648 The value of this option is stored with the tab page, so that each tab
1649 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650
1651 *'cmdwinheight'* *'cwh'*
1652'cmdwinheight' 'cwh' number (default 7)
1653 global
1654 {not in Vi}
1655 {not available when compiled without the |+vertsplit|
1656 feature}
1657 Number of screen lines to use for the command-line window. |cmdwin|
1658
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001659 *'colorcolumn'* *'cc'*
1660'colorcolumn' 'cc' string (default "")
1661 local to window
1662 {not in Vi}
1663 {not available when compiled without the |+syntax|
1664 feature}
1665 'colorcolumn' is a comma separated list of screen columns that are
1666 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1667 text. Will make screen redrawing slower.
1668 The screen column can be an absolute number, or a number preceded with
1669 '+' or '-', which is added to or subtracted from 'textwidth'. >
1670
1671 :set cc=+1 " highlight column after 'textwidth'
1672 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1673 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1674<
1675 When 'textwidth' is zero then the items with '-' and '+' are not used.
1676 A maximum of 256 columns are highlighted.
1677
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 *'columns'* *'co'* *E594*
1679'columns' 'co' number (default 80 or terminal width)
1680 global
1681 {not in Vi}
1682 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001683 initialization and does not have to be set by hand. Also see
1684 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 When Vim is running in the GUI or in a resizable window, setting this
1686 option will cause the window size to be changed. When you only want
1687 to use the size for the GUI, put the command in your |gvimrc| file.
1688 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001689 number of columns of the display, the display may be messed up. For
1690 the GUI it is always possible and Vim limits the number of columns to
1691 what fits on the screen. You can use this command to get the widest
1692 window possible: >
1693 :set columns=9999
1694< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695
1696 *'comments'* *'com'* *E524* *E525*
1697'comments' 'com' string (default
1698 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1699 local to buffer
1700 {not in Vi}
1701 {not available when compiled without the |+comments|
1702 feature}
1703 A comma separated list of strings that can start a comment line. See
1704 |format-comments|. See |option-backslash| about using backslashes to
1705 insert a space.
1706
1707 *'commentstring'* *'cms'* *E537*
1708'commentstring' 'cms' string (default "/*%s*/")
1709 local to buffer
1710 {not in Vi}
1711 {not available when compiled without the |+folding|
1712 feature}
1713 A template for a comment. The "%s" in the value is replaced with the
1714 comment text. Currently only used to add markers for folding, see
1715 |fold-marker|.
1716
1717 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001718'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001719 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 global
1721 {not in Vi}
1722 This option has the effect of making Vim either more Vi-compatible, or
1723 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001724
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001726 other options are also changed as a side effect.
1727 NOTE: Setting or resetting this option can have a lot of unexpected
1728 effects: Mappings are interpreted in another way, undo behaves
1729 differently, etc. If you set this option in your vimrc file, you
1730 should probably put it at the very start.
1731
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 By default this option is on and the Vi defaults are used for the
1733 options. This default was chosen for those people who want to use Vim
1734 just like Vi, and don't even (want to) know about the 'compatible'
1735 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001736 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001737 this option is switched off, and all options that have not been
1738 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001739 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001740 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001741 happen for the system-wide vimrc or gvimrc file, nor for a file given
1742 with the |-u| argument). Also see |compatible-default| and
1743 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 You can also set this option with the "-C" argument, and reset it with
1745 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747
Bram Moolenaar214641f2017-03-05 17:04:09 +01001748 When this option is set, numerous other options are set to make Vim as
1749 Vi-compatible as possible. When this option is unset, various options
1750 are set to make Vim more useful. The table below lists all the
1751 options affected.
1752 The {?} column indicates when the options are affected:
1753 + Means that the option is set to the value given in {set value} when
1754 'compatible' is set.
1755 & Means that the option is set to the value given in {set value} when
1756 'compatible' is set AND is set to its Vim default value when
1757 'compatible' is unset.
1758 - Means the option is NOT changed when setting 'compatible' but IS
1759 set to its Vim default when 'compatible' is unset.
1760 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761
Bram Moolenaar036986f2017-03-16 17:41:02 +01001762 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001763
1764 'allowrevins' + off no CTRL-_ command
1765 'antialias' + off don't use antialiased fonts
1766 'arabic' + off reset arabic-related options
1767 'arabicshape' + on correct character shapes
1768 'backspace' + "" normal backspace
1769 'backup' + off no backup file
1770 'backupcopy' & Unix: "yes" backup file is a copy
1771 else: "auto" copy or rename backup file
1772 'balloonexpr' + "" text to show in evaluation balloon
1773 'breakindent' + off don't indent when wrapping lines
1774 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1775 'cindent' + off no C code indentation
1776 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1777 'copyindent' + off don't copy indent structure
1778 'cpoptions' & (all flags) Vi-compatible flags
1779 'cscopepathcomp'+ 0 don't show directories in tags list
1780 'cscoperelative'+ off
1781 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001782 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001783 'cscopeverbose' + off see |cscopeverbose|
1784 'delcombine' + off unicode: delete whole char combination
1785 'digraph' + off no digraphs
1786 'esckeys' & off no <Esc>-keys in Insert mode
1787 'expandtab' + off tabs not expanded to spaces
1788 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001790 'formatexpr' + "" use 'formatprg' for auto-formatting
1791 'formatoptions' & "vt" Vi compatible formatting
1792 'gdefault' + off no default 'g' flag for ":s"
1793 'history' & 0 no commandline history
1794 'hkmap' + off no Hebrew keyboard mapping
1795 'hkmapp' + off no phonetic Hebrew keyboard mapping
1796 'hlsearch' + off no highlighting of search matches
1797 'incsearch' + off no incremental searching
1798 'indentexpr' + "" no indenting by expression
1799 'insertmode' + off do not start in Insert mode
1800 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001802 'joinspaces' + on insert 2 spaces after period
1803 'modeline' & off no modelines
1804 'more' & off no pauses in listings
1805 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1806 'numberwidth' & 8 min number of columns for line number
1807 'preserveindent'+ off don't preserve current indent structure
1808 when changing it
1809 'revins' + off no reverse insert
1810 'ruler' + off no ruler
1811 'scrolljump' + 1 no jump scroll
1812 'scrolloff' + 0 no scroll offset
1813 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1814 'shiftround' + off indent not rounded to shiftwidth
1815 'shortmess' & "" no shortening of messages
1816 'showcmd' & off command characters not shown
1817 'showmode' & off current mode not shown
1818 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1819 'smartcase' + off no automatic ignore case switch
1820 'smartindent' + off no smart indentation
1821 'smarttab' + off no smart tab size
1822 'softtabstop' + 0 tabs are always 'tabstop' positions
1823 'startofline' + on goto startofline with some commands
1824 'tagcase' & "followic" 'ignorecase' when searching tags file
1825 'tagrelative' & off tag file names are not relative
1826 'termguicolors' + off don't use highlight-(guifg|guibg)
1827 'textauto' & off no automatic textmode detection
1828 'textwidth' + 0 no automatic line wrap
1829 'tildeop' + off tilde is not an operator
1830 'ttimeout' + off no terminal timeout
1831 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001832 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'virtualedit' + "" cursor can only be placed on characters
1834 'whichwrap' & "" left-right movements don't wrap
1835 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001837 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838
1839 *'complete'* *'cpt'* *E535*
1840'complete' 'cpt' string (default: ".,w,b,u,t,i")
1841 local to buffer
1842 {not in Vi}
1843 This option specifies how keyword completion |ins-completion| works
1844 when CTRL-P or CTRL-N are used. It is also used for whole-line
1845 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1846 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001847 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 w scan buffers from other windows
1849 b scan other loaded buffers that are in the buffer list
1850 u scan the unloaded buffers that are in the buffer list
1851 U scan the buffers that are not in the buffer list
1852 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001853 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 k{dict} scan the file {dict}. Several "k" flags can be given,
1855 patterns are valid too. For example: >
1856 :set cpt=k/usr/dict/*,k~/spanish
1857< s scan the files given with the 'thesaurus' option
1858 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1859 are valid too.
1860 i scan current and included files
1861 d scan current and included files for defined name or macro
1862 |i_CTRL-X_CTRL-D|
1863 ] tag completion
1864 t same as "]"
1865
1866 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1867 not executed, this may lead to unexpected completions from some files
1868 (gzipped files for example). Unloaded buffers are not scanned for
1869 whole-line completion.
1870
1871 The default is ".,w,b,u,t,i", which means to scan:
1872 1. the current buffer
1873 2. buffers in other windows
1874 3. other loaded buffers
1875 4. unloaded buffers
1876 5. tags
1877 6. included files
1878
1879 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001880 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1881 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001883 *'completefunc'* *'cfu'*
1884'completefunc' 'cfu' string (default: empty)
1885 local to buffer
1886 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001887 {not available when compiled without the |+eval|
1888 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001889 This option specifies a function to be used for Insert mode completion
1890 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001891 See |complete-functions| for an explanation of how the function is
1892 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001893 This option cannot be set from a |modeline| or in the |sandbox|, for
1894 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001895
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001896 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001897'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001898 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001899 {not available when compiled without the
1900 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001901 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001902 A comma separated list of options for Insert mode completion
1903 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001904
1905 menu Use a popup menu to show the possible completions. The
1906 menu is only shown when there is more than one match and
1907 sufficient colors are available. |ins-completion-menu|
1908
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001909 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001910 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001911 match, e.g., what file it comes from.
1912
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001913 longest Only insert the longest common text of the matches. If
1914 the menu is displayed you can use CTRL-L to add more
1915 characters. Whether case is ignored depends on the kind
1916 of completion. For buffer text the 'ignorecase' option is
1917 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001918
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001919 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001920 completion in the preview window. Only works in
1921 combination with "menu" or "menuone".
1922
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001923 noinsert Do not insert any text for a match until the user selects
1924 a match from the menu. Only works in combination with
1925 "menu" or "menuone". No effect if "longest" is present.
1926
1927 noselect Do not select a match in the menu, force the user to
1928 select one from the menu. Only works in combination with
1929 "menu" or "menuone".
1930
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001931
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001932 *'concealcursor'* *'cocu'*
1933'concealcursor' 'cocu' string (default: "")
1934 local to window
1935 {not in Vi}
1936 {not available when compiled without the |+conceal|
1937 feature}
1938 Sets the modes in which text in the cursor line can also be concealed.
1939 When the current mode is listed then concealing happens just like in
1940 other lines.
1941 n Normal mode
1942 v Visual mode
1943 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001944 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001945
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001946 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001947 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001948 are moving around text is concealed, but when starting to insert text
1949 or selecting a Visual area the concealed text is displayed, so that
1950 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001951 Keep in mind that the cursor position is not always where it's
1952 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001953
1954
1955'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001956 number (default 0)
1957 local to window
1958 {not in Vi}
1959 {not available when compiled without the |+conceal|
1960 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001961 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1962 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001963
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001964 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001965 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001966 1 Each block of concealed text is replaced with one
1967 character. If the syntax item does not have a custom
1968 replacement character defined (see |:syn-cchar|) the
1969 character defined in 'listchars' is used (default is a
1970 space).
1971 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001972 2 Concealed text is completely hidden unless it has a
1973 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001974 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001975 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001976
Bram Moolenaara7781e02010-07-19 20:13:22 +02001977 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001978 edit and copy the text. This can be changed with the 'concealcursor'
1979 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1982'confirm' 'cf' boolean (default off)
1983 global
1984 {not in Vi}
1985 When 'confirm' is on, certain operations that would normally
1986 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1987 instead raise a |dialog| asking if you wish to save the current
1988 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1989 If 'confirm' is off you can still activate confirmation for one
1990 command only (this is most useful in mappings) with the |:confirm|
1991 command.
1992 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1993
1994 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1995'conskey' 'consk' boolean (default off)
1996 global
1997 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001998 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999
2000 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2001'copyindent' 'ci' boolean (default off)
2002 local to buffer
2003 {not in Vi}
2004 Copy the structure of the existing lines indent when autoindenting a
2005 new line. Normally the new indent is reconstructed by a series of
2006 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2007 in which case only spaces are used). Enabling this option makes the
2008 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002009 existing line. 'expandtab' has no effect on these characters, a Tab
2010 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002012 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 Also see 'preserveindent'.
2014
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002015 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016'cpoptions' 'cpo' string (Vim default: "aABceFs",
2017 Vi default: all flags)
2018 global
2019 {not in Vi}
2020 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002021 this indicates Vi-compatible behavior. This is used for things where
2022 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 'cpoptions' stands for "compatible-options".
2024 Commas can be added for readability.
2025 To avoid problems with flags that are added in the future, use the
2026 "+=" and "-=" feature of ":set" |add-option-flags|.
2027 NOTE: This option is set to the Vi default value when 'compatible' is
2028 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002029 NOTE: This option is set to the POSIX default value at startup when
2030 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002031 variable exists |posix|. This means Vim tries to behave like the
2032 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033
2034 contains behavior ~
2035 *cpo-a*
2036 a When included, a ":read" command with a file name
2037 argument will set the alternate file name for the
2038 current window.
2039 *cpo-A*
2040 A When included, a ":write" command with a file name
2041 argument will set the alternate file name for the
2042 current window.
2043 *cpo-b*
2044 b "\|" in a ":map" command is recognized as the end of
2045 the map command. The '\' is included in the mapping,
2046 the text after the '|' is interpreted as the next
2047 command. Use a CTRL-V instead of a backslash to
2048 include the '|' in the mapping. Applies to all
2049 mapping, abbreviation, menu and autocmd commands.
2050 See also |map_bar|.
2051 *cpo-B*
2052 B A backslash has no special meaning in mappings,
2053 abbreviations and the "to" part of the menu commands.
2054 Remove this flag to be able to use a backslash like a
2055 CTRL-V. For example, the command ":map X \<Esc>"
2056 results in X being mapped to:
2057 'B' included: "\^[" (^[ is a real <Esc>)
2058 'B' excluded: "<Esc>" (5 characters)
2059 ('<' excluded in both cases)
2060 *cpo-c*
2061 c Searching continues at the end of any match at the
2062 cursor position, but not further than the start of the
2063 next line. When not present searching continues
2064 one character from the cursor position. With 'c'
2065 "abababababab" only gets three matches when repeating
2066 "/abab", without 'c' there are five matches.
2067 *cpo-C*
2068 C Do not concatenate sourced lines that start with a
2069 backslash. See |line-continuation|.
2070 *cpo-d*
2071 d Using "./" in the 'tags' option doesn't mean to use
2072 the tags file relative to the current file, but the
2073 tags file in the current directory.
2074 *cpo-D*
2075 D Can't use CTRL-K to enter a digraph after Normal mode
2076 commands with a character argument, like |r|, |f| and
2077 |t|.
2078 *cpo-e*
2079 e When executing a register with ":@r", always add a
2080 <CR> to the last line, also when the register is not
2081 linewise. If this flag is not present, the register
2082 is not linewise and the last line does not end in a
2083 <CR>, then the last line is put on the command-line
2084 and can be edited before hitting <CR>.
2085 *cpo-E*
2086 E It is an error when using "y", "d", "c", "g~", "gu" or
2087 "gU" on an Empty region. The operators only work when
2088 at least one character is to be operate on. Example:
2089 This makes "y0" fail in the first column.
2090 *cpo-f*
2091 f When included, a ":read" command with a file name
2092 argument will set the file name for the current buffer,
2093 if the current buffer doesn't have a file name yet.
2094 *cpo-F*
2095 F When included, a ":write" command with a file name
2096 argument will set the file name for the current
2097 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002098 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 *cpo-g*
2100 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002101 *cpo-H*
2102 H When using "I" on a line with only blanks, insert
2103 before the last blank. Without this flag insert after
2104 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-i*
2106 i When included, interrupting the reading of a file will
2107 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002108 *cpo-I*
2109 I When moving the cursor up or down just after inserting
2110 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 *cpo-j*
2112 j When joining lines, only add two spaces after a '.',
2113 not after '!' or '?'. Also see 'joinspaces'.
2114 *cpo-J*
2115 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002116 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 white space.
2118 *cpo-k*
2119 k Disable the recognition of raw key codes in
2120 mappings, abbreviations, and the "to" part of menu
2121 commands. For example, if <Key> sends ^[OA (where ^[
2122 is <Esc>), the command ":map X ^[OA" results in X
2123 being mapped to:
2124 'k' included: "^[OA" (3 characters)
2125 'k' excluded: "<Key>" (one key code)
2126 Also see the '<' flag below.
2127 *cpo-K*
2128 K Don't wait for a key code to complete when it is
2129 halfway a mapping. This breaks mapping <F1><F1> when
2130 only part of the second <F1> has been read. It
2131 enables cancelling the mapping by typing <F1><Esc>.
2132 *cpo-l*
2133 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002134 literally, only "\]", "\^", "\-" and "\\" are special.
2135 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2137 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002138 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 *cpo-L*
2140 L When the 'list' option is set, 'wrapmargin',
2141 'textwidth', 'softtabstop' and Virtual Replace mode
2142 (see |gR|) count a <Tab> as two characters, instead of
2143 the normal behavior of a <Tab>.
2144 *cpo-m*
2145 m When included, a showmatch will always wait half a
2146 second. When not included, a showmatch will wait half
2147 a second or until a character is typed. |'showmatch'|
2148 *cpo-M*
2149 M When excluded, "%" matching will take backslashes into
2150 account. Thus in "( \( )" and "\( ( \)" the outer
2151 parenthesis match. When included "%" ignores
2152 backslashes, which is Vi compatible.
2153 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002154 n When included, the column used for 'number' and
2155 'relativenumber' will also be used for text of wrapped
2156 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 *cpo-o*
2158 o Line offset to search command is not remembered for
2159 next search.
2160 *cpo-O*
2161 O Don't complain if a file is being overwritten, even
2162 when it didn't exist when editing it. This is a
2163 protection against a file unexpectedly created by
2164 someone else. Vi didn't complain about this.
2165 *cpo-p*
2166 p Vi compatible Lisp indenting. When not present, a
2167 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002168 *cpo-P*
2169 P When included, a ":write" command that appends to a
2170 file will set the file name for the current buffer, if
2171 the current buffer doesn't have a file name yet and
2172 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002173 *cpo-q*
2174 q When joining multiple lines leave the cursor at the
2175 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 *cpo-r*
2177 r Redo ("." command) uses "/" to repeat a search
2178 command, instead of the actually used search string.
2179 *cpo-R*
2180 R Remove marks from filtered lines. Without this flag
2181 marks are kept like |:keepmarks| was used.
2182 *cpo-s*
2183 s Set buffer options when entering the buffer for the
2184 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002185 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 set when the buffer is created.
2187 *cpo-S*
2188 S Set buffer options always when entering a buffer
2189 (except 'readonly', 'fileformat', 'filetype' and
2190 'syntax'). This is the (most) Vi compatible setting.
2191 The options are set to the values in the current
2192 buffer. When you change an option and go to another
2193 buffer, the value is copied. Effectively makes the
2194 buffer options global to all buffers.
2195
2196 's' 'S' copy buffer options
2197 no no when buffer created
2198 yes no when buffer first entered (default)
2199 X yes each time when buffer entered (vi comp.)
2200 *cpo-t*
2201 t Search pattern for the tag command is remembered for
2202 "n" command. Otherwise Vim only puts the pattern in
2203 the history for search pattern, but doesn't change the
2204 last used search pattern.
2205 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002206 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 *cpo-v*
2208 v Backspaced characters remain visible on the screen in
2209 Insert mode. Without this flag the characters are
2210 erased from the screen right away. With this flag the
2211 screen newly typed text overwrites backspaced
2212 characters.
2213 *cpo-w*
2214 w When using "cw" on a blank character, only change one
2215 character and not all blanks until the start of the
2216 next word.
2217 *cpo-W*
2218 W Don't overwrite a readonly file. When omitted, ":w!"
2219 overwrites a readonly file, if possible.
2220 *cpo-x*
2221 x <Esc> on the command-line executes the command-line.
2222 The default in Vim is to abandon the command-line,
2223 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002224 *cpo-X*
2225 X When using a count with "R" the replaced text is
2226 deleted only once. Also when repeating "R" with "."
2227 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 *cpo-y*
2229 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002230 *cpo-Z*
2231 Z When using "w!" while the 'readonly' option is set,
2232 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 *cpo-!*
2234 ! When redoing a filter command, use the last used
2235 external command, whatever it was. Otherwise the last
2236 used -filter- command is used.
2237 *cpo-$*
2238 $ When making a change to one line, don't redisplay the
2239 line, but put a '$' at the end of the changed text.
2240 The changed text will be overwritten when you type the
2241 new text. The line is redisplayed if you type any
2242 command that moves the cursor from the insertion
2243 point.
2244 *cpo-%*
2245 % Vi-compatible matching is done for the "%" command.
2246 Does not recognize "#if", "#endif", etc.
2247 Does not recognize "/*" and "*/".
2248 Parens inside single and double quotes are also
2249 counted, causing a string that contains a paren to
2250 disturb the matching. For example, in a line like
2251 "if (strcmp("foo(", s))" the first paren does not
2252 match the last one. When this flag is not included,
2253 parens inside single and double quotes are treated
2254 specially. When matching a paren outside of quotes,
2255 everything inside quotes is ignored. When matching a
2256 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002257 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002258 This flag is also used for other features, such as
2259 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002260 *cpo--*
2261 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002262 it would go above the first line or below the last
2263 line. Without it the cursor moves to the first or
2264 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002265 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002266 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002267 *cpo-+*
2268 + When included, a ":write file" command will reset the
2269 'modified' flag of the buffer, even though the buffer
2270 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002271 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 * Use ":*" in the same way as ":@". When not included,
2273 ":*" is an alias for ":'<,'>", select the Visual area.
2274 *cpo-<*
2275 < Disable the recognition of special key codes in |<>|
2276 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002277 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 ":map X <Tab>" results in X being mapped to:
2279 '<' included: "<Tab>" (5 characters)
2280 '<' excluded: "^I" (^I is a real <Tab>)
2281 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002282 *cpo->*
2283 > When appending to a register, put a line break before
2284 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002285 *cpo-;*
2286 ; When using |,| or |;| to repeat the last |t| search
2287 and the cursor is right in front of the searched
2288 character, the cursor won't move. When not included,
2289 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002290 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002291
2292 POSIX flags. These are not included in the Vi default value, except
2293 when $VIM_POSIX was set on startup. |posix|
2294
2295 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002296 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002297 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002298 *cpo-&*
2299 & When ":preserve" was used keep the swap file when
2300 exiting normally while this buffer is still loaded.
2301 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002302 *cpo-\*
2303 \ Backslash in a [] range in a search pattern is taken
2304 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002305 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2306 '\' excluded: "/[ \-]" finds <Space> and '-'
2307 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002308 *cpo-/*
2309 / When "%" is used as the replacement string in a |:s|
2310 command, use the previous replacement string. |:s%|
2311 *cpo-{*
2312 { The |{| and |}| commands also stop at a "{" character
2313 at the start of a line.
2314 *cpo-.*
2315 . The ":chdir" and ":cd" commands fail if the current
2316 buffer is modified, unless ! is used. Vim doesn't
2317 need this, since it remembers the full path of an
2318 opened file.
2319 *cpo-bar*
2320 | The value of the $LINES and $COLUMNS environment
2321 variables overrule the terminal size values obtained
2322 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002323
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002325 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002326'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002327 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002328 {not in Vi}
2329 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002330 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002331 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002332 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002333 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002334 blowfish Blowfish method. Medium strong encryption but it has
2335 an implementation flaw. Requires Vim 7.3 or later,
2336 files can NOT be read by Vim 7.2 and older. This adds
2337 a "seed" to the file, every time you write the file
2338 the encrypted bytes will be different.
2339 *blowfish2*
2340 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002341 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002342 and older. This adds a "seed" to the file, every time
2343 you write the file the encrypted bytes will be
2344 different. The whole undo file is encrypted, not just
2345 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002346
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002347 You should use "blowfish2", also to re-encrypt older files.
2348
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002349 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002350 to the detected method of the file being read. Thus if you write it
2351 without changing 'cryptmethod' the same method will be used.
2352 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002353 explicitly write it, you don't get a warning unless there are other
2354 modifications. Also see |:X|.
2355
2356 When setting the global value to an empty string, it will end up with
2357 the value "zip". When setting the local value to an empty string the
2358 buffer will use the global value.
2359
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002360 When a new encryption method is added in a later version of Vim, and
2361 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002362 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002363
2364
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 *'cscopepathcomp'* *'cspc'*
2366'cscopepathcomp' 'cspc' number (default 0)
2367 global
2368 {not available when compiled without the |+cscope|
2369 feature}
2370 {not in Vi}
2371 Determines how many components of the path to show in a list of tags.
2372 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002373 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374
2375 *'cscopeprg'* *'csprg'*
2376'cscopeprg' 'csprg' string (default "cscope")
2377 global
2378 {not available when compiled without the |+cscope|
2379 feature}
2380 {not in Vi}
2381 Specifies the command to execute cscope. See |cscopeprg|.
2382 This option cannot be set from a |modeline| or in the |sandbox|, for
2383 security reasons.
2384
2385 *'cscopequickfix'* *'csqf'*
2386'cscopequickfix' 'csqf' string (default "")
2387 global
2388 {not available when compiled without the |+cscope|
2389 or |+quickfix| features}
2390 {not in Vi}
2391 Specifies whether to use quickfix window to show cscope results.
2392 See |cscopequickfix|.
2393
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002394 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002395'cscoperelative' 'csre' boolean (default off)
2396 global
2397 {not available when compiled without the |+cscope|
2398 feature}
2399 {not in Vi}
2400 In the absence of a prefix (-P) for cscope. setting this option enables
2401 to use the basename of cscope.out path as the prefix.
2402 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002403 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002404
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2406'cscopetag' 'cst' boolean (default off)
2407 global
2408 {not available when compiled without the |+cscope|
2409 feature}
2410 {not in Vi}
2411 Use cscope for tag commands. See |cscope-options|.
2412 NOTE: This option is reset when 'compatible' is set.
2413
2414 *'cscopetagorder'* *'csto'*
2415'cscopetagorder' 'csto' number (default 0)
2416 global
2417 {not available when compiled without the |+cscope|
2418 feature}
2419 {not in Vi}
2420 Determines the order in which ":cstag" performs a search. See
2421 |cscopetagorder|.
2422 NOTE: This option is set to 0 when 'compatible' is set.
2423
2424 *'cscopeverbose'* *'csverb'*
2425 *'nocscopeverbose'* *'nocsverb'*
2426'cscopeverbose' 'csverb' boolean (default off)
2427 global
2428 {not available when compiled without the |+cscope|
2429 feature}
2430 {not in Vi}
2431 Give messages when adding a cscope database. See |cscopeverbose|.
2432 NOTE: This option is reset when 'compatible' is set.
2433
Bram Moolenaar860cae12010-06-05 23:22:07 +02002434 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2435'cursorbind' 'crb' boolean (default off)
2436 local to window
2437 {not in Vi}
2438 {not available when compiled without the |+cursorbind|
2439 feature}
2440 When this option is set, as the cursor in the current
2441 window moves other cursorbound windows (windows that also have
2442 this option set) move their cursors to the corresponding line and
2443 column. This option is useful for viewing the
2444 differences between two versions of a file (see 'diff'); in diff mode,
2445 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002446 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002447
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002448
2449 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2450'cursorcolumn' 'cuc' boolean (default off)
2451 local to window
2452 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002453 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002454 feature}
2455 Highlight the screen column of the cursor with CursorColumn
2456 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2457 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002458 If you only want the highlighting in the current window you can use
2459 these autocommands: >
2460 au WinLeave * set nocursorline nocursorcolumn
2461 au WinEnter * set cursorline cursorcolumn
2462<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463
2464 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2465'cursorline' 'cul' boolean (default off)
2466 local to window
2467 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002468 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002469 feature}
2470 Highlight the screen line of the cursor with CursorLine
2471 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2472 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002473 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002474 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475
2476
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 *'debug'*
2478'debug' string (default "")
2479 global
2480 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002481 These values can be used:
2482 msg Error messages that would otherwise be omitted will be given
2483 anyway.
2484 throw Error messages that would otherwise be omitted will be given
2485 anyway and also throw an exception and set |v:errmsg|.
2486 beep A message will be given when otherwise only a beep would be
2487 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002488 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002489 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2490 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491
2492 *'define'* *'def'*
2493'define' 'def' string (default "^\s*#\s*define")
2494 global or local to buffer |global-local|
2495 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002496 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 pattern, just like for the "/" command. This option is used for the
2498 commands like "[i" and "[d" |include-search|. The 'isident' option is
2499 used to recognize the defined name after the match:
2500 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2501 See |option-backslash| about inserting backslashes to include a space
2502 or backslash.
2503 The default value is for C programs. For C++ this value would be
2504 useful, to include const type declarations: >
2505 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2506< When using the ":set" command, you need to double the backslashes!
2507
2508 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2509'delcombine' 'deco' boolean (default off)
2510 global
2511 {not in Vi}
2512 {only available when compiled with the |+multi_byte|
2513 feature}
2514 If editing Unicode and this option is set, backspace and Normal mode
2515 "x" delete each combining character on its own. When it is off (the
2516 default) the character along with its combining characters are
2517 deleted.
2518 Note: When 'delcombine' is set "xx" may work different from "2x"!
2519
2520 This is useful for Arabic, Hebrew and many other languages where one
2521 may have combining characters overtop of base characters, and want
2522 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002523 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'dictionary'* *'dict'*
2526'dictionary' 'dict' string (default "")
2527 global or local to buffer |global-local|
2528 {not in Vi}
2529 List of file names, separated by commas, that are used to lookup words
2530 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2531 contain a list of words. This can be one word per line, or several
2532 words per line, separated by non-keyword characters (white space is
2533 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002534 When this option is empty, or an entry "spell" is present, spell
2535 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002536 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 after a comma are ignored, otherwise spaces are included in the file
2538 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002539 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 Where to find a list of words?
2541 - On FreeBSD, there is the file "/usr/share/dict/words".
2542 - In the Simtel archive, look in the "msdos/linguist" directory.
2543 - In "miscfiles" of the GNU collection.
2544 The use of |:set+=| and |:set-=| is preferred when adding or removing
2545 directories from the list. This avoids problems when a future version
2546 uses another default.
2547 Backticks cannot be used in this option for security reasons.
2548
2549 *'diff'* *'nodiff'*
2550'diff' boolean (default off)
2551 local to window
2552 {not in Vi}
2553 {not available when compiled without the |+diff|
2554 feature}
2555 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002556 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557
2558 *'dex'* *'diffexpr'*
2559'diffexpr' 'dex' string (default "")
2560 global
2561 {not in Vi}
2562 {not available when compiled without the |+diff|
2563 feature}
2564 Expression which is evaluated to obtain an ed-style diff file from two
2565 versions of a file. See |diff-diffexpr|.
2566 This option cannot be set from a |modeline| or in the |sandbox|, for
2567 security reasons.
2568
2569 *'dip'* *'diffopt'*
2570'diffopt' 'dip' string (default "filler")
2571 global
2572 {not in Vi}
2573 {not available when compiled without the |+diff|
2574 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002575 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 All are optional. Items must be separated by a comma.
2577
2578 filler Show filler lines, to keep the text
2579 synchronized with a window that has inserted
2580 lines at the same position. Mostly useful
2581 when windows are side-by-side and 'scrollbind'
2582 is set.
2583
2584 context:{n} Use a context of {n} lines between a change
2585 and a fold that contains unchanged lines.
2586 When omitted a context of six lines is used.
2587 See |fold-diff|.
2588
2589 icase Ignore changes in case of text. "a" and "A"
2590 are considered the same. Adds the "-i" flag
2591 to the "diff" command if 'diffexpr' is empty.
2592
2593 iwhite Ignore changes in amount of white space. Adds
2594 the "-b" flag to the "diff" command if
2595 'diffexpr' is empty. Check the documentation
2596 of the "diff" command for what this does
2597 exactly. It should ignore adding trailing
2598 white space, but not leading white space.
2599
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002600 horizontal Start diff mode with horizontal splits (unless
2601 explicitly specified otherwise).
2602
2603 vertical Start diff mode with vertical splits (unless
2604 explicitly specified otherwise).
2605
2606 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2607 starting diff mode. Without this 2 is used.
2608
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 Examples: >
2610
2611 :set diffopt=filler,context:4
2612 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002613 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614<
2615 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2616'digraph' 'dg' boolean (default off)
2617 global
2618 {not in Vi}
2619 {not available when compiled without the |+digraphs|
2620 feature}
2621 Enable the entering of digraphs in Insert mode with {char1} <BS>
2622 {char2}. See |digraphs|.
2623 NOTE: This option is reset when 'compatible' is set.
2624
2625 *'directory'* *'dir'*
2626'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002627 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 for Unix: ".,~/tmp,/var/tmp,/tmp")
2629 global
2630 List of directory names for the swap file, separated with commas.
2631 - The swap file will be created in the first directory where this is
2632 possible.
2633 - Empty means that no swap file will be used (recovery is
2634 impossible!).
2635 - A directory "." means to put the swap file in the same directory as
2636 the edited file. On Unix, a dot is prepended to the file name, so
2637 it doesn't show in a directory listing. On MS-Windows the "hidden"
2638 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002639 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 put the swap file relative to where the edited file is. The leading
2641 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002642 - For Unix and Win32, if a directory ends in two path separators "//"
2643 or "\\", the swap file name will be built from the complete path to
2644 the file with all path separators substituted to percent '%' signs.
2645 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002646 On Win32, when a separating comma is following, you must use "//",
2647 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 - Spaces after the comma are ignored, other spaces are considered part
2649 of the directory name. To have a space at the start of a directory
2650 name, precede it with a backslash.
2651 - To include a comma in a directory name precede it with a backslash.
2652 - A directory name may end in an ':' or '/'.
2653 - Environment variables are expanded |:set_env|.
2654 - Careful with '\' characters, type one before a space, type two to
2655 get one in the option (see |option-backslash|), for example: >
2656 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2657< - For backwards compatibility with Vim version 3.0 a '>' at the start
2658 of the option is removed.
2659 Using "." first in the list is recommended. This means that editing
2660 the same file twice will result in a warning. Using "/tmp" on Unix is
2661 discouraged: When the system crashes you lose the swap file.
2662 "/var/tmp" is often not cleared when rebooting, thus is a better
2663 choice than "/tmp". But it can contain a lot of files, your swap
2664 files get lost in the crowd. That is why a "tmp" directory in your
2665 home directory is tried first.
2666 The use of |:set+=| and |:set-=| is preferred when adding or removing
2667 directories from the list. This avoids problems when a future version
2668 uses another default.
2669 This option cannot be set from a |modeline| or in the |sandbox|, for
2670 security reasons.
2671 {Vi: directory to put temp file in, defaults to "/tmp"}
2672
2673 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002674'display' 'dy' string (default "", set to "truncate" in
2675 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 global
2677 {not in Vi}
2678 Change the way text is displayed. This is comma separated list of
2679 flags:
2680 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002681 in a window will be displayed. "@@@" is put in the
2682 last columns of the last screen line to indicate the
2683 rest of the line is not displayed.
2684 truncate Like "lastline", but "@@@" is displayed in the first
2685 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 uhex Show unprintable characters hexadecimal as <xx>
2687 instead of using ^C and ~C.
2688
Bram Moolenaard0796902016-09-16 20:02:31 +02002689 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002690 doesn't fit is replaced with "@" lines.
2691
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 *'eadirection'* *'ead'*
2693'eadirection' 'ead' string (default "both")
2694 global
2695 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002696 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 feature}
2698 Tells when the 'equalalways' option applies:
2699 ver vertically, width of windows is not affected
2700 hor horizontally, height of windows is not affected
2701 both width and height of windows is affected
2702
2703 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2704'edcompatible' 'ed' boolean (default off)
2705 global
2706 Makes the 'g' and 'c' flags of the ":substitute" command to be
2707 toggled each time the flag is given. See |complex-change|. See
2708 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002709 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710
Bram Moolenaar03413f42016-04-12 21:07:15 +02002711 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002712'emoji' 'emo' boolean (default: on)
2713 global
2714 {not in Vi}
2715 {only available when compiled with the |+multi_byte|
2716 feature}
2717 When on all Unicode emoji characters are considered to be full width.
2718
2719
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 *'encoding'* *'enc'* *E543*
2721'encoding' 'enc' string (default: "latin1" or value from $LANG)
2722 global
2723 {only available when compiled with the |+multi_byte|
2724 feature}
2725 {not in Vi}
2726 Sets the character encoding used inside Vim. It applies to text in
2727 the buffers, registers, Strings in expressions, text stored in the
2728 viminfo file, etc. It sets the kind of characters which Vim can work
2729 with. See |encoding-names| for the possible values.
2730
2731 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002732 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002734 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
Bram Moolenaar865242e2010-07-14 21:12:05 +02002736 This option cannot be set from a |modeline|. It would most likely
2737 corrupt the text.
2738
Bram Moolenaar3df01732017-02-17 22:47:16 +01002739 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2740 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 'encoding', "utf-8" is the natural choice for the environment and
2742 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002743 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 versions, and to avoid changing the encoding of newly created files
2745 without your knowledge (in case 'fileencodings' is empty).
2746
2747 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002748 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 iconv() or as specified with 'charconvert'.
2750
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002751 If you need to know whether 'encoding' is a multi-byte encoding, you
2752 can use: >
2753 if has("multi_byte_encoding")
2754<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 Normally 'encoding' will be equal to your current locale. This will
2756 be the default if Vim recognizes your environment settings. If
2757 'encoding' is not set to the current locale, 'termencoding' must be
2758 set to convert typed and displayed text. See |encoding-table|.
2759
2760 When you set this option, it fires the |EncodingChanged| autocommand
2761 event so that you can set up fonts if necessary.
2762
2763 When the option is set, the value is converted to lowercase. Thus
2764 you can set it with uppercase values too. Underscores are translated
2765 to '-' signs.
2766 When the encoding is recognized, it is changed to the standard name.
2767 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2768 "iso-8859-2" and "utf8" becomes "utf-8".
2769
2770 Note: "latin1" is also used when the encoding could not be detected.
2771 This only works when editing files in the same encoding! When the
2772 actual character set is not latin1, make sure 'fileencoding' and
2773 'fileencodings' are empty. When conversion is needed, switch to using
2774 utf-8.
2775
2776 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2777 You don't notice this while editing, but it does matter for the
2778 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2779 setting 'encoding' to one of these values instead of utf-8 only has
2780 effect for encoding used for files when 'fileencoding' is empty.
2781
Bram Moolenaar661b1822005-07-28 22:36:45 +00002782 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2783 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784
2785 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2786'endofline' 'eol' boolean (default on)
2787 local to buffer
2788 {not in Vi}
2789 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002790 is on, or 'fixeol' option is off, no <EOL> will be written for the
2791 last line in the file. This option is automatically set or reset when
2792 starting to edit a new file, depending on whether file has an <EOL>
2793 for the last line in the file. Normally you don't have to set or
2794 reset this option.
2795 When 'binary' is off and 'fixeol' is on the value is not used when
2796 writing the file. When 'binary' is on or 'fixeol' is off it is used
2797 to remember the presence of a <EOL> for the last line in the file, so
2798 that when you write the file the situation from the original file can
2799 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800
2801 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2802'equalalways' 'ea' boolean (default on)
2803 global
2804 {not in Vi}
2805 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002806 splitting or closing a window. This also happens the moment the
2807 option is switched on. When off, splitting a window will reduce the
2808 size of the current window and leave the other windows the same. When
2809 closing a window the extra lines are given to the window next to it
2810 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 When mixing vertically and horizontally split windows, a minimal size
2812 is computed and some windows may be larger if there is room. The
2813 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002814 Changing the height and width of a window can be avoided by setting
2815 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002816 If a window size is specified when creating a new window sizes are
2817 currently not equalized (it's complicated, but may be implemented in
2818 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819
2820 *'equalprg'* *'ep'*
2821'equalprg' 'ep' string (default "")
2822 global or local to buffer |global-local|
2823 {not in Vi}
2824 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002825 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002826 or 'indentexpr'. When Vim was compiled without internal formatting,
2827 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 about including spaces and backslashes.
2830 This option cannot be set from a |modeline| or in the |sandbox|, for
2831 security reasons.
2832
2833 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2834'errorbells' 'eb' boolean (default off)
2835 global
2836 Ring the bell (beep or screen flash) for error messages. This only
2837 makes a difference for error messages, the bell will be used always
2838 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002839 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002840 screen flash or do nothing. See 'belloff' to finetune when to ring the
2841 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
2843 *'errorfile'* *'ef'*
2844'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2845 others: "errors.err")
2846 global
2847 {not in Vi}
2848 {not available when compiled without the |+quickfix|
2849 feature}
2850 Name of the errorfile for the QuickFix mode (see |:cf|).
2851 When the "-q" command-line argument is used, 'errorfile' is set to the
2852 following argument. See |-q|.
2853 NOT used for the ":make" command. See 'makeef' for that.
2854 Environment variables are expanded |:set_env|.
2855 See |option-backslash| about including spaces and backslashes.
2856 This option cannot be set from a |modeline| or in the |sandbox|, for
2857 security reasons.
2858
2859 *'errorformat'* *'efm'*
2860'errorformat' 'efm' string (default is very long)
2861 global or local to buffer |global-local|
2862 {not in Vi}
2863 {not available when compiled without the |+quickfix|
2864 feature}
2865 Scanf-like description of the format for the lines in the error file
2866 (see |errorformat|).
2867
2868 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2869'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2870 global
2871 {not in Vi}
2872 Function keys that start with an <Esc> are recognized in Insert
2873 mode. When this option is off, the cursor and function keys cannot be
2874 used in Insert mode if they start with an <Esc>. The advantage of
2875 this is that the single <Esc> is recognized immediately, instead of
2876 after one second. Instead of resetting this option, you might want to
2877 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2878 when 'esckeys' is off, you can still map anything, but the cursor keys
2879 won't work by default.
2880 NOTE: This option is set to the Vi default value when 'compatible' is
2881 set and to the Vim default value when 'compatible' is reset.
2882
2883 *'eventignore'* *'ei'*
2884'eventignore' 'ei' string (default "")
2885 global
2886 {not in Vi}
2887 {not available when compiled without the |+autocmd|
2888 feature}
2889 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002890 When set to "all" or when "all" is one of the items, all autocommand
2891 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 Otherwise this is a comma separated list of event names. Example: >
2893 :set ei=WinEnter,WinLeave
2894<
2895 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2896'expandtab' 'et' boolean (default off)
2897 local to buffer
2898 {not in Vi}
2899 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002900 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2902 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002903 This option is reset when the 'paste' option is set and restored when
2904 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 NOTE: This option is reset when 'compatible' is set.
2906
2907 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2908'exrc' 'ex' boolean (default off)
2909 global
2910 {not in Vi}
2911 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002912 directory.
2913
2914 Setting this option is a potential security leak. E.g., consider
2915 unpacking a package or fetching files from github, a .vimrc in there
2916 might be a trojan horse. BETTER NOT SET THIS OPTION!
2917 Instead, define an autocommand in your .vimrc to set options for a
2918 matching directory.
2919
2920 If you do switch this option on you should also consider setting the
2921 'secure' option (see |initialization|).
2922 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 This option cannot be set from a |modeline| or in the |sandbox|, for
2924 security reasons.
2925
2926 *'fileencoding'* *'fenc'* *E213*
2927'fileencoding' 'fenc' string (default: "")
2928 local to buffer
2929 {only available when compiled with the |+multi_byte|
2930 feature}
2931 {not in Vi}
2932 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002933
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002935 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 When 'fileencoding' is empty, the same value as 'encoding' will be
2937 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002938 No error will be given when the value is set, only when it is used,
2939 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002940 Conversion will also be done when 'encoding' and 'fileencoding' are
2941 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2942 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002944 'encoding' is "utf-8" or another Unicode encoding, conversion
2945 is most likely done in a way that the reverse conversion
2946 results in the same text. When 'encoding' is not "utf-8" some
2947 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002948
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 See 'encoding' for the possible values. Additionally, values may be
2950 specified that can be handled by the converter, see
2951 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002952
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 When reading a file 'fileencoding' will be set from 'fileencodings'.
2954 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002955 'fileencoding', use the |++enc| argument. One exception: when
2956 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002957 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002958
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2960 When the option is set, the value is converted to lowercase. Thus
2961 you can set it with uppercase values too. '_' characters are
2962 replaced with '-'. If a name is recognized from the list for
2963 'encoding', it is replaced by the standard name. For example
2964 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002965
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 When this option is set, after starting to edit a file, the 'modified'
2967 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002968
2969 Keep in mind that changing 'fenc' from a modeline happens
2970 AFTER the text has been read, thus it applies to when the file will be
2971 written. If you do set 'fenc' in a modeline, you might want to set
2972 'nomodified' to avoid not being able to ":q".
2973
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 This option can not be changed when 'modifiable' is off.
2975
2976 *'fe'*
2977 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002978 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979 old short name was 'fe', which is no longer used.
2980
2981 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002982'fileencodings' 'fencs' string (default: "ucs-bom",
2983 "ucs-bom,utf-8,default,latin1" when
2984 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 global
2986 {only available when compiled with the |+multi_byte|
2987 feature}
2988 {not in Vi}
2989 This is a list of character encodings considered when starting to edit
2990 an existing file. When a file is read, Vim tries to use the first
2991 mentioned character encoding. If an error is detected, the next one
2992 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002993 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 an empty string, which means the value of 'encoding' is used.
2995 WARNING: Conversion can cause loss of information! When
2996 'encoding' is "utf-8" (or one of the other Unicode variants)
2997 conversion is most likely done in a way that the reverse
2998 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002999 "utf-8" some non-ASCII characters may be lost! You can use
3000 the |++bad| argument to specify what is done with characters
3001 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 For an empty file or a file with only ASCII characters most encodings
3003 will work and the first entry of 'fileencodings' will be used (except
3004 "ucs-bom", which requires the BOM to be present). If you prefer
3005 another encoding use an BufReadPost autocommand event to test if your
3006 preferred encoding is to be used. Example: >
3007 au BufReadPost * if search('\S', 'w') == 0 |
3008 \ set fenc=iso-2022-jp | endif
3009< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3010 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003011 When the |++enc| argument is used then the value of 'fileencodings' is
3012 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003013 Note that 'fileencodings' is not used for a new file, the global value
3014 of 'fileencoding' is used instead. You can set it with: >
3015 :setglobal fenc=iso-8859-2
3016< This means that a non-existing file may get a different encoding than
3017 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 The special value "ucs-bom" can be used to check for a Unicode BOM
3019 (Byte Order Mark) at the start of the file. It must not be preceded
3020 by "utf-8" or another Unicode encoding for this to work properly.
3021 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3022 because Vim cannot detect an error, thus the encoding is always
3023 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003024 The special value "default" can be used for the encoding from the
3025 environment. This is the default value for 'encoding'. It is useful
3026 when 'encoding' is set to "utf-8" and your environment uses a
3027 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003028 When 'encoding' is "utf-8" and a file contains an illegal byte
3029 sequence it won't be recognized as UTF-8. You can use the |8g8|
3030 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 WRONG VALUES: WHAT'S WRONG:
3032 latin1,utf-8 "latin1" will always be used
3033 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3034 file
3035 cp1250,latin1 "cp1250" will always be used
3036 If 'fileencodings' is empty, 'fileencoding' is not modified.
3037 See 'fileencoding' for the possible values.
3038 Setting this option does not have an effect until the next time a file
3039 is read.
3040
3041 *'fileformat'* *'ff'*
3042'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3043 Unix default: "unix",
3044 Macintosh default: "mac")
3045 local to buffer
3046 {not in Vi}
3047 This gives the <EOL> of the current buffer, which is used for
3048 reading/writing the buffer from/to a file:
3049 dos <CR> <NL>
3050 unix <NL>
3051 mac <CR>
3052 When "dos" is used, CTRL-Z at the end of a file is ignored.
3053 See |file-formats| and |file-read|.
3054 For the character encoding of the file see 'fileencoding'.
3055 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003056 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 This option is set automatically when starting to edit a file and
3058 'fileformats' is not empty and 'binary' is off.
3059 When this option is set, after starting to edit a file, the 'modified'
3060 option is set, because the file would be different when written.
3061 This option can not be changed when 'modifiable' is off.
3062 For backwards compatibility: When this option is set to "dos",
3063 'textmode' is set, otherwise 'textmode' is reset.
3064
3065 *'fileformats'* *'ffs'*
3066'fileformats' 'ffs' string (default:
3067 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3068 Vim Unix: "unix,dos",
3069 Vim Mac: "mac,unix,dos",
3070 Vi Cygwin: "unix,dos",
3071 Vi others: "")
3072 global
3073 {not in Vi}
3074 This gives the end-of-line (<EOL>) formats that will be tried when
3075 starting to edit a new buffer and when reading a file into an existing
3076 buffer:
3077 - When empty, the format defined with 'fileformat' will be used
3078 always. It is not set automatically.
3079 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003080 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 'fileformats' name will be used when a file is read into an existing
3082 buffer, no matter what 'fileformat' for that buffer is set to.
3083 - When more than one name is present, separated by commas, automatic
3084 <EOL> detection will be done when reading a file. When starting to
3085 edit a file, a check is done for the <EOL>:
3086 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3087 'fileformat' is set to "dos".
3088 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003089 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003091 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3092 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003093 This means that "mac" is only chosen when:
3094 "unix" is not present or no <NL> is found in the file, and
3095 "dos" is not present or no <CR><NL> is found in the file.
3096 Except: if "unix" was chosen, but there is a <CR> before
3097 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003098 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 4. If 'fileformat' is still not set, the first name from
3100 'fileformats' is used.
3101 When reading a file into an existing buffer, the same is done, but
3102 this happens like 'fileformat' has been set appropriately for that
3103 file only, the option is not changed.
3104 When 'binary' is set, the value of 'fileformats' is not used.
3105
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003106 When Vim starts up with an empty buffer the first item is used. You
3107 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003108
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3110 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3111 done:
3112 - When 'fileformats' is empty, there is no automatic detection. Dos
3113 format will be used.
3114 - When 'fileformats' is set to one or more names, automatic detection
3115 is done. This is based on the first <NL> in the file: If there is a
3116 <CR> in front of it, Dos format is used, otherwise Unix format is
3117 used.
3118 Also see |file-formats|.
3119 For backwards compatibility: When this option is set to an empty
3120 string or one format (no comma is included), 'textauto' is reset,
3121 otherwise 'textauto' is set.
3122 NOTE: This option is set to the Vi default value when 'compatible' is
3123 set and to the Vim default value when 'compatible' is reset.
3124
Bram Moolenaarbf884932013-04-05 22:26:15 +02003125 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3126'fileignorecase' 'fic' boolean (default on for systems where case in file
3127 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003128 global
3129 {not in Vi}
3130 When set case is ignored when using file names and directories.
3131 See 'wildignorecase' for only ignoring case when doing completion.
3132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 *'filetype'* *'ft'*
3134'filetype' 'ft' string (default: "")
3135 local to buffer
3136 {not in Vi}
3137 {not available when compiled without the |+autocmd|
3138 feature}
3139 When this option is set, the FileType autocommand event is triggered.
3140 All autocommands that match with the value of this option will be
3141 executed. Thus the value of 'filetype' is used in place of the file
3142 name.
3143 Otherwise this option does not always reflect the current file type.
3144 This option is normally set when the file type is detected. To enable
3145 this use the ":filetype on" command. |:filetype|
3146 Setting this option to a different value is most useful in a modeline,
3147 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003148 Example, for in an IDL file:
3149 /* vim: set filetype=idl : */ ~
3150 |FileType| |filetypes|
3151 When a dot appears in the value then this separates two filetype
3152 names. Example:
3153 /* vim: set filetype=c.doxygen : */ ~
3154 This will use the "c" filetype first, then the "doxygen" filetype.
3155 This works both for filetype plugins and for syntax files. More than
3156 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 This option is not copied to another buffer, independent of the 's' or
3158 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003159 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160
3161 *'fillchars'* *'fcs'*
3162'fillchars' 'fcs' string (default "vert:|,fold:-")
3163 global
3164 {not in Vi}
3165 {not available when compiled without the |+windows|
3166 and |+folding| features}
3167 Characters to fill the statuslines and vertical separators.
3168 It is a comma separated list of items:
3169
3170 item default Used for ~
3171 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003172 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 vert:c '|' vertical separators |:vsplit|
3174 fold:c '-' filling 'foldtext'
3175 diff:c '-' deleted lines of the 'diff' option
3176
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003177 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003178 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 otherwise.
3180
3181 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003182 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183< This is similar to the default, except that these characters will also
3184 be used when there is highlighting.
3185
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003186 for "stl" and "stlnc" only single-byte values are supported.
3187
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 The highlighting used for these items:
3189 item highlight group ~
3190 stl:c StatusLine |hl-StatusLine|
3191 stlnc:c StatusLineNC |hl-StatusLineNC|
3192 vert:c VertSplit |hl-VertSplit|
3193 fold:c Folded |hl-Folded|
3194 diff:c DiffDelete |hl-DiffDelete|
3195
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003196 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3197'fixendofline' 'fixeol' boolean (default on)
3198 local to buffer
3199 {not in Vi}
3200 When writing a file and this option is on, <EOL> at the end of file
3201 will be restored if missing. Turn this option off if you want to
3202 preserve the situation from the original file.
3203 When the 'binary' option is set the value of this option doesn't
3204 matter.
3205 See the 'endofline' option.
3206
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3208'fkmap' 'fk' boolean (default off) *E198*
3209 global
3210 {not in Vi}
3211 {only available when compiled with the |+rightleft|
3212 feature}
3213 When on, the keyboard is mapped for the Farsi character set.
3214 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003215 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216
3217 *'foldclose'* *'fcl'*
3218'foldclose' 'fcl' string (default "")
3219 global
3220 {not in Vi}
3221 {not available when compiled without the |+folding|
3222 feature}
3223 When set to "all", a fold is closed when the cursor isn't in it and
3224 its level is higher than 'foldlevel'. Useful if you want folds to
3225 automatically close when moving out of them.
3226
3227 *'foldcolumn'* *'fdc'*
3228'foldcolumn' 'fdc' number (default 0)
3229 local to window
3230 {not in Vi}
3231 {not available when compiled without the |+folding|
3232 feature}
3233 When non-zero, a column with the specified width is shown at the side
3234 of the window which indicates open and closed folds. The maximum
3235 value is 12.
3236 See |folding|.
3237
3238 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3239'foldenable' 'fen' boolean (default on)
3240 local to window
3241 {not in Vi}
3242 {not available when compiled without the |+folding|
3243 feature}
3244 When off, all folds are open. This option can be used to quickly
3245 switch between showing all text unfolded and viewing the text with
3246 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248 'foldenable' is off.
3249 This option is set by commands that create a new fold or close a fold.
3250 See |folding|.
3251
3252 *'foldexpr'* *'fde'*
3253'foldexpr' 'fde' string (default: "0")
3254 local to window
3255 {not in Vi}
3256 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003257 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003259 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003260
Bram Moolenaar30b65812012-07-12 22:01:11 +02003261 The expression will be evaluated in the |sandbox| if set from a
3262 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003263 This option can't be set from a |modeline| when the 'diff' option is
3264 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003265
3266 It is not allowed to change text or jump to another window while
3267 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268
3269 *'foldignore'* *'fdi'*
3270'foldignore' 'fdi' string (default: "#")
3271 local to window
3272 {not in Vi}
3273 {not available when compiled without the |+folding|
3274 feature}
3275 Used only when 'foldmethod' is "indent". Lines starting with
3276 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003277 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278 The default "#" works well for C programs. See |fold-indent|.
3279
3280 *'foldlevel'* *'fdl'*
3281'foldlevel' 'fdl' number (default: 0)
3282 local to window
3283 {not in Vi}
3284 {not available when compiled without the |+folding|
3285 feature}
3286 Sets the fold level: Folds with a higher level will be closed.
3287 Setting this option to zero will close all folds. Higher numbers will
3288 close fewer folds.
3289 This option is set by commands like |zm|, |zM| and |zR|.
3290 See |fold-foldlevel|.
3291
3292 *'foldlevelstart'* *'fdls'*
3293'foldlevelstart' 'fdls' number (default: -1)
3294 global
3295 {not in Vi}
3296 {not available when compiled without the |+folding|
3297 feature}
3298 Sets 'foldlevel' when starting to edit another buffer in a window.
3299 Useful to always start editing with all folds closed (value zero),
3300 some folds closed (one) or no folds closed (99).
3301 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003302 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 ignores this option and closes all folds.
3304 It is also done before BufReadPre autocommands, to allow an autocmd to
3305 overrule the 'foldlevel' value for specific files.
3306 When the value is negative, it is not used.
3307
3308 *'foldmarker'* *'fmr'* *E536*
3309'foldmarker' 'fmr' string (default: "{{{,}}}")
3310 local to window
3311 {not in Vi}
3312 {not available when compiled without the |+folding|
3313 feature}
3314 The start and end marker used when 'foldmethod' is "marker". There
3315 must be one comma, which separates the start and end marker. The
3316 marker is a literal string (a regular expression would be too slow).
3317 See |fold-marker|.
3318
3319 *'foldmethod'* *'fdm'*
3320'foldmethod' 'fdm' string (default: "manual")
3321 local to window
3322 {not in Vi}
3323 {not available when compiled without the |+folding|
3324 feature}
3325 The kind of folding used for the current window. Possible values:
3326 |fold-manual| manual Folds are created manually.
3327 |fold-indent| indent Lines with equal indent form a fold.
3328 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3329 |fold-marker| marker Markers are used to specify folds.
3330 |fold-syntax| syntax Syntax highlighting items specify folds.
3331 |fold-diff| diff Fold text that is not changed.
3332
3333 *'foldminlines'* *'fml'*
3334'foldminlines' 'fml' number (default: 1)
3335 local to window
3336 {not in Vi}
3337 {not available when compiled without the |+folding|
3338 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003339 Sets the number of screen lines above which a fold can be displayed
3340 closed. Also for manually closed folds. With the default value of
3341 one a fold can only be closed if it takes up two or more screen lines.
3342 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003343 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 "zc" to close a fold, which is displayed open because it's smaller
3345 than 'foldminlines', a following "zc" may close a containing fold.
3346
3347 *'foldnestmax'* *'fdn'*
3348'foldnestmax' 'fdn' number (default: 20)
3349 local to window
3350 {not in Vi}
3351 {not available when compiled without the |+folding|
3352 feature}
3353 Sets the maximum nesting of folds for the "indent" and "syntax"
3354 methods. This avoids that too many folds will be created. Using more
3355 than 20 doesn't work, because the internal limit is 20.
3356
3357 *'foldopen'* *'fdo'*
3358'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3359 search,tag,undo")
3360 global
3361 {not in Vi}
3362 {not available when compiled without the |+folding|
3363 feature}
3364 Specifies for which type of commands folds will be opened, if the
3365 command moves the cursor into a closed fold. It is a comma separated
3366 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003367 NOTE: When the command is part of a mapping this option is not used.
3368 Add the |zv| command to the mapping to get the same effect.
3369 (rationale: the mapping may want to control opening folds itself)
3370
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 item commands ~
3372 all any
3373 block "(", "{", "[[", "[{", etc.
3374 hor horizontal movements: "l", "w", "fx", etc.
3375 insert any command in Insert mode
3376 jump far jumps: "G", "gg", etc.
3377 mark jumping to a mark: "'m", CTRL-O, etc.
3378 percent "%"
3379 quickfix ":cn", ":crew", ":make", etc.
3380 search search for a pattern: "/", "n", "*", "gd", etc.
3381 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003382 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 tag jumping to a tag: ":ta", CTRL-T, etc.
3384 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 When a movement command is used for an operator (e.g., "dl" or "y%")
3386 this option is not used. This means the operator will include the
3387 whole closed fold.
3388 Note that vertical movements are not here, because it would make it
3389 very difficult to move onto a closed fold.
3390 In insert mode the folds containing the cursor will always be open
3391 when text is inserted.
3392 To close folds you can re-apply 'foldlevel' with the |zx| command or
3393 set the 'foldclose' option to "all".
3394
3395 *'foldtext'* *'fdt'*
3396'foldtext' 'fdt' string (default: "foldtext()")
3397 local to window
3398 {not in Vi}
3399 {not available when compiled without the |+folding|
3400 feature}
3401 An expression which is used to specify the text displayed for a closed
3402 fold. See |fold-foldtext|.
3403
Bram Moolenaar30b65812012-07-12 22:01:11 +02003404 The expression will be evaluated in the |sandbox| if set from a
3405 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003406
3407 It is not allowed to change text or jump to another window while
3408 evaluating 'foldtext' |textlock|.
3409
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003410 *'formatexpr'* *'fex'*
3411'formatexpr' 'fex' string (default "")
3412 local to buffer
3413 {not in Vi}
3414 {not available when compiled without the |+eval|
3415 feature}
3416 Expression which is evaluated to format a range of lines for the |gq|
3417 operator or automatic formatting (see 'formatoptions'). When this
3418 option is empty 'formatprg' is used.
3419
3420 The |v:lnum| variable holds the first line to be formatted.
3421 The |v:count| variable holds the number of lines to be formatted.
3422 The |v:char| variable holds the character that is going to be
3423 inserted if the expression is being evaluated due to
3424 automatic formatting. This can be empty. Don't insert
3425 it yet!
3426
3427 Example: >
3428 :set formatexpr=mylang#Format()
3429< This will invoke the mylang#Format() function in the
3430 autoload/mylang.vim file in 'runtimepath'. |autoload|
3431
3432 The expression is also evaluated when 'textwidth' is set and adding
3433 text beyond that limit. This happens under the same conditions as
3434 when internal formatting is used. Make sure the cursor is kept in the
3435 same spot relative to the text then! The |mode()| function will
3436 return "i" or "R" in this situation.
3437
3438 When the expression evaluates to non-zero Vim will fall back to using
3439 the internal format mechanism.
3440
3441 The expression will be evaluated in the |sandbox| when set from a
3442 modeline, see |sandbox-option|. That stops the option from working,
3443 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003444 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003445
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 *'formatoptions'* *'fo'*
3447'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3448 local to buffer
3449 {not in Vi}
3450 This is a sequence of letters which describes how automatic
3451 formatting is to be done. See |fo-table|. When the 'paste' option is
3452 on, no formatting is done (like 'formatoptions' is empty). Commas can
3453 be inserted for readability.
3454 To avoid problems with flags that are added in the future, use the
3455 "+=" and "-=" feature of ":set" |add-option-flags|.
3456 NOTE: This option is set to the Vi default value when 'compatible' is
3457 set and to the Vim default value when 'compatible' is reset.
3458
Bram Moolenaar86b68352004-12-27 21:59:20 +00003459 *'formatlistpat'* *'flp'*
3460'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3461 local to buffer
3462 {not in Vi}
3463 A pattern that is used to recognize a list header. This is used for
3464 the "n" flag in 'formatoptions'.
3465 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003466 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003467 while still checking more characters. There must be a character
3468 following the pattern, when it matches the whole line it is handled
3469 like there is no match.
3470 The default recognizes a number, followed by an optional punctuation
3471 character and white space.
3472
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 *'formatprg'* *'fp'*
3474'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003475 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 {not in Vi}
3477 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003478 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003480 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003481 If the 'formatexpr' option is not empty it will be used instead.
3482 Otherwise, if 'formatprg' option is an empty string, the internal
3483 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003484 Environment variables are expanded |:set_env|. See |option-backslash|
3485 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003486 This option cannot be set from a |modeline| or in the |sandbox|, for
3487 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488
Bram Moolenaard94464e2015-11-02 15:28:18 +01003489 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003490'fsync' 'fs' boolean (default on)
3491 global
3492 {not in Vi}
3493 When on, the library function fsync() will be called after writing a
3494 file. This will flush a file to disk, ensuring that it is safely
3495 written even on filesystems which do metadata-only journaling. This
3496 will force the harddrive to spin up on Linux systems running in laptop
3497 mode, so it may be undesirable in some situations. Be warned that
3498 turning this off increases the chances of data loss after a crash. On
3499 systems without an fsync() implementation, this variable is always
3500 off.
3501 Also see 'swapsync' for controlling fsync() on swap files.
3502
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3504'gdefault' 'gd' boolean (default off)
3505 global
3506 {not in Vi}
3507 When on, the ":substitute" flag 'g' is default on. This means that
3508 all matches in a line are substituted instead of one. When a 'g' flag
3509 is given to a ":substitute" command, this will toggle the substitution
3510 of all or one match. See |complex-change|.
3511
3512 command 'gdefault' on 'gdefault' off ~
3513 :s/// subst. all subst. one
3514 :s///g subst. one subst. all
3515 :s///gg subst. all subst. one
3516
3517 NOTE: This option is reset when 'compatible' is set.
3518
3519 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003520'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 global
3522 {not in Vi}
3523 Format to recognize for the ":grep" command output.
3524 This is a scanf-like string that uses the same format as the
3525 'errorformat' option: see |errorformat|.
3526
3527 *'grepprg'* *'gp'*
3528'grepprg' 'gp' string (default "grep -n ",
3529 Unix: "grep -n $* /dev/null",
3530 Win32: "findstr /n" or "grep -n",
3531 VMS: "SEARCH/NUMBERS ")
3532 global or local to buffer |global-local|
3533 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003534 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 and '#' characters, which are expanded like when used in a command-
3536 line. The placeholder "$*" is allowed to specify where the arguments
3537 will be included. Environment variables are expanded |:set_env|. See
3538 |option-backslash| about including spaces and backslashes.
3539 When your "grep" accepts the "-H" argument, use this to make ":grep"
3540 also work well with a single file: >
3541 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003542< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003543 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3544 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003545 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 apply equally to 'grepprg'.
3547 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3548 otherwise it's "grep -n".
3549 This option cannot be set from a |modeline| or in the |sandbox|, for
3550 security reasons.
3551
3552 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3553'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3554 ve:ver35-Cursor,
3555 o:hor50-Cursor,
3556 i-ci:ver25-Cursor/lCursor,
3557 r-cr:hor20-Cursor/lCursor,
3558 sm:block-Cursor
3559 -blinkwait175-blinkoff150-blinkon175",
3560 for MS-DOS and Win32 console:
3561 "n-v-c:block,o:hor50,i-ci:hor15,
3562 r-cr:hor30,sm:block")
3563 global
3564 {not in Vi}
3565 {only available when compiled with GUI enabled, and
3566 for MS-DOS and Win32 console}
3567 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003568 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 the height of the cursor can be changed. This can be done by
3570 specifying a block cursor, or a percentage for a vertical or
3571 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003572 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3573 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003575 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 mode-list and an argument-list:
3577 mode-list:argument-list,mode-list:argument-list,..
3578 The mode-list is a dash separated list of these modes:
3579 n Normal mode
3580 v Visual mode
3581 ve Visual mode with 'selection' "exclusive" (same as 'v',
3582 if not specified)
3583 o Operator-pending mode
3584 i Insert mode
3585 r Replace mode
3586 c Command-line Normal (append) mode
3587 ci Command-line Insert mode
3588 cr Command-line Replace mode
3589 sm showmatch in Insert mode
3590 a all modes
3591 The argument-list is a dash separated list of these arguments:
3592 hor{N} horizontal bar, {N} percent of the character height
3593 ver{N} vertical bar, {N} percent of the character width
3594 block block cursor, fills the whole character
3595 [only one of the above three should be present]
3596 blinkwait{N} *cursor-blinking*
3597 blinkon{N}
3598 blinkoff{N}
3599 blink times for cursor: blinkwait is the delay before
3600 the cursor starts blinking, blinkon is the time that
3601 the cursor is shown and blinkoff is the time that the
3602 cursor is not shown. The times are in msec. When one
3603 of the numbers is zero, there is no blinking. The
3604 default is: "blinkwait700-blinkon400-blinkoff250".
3605 These numbers are used for a missing entry. This
3606 means that blinking is enabled by default. To switch
3607 blinking off you can use "blinkon0". The cursor only
3608 blinks when Vim is waiting for input, not while
3609 executing a command.
3610 To make the cursor blink in an xterm, see
3611 |xterm-blink|.
3612 {group-name}
3613 a highlight group name, that sets the color and font
3614 for the cursor
3615 {group-name}/{group-name}
3616 Two highlight group names, the first is used when
3617 no language mappings are used, the other when they
3618 are. |language-mapping|
3619
3620 Examples of parts:
3621 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3622 block cursor with colors from the "nCursor"
3623 highlight group
3624 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3625 In Insert and Command-line Insert mode, use a
3626 30% vertical bar cursor with colors from the
3627 "iCursor" highlight group. Blink a bit
3628 faster.
3629
3630 The 'a' mode is different. It will set the given argument-list for
3631 all modes. It does not reset anything to defaults. This can be used
3632 to do a common setting for all modes. For example, to switch off
3633 blinking: "a:blinkon0"
3634
3635 Examples of cursor highlighting: >
3636 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3637 :highlight Cursor gui=NONE guifg=bg guibg=fg
3638<
3639 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003640 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641'guifont' 'gfn' string (default "")
3642 global
3643 {not in Vi}
3644 {only available when compiled with GUI enabled}
3645 This is a list of fonts which will be used for the GUI version of Vim.
3646 In its simplest form the value is just one font name. When
3647 the font cannot be found you will get an error message. To try other
3648 font names a list can be specified, font names separated with commas.
3649 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003650
Bram Moolenaar05159a02005-02-26 23:04:13 +00003651 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3652 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003653
Bram Moolenaar3df01732017-02-17 22:47:16 +01003654 Note: As to the GTK GUIs, no error is given against any invalid names,
3655 and the first element of the list is always picked up and made use of.
3656 This is because, instead of identifying a given name with a font, the
3657 GTK GUIs use it to construct a pattern and try to look up a font which
3658 best matches the pattern among available fonts, and this way, the
3659 matching never fails. An invalid name doesn't matter because a number
3660 of font properties other than name will do to get the matching done.
3661
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 Spaces after a comma are ignored. To include a comma in a font name
3663 precede it with a backslash. Setting an option requires an extra
3664 backslash before a space and a backslash. See also
3665 |option-backslash|. For example: >
3666 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003667< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003669
3670 If none of the fonts can be loaded, Vim will keep the current setting.
3671 If an empty font list is given, Vim will try using other resource
3672 settings (for X, it will use the Vim.font resource), and finally it
3673 will try some builtin default which should always be there ("7x13" in
3674 the case of X). The font names given should be "normal" fonts. Vim
3675 will try to find the related bold and italic fonts.
3676
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003677 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003678 :set guifont=*
3679< will bring up a font requester, where you can pick the font you want.
3680
3681 The font name depends on the GUI used. See |setting-guifont| for a
3682 way to set 'guifont' for various systems.
3683
Bram Moolenaar3df01732017-02-17 22:47:16 +01003684 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003686< That's all. XLFDs are not used. For Chinese this is reported to work
3687 well: >
3688 if has("gui_gtk2")
3689 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3690 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3691 endif
3692<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003693 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3694
Bram Moolenaar05159a02005-02-26 23:04:13 +00003695 For Mac OSX you can use something like this: >
3696 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003697< Also see 'macatsui', it can help fix display problems.
3698 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003700 width). An exception is GTK: all fonts are accepted, but mono-spaced
3701 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003702
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 To preview a font on X11, you might be able to use the "xfontsel"
3704 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003705
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 For the Win32 GUI *E244* *E245*
3707 - takes these options in the font name:
3708 hXX - height is XX (points, can be floating-point)
3709 wXX - width is XX (points, can be floating-point)
3710 b - bold
3711 i - italic
3712 u - underline
3713 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003714 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3716 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3717 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003718 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003719 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003720 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003721 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003722 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723
3724 Use a ':' to separate the options.
3725 - A '_' can be used in the place of a space, so you don't need to use
3726 backslashes to escape the spaces.
3727 - Examples: >
3728 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3729 :set guifont=Andale_Mono:h7.5:w4.5
3730< See also |font-sizes|.
3731
3732 *'guifontset'* *'gfs'*
3733 *E250* *E252* *E234* *E597* *E598*
3734'guifontset' 'gfs' string (default "")
3735 global
3736 {not in Vi}
3737 {only available when compiled with GUI enabled and
3738 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003739 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 When not empty, specifies two (or more) fonts to be used. The first
3741 one for normal English, the second one for your special language. See
3742 |xfontset|.
3743 Setting this option also means that all font names will be handled as
3744 a fontset name. Also the ones used for the "font" argument of the
3745 |:highlight| command.
3746 The fonts must match with the current locale. If fonts for the
3747 character sets that the current locale uses are not included, setting
3748 'guifontset' will fail.
3749 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3750 the comma-separated names are alternative names, one of which will be
3751 used. In 'guifontset' the whole string is one fontset name,
3752 including the commas. It is not possible to specify alternative
3753 fontset names.
3754 This example works on many X11 systems: >
3755 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3756<
3757 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3758'guifontwide' 'gfw' string (default "")
3759 global
3760 {not in Vi}
3761 {only available when compiled with GUI enabled}
3762 When not empty, specifies a comma-separated list of fonts to be used
3763 for double-width characters. The first font that can be loaded is
3764 used.
3765 Note: The size of these fonts must be exactly twice as wide as the one
3766 specified with 'guifont' and the same height.
3767
Bram Moolenaar3df01732017-02-17 22:47:16 +01003768 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769
3770 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3771 'guifontset' is empty or invalid.
3772 When 'guifont' is set and a valid font is found in it and
3773 'guifontwide' is empty Vim will attempt to find a matching
3774 double-width font and set 'guifontwide' to it.
3775
Bram Moolenaar3df01732017-02-17 22:47:16 +01003776 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
3778 If set and valid, 'guifontwide' is always used for double width
3779 characters, even if 'encoding' is not set to "utf-8".
3780 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003781 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 font for characters not available in 'guifont'. Thus you do not need
3783 to set 'guifontwide' at all unless you want to override the choice
3784 made by Pango/Xft.
3785
Bram Moolenaar0f272122013-01-23 18:37:40 +01003786 Windows +multibyte only: *guifontwide_win_mbyte*
3787
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003788 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003789
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 *'guiheadroom'* *'ghr'*
3791'guiheadroom' 'ghr' number (default 50)
3792 global
3793 {not in Vi} {only for GTK and X11 GUI}
3794 The number of pixels subtracted from the screen height when fitting
3795 the GUI window on the screen. Set this before the GUI is started,
3796 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003797 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 lines will be left for window decorations and other items on the
3799 screen. Set it to a negative value to allow windows taller than the
3800 screen.
3801
3802 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003803'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3804 removed in |defaults.vim|),
3805 "aegimrLtT" (GTK, Motif and Athena),
3806 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 global
3808 {not in Vi}
3809 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003810 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 sequence of letters which describes what components and options of the
3812 GUI should be used.
3813 To avoid problems with flags that are added in the future, use the
3814 "+=" and "-=" feature of ":set" |add-option-flags|.
3815
3816 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003817 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 'a' Autoselect: If present, then whenever VISUAL mode is started,
3819 or the Visual area extended, Vim tries to become the owner of
3820 the windowing system's global selection. This means that the
3821 Visually highlighted text is available for pasting into other
3822 applications as well as into Vim itself. When the Visual mode
3823 ends, possibly due to an operation on the text, or when an
3824 application wants to paste the selection, the highlighted text
3825 is automatically yanked into the "* selection register.
3826 Thus the selection is still available for pasting into other
3827 applications after the VISUAL mode has ended.
3828 If not present, then Vim won't become the owner of the
3829 windowing system's global selection unless explicitly told to
3830 by a yank or delete operation for the "* register.
3831 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003832 *'go-P'*
3833 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003834 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003835 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003836 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 applies to the modeless selection.
3838
3839 'guioptions' autoselect Visual autoselect modeless ~
3840 "" - -
3841 "a" yes yes
3842 "A" - yes
3843 "aA" yes yes
3844
Bram Moolenaar02467872007-05-06 13:22:01 +00003845 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 'c' Use console dialogs instead of popup dialogs for simple
3847 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003848 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003849 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 'guitablabel' can be used to change the text in the labels.
3851 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003852 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003853 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003854 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 'f' Foreground: Don't use fork() to detach the GUI from the shell
3856 where it was started. Use this for programs that wait for the
3857 editor to finish (e.g., an e-mail program). Alternatively you
3858 can use "gvim -f" or ":gui -f" to start the GUI in the
3859 foreground. |gui-fork|
3860 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003861 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003862 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3864 corner of the window. It's black&white on non-GTK, because of
3865 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003866 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003868 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003869 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003871 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 file is sourced the system menu has already been loaded; the
3873 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003874 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 'g' Grey menu items: Make menu items that are not active grey. If
3876 'g' is not included inactive menu items are not shown at all.
3877 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003878 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 't' Include tearoff menu items. Currently only works for Win32,
3880 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003881 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003882 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003883 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003886 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 'R' Right-hand scrollbar is present when there is a vertically
3888 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003889 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003891 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'L' Left-hand scrollbar is present when there is a vertically
3893 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003894 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3896 the longest visible line, or on the cursor line if the 'h'
3897 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003898 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'h' Limit horizontal scrollbar size to the length of the cursor
3900 line. Reduces computations. |gui-horiz-scroll|
3901
3902 And yes, you may even have scrollbars on the left AND the right if
3903 you really want to :-). See |gui-scrollbars| for more information.
3904
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003905 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 'v' Use a vertical button layout for dialogs. When not included,
3907 a horizontal layout is preferred, but when it doesn't fit a
3908 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003909 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 'p' Use Pointer callbacks for X11 GUI. This is required for some
3911 window managers. If the cursor is not blinking or hollow at
3912 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003913 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003915 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003916 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917
Bram Moolenaar02467872007-05-06 13:22:01 +00003918
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 *'guipty'* *'noguipty'*
3920'guipty' boolean (default on)
3921 global
3922 {not in Vi}
3923 {only available when compiled with GUI enabled}
3924 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3925 I/O to/from shell commands. See |gui-pty|.
3926
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003927 *'guitablabel'* *'gtl'*
3928'guitablabel' 'gtl' string (default empty)
3929 global
3930 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003931 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003932 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003933 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003934 pages line. When empty and when the result is empty Vim will use a
3935 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003936
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003937 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003938 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003939 The expression will be evaluated in the |sandbox| when set from a
3940 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003941
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003942 Only used when the GUI tab pages line is displayed. 'e' must be
3943 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3944 used.
3945
Bram Moolenaar57657d82006-04-21 22:12:41 +00003946 *'guitabtooltip'* *'gtt'*
3947'guitabtooltip' 'gtt' string (default empty)
3948 global
3949 {not in Vi}
3950 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003951 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003952 When nonempty describes the text to use in a tooltip for the GUI tab
3953 pages line. When empty Vim will use a default tooltip.
3954 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003955 You can include a line break. Simplest method is to use |:let|: >
3956 :let &guitabtooltip = "line one\nline two"
3957<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003958
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 *'helpfile'* *'hf'*
3960'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3961 (others) "$VIMRUNTIME/doc/help.txt")
3962 global
3963 {not in Vi}
3964 Name of the main help file. All distributed help files should be
3965 placed together in one directory. Additionally, all "doc" directories
3966 in 'runtimepath' will be used.
3967 Environment variables are expanded |:set_env|. For example:
3968 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003969 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 spaces and backslashes.
3971 This option cannot be set from a |modeline| or in the |sandbox|, for
3972 security reasons.
3973
3974 *'helpheight'* *'hh'*
3975'helpheight' 'hh' number (default 20)
3976 global
3977 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003978 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 feature}
3980 Minimal initial height of the help window when it is opened with the
3981 ":help" command. The initial height of the help window is half of the
3982 current window, or (when the 'ea' option is on) the same as other
3983 windows. When the height is less than 'helpheight', the height is
3984 set to 'helpheight'. Set to zero to disable.
3985
3986 *'helplang'* *'hlg'*
3987'helplang' 'hlg' string (default: messages language or empty)
3988 global
3989 {only available when compiled with the |+multi_lang|
3990 feature}
3991 {not in Vi}
3992 Comma separated list of languages. Vim will use the first language
3993 for which the desired help can be found. The English help will always
3994 be used as a last resort. You can add "en" to prefer English over
3995 another language, but that will only find tags that exist in that
3996 language and not in the English help.
3997 Example: >
3998 :set helplang=de,it
3999< This will first search German, then Italian and finally English help
4000 files.
4001 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4002 try to find the tag in the current language before using this option.
4003 See |help-translated|.
4004
4005 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4006'hidden' 'hid' boolean (default off)
4007 global
4008 {not in Vi}
4009 When off a buffer is unloaded when it is |abandon|ed. When on a
4010 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4011 displayed in another window, it does not become hidden, of course.
4012 The commands that move through the buffer list sometimes make a buffer
4013 hidden although the 'hidden' option is off: When the buffer is
4014 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004015 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004016 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 This option is set for one command with ":hide {command}" |:hide|.
4018 WARNING: It's easy to forget that you have changes in hidden buffers.
4019 Think twice when using ":q!" or ":qa!".
4020
4021 *'highlight'* *'hl'*
4022'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004023 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4024 d:Directory,e:ErrorMsg,i:IncSearch,
4025 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4026 N:CursorLineNr,r:Question,s:StatusLine,
4027 S:StatusLineNC,c:VertSplit,t:Title,
4028 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4029 F:FoldColumn,A:DiffAdd,C:DiffChange,
4030 D:DiffDelete,T:DiffText,>:SignColumn,
4031 B:SpellBad,P:SpellCap,R:SpellRare,
4032 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004033 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 global
4035 {not in Vi}
4036 This option can be used to set highlighting mode for various
4037 occasions. It is a comma separated list of character pairs. The
4038 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004039 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004041 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4042 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 characters from 'showbreak'
4044 |hl-Directory| d directories in CTRL-D listing and other special
4045 things in listings
4046 |hl-ErrorMsg| e error messages
4047 h (obsolete, ignored)
4048 |hl-IncSearch| i 'incsearch' highlighting
4049 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4050 |hl-MoreMsg| m |more-prompt|
4051 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004052 |hl-LineNr| n line number for ":number" and ":#" commands, and
4053 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004054 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4055 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 |hl-Question| r |hit-enter| prompt and yes/no questions
4057 |hl-StatusLine| s status line of current window |status-line|
4058 |hl-StatusLineNC| S status lines of not-current windows
4059 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4060 |hl-VertSplit| c column used to separate vertically split windows
4061 |hl-Visual| v Visual mode
4062 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4063 Selection" Only X11 Gui's |gui-x11| and
4064 |xterm-clipboard|.
4065 |hl-WarningMsg| w warning messages
4066 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4067 |hl-Folded| f line used for closed folds
4068 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004069 |hl-DiffAdd| A added line in diff mode
4070 |hl-DiffChange| C changed line in diff mode
4071 |hl-DiffDelete| D deleted line in diff mode
4072 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004074 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004075 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004076 |hl-SpellRare| R rare word |spell|
4077 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004078 |hl-Conceal| - the placeholders used for concealed characters
4079 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004080 |hl-Pmenu| + popup menu normal line
4081 |hl-PmenuSel| = popup menu normal line
4082 |hl-PmenuSbar| x popup menu scrollbar
4083 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084
4085 The display modes are:
4086 r reverse (termcap entry "mr" and "me")
4087 i italic (termcap entry "ZH" and "ZR")
4088 b bold (termcap entry "md" and "me")
4089 s standout (termcap entry "so" and "se")
4090 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004091 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 n no highlighting
4093 - no highlighting
4094 : use a highlight group
4095 The default is used for occasions that are not included.
4096 If you want to change what the display modes do, see |dos-colors|
4097 for an example.
4098 When using the ':' display mode, this must be followed by the name of
4099 a highlight group. A highlight group can be used to define any type
4100 of highlighting, including using color. See |:highlight| on how to
4101 define one. The default uses a different group for each occasion.
4102 See |highlight-default| for the default highlight groups.
4103
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004105'history' 'hi' number (Vim default: 50, Vi default: 0,
4106 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 global
4108 {not in Vi}
4109 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004110 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004112 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 NOTE: This option is set to the Vi default value when 'compatible' is
4114 set and to the Vim default value when 'compatible' is reset.
4115
4116 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4117'hkmap' 'hk' boolean (default off)
4118 global
4119 {not in Vi}
4120 {only available when compiled with the |+rightleft|
4121 feature}
4122 When on, the keyboard is mapped for the Hebrew character set.
4123 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4124 toggle this option. See |rileft.txt|.
4125 NOTE: This option is reset when 'compatible' is set.
4126
4127 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4128'hkmapp' 'hkp' boolean (default off)
4129 global
4130 {not in Vi}
4131 {only available when compiled with the |+rightleft|
4132 feature}
4133 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4134 This is useful if you have a non-Hebrew keyboard.
4135 See |rileft.txt|.
4136 NOTE: This option is reset when 'compatible' is set.
4137
Bram Moolenaar036986f2017-03-16 17:41:02 +01004138 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4139'hlsearch' 'hls' boolean (default off)
4140 global
4141 {not in Vi}
4142 {not available when compiled without the
4143 |+extra_search| feature}
4144 When there is a previous search pattern, highlight all its matches.
4145 The type of highlighting used can be set with the 'l' occasion in the
4146 'highlight' option. This uses the "Search" highlight group by
4147 default. Note that only the matching text is highlighted, any offsets
4148 are not applied.
4149 See also: 'incsearch' and |:match|.
4150 When you get bored looking at the highlighted matches, you can turn it
4151 off with |:nohlsearch|. This does not change the option value, as
4152 soon as you use a search command, the highlighting comes back.
4153 'redrawtime' specifies the maximum time spent on finding matches.
4154 When the search pattern can match an end-of-line, Vim will try to
4155 highlight all of the matched text. However, this depends on where the
4156 search starts. This will be the first line in the window or the first
4157 line below a closed fold. A match in a previous line which is not
4158 drawn may not continue in a newly drawn line.
4159 You can specify whether the highlight status is restored on startup
4160 with the 'h' flag in 'viminfo' |viminfo-h|.
4161 NOTE: This option is reset when 'compatible' is set.
4162
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 *'icon'* *'noicon'*
4164'icon' boolean (default off, on when title can be restored)
4165 global
4166 {not in Vi}
4167 {not available when compiled without the |+title|
4168 feature}
4169 When on, the icon text of the window will be set to the value of
4170 'iconstring' (if it is not empty), or to the name of the file
4171 currently being edited. Only the last part of the name is used.
4172 Overridden by the 'iconstring' option.
4173 Only works if the terminal supports setting window icons (currently
4174 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4175 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4176 builtin termcap).
4177 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004178 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004180 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181
4182 *'iconstring'*
4183'iconstring' string (default "")
4184 global
4185 {not in Vi}
4186 {not available when compiled without the |+title|
4187 feature}
4188 When this option is not empty, it will be used for the icon text of
4189 the window. This happens only when the 'icon' option is on.
4190 Only works if the terminal supports setting window icon text
4191 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4192 Does not work for MS Windows.
4193 When Vim was compiled with HAVE_X11 defined, the original icon will be
4194 restored if possible |X11|.
4195 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004196 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 'titlestring' for example settings.
4198 {not available when compiled without the |+statusline| feature}
4199
4200 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4201'ignorecase' 'ic' boolean (default off)
4202 global
4203 Ignore case in search patterns. Also used when searching in the tags
4204 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004205 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 Can be overruled by using "\c" or "\C" in the pattern, see
4207 |/ignorecase|.
4208
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004209 *'imactivatefunc'* *'imaf'*
4210'imactivatefunc' 'imaf' string (default "")
4211 global
4212 {not in Vi}
4213 {only available when compiled with |+xim| and
4214 |+GUI_GTK|}
4215 This option specifies a function that will be called to
4216 activate/inactivate Input Method.
4217
4218 Example: >
4219 function ImActivateFunc(active)
4220 if a:active
4221 ... do something
4222 else
4223 ... do something
4224 endif
4225 " return value is not used
4226 endfunction
4227 set imactivatefunc=ImActivateFunc
4228<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 *'imactivatekey'* *'imak'*
4230'imactivatekey' 'imak' string (default "")
4231 global
4232 {not in Vi}
4233 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004234 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 Specifies the key that your Input Method in X-Windows uses for
4236 activation. When this is specified correctly, vim can fully control
4237 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4238 You can't use this option to change the activation key, the option
4239 tells Vim what the key is.
4240 Format:
4241 [MODIFIER_FLAG-]KEY_STRING
4242
4243 These characters can be used for MODIFIER_FLAG (case is ignored):
4244 S Shift key
4245 L Lock key
4246 C Control key
4247 1 Mod1 key
4248 2 Mod2 key
4249 3 Mod3 key
4250 4 Mod4 key
4251 5 Mod5 key
4252 Combinations are allowed, for example "S-C-space" or "SC-space" are
4253 both shift+ctrl+space.
4254 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4255
4256 Example: >
4257 :set imactivatekey=S-space
4258< "S-space" means shift+space. This is the activation key for kinput2 +
4259 canna (Japanese), and ami (Korean).
4260
4261 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4262'imcmdline' 'imc' boolean (default off)
4263 global
4264 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004265 {only available when compiled with the |+xim|,
4266 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 When set the Input Method is always on when starting to edit a command
4268 line, unless entering a search pattern (see 'imsearch' for that).
4269 Setting this option is useful when your input method allows entering
4270 English characters directly, e.g., when it's used to type accented
4271 characters with dead keys.
4272
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004273 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4275 global
4276 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004277 {only available when compiled with the |+xim|,
4278 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 When set the Input Method is never used. This is useful to disable
4280 the IM when it doesn't work properly.
4281 Currently this option is on by default for SGI/IRIX machines. This
4282 may change in later releases.
4283
4284 *'iminsert'* *'imi'*
4285'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4286 local to buffer
4287 {not in Vi}
4288 Specifies whether :lmap or an Input Method (IM) is to be used in
4289 Insert mode. Valid values:
4290 0 :lmap is off and IM is off
4291 1 :lmap is ON and IM is off
4292 2 :lmap is off and IM is ON
4293 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4294 or |global-ime|.
4295 To always reset the option to zero when leaving Insert mode with <Esc>
4296 this can be used: >
4297 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4298< This makes :lmap and IM turn off automatically when leaving Insert
4299 mode.
4300 Note that this option changes when using CTRL-^ in Insert mode
4301 |i_CTRL-^|.
4302 The value is set to 1 when setting 'keymap' to a valid keymap name.
4303 It is also used for the argument of commands like "r" and "f".
4304 The value 0 may not work correctly with Athena and Motif with some XIM
4305 methods. Use 'imdisable' to disable XIM then.
4306
4307 *'imsearch'* *'ims'*
4308'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4309 local to buffer
4310 {not in Vi}
4311 Specifies whether :lmap or an Input Method (IM) is to be used when
4312 entering a search pattern. Valid values:
4313 -1 the value of 'iminsert' is used, makes it look like
4314 'iminsert' is also used when typing a search pattern
4315 0 :lmap is off and IM is off
4316 1 :lmap is ON and IM is off
4317 2 :lmap is off and IM is ON
4318 Note that this option changes when using CTRL-^ in Command-line mode
4319 |c_CTRL-^|.
4320 The value is set to 1 when it is not -1 and setting the 'keymap'
4321 option to a valid keymap name.
4322 The value 0 may not work correctly with Athena and Motif with some XIM
4323 methods. Use 'imdisable' to disable XIM then.
4324
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004325 *'imstatusfunc'* *'imsf'*
4326'imstatusfunc' 'imsf' string (default "")
4327 global
4328 {not in Vi}
4329 {only available when compiled with |+xim| and
4330 |+GUI_GTK|}
4331 This option specifies a function that is called to obtain the status
4332 of Input Method. It must return a positive number when IME is active.
4333
4334 Example: >
4335 function ImStatusFunc()
4336 let is_active = ...do something
4337 return is_active ? 1 : 0
4338 endfunction
4339 set imstatusfunc=ImStatusFunc
4340<
4341 NOTE: This function is invoked very often. Keep it fast.
4342
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 *'include'* *'inc'*
4344'include' 'inc' string (default "^\s*#\s*include")
4345 global or local to buffer |global-local|
4346 {not in Vi}
4347 {not available when compiled without the
4348 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004349 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 pattern, just like for the "/" command (See |pattern|). The default
4351 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004352 "]I", "[d", etc.
4353 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004354 comes after the matched pattern. But if "\zs" appears in the pattern
4355 then the text matched from "\zs" to the end, or until "\ze" if it
4356 appears, is used as the file name. Use this to include characters
4357 that are not in 'isfname', such as a space. You can then use
4358 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004359 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360
4361 *'includeexpr'* *'inex'*
4362'includeexpr' 'inex' string (default "")
4363 local to buffer
4364 {not in Vi}
4365 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004366 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004368 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 :set includeexpr=substitute(v:fname,'\\.','/','g')
4370< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004371
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004373 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 Also used for |<cfile>|.
4375
Bram Moolenaar30b65812012-07-12 22:01:11 +02004376 The expression will be evaluated in the |sandbox| when set from a
4377 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004378
4379 It is not allowed to change text or jump to another window while
4380 evaluating 'includeexpr' |textlock|.
4381
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004383'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4384 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385 global
4386 {not in Vi}
4387 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004388 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004389 While typing a search command, show where the pattern, as it was typed
4390 so far, matches. The matched string is highlighted. If the pattern
4391 is invalid or not found, nothing is shown. The screen will be updated
4392 often, this is only useful on fast terminals.
4393 Note that the match will be shown, but the cursor will return to its
4394 original position when no match is found and when pressing <Esc>. You
4395 still need to finish the search command with <Enter> to move the
4396 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004397 You can use the CTRL-G and CTRL-T keys to move to the next and
4398 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004399 When compiled with the |+reltime| feature Vim only searches for about
4400 half a second. With a complicated pattern and/or a lot of text the
4401 match may not be found. This is to avoid that Vim hangs while you
4402 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004403 The highlighting can be set with the 'i' flag in 'highlight'.
4404 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004405 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004406 to the command line. If 'ignorecase' and 'smartcase' are set and the
4407 command line has no uppercase characters, the added character is
4408 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004409 CTRL-R CTRL-W can be used to add the word at the end of the current
4410 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 NOTE: This option is reset when 'compatible' is set.
4412
4413 *'indentexpr'* *'inde'*
4414'indentexpr' 'inde' string (default "")
4415 local to buffer
4416 {not in Vi}
4417 {not available when compiled without the |+cindent|
4418 or |+eval| features}
4419 Expression which is evaluated to obtain the proper indent for a line.
4420 It is used when a new line is created, for the |=| operator and
4421 in Insert mode as specified with the 'indentkeys' option.
4422 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004423 'smartindent' indenting. When 'lisp' is set, this option is
4424 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 When 'paste' is set this option is not used for indenting.
4426 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004427 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 when the expression is evaluated (but it may be moved around).
4429 The expression must return the number of spaces worth of indent. It
4430 can return "-1" to keep the current indent (this means 'autoindent' is
4431 used for the indent).
4432 Functions useful for computing the indent are |indent()|, |cindent()|
4433 and |lispindent()|.
4434 The evaluation of the expression must not have side effects! It must
4435 not change the text, jump to another window, etc. Afterwards the
4436 cursor position is always restored, thus the cursor may be moved.
4437 Normally this option would be set to call a function: >
4438 :set indentexpr=GetMyIndent()
4439< Error messages will be suppressed, unless the 'debug' option contains
4440 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004441 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004442 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
Bram Moolenaar30b65812012-07-12 22:01:11 +02004444 The expression will be evaluated in the |sandbox| when set from a
4445 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004446
4447 It is not allowed to change text or jump to another window while
4448 evaluating 'indentexpr' |textlock|.
4449
4450
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 *'indentkeys'* *'indk'*
4452'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4453 local to buffer
4454 {not in Vi}
4455 {not available when compiled without the |+cindent|
4456 feature}
4457 A list of keys that, when typed in Insert mode, cause reindenting of
4458 the current line. Only happens if 'indentexpr' isn't empty.
4459 The format is identical to 'cinkeys', see |indentkeys-format|.
4460 See |C-indenting| and |indent-expression|.
4461
4462 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4463'infercase' 'inf' boolean (default off)
4464 local to buffer
4465 {not in Vi}
4466 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004467 'ignorecase' is also on, the case of the match is adjusted depending
4468 on the typed text. If the typed text contains a lowercase letter
4469 where the match has an upper case letter, the completed part is made
4470 lowercase. If the typed text has no lowercase letters and the match
4471 has a lowercase letter where the typed text has an uppercase letter,
4472 and there is a letter before it, the completed part is made uppercase.
4473 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474
4475 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4476'insertmode' 'im' boolean (default off)
4477 global
4478 {not in Vi}
4479 Makes Vim work in a way that Insert mode is the default mode. Useful
4480 if you want to use Vim as a modeless editor. Used for |evim|.
4481 These Insert mode commands will be useful:
4482 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004483 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 this is a mapping, it is executed as if 'insertmode' was off.
4485 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004487 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4488 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 These items change when 'insertmode' is set:
4491 - when starting to edit of a file, Vim goes to Insert mode.
4492 - <Esc> in Insert mode is a no-op and beeps.
4493 - <Esc> in Normal mode makes Vim go to Insert mode.
4494 - CTRL-L in Insert mode is a command, it is not inserted.
4495 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4496 However, when <Esc> is used inside a mapping, it behaves like
4497 'insertmode' was not set. This was done to be able to use the same
4498 mappings with 'insertmode' set or not set.
4499 When executing commands with |:normal| 'insertmode' is not used.
4500
4501 NOTE: This option is reset when 'compatible' is set.
4502
4503 *'isfname'* *'isf'*
4504'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4505 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4506 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4507 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4508 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4509 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4510 global
4511 {not in Vi}
4512 The characters specified by this option are included in file names and
4513 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004514 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 Multi-byte characters 256 and above are always included, only the
4516 characters up to 255 are specified with this option.
4517 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004518 Think twice before adding white space to this option. Although a
4519 space may appear inside a file name, the effect will be that Vim
4520 doesn't know where a file name starts or ends when doing completion.
4521 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522
4523 Note that on systems using a backslash as path separator, Vim tries to
4524 do its best to make it work as you would expect. That is a bit
4525 tricky, since Vi originally used the backslash to escape special
4526 characters. Vim will not remove a backslash in front of a normal file
4527 name character on these systems, but it will on Unix and alikes. The
4528 '&' and '^' are not included by default, because these are special for
4529 cmd.exe.
4530
4531 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004532 Each part can be a single character number or a range. A range is two
4533 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 decimal number between 0 and 255 or the ASCII character itself (does
4535 not work for digits). Example:
4536 "_,-,128-140,#-43" (include '_' and '-' and the range
4537 128 to 140 and '#' to 43)
4538 If a part starts with '^', the following character number or range
4539 will be excluded from the option. The option is interpreted from left
4540 to right. Put the excluded character after the range where it is
4541 included. To include '^' itself use it as the last character of the
4542 option or the end of a range. Example:
4543 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4544 If the character is '@', all characters where isalpha() returns TRUE
4545 are included. Normally these are the characters a to z and A to Z,
4546 plus accented characters. To include '@' itself use "@-@". Examples:
4547 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004548 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 "a-z,A-Z,@-@" All letters plus the '@' character.
4550 A comma can be included by using it where a character number is
4551 expected. Example:
4552 "48-57,,,_" Digits, comma and underscore.
4553 A comma can be excluded by prepending a '^'. Example:
4554 " -~,^,,9" All characters from space to '~', excluding
4555 comma, plus <Tab>.
4556 See |option-backslash| about including spaces and backslashes.
4557
4558 *'isident'* *'isi'*
4559'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4560 "@,48-57,_,128-167,224-235"
4561 otherwise: "@,48-57,_,192-255")
4562 global
4563 {not in Vi}
4564 The characters given by this option are included in identifiers.
4565 Identifiers are used in recognizing environment variables and after a
4566 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004567 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 option.
4569 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004570 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4572
4573 *'iskeyword'* *'isk'*
4574'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4575 "@,48-57,_,128-167,224-235"
4576 otherwise: "@,48-57,_,192-255"
4577 Vi default: "@,48-57,_")
4578 local to buffer
4579 {not in Vi}
4580 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004581 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 'isfname' for a description of the format of this option. For C
4583 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4584 For a help file it is set to all non-blank printable characters except
4585 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4586 command).
4587 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004588 This option also influences syntax highlighting, unless the syntax
4589 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 NOTE: This option is set to the Vi default value when 'compatible' is
4591 set and to the Vim default value when 'compatible' is reset.
4592
4593 *'isprint'* *'isp'*
4594'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4595 "@,~-255"; otherwise: "@,161-255")
4596 global
4597 {not in Vi}
4598 The characters given by this option are displayed directly on the
4599 screen. It is also used for "\p" in a |pattern|. The characters from
4600 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4601 even when they are not included in 'isprint' or excluded. See
4602 'isfname' for a description of the format of this option.
4603
4604 Non-printable characters are displayed with two characters:
4605 0 - 31 "^@" - "^_"
4606 32 - 126 always single characters
4607 127 "^?"
4608 128 - 159 "~@" - "~_"
4609 160 - 254 "| " - "|~"
4610 255 "~?"
4611 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4612 displayed as <xx>, with the hexadecimal value of the byte.
4613 When 'display' contains "uhex" all unprintable characters are
4614 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004615 The SpecialKey highlighting will be used for unprintable characters.
4616 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617
4618 Multi-byte characters 256 and above are always included, only the
4619 characters up to 255 are specified with this option. When a character
4620 is printable but it is not available in the current font, a
4621 replacement character will be shown.
4622 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4623 There is no option to specify these characters.
4624
4625 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4626'joinspaces' 'js' boolean (default on)
4627 global
4628 {not in Vi}
4629 Insert two spaces after a '.', '?' and '!' with a join command.
4630 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4631 Otherwise only one space is inserted.
4632 NOTE: This option is set when 'compatible' is set.
4633
4634 *'key'*
4635'key' string (default "")
4636 local to buffer
4637 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004638 {only available when compiled with the |+cryptv|
4639 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004641 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 Careful: Do not set the key value by hand, someone might see the typed
4643 key. Use the |:X| command. But you can make 'key' empty: >
4644 :set key=
4645< It is not possible to get the value of this option with ":set key" or
4646 "echo &key". This is to avoid showing it to someone who shouldn't
4647 know. It also means you cannot see it yourself once you have set it,
4648 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004649 You can use "&key" in an expression to detect whether encryption is
4650 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
4652 *'keymap'* *'kmp'* *E544*
4653'keymap' 'kmp' string (default "")
4654 local to buffer
4655 {not in Vi}
4656 {only available when compiled with the |+keymap|
4657 feature}
4658 Name of a keyboard mapping. See |mbyte-keymap|.
4659 Setting this option to a valid keymap name has the side effect of
4660 setting 'iminsert' to one, so that the keymap becomes effective.
4661 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004662 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663
4664 *'keymodel'* *'km'*
4665'keymodel' 'km' string (default "")
4666 global
4667 {not in Vi}
4668 List of comma separated words, which enable special things that keys
4669 can do. These values can be used:
4670 startsel Using a shifted special key starts selection (either
4671 Select mode or Visual mode, depending on "key" being
4672 present in 'selectmode').
4673 stopsel Using a not-shifted special key stops selection.
4674 Special keys in this context are the cursor keys, <End>, <Home>,
4675 <PageUp> and <PageDown>.
4676 The 'keymodel' option is set by the |:behave| command.
4677
4678 *'keywordprg'* *'kp'*
4679'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004680 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 global or local to buffer |global-local|
4682 {not in Vi}
4683 Program to use for the |K| command. Environment variables are
4684 expanded |:set_env|. ":help" may be used to access the Vim internal
4685 help. (Note that previously setting the global option to the empty
4686 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004687 When the first character is ":", the command is invoked as a Vim
4688 Ex command prefixed with [count].
4689 When "man", "man -s" or an Ex command is used, Vim will automatically
4690 translate a count for the "K" command and pass it as the first
4691 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 See |option-backslash| about including spaces and backslashes.
4693 Example: >
4694 :set keywordprg=man\ -s
4695< This option cannot be set from a |modeline| or in the |sandbox|, for
4696 security reasons.
4697
4698 *'langmap'* *'lmap'* *E357* *E358*
4699'langmap' 'lmap' string (default "")
4700 global
4701 {not in Vi}
4702 {only available when compiled with the |+langmap|
4703 feature}
4704 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004706 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 care of translating these special characters to the original meaning
4708 of the key. This means you don't have to change the keyboard mode to
4709 be able to execute Normal mode commands.
4710 This is the opposite of the 'keymap' option, where characters are
4711 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004712 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004713 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004714 This option cannot be set from a |modeline| or in the |sandbox|, for
4715 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004717 Example (for Greek, in UTF-8): *greek* >
4718 :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 +00004719< Example (exchanges meaning of z and y for commands): >
4720 :set langmap=zy,yz,ZY,YZ
4721<
4722 The 'langmap' option is a list of parts, separated with commas. Each
4723 part can be in one of two forms:
4724 1. A list of pairs. Each pair is a "from" character immediately
4725 followed by the "to" character. Examples: "aA", "aAbBcC".
4726 2. A list of "from" characters, a semi-colon and a list of "to"
4727 characters. Example: "abc;ABC"
4728 Example: "aA,fgh;FGH,cCdDeE"
4729 Special characters need to be preceded with a backslash. These are
4730 ";", ',' and backslash itself.
4731
4732 This will allow you to activate vim actions without having to switch
4733 back and forth between the languages. Your language characters will
4734 be understood as normal vim English characters (according to the
4735 langmap mappings) in the following cases:
4736 o Normal/Visual mode (commands, buffer/register names, user mappings)
4737 o Insert/Replace Mode: Register names after CTRL-R
4738 o Insert/Replace Mode: Mappings
4739 Characters entered in Command-line mode will NOT be affected by
4740 this option. Note that this option can be changed at any time
4741 allowing to switch between mappings for different languages/encodings.
4742 Use a mapping to avoid having to type it each time!
4743
4744 *'langmenu'* *'lm'*
4745'langmenu' 'lm' string (default "")
4746 global
4747 {not in Vi}
4748 {only available when compiled with the |+menu| and
4749 |+multi_lang| features}
4750 Language to use for menu translation. Tells which file is loaded
4751 from the "lang" directory in 'runtimepath': >
4752 "lang/menu_" . &langmenu . ".vim"
4753< (without the spaces). For example, to always use the Dutch menus, no
4754 matter what $LANG is set to: >
4755 :set langmenu=nl_NL.ISO_8859-1
4756< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004757 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 If your $LANG is set to a non-English language but you do want to use
4759 the English menus: >
4760 :set langmenu=none
4761< This option must be set before loading menus, switching on filetype
4762 detection or syntax highlighting. Once the menus are defined setting
4763 this option has no effect. But you could do this: >
4764 :source $VIMRUNTIME/delmenu.vim
4765 :set langmenu=de_DE.ISO_8859-1
4766 :source $VIMRUNTIME/menu.vim
4767< Warning: This deletes all menus that you defined yourself!
4768
Bram Moolenaard94464e2015-11-02 15:28:18 +01004769 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004770'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004771 global
4772 {not in Vi}
4773 {only available when compiled with the |+langmap|
4774 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004775 This is just like 'langremap' but with the value inverted. It only
4776 exists for backwards compatibility. When setting 'langremap' then
4777 'langnoremap' is set to the inverted value, and the other way around.
4778
4779 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4780'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4781 global
4782 {not in Vi}
4783 {only available when compiled with the |+langmap|
4784 feature}
4785 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004786 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004787 'langmap' disables some of your mappings, try resetting this option.
4788 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004789 that works for you to avoid mappings to break.
4790
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 *'laststatus'* *'ls'*
4792'laststatus' 'ls' number (default 1)
4793 global
4794 {not in Vi}
4795 The value of this option influences when the last window will have a
4796 status line:
4797 0: never
4798 1: only if there are at least two windows
4799 2: always
4800 The screen looks nicer with a status line if you have several
4801 windows, but it takes another screen line. |status-line|
4802
4803 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4804'lazyredraw' 'lz' boolean (default off)
4805 global
4806 {not in Vi}
4807 When this option is set, the screen will not be redrawn while
4808 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004809 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 update use |:redraw|.
4811
4812 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4813'linebreak' 'lbr' boolean (default off)
4814 local to window
4815 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004816 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004818 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 than at the last character that fits on the screen. Unlike
4820 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004821 it only affects the way the file is displayed, not its contents.
4822 If 'breakindent' is set, line is visually indented. Then, the value
4823 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004824 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 Note that <Tab> characters after an <EOL> are mostly not displayed
4826 with the right amount of white space.
4827
4828 *'lines'* *E593*
4829'lines' number (default 24 or terminal height)
4830 global
4831 Number of lines of the Vim window.
4832 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004833 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 When Vim is running in the GUI or in a resizable window, setting this
4835 option will cause the window size to be changed. When you only want
4836 to use the size for the GUI, put the command in your |gvimrc| file.
4837 Vim limits the number of lines to what fits on the screen. You can
4838 use this command to get the tallest window possible: >
4839 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004840< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004841 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 When you set this option and Vim is unable to change the physical
4843 number of lines of the display, the display may be messed up.
4844
4845 *'linespace'* *'lsp'*
4846'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4847 global
4848 {not in Vi}
4849 {only in the GUI}
4850 Number of pixel lines inserted between characters. Useful if the font
4851 uses the full character cell height, making lines touch each other.
4852 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004853 With some fonts there can be too much room between lines (to have
4854 space for ascents and descents). Then it makes sense to set
4855 'linespace' to a negative value. This may cause display problems
4856 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857
4858 *'lisp'* *'nolisp'*
4859'lisp' boolean (default off)
4860 local to buffer
4861 {not available when compiled without the |+lispindent|
4862 feature}
4863 Lisp mode: When <Enter> is typed in insert mode set the indent for
4864 the next line to Lisp standards (well, sort of). Also happens with
4865 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4866 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4867 better. Also see 'lispwords'.
4868 The '-' character is included in keyword characters. Redefines the
4869 "=" operator to use this same indentation algorithm rather than
4870 calling an external program if 'equalprg' is empty.
4871 This option is not used when 'paste' is set.
4872 {Vi: Does it a little bit differently}
4873
4874 *'lispwords'* *'lw'*
4875'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877 {not in Vi}
4878 {not available when compiled without the |+lispindent|
4879 feature}
4880 Comma separated list of words that influence the Lisp indenting.
4881 |'lisp'|
4882
4883 *'list'* *'nolist'*
4884'list' boolean (default off)
4885 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004886 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4887 line. Useful to see the difference between tabs and spaces and for
4888 trailing blanks. Further changed by the 'listchars' option.
4889
4890 The cursor is displayed at the start of the space a Tab character
4891 occupies, not at the end as usual in Normal mode. To get this cursor
4892 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004893 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004894<
4895 Note that list mode will also affect formatting (set with 'textwidth'
4896 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 changing the way tabs are displayed.
4898
4899 *'listchars'* *'lcs'*
4900'listchars' 'lcs' string (default "eol:$")
4901 global
4902 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004903 Strings to use in 'list' mode and for the |:list| command. It is a
4904 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004905 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 eol:c Character to show at the end of each line. When
4907 omitted, there is no extra character at the end of the
4908 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004909 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004910 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004912 fill the space that the tab normally occupies.
4913 "tab:>-" will show a tab that takes four spaces as
4914 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004915 *lcs-space*
4916 space:c Character to show for a space. When omitted, spaces
4917 are left blank.
4918 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004919 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004920 trailing spaces are blank. Overrides the "space"
4921 setting for trailing spaces.
4922 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 extends:c Character to show in the last column, when 'wrap' is
4924 off and the line continues beyond the right of the
4925 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004926 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 precedes:c Character to show in the first column, when 'wrap'
4928 is off and there is text preceding the character
4929 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004930 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004931 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004932 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004933 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004934 nbsp:c Character to show for a non-breakable space character
4935 (0xA0 (160 decimal) and U+202F). Left blank when
4936 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004938 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004940 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941
4942 Examples: >
4943 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004944 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 :set lcs=extends:>,precedes:<
4946< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004947 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004948 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949
4950 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4951'loadplugins' 'lpl' boolean (default on)
4952 global
4953 {not in Vi}
4954 When on the plugin scripts are loaded when starting up |load-plugins|.
4955 This option can be reset in your |vimrc| file to disable the loading
4956 of plugins.
4957 Note that using the "-u NONE" and "--noplugin" command line arguments
4958 reset this option. |-u| |--noplugin|
4959
Bram Moolenaard94464e2015-11-02 15:28:18 +01004960 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004961'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004962 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004963 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004964 {only available when compiled with the |+lua/dyn|
4965 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004966 Specifies the name of the Lua shared library. The default is
4967 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004968 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004969 This option cannot be set from a |modeline| or in the |sandbox|, for
4970 security reasons.
4971
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004972 *'macatsui'* *'nomacatsui'*
4973'macatsui' boolean (default on)
4974 global
4975 {only available in Mac GUI version}
4976 This is a workaround for when drawing doesn't work properly. When set
4977 and compiled with multi-byte support ATSUI text drawing is used. When
4978 not set ATSUI text drawing is not used. Switch this option off when
4979 you experience drawing problems. In a future version the problems may
4980 be solved and this option becomes obsolete. Therefore use this method
4981 to unset it: >
4982 if exists('&macatsui')
4983 set nomacatsui
4984 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004985< Another option to check if you have drawing problems is
4986 'termencoding'.
4987
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 *'magic'* *'nomagic'*
4989'magic' boolean (default on)
4990 global
4991 Changes the special characters that can be used in search patterns.
4992 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004993 WARNING: Switching this option off most likely breaks plugins! That
4994 is because many patterns assume it's on and will fail when it's off.
4995 Only switch it off when working with old Vi scripts. In any other
4996 situation write patterns that work when 'magic' is on. Include "\M"
4997 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998
4999 *'makeef'* *'mef'*
5000'makeef' 'mef' string (default: "")
5001 global
5002 {not in Vi}
5003 {not available when compiled without the |+quickfix|
5004 feature}
5005 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5006 and the |:grep| command.
5007 When it is empty, an internally generated temp file will be used.
5008 When "##" is included, it is replaced by a number to make the name
5009 unique. This makes sure that the ":make" command doesn't overwrite an
5010 existing file.
5011 NOT used for the ":cf" command. See 'errorfile' for that.
5012 Environment variables are expanded |:set_env|.
5013 See |option-backslash| about including spaces and backslashes.
5014 This option cannot be set from a |modeline| or in the |sandbox|, for
5015 security reasons.
5016
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005017 *'makeencoding'* *'menc'*
5018'makeencoding' 'menc' string (default "")
5019 global or local to buffer |global-local|
5020 {only available when compiled with the |+multi_byte|
5021 feature}
5022 {not in Vi}
5023 Encoding used for reading the output of external commands. When empty,
5024 encoding is not converted.
5025 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5026 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5027 and `:laddfile`.
5028
5029 This would be mostly useful when you use MS-Windows and set 'encoding'
5030 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5031 'makeencoding' to "char" has the same effect as setting to the system
5032 locale encoding. Example: >
5033 :set encoding=utf-8
5034 :set makeencoding=char " system locale is used
5035<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036 *'makeprg'* *'mp'*
5037'makeprg' 'mp' string (default "make", VMS: "MMS")
5038 global or local to buffer |global-local|
5039 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005040 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005041 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5042 which are expanded to the current and alternate file name. Use |::S|
5043 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005044 Environment variables are expanded |:set_env|. See |option-backslash|
5045 about including spaces and backslashes.
5046 Note that a '|' must be escaped twice: once for ":set" and once for
5047 the interpretation of a command. When you use a filter called
5048 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 :set makeprg=gmake\ \\\|\ myfilter
5050< The placeholder "$*" can be given (even multiple times) to specify
5051 where the arguments will be included, for example: >
5052 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5053< This option cannot be set from a |modeline| or in the |sandbox|, for
5054 security reasons.
5055
5056 *'matchpairs'* *'mps'*
5057'matchpairs' 'mps' string (default "(:),{:},[:]")
5058 local to buffer
5059 {not in Vi}
5060 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005061 other.
5062 Only character pairs are allowed that are different, thus you cannot
5063 jump between two double quotes.
5064 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005065 The pairs must be separated by a comma. Example for including '<' and
5066 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 :set mps+=<:>
5068
5069< A more exotic example, to jump between the '=' and ';' in an
5070 assignment, useful for languages like C and Java: >
5071 :au FileType c,cpp,java set mps+==:;
5072
5073< For a more advanced way of using "%", see the matchit.vim plugin in
5074 the $VIMRUNTIME/macros directory. |add-local-help|
5075
5076 *'matchtime'* *'mat'*
5077'matchtime' 'mat' number (default 5)
5078 global
5079 {not in Vi}{in Nvi}
5080 Tenths of a second to show the matching paren, when 'showmatch' is
5081 set. Note that this is not in milliseconds, like other options that
5082 set a time. This is to be compatible with Nvi.
5083
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005084 *'maxcombine'* *'mco'*
5085'maxcombine' 'mco' number (default 2)
5086 global
5087 {not in Vi}
5088 {only available when compiled with the |+multi_byte|
5089 feature}
5090 The maximum number of combining characters supported for displaying.
5091 Only used when 'encoding' is "utf-8".
5092 The default is OK for most languages. Hebrew may require 4.
5093 Maximum value is 6.
5094 Even when this option is set to 2 you can still edit text with more
5095 combining characters, you just can't see them. Use |g8| or |ga|.
5096 See |mbyte-combining|.
5097
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 *'maxfuncdepth'* *'mfd'*
5099'maxfuncdepth' 'mfd' number (default 100)
5100 global
5101 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005102 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005103 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 Maximum depth of function calls for user functions. This normally
5105 catches endless recursion. When using a recursive function with
5106 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5107 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005108 Increasing this limit above 200 also changes the maximum for Ex
5109 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 See also |:function|.
5111
5112 *'maxmapdepth'* *'mmd'* *E223*
5113'maxmapdepth' 'mmd' number (default 1000)
5114 global
5115 {not in Vi}
5116 Maximum number of times a mapping is done without resulting in a
5117 character to be used. This normally catches endless mappings, like
5118 ":map x y" with ":map y x". It still does not catch ":map g wg",
5119 because the 'w' is used before the next mapping is done. See also
5120 |key-mapping|.
5121
5122 *'maxmem'* *'mm'*
5123'maxmem' 'mm' number (default between 256 to 5120 (system
5124 dependent) or half the amount of memory
5125 available)
5126 global
5127 {not in Vi}
5128 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5129 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005130 other memory to be freed. The maximum usable value is about 2000000.
5131 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005133 *'maxmempattern'* *'mmp'*
5134'maxmempattern' 'mmp' number (default 1000)
5135 global
5136 {not in Vi}
5137 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005138 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005139 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005140 When Vim runs into the limit it gives an error message and mostly
5141 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005142 Running into the limit often means that the pattern is very
5143 inefficient or too complex. This may already happen with the pattern
5144 "\(.\)*" on a very long line. ".*" works much better.
5145 Vim may run out of memory before hitting the 'maxmempattern' limit.
5146
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147 *'maxmemtot'* *'mmt'*
5148'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5149 dependent) or half the amount of memory
5150 available)
5151 global
5152 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005153 Maximum amount of memory in Kbyte to use for all buffers together.
5154 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005155 without a limit.
5156 On 64 bit machines higher values might work. But hey, do you really
5157 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005158 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005159 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005160 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161
5162 *'menuitems'* *'mis'*
5163'menuitems' 'mis' number (default 25)
5164 global
5165 {not in Vi}
5166 {not available when compiled without the |+menu|
5167 feature}
5168 Maximum number of items to use in a menu. Used for menus that are
5169 generated from a list of items, e.g., the Buffers menu. Changing this
5170 option has no direct effect, the menu must be refreshed first.
5171
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005172 *'mkspellmem'* *'msm'*
5173'mkspellmem' 'msm' string (default "460000,2000,500")
5174 global
5175 {not in Vi}
5176 {not available when compiled without the |+syntax|
5177 feature}
5178 Parameters for |:mkspell|. This tunes when to start compressing the
5179 word tree. Compression can be slow when there are many words, but
5180 it's needed to avoid running out of memory. The amount of memory used
5181 per word depends very much on how similar the words are, that's why
5182 this tuning is complicated.
5183
5184 There are three numbers, separated by commas:
5185 {start},{inc},{added}
5186
5187 For most languages the uncompressed word tree fits in memory. {start}
5188 gives the amount of memory in Kbyte that can be used before any
5189 compression is done. It should be a bit smaller than the amount of
5190 memory that is available to Vim.
5191
5192 When going over the {start} limit the {inc} number specifies the
5193 amount of memory in Kbyte that can be allocated before another
5194 compression is done. A low number means compression is done after
5195 less words are added, which is slow. A high number means more memory
5196 will be allocated.
5197
5198 After doing compression, {added} times 1024 words can be added before
5199 the {inc} limit is ignored and compression is done when any extra
5200 amount of memory is needed. A low number means there is a smaller
5201 chance of hitting the {inc} limit, less memory is used but it's
5202 slower.
5203
5204 The languages for which these numbers are important are Italian and
5205 Hungarian. The default works for when you have about 512 Mbyte. If
5206 you have 1 Gbyte you could use: >
5207 :set mkspellmem=900000,3000,800
5208< If you have less than 512 Mbyte |:mkspell| may fail for some
5209 languages, no matter what you set 'mkspellmem' to.
5210
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005212'modeline' 'ml' boolean (Vim default: on (off for root),
5213 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 local to buffer
5215 *'modelines'* *'mls'*
5216'modelines' 'mls' number (default 5)
5217 global
5218 {not in Vi}
5219 If 'modeline' is on 'modelines' gives the number of lines that is
5220 checked for set commands. If 'modeline' is off or 'modelines' is zero
5221 no lines are checked. See |modeline|.
5222 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5223 set and to the Vim default value when 'compatible' is reset.
5224
5225 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5226'modifiable' 'ma' boolean (default on)
5227 local to buffer
5228 {not in Vi} *E21*
5229 When off the buffer contents cannot be changed. The 'fileformat' and
5230 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005231 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
5233 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5234'modified' 'mod' boolean (default off)
5235 local to buffer
5236 {not in Vi}
5237 When on, the buffer is considered to be modified. This option is set
5238 when:
5239 1. A change was made to the text since it was last written. Using the
5240 |undo| command to go back to the original text will reset the
5241 option. But undoing changes that were made before writing the
5242 buffer will set the option again, since the text is different from
5243 when it was written.
5244 2. 'fileformat' or 'fileencoding' is different from its original
5245 value. The original value is set when the buffer is read or
5246 written. A ":set nomodified" command also resets the original
5247 values to the current values and the 'modified' option will be
5248 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005249 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005250 This option is not set when a change is made to the buffer as the
5251 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5252 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5253 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5255 will be ignored.
5256
5257 *'more'* *'nomore'*
5258'more' boolean (Vim default: on, Vi default: off)
5259 global
5260 {not in Vi}
5261 When on, listings pause when the whole screen is filled. You will get
5262 the |more-prompt|. When this option is off there are no pauses, the
5263 listing continues until finished.
5264 NOTE: This option is set to the Vi default value when 'compatible' is
5265 set and to the Vim default value when 'compatible' is reset.
5266
5267 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005268'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5269 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 global
5271 {not in Vi}
5272 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005273 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5274 sysmouse and Linux console with gpm). For using the mouse in the
5275 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 The mouse can be enabled for different modes:
5277 n Normal mode
5278 v Visual mode
5279 i Insert mode
5280 c Command-line mode
5281 h all previous modes when editing a help file
5282 a all previous modes
5283 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 Normally you would enable the mouse in all four modes with: >
5285 :set mouse=a
5286< When the mouse is not enabled, the GUI will still use the mouse for
5287 modeless selection. This doesn't move the text cursor.
5288
5289 See |mouse-using|. Also see |'clipboard'|.
5290
5291 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005292 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 the mouse buttons can still be used by keeping the shift key pressed.
5294 Also see the 'clipboard' option.
5295
5296 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5297'mousefocus' 'mousef' boolean (default off)
5298 global
5299 {not in Vi}
5300 {only works in the GUI}
5301 The window that the mouse pointer is on is automatically activated.
5302 When changing the window layout or window focus in another way, the
5303 mouse pointer is moved to the window with keyboard focus. Off is the
5304 default because it makes using the pull down menus a little goofy, as
5305 a pointer transit may activate a window unintentionally.
5306
5307 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5308'mousehide' 'mh' boolean (default on)
5309 global
5310 {not in Vi}
5311 {only works in the GUI}
5312 When on, the mouse pointer is hidden when characters are typed.
5313 The mouse pointer is restored when the mouse is moved.
5314
5315 *'mousemodel'* *'mousem'*
5316'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5317 global
5318 {not in Vi}
5319 Sets the model to use for the mouse. The name mostly specifies what
5320 the right mouse button is used for:
5321 extend Right mouse button extends a selection. This works
5322 like in an xterm.
5323 popup Right mouse button pops up a menu. The shifted left
5324 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005325 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 popup_setpos Like "popup", but the cursor will be moved to the
5327 position where the mouse was clicked, and thus the
5328 selected operation will act upon the clicked object.
5329 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005330 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 course, that right clicking outside a selection will
5332 end Visual mode.
5333 Overview of what button does what for each model:
5334 mouse extend popup(_setpos) ~
5335 left click place cursor place cursor
5336 left drag start selection start selection
5337 shift-left search word extend selection
5338 right click extend selection popup menu (place cursor)
5339 right drag extend selection -
5340 middle click paste paste
5341
5342 In the "popup" model the right mouse button produces a pop-up menu.
5343 You need to define this first, see |popup-menu|.
5344
5345 Note that you can further refine the meaning of buttons with mappings.
5346 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5347 selection (because that's handled in the GUI code directly).
5348
5349 The 'mousemodel' option is set by the |:behave| command.
5350
5351 *'mouseshape'* *'mouses'* *E547*
5352'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005353 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 global
5355 {not in Vi}
5356 {only available when compiled with the |+mouseshape|
5357 feature}
5358 This option tells Vim what the mouse pointer should look like in
5359 different modes. The option is a comma separated list of parts, much
5360 like used for 'guicursor'. Each part consist of a mode/location-list
5361 and an argument-list:
5362 mode-list:shape,mode-list:shape,..
5363 The mode-list is a dash separated list of these modes/locations:
5364 In a normal window: ~
5365 n Normal mode
5366 v Visual mode
5367 ve Visual mode with 'selection' "exclusive" (same as 'v',
5368 if not specified)
5369 o Operator-pending mode
5370 i Insert mode
5371 r Replace mode
5372
5373 Others: ~
5374 c appending to the command-line
5375 ci inserting in the command-line
5376 cr replacing in the command-line
5377 m at the 'Hit ENTER' or 'More' prompts
5378 ml idem, but cursor in the last line
5379 e any mode, pointer below last window
5380 s any mode, pointer on a status line
5381 sd any mode, while dragging a status line
5382 vs any mode, pointer on a vertical separator line
5383 vd any mode, while dragging a vertical separator line
5384 a everywhere
5385
5386 The shape is one of the following:
5387 avail name looks like ~
5388 w x arrow Normal mouse pointer
5389 w x blank no pointer at all (use with care!)
5390 w x beam I-beam
5391 w x updown up-down sizing arrows
5392 w x leftright left-right sizing arrows
5393 w x busy The system's usual busy pointer
5394 w x no The system's usual 'no input' pointer
5395 x udsizing indicates up-down resizing
5396 x lrsizing indicates left-right resizing
5397 x crosshair like a big thin +
5398 x hand1 black hand
5399 x hand2 white hand
5400 x pencil what you write with
5401 x question big ?
5402 x rightup-arrow arrow pointing right-up
5403 w x up-arrow arrow pointing up
5404 x <number> any X11 pointer number (see X11/cursorfont.h)
5405
5406 The "avail" column contains a 'w' if the shape is available for Win32,
5407 x for X11.
5408 Any modes not specified or shapes not available use the normal mouse
5409 pointer.
5410
5411 Example: >
5412 :set mouseshape=s:udsizing,m:no
5413< will make the mouse turn to a sizing arrow over the status lines and
5414 indicate no input when the hit-enter prompt is displayed (since
5415 clicking the mouse has no effect in this state.)
5416
5417 *'mousetime'* *'mouset'*
5418'mousetime' 'mouset' number (default 500)
5419 global
5420 {not in Vi}
5421 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5422 time in msec between two mouse clicks for the second click to be
5423 recognized as a multi click.
5424
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005425 *'mzquantum'* *'mzq'*
5426'mzquantum' 'mzq' number (default 100)
5427 global
5428 {not in Vi}
5429 {not available when compiled without the |+mzscheme|
5430 feature}
5431 The number of milliseconds between polls for MzScheme threads.
5432 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005433 NOTE: This option is set to the Vim default value when 'compatible'
5434 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005435
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005437'nrformats' 'nf' string (default "bin,octal,hex",
5438 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439 local to buffer
5440 {not in Vi}
5441 This defines what bases Vim will consider for numbers when using the
5442 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5443 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005444 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005446 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005447 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005449 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 considered to be hexadecimal. Example: Using CTRL-X on
5451 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005452 bin If included, numbers starting with "0b" or "0B" will be
5453 considered to be binary. Example: Using CTRL-X on
5454 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 Numbers which simply begin with a digit in the range 1-9 are always
5456 considered decimal. This also happens for numbers that are not
5457 recognized as octal or hex.
5458
5459 *'number'* *'nu'* *'nonumber'* *'nonu'*
5460'number' 'nu' boolean (default off)
5461 local to window
5462 Print the line number in front of each line. When the 'n' option is
5463 excluded from 'cpoptions' a wrapped line will not use the column of
5464 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005465 The 'numberwidth' option can be used to set the room used for the line
5466 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 When a long, wrapped line doesn't start with the first character, '-'
5468 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005469 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5470 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005471 *number_relativenumber*
5472 The 'relativenumber' option changes the displayed number to be
5473 relative to the cursor. Together with 'number' there are these
5474 four combinations (cursor in line 3):
5475
Bram Moolenaar3848e002016-03-19 18:42:29 +01005476 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005477 'nornu' 'nornu' 'rnu' 'rnu'
5478
5479 |apple | 1 apple | 2 apple | 2 apple
5480 |pear | 2 pear | 1 pear | 1 pear
5481 |nobody | 3 nobody | 0 nobody |3 nobody
5482 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005484 *'numberwidth'* *'nuw'*
5485'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5486 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005487 {not in Vi}
5488 {only available when compiled with the |+linebreak|
5489 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005490 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005491 when the 'number' or 'relativenumber' option is set or printing lines
5492 with a line number. Since one space is always between the number and
5493 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005494 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005495 fit the highest line number in the buffer respectively the number of
5496 rows in the window, depending on whether 'number' or 'relativenumber'
5497 is set. Thus with the Vim default of 4 there is room for a line number
5498 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005499 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005500 NOTE: This option is set to the Vi default value when 'compatible' is
5501 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005502
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005503 *'omnifunc'* *'ofu'*
5504'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005505 local to buffer
5506 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005507 {not available when compiled without the |+eval|
5508 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005509 This option specifies a function to be used for Insert mode omni
5510 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005511 See |complete-functions| for an explanation of how the function is
5512 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005513 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005514 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005515 This option cannot be set from a |modeline| or in the |sandbox|, for
5516 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005517
5518
Bram Moolenaar02467872007-05-06 13:22:01 +00005519 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005520'opendevice' 'odev' boolean (default off)
5521 global
5522 {not in Vi}
5523 {only for MS-DOS, MS-Windows and OS/2}
5524 Enable reading and writing from devices. This may get Vim stuck on a
5525 device that can be opened but doesn't actually do the I/O. Therefore
5526 it is off by default.
5527 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5528 result in editing a device.
5529
5530
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005531 *'operatorfunc'* *'opfunc'*
5532'operatorfunc' 'opfunc' string (default: empty)
5533 global
5534 {not in Vi}
5535 This option specifies a function to be called by the |g@| operator.
5536 See |:map-operator| for more info and an example.
5537
5538 This option cannot be set from a |modeline| or in the |sandbox|, for
5539 security reasons.
5540
5541
Bram Moolenaar251e1912011-06-19 05:09:16 +02005542 *'osfiletype'* *'oft'*
5543'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 local to buffer
5545 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005546 This option was supported on RISC OS, which has been removed.
5547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005549 *'packpath'* *'pp'*
5550'packpath' 'pp' string (default: see 'runtimepath')
5551 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005552 Directories used to find packages. See |packages|.
5553
5554
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005556'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005557 global
5558 Specifies the nroff macros that separate paragraphs. These are pairs
5559 of two letters (see |object-motions|).
5560
5561 *'paste'* *'nopaste'*
5562'paste' boolean (default off)
5563 global
5564 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005565 Put Vim in Paste mode. This is useful if you want to cut or copy
5566 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 unexpected effects.
5568 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005569 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 knows about pasting and will mostly do the right thing without 'paste'
5571 being set. The same is true for a terminal where Vim handles the
5572 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005573 This option is reset when starting the GUI. Thus if you set it in
5574 your .vimrc it will work in a terminal, but not in the GUI. Setting
5575 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5576 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 When the 'paste' option is switched on (also when it was already on):
5578 - mapping in Insert mode and Command-line mode is disabled
5579 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005581 - 'expandtab' is reset
5582 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 - 'revins' is reset
5584 - 'ruler' is reset
5585 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005586 - 'smartindent' is reset
5587 - 'smarttab' is reset
5588 - 'softtabstop' is set to 0
5589 - 'textwidth' is set to 0
5590 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005593 - 'indentexpr'
5594 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 NOTE: When you start editing another file while the 'paste' option is
5596 on, settings from the modelines or autocommands may change the
5597 settings again, causing trouble when pasting text. You might want to
5598 set the 'paste' option again.
5599 When the 'paste' option is reset the mentioned options are restored to
5600 the value before the moment 'paste' was switched from off to on.
5601 Resetting 'paste' before ever setting it does not have any effect.
5602 Since mapping doesn't work while 'paste' is active, you need to use
5603 the 'pastetoggle' option to toggle the 'paste' option with some key.
5604
5605 *'pastetoggle'* *'pt'*
5606'pastetoggle' 'pt' string (default "")
5607 global
5608 {not in Vi}
5609 When non-empty, specifies the key sequence that toggles the 'paste'
5610 option. This is like specifying a mapping: >
5611 :map {keys} :set invpaste<CR>
5612< Where {keys} is the value of 'pastetoggle'.
5613 The difference is that it will work even when 'paste' is set.
5614 'pastetoggle' works in Insert mode and Normal mode, but not in
5615 Command-line mode.
5616 Mappings are checked first, thus overrule 'pastetoggle'. However,
5617 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5618 this: >
5619 :map <F10> :set paste<CR>
5620 :map <F11> :set nopaste<CR>
5621 :imap <F10> <C-O>:set paste<CR>
5622 :imap <F11> <nop>
5623 :set pastetoggle=<F11>
5624< This will make <F10> start paste mode and <F11> stop paste mode.
5625 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5626 mode everything is inserted literally, except the 'pastetoggle' key
5627 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005628 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629
5630 *'pex'* *'patchexpr'*
5631'patchexpr' 'pex' string (default "")
5632 global
5633 {not in Vi}
5634 {not available when compiled without the |+diff|
5635 feature}
5636 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005637 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638
Bram Moolenaardbc28022014-07-26 13:40:44 +02005639 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640'patchmode' 'pm' string (default "")
5641 global
5642 {not in Vi}
5643 When non-empty the oldest version of a file is kept. This can be used
5644 to keep the original version of a file if you are changing files in a
5645 source distribution. Only the first time that a file is written a
5646 copy of the original file will be kept. The name of the copy is the
5647 name of the original file with the string in the 'patchmode' option
5648 appended. This option should start with a dot. Use a string like
5649 ".org". 'backupdir' must not be empty for this to work (Detail: The
5650 backup file is renamed to the patchmode file after the new file has
5651 been successfully written, that's why it must be possible to write a
5652 backup file). If there was no file to be backed up, an empty file is
5653 created.
5654 When the 'backupskip' pattern matches, a patchmode file is not made.
5655 Using 'patchmode' for compressed files appends the extension at the
5656 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5657 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005658 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005660 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661'path' 'pa' string (default on Unix: ".,/usr/include,,"
5662 on OS/2: ".,/emx/include,,"
5663 other systems: ".,,")
5664 global or local to buffer |global-local|
5665 {not in Vi}
5666 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005667 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5668 provided that the file being searched for has a relative path (not
5669 starting with "/", "./" or "../"). The directories in the 'path'
5670 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 - Use commas to separate directory names: >
5672 :set path=.,/usr/local/include,/usr/include
5673< - Spaces can also be used to separate directory names (for backwards
5674 compatibility with version 3.0). To have a space in a directory
5675 name, precede it with an extra backslash, and escape the space: >
5676 :set path=.,/dir/with\\\ space
5677< - To include a comma in a directory name precede it with an extra
5678 backslash: >
5679 :set path=.,/dir/with\\,comma
5680< - To search relative to the directory of the current file, use: >
5681 :set path=.
5682< - To search in the current directory use an empty string between two
5683 commas: >
5684 :set path=,,
5685< - A directory name may end in a ':' or '/'.
5686 - Environment variables are expanded |:set_env|.
5687 - When using |netrw.vim| URLs can be used. For example, adding
5688 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005689 - Search upwards and downwards in a directory tree using "*", "**" and
5690 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 {not available when compiled without the |+path_extra| feature}
5692 - Careful with '\' characters, type two to get one in the option: >
5693 :set path=.,c:\\include
5694< Or just use '/' instead: >
5695 :set path=.,c:/include
5696< Don't forget "." or files won't even be found in the same directory as
5697 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005698 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 it is something like 256 or 1024 characters.
5700 You can check if all the include files are found, using the value of
5701 'path', see |:checkpath|.
5702 The use of |:set+=| and |:set-=| is preferred when adding or removing
5703 directories from the list. This avoids problems when a future version
5704 uses another default. To remove the current directory use: >
5705 :set path-=
5706< To add the current directory use: >
5707 :set path+=
5708< To use an environment variable, you probably need to replace the
5709 separator. Here is an example to append $INCL, in which directory
5710 names are separated with a semi-colon: >
5711 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5712< Replace the ';' with a ':' or whatever separator is used. Note that
5713 this doesn't work when $INCL contains a comma or white space.
5714
Bram Moolenaard94464e2015-11-02 15:28:18 +01005715 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005716'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005717 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005718 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005719 {only available when compiled with the |+perl/dyn|
5720 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005721 Specifies the name of the Perl shared library. The default is
5722 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005723 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005724 This option cannot be set from a |modeline| or in the |sandbox|, for
5725 security reasons.
5726
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5728'preserveindent' 'pi' boolean (default off)
5729 local to buffer
5730 {not in Vi}
5731 When changing the indent of the current line, preserve as much of the
5732 indent structure as possible. Normally the indent is replaced by a
5733 series of tabs followed by spaces as required (unless |'expandtab'| is
5734 enabled, in which case only spaces are used). Enabling this option
5735 means the indent will preserve as many existing characters as possible
5736 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005737 'expandtab' does not apply to the preserved white space, a Tab remains
5738 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 NOTE: When using ">>" multiple times the resulting indent is a mix of
5740 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005741 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 Also see 'copyindent'.
5743 Use |:retab| to clean up white space.
5744
5745 *'previewheight'* *'pvh'*
5746'previewheight' 'pvh' number (default 12)
5747 global
5748 {not in Vi}
5749 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005750 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 Default height for a preview window. Used for |:ptag| and associated
5752 commands. Used for |CTRL-W_}| when no count is given.
5753
5754 *'previewwindow'* *'nopreviewwindow'*
5755 *'pvw'* *'nopvw'* *E590*
5756'previewwindow' 'pvw' boolean (default off)
5757 local to window
5758 {not in Vi}
5759 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005760 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005761 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 set. It's normally not set directly, but by using one of the commands
5763 |:ptag|, |:pedit|, etc.
5764
5765 *'printdevice'* *'pdev'*
5766'printdevice' 'pdev' string (default empty)
5767 global
5768 {not in Vi}
5769 {only available when compiled with the |+printer|
5770 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005771 The name of the printer to be used for |:hardcopy|.
5772 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005773 This option cannot be set from a |modeline| or in the |sandbox|, for
5774 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775
Bram Moolenaar8299df92004-07-10 09:47:34 +00005776 *'printencoding'* *'penc'*
5777'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 global
5779 {not in Vi}
5780 {only available when compiled with the |+printer|
5781 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005782 Sets the character encoding used when printing.
5783 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784
5785 *'printexpr'* *'pexpr'*
5786'printexpr' 'pexpr' String (default: see below)
5787 global
5788 {not in Vi}
5789 {only available when compiled with the |+printer|
5790 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005791 Expression used to print the PostScript produced with |:hardcopy|.
5792 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005793 This option cannot be set from a |modeline| or in the |sandbox|, for
5794 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795
Bram Moolenaar8299df92004-07-10 09:47:34 +00005796 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797'printfont' 'pfn' string (default "courier")
5798 global
5799 {not in Vi}
5800 {only available when compiled with the |+printer|
5801 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005802 The name of the font that will be used for |:hardcopy|.
5803 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005804
5805 *'printheader'* *'pheader'*
5806'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5807 global
5808 {not in Vi}
5809 {only available when compiled with the |+printer|
5810 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005811 The format of the header produced in |:hardcopy| output.
5812 See |pheader-option|.
5813
5814 *'printmbcharset'* *'pmbcs'*
5815'printmbcharset' 'pmbcs' string (default "")
5816 global
5817 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005818 {only available when compiled with the |+printer|,
5819 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005820 The CJK character set to be used for CJK output from |:hardcopy|.
5821 See |pmbcs-option|.
5822
5823 *'printmbfont'* *'pmbfn'*
5824'printmbfont' 'pmbfn' string (default "")
5825 global
5826 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005827 {only available when compiled with the |+printer|,
5828 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005829 List of font names to be used for CJK output from |:hardcopy|.
5830 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831
5832 *'printoptions'* *'popt'*
5833'printoptions' 'popt' string (default "")
5834 global
5835 {not in Vi}
5836 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005837 List of items that control the format of the output of |:hardcopy|.
5838 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005840 *'prompt'* *'noprompt'*
5841'prompt' boolean (default on)
5842 global
5843 When on a ":" prompt is used in Ex mode.
5844
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005845 *'pumheight'* *'ph'*
5846'pumheight' 'ph' number (default 0)
5847 global
5848 {not available when compiled without the
5849 |+insert_expand| feature}
5850 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005851 Determines the maximum number of items to show in the popup menu for
5852 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005853 |ins-completion-menu|.
5854
Bram Moolenaard94464e2015-11-02 15:28:18 +01005855 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005856'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005857 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005858 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005859 {only available when compiled with the |+python/dyn|
5860 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005861 Specifies the name of the Python 2.x shared library. The default is
5862 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005863 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005864 This option cannot be set from a |modeline| or in the |sandbox|, for
5865 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005866
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005867 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005868'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005869 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005870 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005871 {only available when compiled with the |+python3/dyn|
5872 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005873 Specifies the name of the Python 3 shared library. The default is
5874 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005875 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005879 *'pyxversion'* *'pyx'*
5880'pyxversion' 'pyx' number (default depends on the build)
5881 global
5882 {not in Vi}
5883 {only available when compiled with the |+python| or
5884 the |+python3| feature}
5885 Specifies the python version used for pyx* functions and commands
5886 |python_x|. The default value is as follows:
5887
5888 Compiled with Default ~
5889 |+python| and |+python3| 0
5890 only |+python| 2
5891 only |+python3| 3
5892
5893 Available values are 0, 2 and 3.
5894 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5895 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5896 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5897 to 2 if Python 2 is available.
5898 See also: |has-pythonx|
5899
5900 If Vim is compiled with only |+python| or |+python3| setting
5901 'pyxversion' has no effect. The pyx* functions and commands are
5902 always the same as the compiled version.
5903
5904 This option cannot be set from a |modeline| or in the |sandbox|, for
5905 security reasons.
5906
Bram Moolenaar677ee682005-01-27 14:41:15 +00005907 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005908'quoteescape' 'qe' string (default "\")
5909 local to buffer
5910 {not in Vi}
5911 The characters that are used to escape quotes in a string. Used for
5912 objects like a', a" and a` |a'|.
5913 When one of the characters in this option is found inside a string,
5914 the following character will be skipped. The default value makes the
5915 text "foo\"bar\\" considered to be one string.
5916
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5918'readonly' 'ro' boolean (default off)
5919 local to buffer
5920 If on, writes fail unless you use a '!'. Protects you from
5921 accidentally overwriting a file. Default on when Vim is started
5922 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005923 When using ":w!" the 'readonly' option is reset for the current
5924 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005926 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005927 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005929 *'redrawtime'* *'rdt'*
5930'redrawtime' 'rdt' number (default 2000)
5931 global
5932 {not in Vi}
5933 {only available when compiled with the |+reltime|
5934 feature}
5935 The time in milliseconds for redrawing the display. This applies to
5936 searching for patterns for 'hlsearch' and |:match| highlighting.
5937 When redrawing takes more than this many milliseconds no further
5938 matches will be highlighted. This is used to avoid that Vim hangs
5939 when using a very complicated pattern.
5940
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005941 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005942'regexpengine' 're' number (default 0)
5943 global
5944 {not in Vi}
5945 This selects the default regexp engine. |two-engines|
5946 The possible values are:
5947 0 automatic selection
5948 1 old engine
5949 2 NFA engine
5950 Note that when using the NFA engine and the pattern contains something
5951 that is not supported the pattern will not match. This is only useful
5952 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005953 Using automatic selection enables Vim to switch the engine, if the
5954 default engine becomes too costly. E.g., when the NFA engine uses too
5955 many states. This should prevent Vim from hanging on a combination of
5956 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005957
Bram Moolenaar64486672010-05-16 15:46:46 +02005958 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5959'relativenumber' 'rnu' boolean (default off)
5960 local to window
5961 {not in Vi}
5962 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005963 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005964 precede some vertical motion commands (e.g. j k + -) with, without
5965 having to calculate it yourself. Especially useful in combination with
5966 other commands (e.g. y d c < > gq gw =).
5967 When the 'n' option is excluded from 'cpoptions' a wrapped
5968 line will not use the column of line numbers (this is the default when
5969 'compatible' isn't set).
5970 The 'numberwidth' option can be used to set the room used for the line
5971 number.
5972 When a long, wrapped line doesn't start with the first character, '-'
5973 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005974 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5975 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005976
5977 The number in front of the cursor line also depends on the value of
5978 'number', see |number_relativenumber| for all combinations of the two
5979 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005980
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 *'remap'* *'noremap'*
5982'remap' boolean (default on)
5983 global
5984 Allows for mappings to work recursively. If you do not want this for
5985 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005986 NOTE: To avoid portability problems with Vim scripts, always keep
5987 this option at the default "on". Only switch it off when working with
5988 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005990 *'renderoptions'* *'rop'*
5991'renderoptions' 'rop' string (default: empty)
5992 global
5993 {not in Vi}
5994 {only available when compiled with GUI and DIRECTX on
5995 MS-Windows}
5996 Select a text renderer and set its options. The options depend on the
5997 renderer.
5998
5999 Syntax: >
6000 set rop=type:{renderer}(,{name}:{value})*
6001<
6002 Currently, only one optional renderer is available.
6003
6004 render behavior ~
6005 directx Vim will draw text using DirectX (DirectWrite). It makes
6006 drawn glyphs more beautiful than default GDI.
6007 It requires 'encoding' is "utf-8", and only works on
6008 MS-Windows Vista or newer version.
6009
6010 Options:
6011 name meaning type value ~
6012 gamma gamma float 1.0 - 2.2 (maybe)
6013 contrast enhancedContrast float (unknown)
6014 level clearTypeLevel float (unknown)
6015 geom pixelGeometry int 0 - 2 (see below)
6016 renmode renderingMode int 0 - 6 (see below)
6017 taamode textAntialiasMode int 0 - 3 (see below)
6018
6019 See this URL for detail:
6020 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6021
6022 For geom: structure of a device pixel.
6023 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6024 1 - DWRITE_PIXEL_GEOMETRY_RGB
6025 2 - DWRITE_PIXEL_GEOMETRY_BGR
6026
6027 See this URL for detail:
6028 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6029
6030 For renmode: method of rendering glyphs.
6031 0 - DWRITE_RENDERING_MODE_DEFAULT
6032 1 - DWRITE_RENDERING_MODE_ALIASED
6033 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6034 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6035 4 - DWRITE_RENDERING_MODE_NATURAL
6036 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6037 6 - DWRITE_RENDERING_MODE_OUTLINE
6038
6039 See this URL for detail:
6040 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6041
6042 For taamode: antialiasing mode used for drawing text.
6043 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6044 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6045 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6046 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6047
6048 See this URL for detail:
6049 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6050
6051 Example: >
6052 set encoding=utf-8
6053 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6054 set rop=type:directx
6055<
6056 If select a raster font (Courier, Terminal or FixedSys) to
6057 'guifont', it fallbacks to be drawn by GDI automatically.
6058
6059 Other render types are currently not supported.
6060
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 *'report'*
6062'report' number (default 2)
6063 global
6064 Threshold for reporting number of lines changed. When the number of
6065 changed lines is more than 'report' a message will be given for most
6066 ":" commands. If you want it always, set 'report' to 0.
6067 For the ":substitute" command the number of substitutions is used
6068 instead of the number of lines.
6069
6070 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6071'restorescreen' 'rs' boolean (default on)
6072 global
6073 {not in Vi} {only in Windows 95/NT console version}
6074 When set, the screen contents is restored when exiting Vim. This also
6075 happens when executing external commands.
6076
6077 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6078 options in your .vimrc. To disable restoring:
6079 set t_ti= t_te=
6080 To enable restoring (for an xterm):
6081 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6082 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6083
6084 *'revins'* *'ri'* *'norevins'* *'nori'*
6085'revins' 'ri' boolean (default off)
6086 global
6087 {not in Vi}
6088 {only available when compiled with the |+rightleft|
6089 feature}
6090 Inserting characters in Insert mode will work backwards. See "typing
6091 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6092 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006093 NOTE: This option is reset when 'compatible' is set.
6094 This option is reset when 'paste' is set and restored when 'paste' is
6095 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096
6097 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6098'rightleft' 'rl' boolean (default off)
6099 local to window
6100 {not in Vi}
6101 {only available when compiled with the |+rightleft|
6102 feature}
6103 When on, display orientation becomes right-to-left, i.e., characters
6104 that are stored in the file appear from the right to the left.
6105 Using this option, it is possible to edit files for languages that
6106 are written from the right to the left such as Hebrew and Arabic.
6107 This option is per window, so it is possible to edit mixed files
6108 simultaneously, or to view the same file in both ways (this is
6109 useful whenever you have a mixed text file with both right-to-left
6110 and left-to-right strings so that both sets are displayed properly
6111 in different windows). Also see |rileft.txt|.
6112
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006113 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114'rightleftcmd' 'rlc' string (default "search")
6115 local to window
6116 {not in Vi}
6117 {only available when compiled with the |+rightleft|
6118 feature}
6119 Each word in this option enables the command line editing to work in
6120 right-to-left mode for a group of commands:
6121
6122 search "/" and "?" commands
6123
6124 This is useful for languages such as Hebrew, Arabic and Farsi.
6125 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6126
Bram Moolenaard94464e2015-11-02 15:28:18 +01006127 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006128'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006129 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006130 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006131 {only available when compiled with the |+ruby/dyn|
6132 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006133 Specifies the name of the Ruby shared library. The default is
6134 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006135 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006136 This option cannot be set from a |modeline| or in the |sandbox|, for
6137 security reasons.
6138
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006140'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 global
6142 {not in Vi}
6143 {not available when compiled without the
6144 |+cmdline_info| feature}
6145 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006146 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 text in the file is shown on the far right:
6148 Top first line is visible
6149 Bot last line is visible
6150 All first and last line are visible
6151 45% relative position in the file
6152 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006153 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006154 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006155 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 this option takes precedence over 'ruler' and 'rulerformat'
6157 If the number of characters displayed is different from the number of
6158 bytes in the text (e.g., for a TAB or a multi-byte character), both
6159 the text column (byte number) and the screen column are shown,
6160 separated with a dash.
6161 For an empty line "0-1" is shown.
6162 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006163 This option is reset when 'paste' is set and restored when 'paste' is
6164 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 If you don't want to see the ruler all the time but want to know where
6166 you are, use "g CTRL-G" |g_CTRL-G|.
6167 NOTE: This option is reset when 'compatible' is set.
6168
6169 *'rulerformat'* *'ruf'*
6170'rulerformat' 'ruf' string (default empty)
6171 global
6172 {not in Vi}
6173 {not available when compiled without the |+statusline|
6174 feature}
6175 When this option is not empty, it determines the content of the ruler
6176 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006177 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 The default ruler width is 17 characters. To make the ruler 15
6179 characters wide, put "%15(" at the start and "%)" at the end.
6180 Example: >
6181 :set rulerformat=%15(%c%V\ %p%%%)
6182<
6183 *'runtimepath'* *'rtp'* *vimfiles*
6184'runtimepath' 'rtp' string (default:
6185 Unix: "$HOME/.vim,
6186 $VIM/vimfiles,
6187 $VIMRUNTIME,
6188 $VIM/vimfiles/after,
6189 $HOME/.vim/after"
6190 Amiga: "home:vimfiles,
6191 $VIM/vimfiles,
6192 $VIMRUNTIME,
6193 $VIM/vimfiles/after,
6194 home:vimfiles/after"
6195 PC, OS/2: "$HOME/vimfiles,
6196 $VIM/vimfiles,
6197 $VIMRUNTIME,
6198 $VIM/vimfiles/after,
6199 $HOME/vimfiles/after"
6200 Macintosh: "$VIM:vimfiles,
6201 $VIMRUNTIME,
6202 $VIM:vimfiles:after"
6203 RISC-OS: "Choices:vimfiles,
6204 $VIMRUNTIME,
6205 Choices:vimfiles/after"
6206 VMS: "sys$login:vimfiles,
6207 $VIM/vimfiles,
6208 $VIMRUNTIME,
6209 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006210 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 global
6212 {not in Vi}
6213 This is a list of directories which will be searched for runtime
6214 files:
6215 filetype.vim filetypes by file name |new-filetype|
6216 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006217 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 colors/ color scheme files |:colorscheme|
6219 compiler/ compiler files |:compiler|
6220 doc/ documentation |write-local-help|
6221 ftplugin/ filetype plugins |write-filetype-plugin|
6222 indent/ indent scripts |indent-expression|
6223 keymap/ key mapping files |mbyte-keymap|
6224 lang/ menu translations |:menutrans|
6225 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006226 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227 plugin/ plugin scripts |write-plugin|
6228 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006229 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 syntax/ syntax files |mysyntaxfile|
6231 tutor/ files for vimtutor |tutor|
6232
6233 And any other file searched for with the |:runtime| command.
6234
6235 The defaults for most systems are setup to search five locations:
6236 1. In your home directory, for your personal preferences.
6237 2. In a system-wide Vim directory, for preferences from the system
6238 administrator.
6239 3. In $VIMRUNTIME, for files distributed with Vim.
6240 *after-directory*
6241 4. In the "after" directory in the system-wide Vim directory. This is
6242 for the system administrator to overrule or add to the distributed
6243 defaults (rarely needed)
6244 5. In the "after" directory in your home directory. This is for
6245 personal preferences to overrule or add to the distributed defaults
6246 or system-wide settings (rarely needed).
6247
Bram Moolenaard0796902016-09-16 20:02:31 +02006248 More entries are added when using |packages|. If it gets very long
6249 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6250 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006251
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6253 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006254 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 wildcards.
6256 See |:runtime|.
6257 Example: >
6258 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6259< This will use the directory "~/vimruntime" first (containing your
6260 personal Vim runtime files), then "/mygroup/vim" (shared between a
6261 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6262 files).
6263 You probably should always include $VIMRUNTIME somewhere, to use the
6264 distributed runtime files. You can put a directory before $VIMRUNTIME
6265 to find files which replace a distributed runtime files. You can put
6266 a directory after $VIMRUNTIME to find files which add to distributed
6267 runtime files.
6268 This option cannot be set from a |modeline| or in the |sandbox|, for
6269 security reasons.
6270
6271 *'scroll'* *'scr'*
6272'scroll' 'scr' number (default: half the window height)
6273 local to window
6274 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6275 set to half the number of lines in the window when the window size
6276 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006277 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6279 the number of screen lines instead of file lines, makes a difference
6280 when lines wrap}
6281
6282 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6283'scrollbind' 'scb' boolean (default off)
6284 local to window
6285 {not in Vi}
6286 {not available when compiled without the |+scrollbind|
6287 feature}
6288 See also |scroll-binding|. When this option is set, the current
6289 window scrolls as other scrollbind windows (windows that also have
6290 this option set) scroll. This option is useful for viewing the
6291 differences between two versions of a file, see 'diff'.
6292 See |'scrollopt'| for options that determine how this option should be
6293 interpreted.
6294 This option is mostly reset when splitting a window to edit another
6295 file. This means that ":split | edit file" results in two windows
6296 with scroll-binding, but ":split file" does not.
6297
6298 *'scrolljump'* *'sj'*
6299'scrolljump' 'sj' number (default 1)
6300 global
6301 {not in Vi}
6302 Minimal number of lines to scroll when the cursor gets off the
6303 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6304 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006305 When set to a negative number from -1 to -100 this is used as the
6306 percentage of the window height. Thus -50 scrolls half the window
6307 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 NOTE: This option is set to 1 when 'compatible' is set.
6309
6310 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006311'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 global
6313 {not in Vi}
6314 Minimal number of screen lines to keep above and below the cursor.
6315 This will make some context visible around where you are working. If
6316 you set it to a very large value (999) the cursor line will always be
6317 in the middle of the window (except at the start or end of the file or
6318 when long lines wrap).
6319 For scrolling horizontally see 'sidescrolloff'.
6320 NOTE: This option is set to 0 when 'compatible' is set.
6321
6322 *'scrollopt'* *'sbo'*
6323'scrollopt' 'sbo' string (default "ver,jump")
6324 global
6325 {not available when compiled without the |+scrollbind|
6326 feature}
6327 {not in Vi}
6328 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006329 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6330 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 The following words are available:
6332 ver Bind vertical scrolling for 'scrollbind' windows
6333 hor Bind horizontal scrolling for 'scrollbind' windows
6334 jump Applies to the offset between two windows for vertical
6335 scrolling. This offset is the difference in the first
6336 displayed line of the bound windows. When moving
6337 around in a window, another 'scrollbind' window may
6338 reach a position before the start or after the end of
6339 the buffer. The offset is not changed though, when
6340 moving back the 'scrollbind' window will try to scroll
6341 to the desired position when possible.
6342 When now making that window the current one, two
6343 things can be done with the relative offset:
6344 1. When "jump" is not included, the relative offset is
6345 adjusted for the scroll position in the new current
6346 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006347 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 2. When "jump" is included, the other windows are
6349 scrolled to keep the same relative offset. When
6350 going back to the other window, it still uses the
6351 same relative offset.
6352 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006353 When 'diff' mode is active there always is vertical scroll binding,
6354 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355
6356 *'sections'* *'sect'*
6357'sections' 'sect' string (default "SHNHH HUnhsh")
6358 global
6359 Specifies the nroff macros that separate sections. These are pairs of
6360 two letters (See |object-motions|). The default makes a section start
6361 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6362
6363 *'secure'* *'nosecure'* *E523*
6364'secure' boolean (default off)
6365 global
6366 {not in Vi}
6367 When on, ":autocmd", shell and write commands are not allowed in
6368 ".vimrc" and ".exrc" in the current directory and map commands are
6369 displayed. Switch it off only if you know that you will not run into
6370 problems, or when the 'exrc' option is off. On Unix this option is
6371 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006372 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 'secure' at the end of your ~/.vimrc then.
6374 This option cannot be set from a |modeline| or in the |sandbox|, for
6375 security reasons.
6376
6377 *'selection'* *'sel'*
6378'selection' 'sel' string (default "inclusive")
6379 global
6380 {not in Vi}
6381 This option defines the behavior of the selection. It is only used
6382 in Visual and Select mode.
6383 Possible values:
6384 value past line inclusive ~
6385 old no yes
6386 inclusive yes yes
6387 exclusive yes no
6388 "past line" means that the cursor is allowed to be positioned one
6389 character past the line.
6390 "inclusive" means that the last character of the selection is included
6391 in an operation. For example, when "x" is used to delete the
6392 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006393 When "old" is used and 'virtualedit' allows the cursor to move past
6394 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 Note that when "exclusive" is used and selecting from the end
6396 backwards, you cannot include the last character of a line, when
6397 starting in Normal mode and 'virtualedit' empty.
6398
6399 The 'selection' option is set by the |:behave| command.
6400
6401 *'selectmode'* *'slm'*
6402'selectmode' 'slm' string (default "")
6403 global
6404 {not in Vi}
6405 This is a comma separated list of words, which specifies when to start
6406 Select mode instead of Visual mode, when a selection is started.
6407 Possible values:
6408 mouse when using the mouse
6409 key when using shifted special keys
6410 cmd when using "v", "V" or CTRL-V
6411 See |Select-mode|.
6412 The 'selectmode' option is set by the |:behave| command.
6413
6414 *'sessionoptions'* *'ssop'*
6415'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006416 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 global
6418 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006419 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 feature}
6421 Changes the effect of the |:mksession| command. It is a comma
6422 separated list of words. Each word enables saving and restoring
6423 something:
6424 word save and restore ~
6425 blank empty windows
6426 buffers hidden and unloaded buffers, not just those in windows
6427 curdir the current directory
6428 folds manually created folds, opened/closed folds and local
6429 fold options
6430 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006431 and contain at least one lowercase letter. Only
6432 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 help the help window
6434 localoptions options and mappings local to a window or buffer (not
6435 global values for local options)
6436 options all options and mappings (also global values for local
6437 options)
6438 resize size of the Vim window: 'lines' and 'columns'
6439 sesdir the directory in which the session file is located
6440 will become the current directory (useful with
6441 projects accessed over a network from different
6442 systems)
6443 slash backslashes in file names replaced with forward
6444 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006445 tabpages all tab pages; without this only the current tab page
6446 is restored, so that you can make a session for each
6447 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 unix with Unix end-of-line format (single <NL>), even when
6449 on Windows or DOS
6450 winpos position of the whole Vim window
6451 winsize window sizes
6452
6453 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006454 When neither "curdir" nor "sesdir" is included, file names are stored
6455 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 "slash" and "unix" are useful on Windows when sharing session files
6457 with Unix. The Unix version of Vim cannot source dos format scripts,
6458 but the Windows version of Vim can source unix format scripts.
6459
6460 *'shell'* *'sh'* *E91*
6461'shell' 'sh' string (default $SHELL or "sh",
6462 MS-DOS and Win32: "command.com" or
6463 "cmd.exe", OS/2: "cmd")
6464 global
6465 Name of the shell to use for ! and :! commands. When changing the
6466 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6467 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006468 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 See |option-backslash| about including spaces and backslashes.
6470 Environment variables are expanded |:set_env|.
6471 If the name of the shell contains a space, you might need to enclose
6472 it in quotes. Example: >
6473 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6474< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 "-f" is not inside the quotes, because it is not part of the command
6477 name. And Vim automagically recognizes the backslashes that are path
6478 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 Under MS-Windows, when the executable ends in ".com" it must be
6480 included. Thus setting the shell to "command.com" or "4dos.com"
6481 works, but "command" and "4dos" do not work for all commands (e.g.,
6482 filtering).
6483 For unknown reasons, when using "4dos.com" the current directory is
6484 changed to "C:\". To avoid this set 'shell' like this: >
6485 :set shell=command.com\ /c\ 4dos
6486< This option cannot be set from a |modeline| or in the |sandbox|, for
6487 security reasons.
6488
6489 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006490'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006491 MS-DOS and Win32, when 'shell' does not
6492 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 global
6494 {not in Vi}
6495 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6496 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6497 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006498 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006499 On Unix it can have more than one flag. Each white space separated
6500 part is passed as an argument to the shell command.
6501 See |option-backslash| about including spaces and backslashes.
6502 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 This option cannot be set from a |modeline| or in the |sandbox|, for
6504 security reasons.
6505
6506 *'shellpipe'* *'sp'*
6507'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6508 global
6509 {not in Vi}
6510 {not available when compiled without the |+quickfix|
6511 feature}
6512 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006513 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 including spaces and backslashes.
6515 The name of the temporary file can be represented by "%s" if necessary
6516 (the file name is appended automatically if no %s appears in the value
6517 of this option).
6518 For the Amiga and MS-DOS the default is ">". The output is directly
6519 saved in a file and not echoed to the screen.
6520 For Unix the default it "| tee". The stdout of the compiler is saved
6521 in a file and echoed to the screen. If the 'shell' option is "csh" or
6522 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006523 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6524 default becomes "2>&1| tee". This means that stderr is also included.
6525 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6526 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 The initialization of this option is done after reading the ".vimrc"
6528 and the other initializations, so that when the 'shell' option is set
6529 there, the 'shellpipe' option changes automatically, unless it was
6530 explicitly set before.
6531 When 'shellpipe' is set to an empty string, no redirection of the
6532 ":make" output will be done. This is useful if you use a 'makeprg'
6533 that writes to 'makeef' by itself. If you want no piping, but do
6534 want to include the 'makeef', set 'shellpipe' to a single space.
6535 Don't forget to precede the space with a backslash: ":set sp=\ ".
6536 In the future pipes may be used for filtering and this option will
6537 become obsolete (at least for Unix).
6538 This option cannot be set from a |modeline| or in the |sandbox|, for
6539 security reasons.
6540
6541 *'shellquote'* *'shq'*
6542'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6543 contains "sh" somewhere: "\"")
6544 global
6545 {not in Vi}
6546 Quoting character(s), put around the command passed to the shell, for
6547 the "!" and ":!" commands. The redirection is kept outside of the
6548 quoting. See 'shellxquote' to include the redirection. It's
6549 probably not useful to set both options.
6550 This is an empty string by default. Only known to be useful for
6551 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6552 or bash, where it should be "\"". The default is adjusted according
6553 the value of 'shell', to reduce the need to set this option by the
6554 user. See |dos-shell|.
6555 This option cannot be set from a |modeline| or in the |sandbox|, for
6556 security reasons.
6557
6558 *'shellredir'* *'srr'*
6559'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6560 global
6561 {not in Vi}
6562 String to be used to put the output of a filter command in a temporary
6563 file. See also |:!|. See |option-backslash| about including spaces
6564 and backslashes.
6565 The name of the temporary file can be represented by "%s" if necessary
6566 (the file name is appended automatically if no %s appears in the value
6567 of this option).
6568 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6569 or "zsh" during initializations, the default becomes ">&". If the
6570 'shell' option is "sh", "ksh" or "bash" the default becomes
6571 ">%s 2>&1". This means that stderr is also included.
6572 For Win32, the Unix checks are done and additionally "cmd" is checked
6573 for, which makes the default ">%s 2>&1". Also, the same names with
6574 ".exe" appended are checked for.
6575 The initialization of this option is done after reading the ".vimrc"
6576 and the other initializations, so that when the 'shell' option is set
6577 there, the 'shellredir' option changes automatically unless it was
6578 explicitly set before.
6579 In the future pipes may be used for filtering and this option will
6580 become obsolete (at least for Unix).
6581 This option cannot be set from a |modeline| or in the |sandbox|, for
6582 security reasons.
6583
6584 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6585'shellslash' 'ssl' boolean (default off)
6586 global
6587 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6588 When set, a forward slash is used when expanding file names. This is
6589 useful when a Unix-like shell is used instead of command.com or
6590 cmd.exe. Backward slashes can still be typed, but they are changed to
6591 forward slashes by Vim.
6592 Note that setting or resetting this option has no effect for some
6593 existing file names, thus this option needs to be set before opening
6594 any file for best results. This might change in the future.
6595 'shellslash' only works when a backslash can be used as a path
6596 separator. To test if this is so use: >
6597 if exists('+shellslash')
6598<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006599 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6600'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6601 global
6602 {not in Vi}
6603 When on, use temp files for shell commands. When off use a pipe.
6604 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006605 Currently a pipe is only supported on Unix and MS-Windows 2K and
6606 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006607 :if has("filterpipe")
6608< The advantage of using a pipe is that nobody can read the temp file
6609 and the 'shell' command does not need to support redirection.
6610 The advantage of using a temp file is that the file type and encoding
6611 can be detected.
6612 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6613 |FilterWritePost| autocommands event are not triggered when
6614 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006615 The `system()` function does not respect this option and always uses
6616 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006617 NOTE: This option is set to the Vim default value when 'compatible'
6618 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006619
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 *'shelltype'* *'st'*
6621'shelltype' 'st' number (default 0)
6622 global
6623 {not in Vi} {only for the Amiga}
6624 On the Amiga this option influences the way how the commands work
6625 which use a shell.
6626 0 and 1: always use the shell
6627 2 and 3: use the shell only to filter lines
6628 4 and 5: use shell only for ':sh' command
6629 When not using the shell, the command is executed directly.
6630
6631 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6632 1 and 3: use "shell cmd" to start external commands
6633
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006634 *'shellxescape'* *'sxe'*
6635'shellxescape' 'sxe' string (default: "";
6636 for MS-DOS and MS-Windows: "\"&|<>()@^")
6637 global
6638 {not in Vi}
6639 When 'shellxquote' is set to "(" then the characters listed in this
6640 option will be escaped with a '^' character. This makes it possible
6641 to execute most external commands with cmd.exe.
6642
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 *'shellxquote'* *'sxq'*
6644'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006645 for Win32, when 'shell' is cmd.exe: "("
6646 for Win32, when 'shell' contains "sh"
6647 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 for Unix, when using system(): "\"")
6649 global
6650 {not in Vi}
6651 Quoting character(s), put around the command passed to the shell, for
6652 the "!" and ":!" commands. Includes the redirection. See
6653 'shellquote' to exclude the redirection. It's probably not useful
6654 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006655 When the value is '(' then ')' is appended. When the value is '"('
6656 then ')"' is appended.
6657 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006658 This is an empty string by default on most systems, but is known to be
6659 useful for on Win32 version, either for cmd.exe which automatically
6660 strips off the first and last quote on a command, or 3rd-party shells
6661 such as the MKS Korn Shell or bash, where it should be "\"". The
6662 default is adjusted according the value of 'shell', to reduce the need
6663 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 This option cannot be set from a |modeline| or in the |sandbox|, for
6665 security reasons.
6666
6667 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6668'shiftround' 'sr' boolean (default off)
6669 global
6670 {not in Vi}
6671 Round indent to multiple of 'shiftwidth'. Applies to > and <
6672 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6673 a multiple of 'shiftwidth' (this is Vi compatible).
6674 NOTE: This option is reset when 'compatible' is set.
6675
6676 *'shiftwidth'* *'sw'*
6677'shiftwidth' 'sw' number (default 8)
6678 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006681 When zero the 'ts' value will be used. Use the |shiftwidth()|
6682 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683
6684 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006685'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6686 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 global
6688 {not in Vi}
6689 This option helps to avoid all the |hit-enter| prompts caused by file
6690 messages, for example with CTRL-G, and to avoid some other messages.
6691 It is a list of flags:
6692 flag meaning when present ~
6693 f use "(3 of 5)" instead of "(file 3 of 5)"
6694 i use "[noeol]" instead of "[Incomplete last line]"
6695 l use "999L, 888C" instead of "999 lines, 888 characters"
6696 m use "[+]" instead of "[Modified]"
6697 n use "[New]" instead of "[New File]"
6698 r use "[RO]" instead of "[readonly]"
6699 w use "[w]" instead of "written" for file write message
6700 and "[a]" instead of "appended" for ':w >> file' command
6701 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6702 "[unix format]" and "[mac]" instead of "[mac format]".
6703 a all of the above abbreviations
6704
6705 o overwrite message for writing a file with subsequent message
6706 for reading a file (useful for ":wn" or when 'autowrite' on)
6707 O message for reading a file overwrites any previous message.
6708 Also for quickfix message (e.g., ":cn").
6709 s don't give "search hit BOTTOM, continuing at TOP" or "search
6710 hit TOP, continuing at BOTTOM" messages
6711 t truncate file message at the start if it is too long to fit
6712 on the command-line, "<" will appear in the left most column.
6713 Ignored in Ex mode.
6714 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006715 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 Ignored in Ex mode.
6717 W don't give "written" or "[w]" when writing a file
6718 A don't give the "ATTENTION" message when an existing swap file
6719 is found.
6720 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006721 c don't give |ins-completion-menu| messages. For example,
6722 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6723 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006724 q use "recording" instead of "recording @a"
6725 F don't give the file info when editing a file, like `:silent`
6726 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727
6728 This gives you the opportunity to avoid that a change between buffers
6729 requires you to hit <Enter>, but still gives as useful a message as
6730 possible for the space available. To get the whole message that you
6731 would have got with 'shm' empty, use ":file!"
6732 Useful values:
6733 shm= No abbreviation of message.
6734 shm=a Abbreviation, but no loss of information.
6735 shm=at Abbreviation, and truncate message when necessary.
6736
6737 NOTE: This option is set to the Vi default value when 'compatible' is
6738 set and to the Vim default value when 'compatible' is reset.
6739
6740 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6741'shortname' 'sn' boolean (default off)
6742 local to buffer
6743 {not in Vi, not in MS-DOS versions}
6744 Filenames are assumed to be 8 characters plus one extension of 3
6745 characters. Multiple dots in file names are not allowed. When this
6746 option is on, dots in file names are replaced with underscores when
6747 adding an extension (".~" or ".swp"). This option is not available
6748 for MS-DOS, because then it would always be on. This option is useful
6749 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6750 or crossdos. When running the Win32 GUI version under Win32s, this
6751 option is always on by default.
6752
6753 *'showbreak'* *'sbr'* *E595*
6754'showbreak' 'sbr' string (default "")
6755 global
6756 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006757 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 feature}
6759 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006760 values are "> " or "+++ ": >
6761 :set showbreak=>\
6762< Note the backslash to escape the trailing space. It's easier like
6763 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006764 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006765< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 comma (in a future version the comma might be used to separate the
6767 part that is shown at the end and at the start of a line).
6768 The characters are highlighted according to the '@' flag in
6769 'highlight'.
6770 Note that tabs after the showbreak will be displayed differently.
6771 If you want the 'showbreak' to appear in between line numbers, add the
6772 "n" flag to 'cpoptions'.
6773
6774 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006775'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6776 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 global
6778 {not in Vi}
6779 {not available when compiled without the
6780 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006781 Show (partial) command in the last line of the screen. Set this
6782 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 In Visual mode the size of the selected area is shown:
6784 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006785 If the number of bytes is different it is also displayed: "2-6"
6786 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006788 - When selecting a block, the size in screen characters:
6789 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 NOTE: This option is set to the Vi default value when 'compatible' is
6791 set and to the Vim default value when 'compatible' is reset.
6792
6793 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6794'showfulltag' 'sft' boolean (default off)
6795 global
6796 {not in Vi}
6797 When completing a word in insert mode (see |ins-completion|) from the
6798 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006799 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006800 matched a C function, you can see a template for what arguments are
6801 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006802 Note that this doesn't work well together with having "longest" in
6803 'completeopt', because the completion from the search pattern may not
6804 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805
6806 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6807'showmatch' 'sm' boolean (default off)
6808 global
6809 When a bracket is inserted, briefly jump to the matching one. The
6810 jump is only done if the match can be seen on the screen. The time to
6811 show the match can be set with 'matchtime'.
6812 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006813 seen or not).
6814 This option is reset when 'paste' is set and restored when 'paste' is
6815 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 When the 'm' flag is not included in 'cpoptions', typing a character
6817 will immediately move the cursor back to where it belongs.
6818 See the "sm" field in 'guicursor' for setting the cursor shape and
6819 blinking when showing the match.
6820 The 'matchpairs' option can be used to specify the characters to show
6821 matches for. 'rightleft' and 'revins' are used to look for opposite
6822 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006823 Also see the matchparen plugin for highlighting the match when moving
6824 around |pi_paren.txt|.
6825 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826
6827 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6828'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6829 global
6830 If in Insert, Replace or Visual mode put a message on the last line.
6831 Use the 'M' flag in 'highlight' to set the type of highlighting for
6832 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006833 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 doesn't mean XIM is really active, especially when 'imactivatekey' is
6835 not set.
6836 NOTE: This option is set to the Vi default value when 'compatible' is
6837 set and to the Vim default value when 'compatible' is reset.
6838
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006839 *'showtabline'* *'stal'*
6840'showtabline' 'stal' number (default 1)
6841 global
6842 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006843 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006844 feature}
6845 The value of this option specifies when the line with tab page labels
6846 will be displayed:
6847 0: never
6848 1: only if there are at least two tab pages
6849 2: always
6850 This is both for the GUI and non-GUI implementation of the tab pages
6851 line.
6852 See |tab-page| for more information about tab pages.
6853
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 *'sidescroll'* *'ss'*
6855'sidescroll' 'ss' number (default 0)
6856 global
6857 {not in Vi}
6858 The minimal number of columns to scroll horizontally. Used only when
6859 the 'wrap' option is off and the cursor is moved off of the screen.
6860 When it is zero the cursor will be put in the middle of the screen.
6861 When using a slow terminal set it to a large number or 0. When using
6862 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6863 commands.
6864
6865 *'sidescrolloff'* *'siso'*
6866'sidescrolloff' 'siso' number (default 0)
6867 global
6868 {not in Vi}
6869 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006870 right of the cursor if 'nowrap' is set. Setting this option to a
6871 value greater than 0 while having |'sidescroll'| also at a non-zero
6872 value makes some context visible in the line you are scrolling in
6873 horizontally (except at beginning of the line). Setting this option
6874 to a large value (like 999) has the effect of keeping the cursor
6875 horizontally centered in the window, as long as one does not come too
6876 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 NOTE: This option is set to 0 when 'compatible' is set.
6878
6879 Example: Try this together with 'sidescroll' and 'listchars' as
6880 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006881 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882
6883 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6884 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006885<
6886 *'signcolumn'* *'scl'*
6887'signcolumn' 'scl' string (default "auto")
6888 local to window
6889 {not in Vi}
6890 {not available when compiled without the |+signs|
6891 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006892 Whether or not to draw the signcolumn. Valid values are:
6893 "auto" only when there is a sign to display
6894 "no" never
6895 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896
6897
6898 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6899'smartcase' 'scs' boolean (default off)
6900 global
6901 {not in Vi}
6902 Override the 'ignorecase' option if the search pattern contains upper
6903 case characters. Only used when the search pattern is typed and
6904 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006905 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6907 recalling the search pattern from history and hitting <Enter>.
6908 NOTE: This option is reset when 'compatible' is set.
6909
6910 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6911'smartindent' 'si' boolean (default off)
6912 local to buffer
6913 {not in Vi}
6914 {not available when compiled without the
6915 |+smartindent| feature}
6916 Do smart autoindenting when starting a new line. Works for C-like
6917 programs, but can also be used for other languages. 'cindent' does
6918 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006919 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006920 setting 'si' has no effect. 'indentexpr' is a more advanced
6921 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 Normally 'autoindent' should also be on when using 'smartindent'.
6923 An indent is automatically inserted:
6924 - After a line ending in '{'.
6925 - After a line starting with a keyword from 'cinwords'.
6926 - Before a line starting with '}' (only with the "O" command).
6927 When typing '}' as the first character in a new line, that line is
6928 given the same indent as the matching '{'.
6929 When typing '#' as the first character in a new line, the indent for
6930 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006931 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6933 When using the ">>" command, lines starting with '#' are not shifted
6934 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006935 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006936 This option is reset when 'paste' is set and restored when 'paste' is
6937 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938
6939 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6940'smarttab' 'sta' boolean (default off)
6941 global
6942 {not in Vi}
6943 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006944 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6945 <BS> will delete a 'shiftwidth' worth of space at the start of the
6946 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006947 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006948 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6949 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006950 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006952 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006953 This option is reset when 'paste' is set and restored when 'paste' is
6954 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 NOTE: This option is reset when 'compatible' is set.
6956
6957 *'softtabstop'* *'sts'*
6958'softtabstop' 'sts' number (default 0)
6959 local to buffer
6960 {not in Vi}
6961 Number of spaces that a <Tab> counts for while performing editing
6962 operations, like inserting a <Tab> or using <BS>. It "feels" like
6963 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6964 used. This is useful to keep the 'ts' setting at its standard value
6965 of 8, while being able to edit like it is set to 'sts'. However,
6966 commands like "x" still work on the actual characters.
6967 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006968 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006969 'softtabstop' is set to 0 when the 'paste' option is set and restored
6970 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6972 spaces is minimized by using <Tab>s.
6973 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6974 set.
6975 NOTE: This option is set to 0 when 'compatible' is set.
6976
Bram Moolenaar217ad922005-03-20 22:37:15 +00006977 *'spell'* *'nospell'*
6978'spell' boolean (default off)
6979 local to window
6980 {not in Vi}
6981 {not available when compiled without the |+syntax|
6982 feature}
6983 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006984 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006985
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006986 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006987'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006988 local to buffer
6989 {not in Vi}
6990 {not available when compiled without the |+syntax|
6991 feature}
6992 Pattern to locate the end of a sentence. The following word will be
6993 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006994 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006995 When this check is not wanted make this option empty.
6996 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006997 Be careful with special characters, see |option-backslash| about
6998 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006999 To set this option automatically depending on the language, see
7000 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007001
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007002 *'spellfile'* *'spf'*
7003'spellfile' 'spf' string (default empty)
7004 local to buffer
7005 {not in Vi}
7006 {not available when compiled without the |+syntax|
7007 feature}
7008 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007009 commands. It must end in ".{encoding}.add". You need to include the
7010 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007011 *E765*
7012 It may also be a comma separated list of names. A count before the
7013 |zg| and |zw| commands can be used to access each. This allows using
7014 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007015 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007016 you: Using the first directory in 'runtimepath' that is writable. If
7017 there is no "spell" directory yet it will be created. For the file
7018 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007019 ignoring the region.
7020 The resulting ".spl" file will be used for spell checking, it does not
7021 have to appear in 'spelllang'.
7022 Normally one file is used for all regions, but you can add the region
7023 name if you want to. However, it will then only be used when
7024 'spellfile' is set to it, for entries in 'spelllang' only files
7025 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007026 This option cannot be set from a |modeline| or in the |sandbox|, for
7027 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007028
Bram Moolenaar217ad922005-03-20 22:37:15 +00007029 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007030'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007031 local to buffer
7032 {not in Vi}
7033 {not available when compiled without the |+syntax|
7034 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007035 A comma separated list of word list names. When the 'spell' option is
7036 on spellchecking will be done for these languages. Example: >
7037 set spelllang=en_us,nl,medical
7038< This means US English, Dutch and medical words are recognized. Words
7039 that are not recognized will be highlighted.
7040 The word list name must not include a comma or dot. Using a dash is
7041 recommended to separate the two letter language name from a
7042 specification. Thus "en-rare" is used for rare English words.
7043 A region name must come last and have the form "_xx", where "xx" is
7044 the two-letter, lower case region name. You can use more than one
7045 region by listing them: "en_us,en_ca" supports both US and Canadian
7046 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007047 Britain. (Note: currently en_au and en_nz dictionaries are older than
7048 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007049 If the name "cjk" is included East Asian characters are excluded from
7050 spell checking. This is useful when editing text that also has Asian
7051 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007052 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007053 As a special case the name of a .spl file can be given as-is. The
7054 first "_xx" in the name is removed and used as the region name
7055 (_xx is an underscore, two letters and followed by a non-letter).
7056 This is mainly for testing purposes. You must make sure the correct
7057 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007058 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007059 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7060 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007061 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007062
Bram Moolenaar98692072006-02-04 00:57:42 +00007063 If the |spellfile.vim| plugin is active and you use a language name
7064 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7065 will ask you if you want to download the file.
7066
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007067 After this option has been set successfully, Vim will source the files
7068 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007069 up to the first comma, dot or underscore.
7070 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007071
7072
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007073 *'spellsuggest'* *'sps'*
7074'spellsuggest' 'sps' string (default "best")
7075 global
7076 {not in Vi}
7077 {not available when compiled without the |+syntax|
7078 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007079 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007080 the |spellsuggest()| function. This is a comma-separated list of
7081 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007082
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007083 best Internal method that works best for English. Finds
7084 changes like "fast" and uses a bit of sound-a-like
7085 scoring to improve the ordering.
7086
7087 double Internal method that uses two methods and mixes the
7088 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007089 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007090 word. That only works when the language specifies
7091 sound folding. Can be slow and doesn't always give
7092 better results.
7093
7094 fast Internal method that only checks for simple changes:
7095 character inserts/deletes/swaps. Works well for
7096 simple typing mistakes.
7097
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007098 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007099 Not used for |spellsuggest()|. The number of
7100 suggestions is never more than the value of 'lines'
7101 minus two.
7102
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007103 file:{filename} Read file {filename}, which must have two columns,
7104 separated by a slash. The first column contains the
7105 bad word, the second column the suggested good word.
7106 Example:
7107 theribal/terrible ~
7108 Use this for common mistakes that do not appear at the
7109 top of the suggestion list with the internal methods.
7110 Lines without a slash are ignored, use this for
7111 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007112 The word in the second column must be correct,
7113 otherwise it will not be used. Add the word to an
7114 ".add" file if it is currently flagged as a spelling
7115 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007116 The file is used for all languages.
7117
7118 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7119 trouble with spaces. |v:val| holds the badly spelled
7120 word. The expression must evaluate to a List of
7121 Lists, each with a suggestion and a score.
7122 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007123 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007124 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007125 internal methods use. A lower score is better.
7126 This may invoke |spellsuggest()| if you temporarily
7127 set 'spellsuggest' to exclude the "expr:" part.
7128 Errors are silently ignored, unless you set the
7129 'verbose' option to a non-zero value.
7130
7131 Only one of "best", "double" or "fast" may be used. The others may
7132 appear several times in any order. Example: >
7133 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7134<
7135 This option cannot be set from a |modeline| or in the |sandbox|, for
7136 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007137
7138
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7140'splitbelow' 'sb' boolean (default off)
7141 global
7142 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007143 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 feature}
7145 When on, splitting a window will put the new window below the current
7146 one. |:split|
7147
7148 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7149'splitright' 'spr' boolean (default off)
7150 global
7151 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007152 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 feature}
7154 When on, splitting a window will put the new window right of the
7155 current one. |:vsplit|
7156
7157 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7158'startofline' 'sol' boolean (default on)
7159 global
7160 {not in Vi}
7161 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007162 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007163 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007164 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 with a linewise operator, with "%" with a count and to buffer changing
7166 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7167 only has a line number, e.g., ":25" or ":+".
7168 In case of buffer changing commands the cursor is placed at the column
7169 where it was the last time the buffer was edited.
7170 NOTE: This option is set when 'compatible' is set.
7171
Bram Moolenaar00654022011-02-25 14:42:19 +01007172 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007174 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 {not in Vi}
7176 {not available when compiled without the |+statusline|
7177 feature}
7178 When nonempty, this option determines the content of the status line.
7179 Also see |status-line|.
7180
7181 The option consists of printf style '%' items interspersed with
7182 normal text. Each status line item is of the form:
7183 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007184 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007185 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186
Bram Moolenaar238a5642006-02-21 22:12:05 +00007187 When the option starts with "%!" then it is used as an expression,
7188 evaluated and the result is used as the option value. Example: >
7189 :set statusline=%!MyStatusLine()
7190< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007191 Note that the "%!" expression is evaluated in the context of the
7192 current window and buffer, while %{} items are evaluated in the
7193 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007194
7195 When there is error while evaluating the option then it will be made
7196 empty to avoid further errors. Otherwise screen updating would loop.
7197
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 Note that the only effect of 'ruler' when this option is set (and
7199 'laststatus' is 2) is controlling the output of |CTRL-G|.
7200
7201 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007202 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007204 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 minwid Minimum width of the item, padding as set by '-' & '0'.
7206 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007207 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 on the left for text items. Numeric items will be
7209 shifted down to maxwid-2 digits followed by '>'number
7210 where number is the amount of missing digits, much like
7211 an exponential notation.
7212 item A one letter code as described below.
7213
7214 Following is a description of the possible statusline items. The
7215 second character in "item" is the type:
7216 N for number
7217 S for string
7218 F for flags as described below
7219 - not applicable
7220
7221 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007222 f S Path to the file in the buffer, as typed or relative to current
7223 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 F S Full path to the file in the buffer.
7225 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007226 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007228 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007230 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007232 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007234 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7236 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007237 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7239 being used: "<keymap>"
7240 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007241 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 B N As above, in hexadecimal.
7243 o N Byte number in file of byte under cursor, first byte is 1.
7244 Mnemonic: Offset from start of file (with one added)
7245 {not available when compiled without |+byte_offset| feature}
7246 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007247 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 l N Line number.
7249 L N Number of lines in buffer.
7250 c N Column number.
7251 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007252 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 p N Percentage through file in lines as in |CTRL-G|.
7254 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007255 percentage described for 'ruler'. Always 3 in length, unless
7256 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007257 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007259 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007260 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 ( - Start of item group. Can be used for setting the width and
7262 alignment of a section. Must be followed by %) somewhere.
7263 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007264 T N For 'tabline': start of tab page N label. Use %T after the last
7265 label. This information is used for mouse clicks.
7266 X N For 'tabline': start of close tab N label. Use %X after the
7267 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7268 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 < - Where to truncate line if too long. Default is at the start.
7270 No width fields allowed.
7271 = - Separation point between left and right aligned items.
7272 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007273 # - Set highlight group. The name must follow and then a # again.
7274 Thus use %#HLname# for highlight group HLname. The same
7275 highlighting is used, also for the statusline of non-current
7276 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007278 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 The difference between User{N} and StatusLine will be applied
7280 to StatusLineNC for the statusline of non-current windows.
7281 The number N must be between 1 and 9. See |hl-User1..9|
7282
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007283 When displaying a flag, Vim removes the leading comma, if any, when
7284 that flag comes right after plaintext. This will make a nice display
7285 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286
Bram Moolenaar582fd852005-03-28 20:58:01 +00007287 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 not set) and a minwid is not set for the group, the whole group will
7289 become empty. This will make a group like the following disappear
7290 completely from the statusline when none of the flags are set. >
7291 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007292< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 Beware that an expression is evaluated each and every time the status
7294 line is displayed. The current buffer and current window will be set
7295 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007296 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007298 real current buffer.
7299
Bram Moolenaar30b65812012-07-12 22:01:11 +02007300 The 'statusline' option will be evaluated in the |sandbox| if set from
7301 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007302
7303 It is not allowed to change text or jump to another window while
7304 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305
7306 If the statusline is not updated when you want it (e.g., after setting
7307 a variable that's used in an expression), you can force an update by
7308 setting an option without changing its value. Example: >
7309 :let &ro = &ro
7310
7311< A result of all digits is regarded a number for display purposes.
7312 Otherwise the result is taken as flag text and applied to the rules
7313 described above.
7314
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007315 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7317 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7318
7319 Examples:
7320 Emulate standard status line with 'ruler' set >
7321 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7322< Similar, but add ASCII value of char under the cursor (like "ga") >
7323 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7324< Display byte count and byte value, modified flag in red. >
7325 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7326 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7327< Display a ,GZ flag if a compressed file is loaded >
7328 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7329< In the |:autocmd|'s: >
7330 :let b:gzflag = 1
7331< And: >
7332 :unlet b:gzflag
7333< And define this function: >
7334 :function VarExists(var, val)
7335 : if exists(a:var) | return a:val | else | return '' | endif
7336 :endfunction
7337<
7338 *'suffixes'* *'su'*
7339'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7340 global
7341 {not in Vi}
7342 Files with these suffixes get a lower priority when multiple files
7343 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007344 suffixes. Spaces after the comma are ignored. A dot is also seen as
7345 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 separator, precede it with a backslash (see |option-backslash| about
7347 including spaces and backslashes).
7348 See 'wildignore' for completely ignoring files.
7349 The use of |:set+=| and |:set-=| is preferred when adding or removing
7350 suffixes from the list. This avoids problems when a future version
7351 uses another default.
7352
7353 *'suffixesadd'* *'sua'*
7354'suffixesadd' 'sua' string (default "")
7355 local to buffer
7356 {not in Vi}
7357 {not available when compiled without the
7358 |+file_in_path| feature}
7359 Comma separated list of suffixes, which are used when searching for a
7360 file for the "gf", "[I", etc. commands. Example: >
7361 :set suffixesadd=.java
7362<
7363 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7364'swapfile' 'swf' boolean (default on)
7365 local to buffer
7366 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007367 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 swapfile is not wanted for a specific buffer. For example, with
7369 confidential information that even root must not be able to access.
7370 Careful: All text will be in memory:
7371 - Don't use this for big files.
7372 - Recovery will be impossible!
7373 A swapfile will only be present when |'updatecount'| is non-zero and
7374 'swapfile' is set.
7375 When 'swapfile' is reset, the swap file for the current buffer is
7376 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7377 non-zero, a swap file is immediately created.
7378 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007379 If you want to open a new buffer without creating a swap file for it,
7380 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381
7382 This option is used together with 'bufhidden' and 'buftype' to
7383 specify special kinds of buffers. See |special-buffers|.
7384
7385 *'swapsync'* *'sws'*
7386'swapsync' 'sws' string (default "fsync")
7387 global
7388 {not in Vi}
7389 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007390 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007391 When this option is empty parts of the swap file may be in memory and
7392 not written to disk. When the system crashes you may lose more work.
7393 On Unix the system does a sync now and then without Vim asking for it,
7394 so the disadvantage of setting this option off is small. On some
7395 systems the swap file will not be written at all. For a unix system
7396 setting it to "sync" will use the sync() call instead of the default
7397 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007398 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399
7400 *'switchbuf'* *'swb'*
7401'switchbuf' 'swb' string (default "")
7402 global
7403 {not in Vi}
7404 This option controls the behavior when switching between buffers.
7405 Possible values (comma separated list):
7406 useopen If included, jump to the first open window that
7407 contains the specified buffer (if there is one).
7408 Otherwise: Do not examine other windows.
7409 This setting is checked with |quickfix| commands, when
7410 jumping to errors (":cc", ":cn", "cp", etc.). It is
7411 also used in all buffer related split commands, for
7412 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007413 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007414 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007416 a buffer for a |quickfix| command that display errors.
7417 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007418 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007419 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007420 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007422 *'synmaxcol'* *'smc'*
7423'synmaxcol' 'smc' number (default 3000)
7424 local to buffer
7425 {not in Vi}
7426 {not available when compiled without the |+syntax|
7427 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007428 Maximum column in which to search for syntax items. In long lines the
7429 text after this column is not highlighted and following lines may not
7430 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007431 This helps to avoid very slow redrawing for an XML file that is one
7432 long line.
7433 Set to zero to remove the limit.
7434
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *'syntax'* *'syn'*
7436'syntax' 'syn' string (default empty)
7437 local to buffer
7438 {not in Vi}
7439 {not available when compiled without the |+syntax|
7440 feature}
7441 When this option is set, the syntax with this name is loaded, unless
7442 syntax highlighting has been switched off with ":syntax off".
7443 Otherwise this option does not always reflect the current syntax (the
7444 b:current_syntax variable does).
7445 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007446 not automatically recognized. Example, in an IDL file:
7447 /* vim: set syntax=idl : */ ~
7448 When a dot appears in the value then this separates two filetype
7449 names. Example:
7450 /* vim: set syntax=c.doxygen : */ ~
7451 This will use the "c" syntax first, then the "doxygen" syntax.
7452 Note that the second one must be prepared to be loaded as an addition,
7453 otherwise it will be skipped. More than one dot may appear.
7454 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 :set syntax=OFF
7456< To switch syntax highlighting on according to the current value of the
7457 'filetype' option: >
7458 :set syntax=ON
7459< What actually happens when setting the 'syntax' option is that the
7460 Syntax autocommand event is triggered with the value as argument.
7461 This option is not copied to another buffer, independent of the 's' or
7462 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007463 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007465 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007466'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007467 global
7468 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007469 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007470 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007471 When nonempty, this option determines the content of the tab pages
7472 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007473 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007474
7475 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007476 option and only when there is no GUI tab line. When 'e' is in
7477 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007478 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007479
7480 The value is evaluated like with 'statusline'. You can use
7481 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007482 the text to be displayed. Use "%1T" for the first label, "%2T" for
7483 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007484
7485 Keep in mind that only one of the tab pages is the current one, others
7486 are invisible and you can't jump to their windows.
7487
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007488
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007489 *'tabpagemax'* *'tpm'*
7490'tabpagemax' 'tpm' number (default 10)
7491 global
7492 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007493 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007494 feature}
7495 Maximum number of tab pages to be opened by the |-p| command line
7496 argument or the ":tab all" command. |tabpage|
7497
7498
7499 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500'tabstop' 'ts' number (default 8)
7501 local to buffer
7502 Number of spaces that a <Tab> in the file counts for. Also see
7503 |:retab| command, and 'softtabstop' option.
7504
7505 Note: Setting 'tabstop' to any other value than 8 can make your file
7506 appear wrong in many places (e.g., when printing it).
7507
7508 There are four main ways to use tabs in Vim:
7509 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7510 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007511 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 behave like a tab appears every 4 (or 3) characters.
7513 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7514 'expandtab'. This way you will always insert spaces. The
7515 formatting will never be messed up when 'tabstop' is changed.
7516 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007517 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 works when using Vim to edit the file.
7519 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7520 'noexpandtab'. This should then work (for initial indents only)
7521 for any tabstop setting that people use. It might be nice to have
7522 tabs after the first non-blank inserted as spaces if you do this
7523 though. Otherwise aligned comments will be wrong when 'tabstop' is
7524 changed.
7525
7526 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7527'tagbsearch' 'tbs' boolean (default on)
7528 global
7529 {not in Vi}
7530 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007531 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 searching makes searching for a tag a LOT faster, but a linear search
7533 will find more tags if the tags file wasn't properly sorted.
7534 Vim normally assumes that your tags files are sorted, or indicate that
7535 they are not sorted. Only when this is not the case does the
7536 'tagbsearch' option need to be switched off.
7537
7538 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007539 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 certain files, or retry all files with a linear search. When
7541 'tagbsearch' is off, only a linear search is done.
7542
7543 Linear searching is done anyway, for one file, when Vim finds a line
7544 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007545 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546< [The whitespace before and after the '0' must be a single <Tab>]
7547
7548 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007549 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 instead of a normal tag name, a retry is done with a linear search.
7551 Tags in unsorted tags files, and matches with different case will only
7552 be found in the retry.
7553
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007554 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007555 linear search can be avoided when case is ignored. Use a value of '2'
7556 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7557 sorted with the -f switch to "sort" in most unices, as in the command:
7558 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7559 (at least 5.5) the --sort=foldcase switch can be used for this as
7560 well. Note that case must be folded to uppercase for this to work.
7561
7562 By default, tag searches are case-sensitive. Case is ignored when
7563 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7564 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007565 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7566 'tagcase' is "smart", and the pattern contains only lowercase
7567 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568
7569 When 'tagbsearch' is off, tags searching is slower when a full match
7570 exists, but faster when no full match exists. Tags in unsorted tags
7571 files may only be found with 'tagbsearch' off.
7572 When the tags file is not sorted, or sorted in a wrong way (not on
7573 ASCII byte value), 'tagbsearch' should be off, or the line given above
7574 must be included in the tags file.
7575 This option doesn't affect commands that find all matching tags (e.g.,
7576 command-line completion and ":help").
7577 {Vi: always uses binary search in some versions}
7578
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007579 *'tagcase'* *'tc'*
7580'tagcase' 'tc' string (default "followic")
7581 global or local to buffer |global-local|
7582 {not in Vi}
7583 This option specifies how case is handled when searching the tags
7584 file:
7585 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007586 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007587 ignore Ignore case
7588 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007589 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007590 NOTE: This option is set to the Vi default value when 'compatible' is
7591 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007592
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 *'taglength'* *'tl'*
7594'taglength' 'tl' number (default 0)
7595 global
7596 If non-zero, tags are significant up to this number of characters.
7597
7598 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7599'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7600 global
7601 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007602 If on and using a tags file in another directory, file names in that
7603 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007604 NOTE: This option is set to the Vi default value when 'compatible' is
7605 set and to the Vim default value when 'compatible' is reset.
7606
7607 *'tags'* *'tag'* *E433*
7608'tags' 'tag' string (default "./tags,tags", when compiled with
7609 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7610 global or local to buffer |global-local|
7611 Filenames for the tag command, separated by spaces or commas. To
7612 include a space or comma in a file name, precede it with a backslash
7613 (see |option-backslash| about including spaces and backslashes).
7614 When a file name starts with "./", the '.' is replaced with the path
7615 of the current file. But only when the 'd' flag is not included in
7616 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7617 |tags-option|.
7618 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007619 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7620 find all files named "tags" below "/lib". The filename itself cannot
7621 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7622 files called "tags?". {not available when compiled without the
7623 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007624 The |tagfiles()| function can be used to get a list of the file names
7625 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7627 files are also supported. They are automatically recognized. The
7628 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7629 differences are ignored (MS-Windows). |emacs-tags|
7630 The use of |:set+=| and |:set-=| is preferred when adding or removing
7631 file names from the list. This avoids problems when a future version
7632 uses another default.
7633 {Vi: default is "tags /usr/lib/tags"}
7634
7635 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7636'tagstack' 'tgst' boolean (default on)
7637 global
7638 {not in all versions of Vi}
7639 When on, the |tagstack| is used normally. When off, a ":tag" or
7640 ":tselect" command with an argument will not push the tag onto the
7641 tagstack. A following ":tag" without an argument, a ":pop" command or
7642 any other command that uses the tagstack will use the unmodified
7643 tagstack, but does change the pointer to the active entry.
7644 Resetting this option is useful when using a ":tag" command in a
7645 mapping which should not change the tagstack.
7646
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007647 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007648'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007649 global
7650 {not in Vi}
7651 {only available when compiled with the |+tcl/dyn|
7652 feature}
7653 Specifies the name of the Tcl shared library. The default is
7654 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007655 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007656 This option cannot be set from a |modeline| or in the |sandbox|, for
7657 security reasons.
7658
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 *'term'* *E529* *E530* *E531*
7660'term' string (default is $TERM, if that fails:
7661 in the GUI: "builtin_gui"
7662 on Amiga: "amiga"
7663 on BeOS: "beos-ansi"
7664 on Mac: "mac-ansi"
7665 on MiNT: "vt52"
7666 on MS-DOS: "pcterm"
7667 on OS/2: "os2ansi"
7668 on Unix: "ansi"
7669 on VMS: "ansi"
7670 on Win 32: "win32")
7671 global
7672 Name of the terminal. Used for choosing the terminal control
7673 characters. Environment variables are expanded |:set_env|.
7674 For example: >
7675 :set term=$TERM
7676< See |termcap|.
7677
7678 *'termbidi'* *'tbidi'*
7679 *'notermbidi'* *'notbidi'*
7680'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7681 global
7682 {not in Vi}
7683 {only available when compiled with the |+arabic|
7684 feature}
7685 The terminal is in charge of Bi-directionality of text (as specified
7686 by Unicode). The terminal is also expected to do the required shaping
7687 that some languages (such as Arabic) require.
7688 Setting this option implies that 'rightleft' will not be set when
7689 'arabic' is set and the value of 'arabicshape' will be ignored.
7690 Note that setting 'termbidi' has the immediate effect that
7691 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7692 This option is reset when the GUI is started.
7693 For further details see |arabic.txt|.
7694
7695 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007696'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007697 Macintosh GUI: "macroman")
7698 global
7699 {only available when compiled with the |+multi_byte|
7700 feature}
7701 {not in Vi}
7702 Encoding used for the terminal. This specifies what character
7703 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007704 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007705 display). Except for the Mac when 'macatsui' is off, then
7706 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007708 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7710 Any attempts to set a different value will be rejected, and an error
7711 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007712 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 because the Win32 system always passes Unicode characters.
7714 When empty, the same encoding is used as for the 'encoding' option.
7715 This is the normal value.
7716 Not all combinations for 'termencoding' and 'encoding' are valid. See
7717 |encoding-table|.
7718 The value for this option must be supported by internal conversions or
7719 iconv(). When this is not possible no conversion will be done and you
7720 will probably experience problems with non-ASCII characters.
7721 Example: You are working with the locale set to euc-jp (Japanese) and
7722 want to edit a UTF-8 file: >
7723 :let &termencoding = &encoding
7724 :set encoding=utf-8
7725< You need to do this when your system has no locale support for UTF-8.
7726
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007727 *'termguicolors'* *'tgc'*
7728'termguicolors' 'tgc' boolean (default off)
7729 global
7730 {not in Vi}
7731 {not available when compiled without the
7732 |+termguicolors| feature}
7733 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7734 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7735 compatible terminal.
7736 If setting this option does not work (produces a colorless UI)
7737 reading |xterm-true-color| might help.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007738 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007739
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 *'terse'* *'noterse'*
7741'terse' boolean (default off)
7742 global
7743 When set: Add 's' flag to 'shortmess' option (this makes the message
7744 for a search that hits the start or end of the file not being
7745 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7746 shortens a lot of messages}
7747
7748 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7749'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7750 global
7751 {not in Vi}
7752 This option is obsolete. Use 'fileformats'.
7753 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7754 set to the default value for the current system. When 'textauto' is
7755 reset, 'fileformats' is made empty.
7756 NOTE: This option is set to the Vi default value when 'compatible' is
7757 set and to the Vim default value when 'compatible' is reset.
7758
7759 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7760'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7761 others: default off)
7762 local to buffer
7763 {not in Vi}
7764 This option is obsolete. Use 'fileformat'.
7765 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7766 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7767 "unix".
7768
7769 *'textwidth'* *'tw'*
7770'textwidth' 'tw' number (default 0)
7771 local to buffer
7772 {not in Vi}
7773 Maximum width of text that is being inserted. A longer line will be
7774 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007775 this.
7776 'textwidth' is set to 0 when the 'paste' option is set and restored
7777 when 'paste' is reset.
7778 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007780 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 NOTE: This option is set to 0 when 'compatible' is set.
7782
7783 *'thesaurus'* *'tsr'*
7784'thesaurus' 'tsr' string (default "")
7785 global or local to buffer |global-local|
7786 {not in Vi}
7787 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007788 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 the file should contain words with similar meaning, separated by
7790 non-keyword characters (white space is preferred). Maximum line
7791 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007792 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007793 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007794 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007795 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 after a comma are ignored, otherwise spaces are included in the file
7797 name. See |option-backslash| about using backslashes.
7798 The use of |:set+=| and |:set-=| is preferred when adding or removing
7799 directories from the list. This avoids problems when a future version
7800 uses another default.
7801 Backticks cannot be used in this option for security reasons.
7802
7803 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7804'tildeop' 'top' boolean (default off)
7805 global
7806 {not in Vi}
7807 When on: The tilde command "~" behaves like an operator.
7808 NOTE: This option is reset when 'compatible' is set.
7809
7810 *'timeout'* *'to'* *'notimeout'* *'noto'*
7811'timeout' 'to' boolean (default on)
7812 global
7813 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007814'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 global
7816 {not in Vi}
7817 These two options together determine the behavior when part of a
7818 mapped key sequence or keyboard code has been received:
7819
7820 'timeout' 'ttimeout' action ~
7821 off off do not time out
7822 on on or off time out on :mappings and key codes
7823 off on time out on key codes
7824
7825 If both options are off, Vim will wait until either the complete
7826 mapping or key sequence has been received, or it is clear that there
7827 is no mapping or key sequence for the received characters. For
7828 example: if you have mapped "vl" and Vim has received 'v', the next
7829 character is needed to see if the 'v' is followed by an 'l'.
7830 When one of the options is on, Vim will wait for about 1 second for
7831 the next character to arrive. After that the already received
7832 characters are interpreted as single characters. The waiting time can
7833 be changed with the 'timeoutlen' option.
7834 On slow terminals or very busy systems timing out may cause
7835 malfunctioning cursor keys. If both options are off, Vim waits
7836 forever after an entered <Esc> if there are key codes that start
7837 with <Esc>. You will have to type <Esc> twice. If you do not have
7838 problems with key codes, but would like to have :mapped key
7839 sequences not timing out in 1 second, set the 'ttimeout' option and
7840 reset the 'timeout' option.
7841
7842 NOTE: 'ttimeout' is reset when 'compatible' is set.
7843
7844 *'timeoutlen'* *'tm'*
7845'timeoutlen' 'tm' number (default 1000)
7846 global
7847 {not in all versions of Vi}
7848 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007849'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 global
7851 {not in Vi}
7852 The time in milliseconds that is waited for a key code or mapped key
7853 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7854 when part of a command has been typed.
7855 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7856 different timeout value for key codes is desired set 'ttimeoutlen' to
7857 a non-negative number.
7858
7859 ttimeoutlen mapping delay key code delay ~
7860 < 0 'timeoutlen' 'timeoutlen'
7861 >= 0 'timeoutlen' 'ttimeoutlen'
7862
7863 The timeout only happens when the 'timeout' and 'ttimeout' options
7864 tell so. A useful setting would be >
7865 :set timeout timeoutlen=3000 ttimeoutlen=100
7866< (time out on mapping after three seconds, time out on key codes after
7867 a tenth of a second).
7868
7869 *'title'* *'notitle'*
7870'title' boolean (default off, on when title can be restored)
7871 global
7872 {not in Vi}
7873 {not available when compiled without the |+title|
7874 feature}
7875 When on, the title of the window will be set to the value of
7876 'titlestring' (if it is not empty), or to:
7877 filename [+=-] (path) - VIM
7878 Where:
7879 filename the name of the file being edited
7880 - indicates the file cannot be modified, 'ma' off
7881 + indicates the file was modified
7882 = indicates the file is read-only
7883 =+ indicates the file is read-only and modified
7884 (path) is the path of the file being edited
7885 - VIM the server name |v:servername| or "VIM"
7886 Only works if the terminal supports setting window titles
7887 (currently Amiga console, Win32 console, all GUI versions and
7888 terminals with a non- empty 't_ts' option - these are Unix xterm and
7889 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7890 *X11*
7891 When Vim was compiled with HAVE_X11 defined, the original title will
7892 be restored if possible. The output of ":version" will include "+X11"
7893 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7894 works for the icon name |'icon'|.
7895 But: When Vim was started with the |-X| argument, restoring the title
7896 will not work (except in the GUI).
7897 If the title cannot be restored, it is set to the value of 'titleold'.
7898 You might want to restore the title outside of Vim then.
7899 When using an xterm from a remote machine you can use this command:
7900 rsh machine_name xterm -display $DISPLAY &
7901 then the WINDOWID environment variable should be inherited and the
7902 title of the window should change back to what it should be after
7903 exiting Vim.
7904
7905 *'titlelen'*
7906'titlelen' number (default 85)
7907 global
7908 {not in Vi}
7909 {not available when compiled without the |+title|
7910 feature}
7911 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007912 title. When the title is longer, only the end of the path name is
7913 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 Using a percentage makes this adapt to the width of the window. But
7915 it won't work perfectly, because the actual number of characters
7916 available also depends on the font used and other things in the title
7917 bar. When 'titlelen' is zero the full path is used. Otherwise,
7918 values from 1 to 30000 percent can be used.
7919 'titlelen' is also used for the 'titlestring' option.
7920
7921 *'titleold'*
7922'titleold' string (default "Thanks for flying Vim")
7923 global
7924 {not in Vi}
7925 {only available when compiled with the |+title|
7926 feature}
7927 This option will be used for the window title when exiting Vim if the
7928 original title cannot be restored. Only happens if 'title' is on or
7929 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007930 This option cannot be set from a |modeline| or in the |sandbox|, for
7931 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 *'titlestring'*
7933'titlestring' string (default "")
7934 global
7935 {not in Vi}
7936 {not available when compiled without the |+title|
7937 feature}
7938 When this option is not empty, it will be used for the title of the
7939 window. This happens only when the 'title' option is on.
7940 Only works if the terminal supports setting window titles (currently
7941 Amiga console, Win32 console, all GUI versions and terminals with a
7942 non-empty 't_ts' option).
7943 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007944 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 When this option contains printf-style '%' items, they will be
7946 expanded according to the rules used for 'statusline'.
7947 Example: >
7948 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7949 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7950< The value of 'titlelen' is used to align items in the middle or right
7951 of the available space.
7952 Some people prefer to have the file name first: >
7953 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7954< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007955 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 separating space only when needed.
7957 NOTE: Use of special characters in 'titlestring' may cause the display
7958 to be garbled (e.g., when it contains a CR or NL character).
7959 {not available when compiled without the |+statusline| feature}
7960
7961 *'toolbar'* *'tb'*
7962'toolbar' 'tb' string (default "icons,tooltips")
7963 global
7964 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7965 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007966 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 possible values are:
7968 icons Toolbar buttons are shown with icons.
7969 text Toolbar buttons shown with text.
7970 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007971 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 tooltips Tooltips are active for toolbar buttons.
7973 Tooltips refer to the popup help text which appears after the mouse
7974 cursor is placed over a toolbar button for a brief moment.
7975
7976 If you want the toolbar to be shown with icons as well as text, do the
7977 following: >
7978 :set tb=icons,text
7979< Motif and Athena cannot display icons and text at the same time. They
7980 will show icons if both are requested.
7981
7982 If none of the strings specified in 'toolbar' are valid or if
7983 'toolbar' is empty, this option is ignored. If you want to disable
7984 the toolbar, you need to set the 'guioptions' option. For example: >
7985 :set guioptions-=T
7986< Also see |gui-toolbar|.
7987
7988 *'toolbariconsize'* *'tbis'*
7989'toolbariconsize' 'tbis' string (default "small")
7990 global
7991 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01007992 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007994 tiny Use tiny icons.
7995 small Use small icons (default).
7996 medium Use medium-sized icons.
7997 large Use large icons.
7998 huge Use even larger icons.
7999 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008001 the current theme. Common dimensions are giant=48x48, huge=32x32,
8002 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003
8004 If 'toolbariconsize' is empty, the global default size as determined
8005 by user preferences or the current theme is used.
8006
8007 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8008'ttybuiltin' 'tbi' boolean (default on)
8009 global
8010 {not in Vi}
8011 When on, the builtin termcaps are searched before the external ones.
8012 When off the builtin termcaps are searched after the external ones.
8013 When this option is changed, you should set the 'term' option next for
8014 the change to take effect, for example: >
8015 :set notbi term=$TERM
8016< See also |termcap|.
8017 Rationale: The default for this option is "on", because the builtin
8018 termcap entries are generally better (many systems contain faulty
8019 xterm entries...).
8020
8021 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8022'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8023 sun-cmd, screen, rxvt, dtterm or
8024 iris-ansi; also on when running Vim in
8025 a DOS console)
8026 global
8027 {not in Vi}
8028 Indicates a fast terminal connection. More characters will be sent to
8029 the screen for redrawing, instead of using insert/delete line
8030 commands. Improves smoothness of redrawing when there are multiple
8031 windows and the terminal does not support a scrolling region.
8032 Also enables the extra writing of characters at the end of each screen
8033 line for lines that wrap. This helps when using copy/paste with the
8034 mouse in an xterm and other terminals.
8035
8036 *'ttymouse'* *'ttym'*
8037'ttymouse' 'ttym' string (default depends on 'term')
8038 global
8039 {not in Vi}
8040 {only in Unix and VMS, doesn't work in the GUI; not
8041 available when compiled without |+mouse|}
8042 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008043 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 *xterm-mouse*
8045 xterm xterm-like mouse handling. The mouse generates
8046 "<Esc>[Mscr", where "scr" is three bytes:
8047 "s" = button state
8048 "c" = column plus 33
8049 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008050 This only works up to 223 columns! See "dec",
8051 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 xterm2 Works like "xterm", but with the xterm reporting the
8053 mouse position while the mouse is dragged. This works
8054 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008055 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 work. See below for how Vim detects this
8057 automatically.
8058 *netterm-mouse*
8059 netterm NetTerm mouse handling. The mouse generates
8060 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8061 for the row and column.
8062 *dec-mouse*
8063 dec DEC terminal mouse handling. The mouse generates a
8064 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008065 This is also available for an Xterm, if it was
8066 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 *jsbterm-mouse*
8068 jsbterm JSB term mouse handling.
8069 *pterm-mouse*
8070 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008071 *urxvt-mouse*
8072 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008073 The mouse works only if the terminal supports this
8074 encoding style, but it does not have 223 columns limit
8075 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008076 *sgr-mouse*
8077 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008078 mouse reporting. The mouse works even in columns
8079 beyond 223. This option is backward compatible with
8080 "xterm2" because it can also decode "xterm2" style
8081 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082
8083 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008084 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8085 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8087 recognized, if enabled at compile time. DEC terminal mouse codes
8088 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008089 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8090 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008092 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8093 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8094 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008095 Additionally, if vim is compiled with the |+termresponse| feature and
8096 |t_RV| is set to the escape sequence to request the xterm version
8097 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008099 from 95 to 276. The "sgr" value will be set if the xterm version is
8100 277 or highter.
8101 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8102 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008103 :set t_RV=
8104<
8105 *'ttyscroll'* *'tsl'*
8106'ttyscroll' 'tsl' number (default 999)
8107 global
8108 Maximum number of lines to scroll the screen. If there are more lines
8109 to scroll the window is redrawn. For terminals where scrolling is
8110 very slow and redrawing is not slow this can be set to a small number,
8111 e.g., 3, to speed up displaying.
8112
8113 *'ttytype'* *'tty'*
8114'ttytype' 'tty' string (default from $TERM)
8115 global
8116 Alias for 'term', see above.
8117
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008118 *'undodir'* *'udir'*
8119'undodir' 'udir' string (default ".")
8120 global
8121 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008122 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008123 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008124 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008125 "." means using the directory of the file. The undo file name for
8126 "file.txt" is ".file.txt.un~".
8127 For other directories the file name is the full path of the edited
8128 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008129 When writing: The first directory that exists is used. "." always
8130 works, no directories after "." will be used for writing.
8131 When reading all entries are tried to find an undo file. The first
8132 undo file that exists is used. When it cannot be read an error is
8133 given, no further entry is used.
8134 See |undo-persistence|.
8135
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008136 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008137'undofile' 'udf' boolean (default off)
8138 local to buffer
8139 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008140 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008141 When on, Vim automatically saves undo history to an undo file when
8142 writing a buffer to a file, and restores undo history from the same
8143 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008144 The directory where the undo file is stored is specified by 'undodir'.
8145 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008146 The undo file is not read when 'undoreload' causes the buffer from
8147 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008148 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008149 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008150
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 *'undolevels'* *'ul'*
8152'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8153 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008154 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 {not in Vi}
8156 Maximum number of changes that can be undone. Since undo information
8157 is kept in memory, higher numbers will cause more memory to be used
8158 (nevertheless, a single change can use an unlimited amount of memory).
8159 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8160 itself: >
8161 set ul=0
8162< But you can also get Vi compatibility by including the 'u' flag in
8163 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008164 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008165 Set to -1 for no undo at all. You might want to do this only for the
8166 current buffer: >
8167 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008169
8170 The local value is set to -123456 when the global value is to be used.
8171
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008172 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008174 *'undoreload'* *'ur'*
8175'undoreload' 'ur' number (default 10000)
8176 global
8177 {not in Vi}
8178 Save the whole buffer for undo when reloading it. This applies to the
8179 ":e!" command and reloading for when the buffer changed outside of
8180 Vim. |FileChangedShell|
8181 The save only happens when this options is negative or when the number
8182 of lines is smaller than the value of this option.
8183 Set this option to zero to disable undo for a reload.
8184
8185 When saving undo for a reload, any undo file is not read.
8186
8187 Note that this causes the whole buffer to be stored in memory. Set
8188 this option to a lower value if you run out of memory.
8189
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 *'updatecount'* *'uc'*
8191'updatecount' 'uc' number (default: 200)
8192 global
8193 {not in Vi}
8194 After typing this many characters the swap file will be written to
8195 disk. When zero, no swap file will be created at all (see chapter on
8196 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8197 Vim with the "-n" option, see |startup|. When editing in readonly
8198 mode this option will be initialized to 10000.
8199 The swapfile can be disabled per buffer with |'swapfile'|.
8200 When 'updatecount' is set from zero to non-zero, swap files are
8201 created for all buffers that have 'swapfile' set. When 'updatecount'
8202 is set to zero, existing swap files are not deleted.
8203 Also see |'swapsync'|.
8204 This option has no meaning in buffers where |'buftype'| is "nofile"
8205 or "nowrite".
8206
8207 *'updatetime'* *'ut'*
8208'updatetime' 'ut' number (default 4000)
8209 global
8210 {not in Vi}
8211 If this many milliseconds nothing is typed the swap file will be
8212 written to disk (see |crash-recovery|). Also used for the
8213 |CursorHold| autocommand event.
8214
8215 *'verbose'* *'vbs'*
8216'verbose' 'vbs' number (default 0)
8217 global
8218 {not in Vi, although some versions have a boolean
8219 verbose option}
8220 When bigger than zero, Vim will give messages about what it is doing.
8221 Currently, these messages are given:
8222 >= 1 When the viminfo file is read or written.
8223 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008224 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 >= 8 Files for which a group of autocommands is executed.
8226 >= 9 Every executed autocommand.
8227 >= 12 Every executed function.
8228 >= 13 When an exception is thrown, caught, finished, or discarded.
8229 >= 14 Anything pending in a ":finally" clause.
8230 >= 15 Every executed Ex command (truncated at 200 characters).
8231
8232 This option can also be set with the "-V" argument. See |-V|.
8233 This option is also set by the |:verbose| command.
8234
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008235 When the 'verbosefile' option is set then the verbose messages are not
8236 displayed.
8237
8238 *'verbosefile'* *'vfile'*
8239'verbosefile' 'vfile' string (default empty)
8240 global
8241 {not in Vi}
8242 When not empty all messages are written in a file with this name.
8243 When the file exists messages are appended.
8244 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008245 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008246 Setting 'verbosefile' to a new value is like making it empty first.
8247 The difference with |:redir| is that verbose messages are not
8248 displayed when 'verbosefile' is set.
8249
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 *'viewdir'* *'vdir'*
8251'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8252 "$VIM/vimfiles/view",
8253 for Unix: "~/.vim/view",
8254 for Macintosh: "$VIM:vimfiles:view"
8255 for VMS: "sys$login:vimfiles/view"
8256 for RiscOS: "Choices:vimfiles/view")
8257 global
8258 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008259 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260 feature}
8261 Name of the directory where to store files for |:mkview|.
8262 This option cannot be set from a |modeline| or in the |sandbox|, for
8263 security reasons.
8264
8265 *'viewoptions'* *'vop'*
8266'viewoptions' 'vop' string (default: "folds,options,cursor")
8267 global
8268 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008269 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 feature}
8271 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008272 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 word save and restore ~
8274 cursor cursor position in file and in window
8275 folds manually created folds, opened/closed folds and local
8276 fold options
8277 options options and mappings local to a window or buffer (not
8278 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008279 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 slash backslashes in file names replaced with forward
8281 slashes
8282 unix with Unix end-of-line format (single <NL>), even when
8283 on Windows or DOS
8284
8285 "slash" and "unix" are useful on Windows when sharing view files
8286 with Unix. The Unix version of Vim cannot source dos format scripts,
8287 but the Windows version of Vim can source unix format scripts.
8288
8289 *'viminfo'* *'vi'* *E526* *E527* *E528*
8290'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008291 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8292 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8293 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 global
8295 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008296 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 feature}
8298 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008299 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 separated list of parameters, each consisting of a single character
8301 identifying the particular parameter, followed by a number or string
8302 which specifies the value of that parameter. If a particular
8303 character is left out, then the default value is used for that
8304 parameter. The following is a list of the identifying characters and
8305 the effect of their value.
8306 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008307 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008308 ! When included, save and restore global variables that start
8309 with an uppercase letter, and don't contain a lowercase
8310 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008311 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008312 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008313 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008314 " Maximum number of lines saved for each register. Old name of
8315 the '<' item, with the disadvantage that you need to put a
8316 backslash before the ", otherwise it will be recognized as the
8317 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008318 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 % When included, save and restore the buffer list. If Vim is
8320 started with a file name argument, the buffer list is not
8321 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008322 buffer list is restored from the viminfo file. Quickfix
8323 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8324 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008325 When followed by a number, the number specifies the maximum
8326 number of buffers that are stored. Without a number all
8327 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008328 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008329 ' Maximum number of previously edited files for which the marks
8330 are remembered. This parameter must always be included when
8331 'viminfo' is non-empty.
8332 Including this item also means that the |jumplist| and the
8333 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008334 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008336 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 patterns are also saved. When not included, the value of
8338 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008339 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008341 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008342 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 < Maximum number of lines saved for each register. If zero then
8344 registers are not saved. When not included, all lines are
8345 saved. '"' is the old name for this item.
8346 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008347 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008349 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008350 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 c When included, convert the text in the viminfo file from the
8352 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008353 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008354 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008355 f Whether file marks need to be stored. If zero, file marks ('0
8356 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008357 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008359 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 h Disable the effect of 'hlsearch' when loading the viminfo
8361 file. When not included, it depends on whether ":nohlsearch"
8362 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008363 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008365 the 'n'. Must be at the end of the option! If the "-i"
8366 argument was given when starting Vim, that file name overrides
8367 the one given here with 'viminfo'. Environment variables are
8368 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008369 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 r Removable media. The argument is a string (up to the next
8371 ','). This parameter can be given several times. Each
8372 specifies the start of a path for which no marks will be
8373 stored. This is to avoid removable media. For MS-DOS you
8374 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8375 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8376 ignored. Maximum length of each 'r' argument is 50
8377 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008378 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 s Maximum size of an item in Kbyte. If zero then registers are
8380 not saved. Currently only applies to registers. The default
8381 "s10" will exclude registers with more than 10 Kbyte of text.
8382 Also see the '<' item above: line count limit.
8383
8384 Example: >
8385 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8386<
8387 '50 Marks will be remembered for the last 50 files you
8388 edited.
8389 <1000 Contents of registers (up to 1000 lines each) will be
8390 remembered.
8391 s100 Registers with more than 100 Kbyte text are skipped.
8392 :0 Command-line history will not be saved.
8393 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8394 no / Since '/' is not specified, the default will be used,
8395 that is, save all of the search history, and also the
8396 previous search and substitute patterns.
8397 no % The buffer list will not be saved nor read back.
8398 no h 'hlsearch' highlighting will be restored.
8399
8400 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8401 load the contents of the file, this is not done automatically.
8402
8403 This option cannot be set from a |modeline| or in the |sandbox|, for
8404 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008405 NOTE: This option is set to the Vim default value when 'compatible'
8406 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407
8408 *'virtualedit'* *'ve'*
8409'virtualedit' 've' string (default "")
8410 global
8411 {not in Vi}
8412 {not available when compiled without the
8413 |+virtualedit| feature}
8414 A comma separated list of these words:
8415 block Allow virtual editing in Visual block mode.
8416 insert Allow virtual editing in Insert mode.
8417 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008418 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008419
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008421 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 of the line. Useful for selecting a rectangle in Visual mode and
8423 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008424 "onemore" is not the same, it will only allow moving the cursor just
8425 after the last character of the line. This makes some commands more
8426 consistent. Previously the cursor was always past the end of the line
8427 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008428 break some plugins or Vim scripts. For example because |l| can move
8429 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008430 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008431 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008432 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008433 It doesn't make sense to combine "all" with "onemore", but you will
8434 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008435 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436
8437 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8438'visualbell' 'vb' boolean (default off)
8439 global
8440 {not in Vi}
8441 Use visual bell instead of beeping. The terminal code to display the
8442 visual bell is given with 't_vb'. When no beep or flash is wanted,
8443 use ":set vb t_vb=".
8444 Note: When the GUI starts, 't_vb' is reset to its default value. You
8445 might want to set it again in your |gvimrc|.
8446 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8447 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8448 where 40 is the time in msec.
8449 Does not work on the Amiga, you always get a screen flash.
8450 Also see 'errorbells'.
8451
8452 *'warn'* *'nowarn'*
8453'warn' boolean (default on)
8454 global
8455 Give a warning message when a shell command is used while the buffer
8456 has been changed.
8457
8458 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8459'weirdinvert' 'wiv' boolean (default off)
8460 global
8461 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008462 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 It is provided for backwards compatibility with version 4.x.
8464 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8465 vice versa. Has no effect when the GUI is running.
8466
8467 *'whichwrap'* *'ww'*
8468'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8469 global
8470 {not in Vi}
8471 Allow specified keys that move the cursor left/right to move to the
8472 previous/next line when the cursor is on the first/last character in
8473 the line. Concatenate characters to allow this for these keys:
8474 char key mode ~
8475 b <BS> Normal and Visual
8476 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008477 h "h" Normal and Visual (not recommended)
8478 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 < <Left> Normal and Visual
8480 > <Right> Normal and Visual
8481 ~ "~" Normal
8482 [ <Left> Insert and Replace
8483 ] <Right> Insert and Replace
8484 For example: >
8485 :set ww=<,>,[,]
8486< allows wrap only when cursor keys are used.
8487 When the movement keys are used in combination with a delete or change
8488 operator, the <EOL> also counts for a character. This makes "3h"
8489 different from "3dh" when the cursor crosses the end of a line. This
8490 is also true for "x" and "X", because they do the same as "dl" and
8491 "dh". If you use this, you may also want to use the mapping
8492 ":map <BS> X" to make backspace delete the character in front of the
8493 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008494 When 'l' is included and it is used after an operator at the end of a
8495 line then it will not move to the next line. This makes "dl", "cl",
8496 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 NOTE: This option is set to the Vi default value when 'compatible' is
8498 set and to the Vim default value when 'compatible' is reset.
8499
8500 *'wildchar'* *'wc'*
8501'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8502 global
8503 {not in Vi}
8504 Character you have to type to start wildcard expansion in the
8505 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008506 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 The character is not recognized when used inside a macro. See
8508 'wildcharm' for that.
8509 Although 'wc' is a number option, you can set it to a special key: >
8510 :set wc=<Esc>
8511< NOTE: This option is set to the Vi default value when 'compatible' is
8512 set and to the Vim default value when 'compatible' is reset.
8513
8514 *'wildcharm'* *'wcm'*
8515'wildcharm' 'wcm' number (default: none (0))
8516 global
8517 {not in Vi}
8518 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008519 recognized when used inside a macro. You can find "spare" command-line
8520 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 you'll never actually type 'wildcharm', just use it in mappings that
8522 automatically invoke completion mode, e.g.: >
8523 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008524 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525< Then after typing :ss you can use CTRL-P & CTRL-N.
8526
8527 *'wildignore'* *'wig'*
8528'wildignore' 'wig' string (default "")
8529 global
8530 {not in Vi}
8531 {not available when compiled without the |+wildignore|
8532 feature}
8533 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008534 patterns is ignored when expanding |wildcards|, completing file or
8535 directory names, and influences the result of |expand()|, |glob()| and
8536 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8538 Also see 'suffixes'.
8539 Example: >
8540 :set wildignore=*.o,*.obj
8541< The use of |:set+=| and |:set-=| is preferred when adding or removing
8542 a pattern from the list. This avoids problems when a future version
8543 uses another default.
8544
Bram Moolenaar94950a92010-12-02 16:01:29 +01008545
Bram Moolenaar81af9252010-12-10 20:35:50 +01008546 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008547'wildignorecase' 'wic' boolean (default off)
8548 global
8549 {not in Vi}
8550 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008551 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008552 Does not apply when the shell is used to expand wildcards, which
8553 happens when there are special characters.
8554
8555
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008557'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008558 global
8559 {not in Vi}
8560 {not available if compiled without the |+wildmenu|
8561 feature}
8562 When 'wildmenu' is on, command-line completion operates in an enhanced
8563 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8564 the possible matches are shown just above the command line, with the
8565 first match highlighted (overwriting the status line, if there is
8566 one). Keys that show the previous/next match, such as <Tab> or
8567 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8568 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8569 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008570 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008571 If there are more matches than can fit in the line, a ">" is shown on
8572 the right and/or a "<" is shown on the left. The status line scrolls
8573 as needed.
8574 The "wildmenu" mode is abandoned when a key is hit that is not used
8575 for selecting a completion.
8576 While the "wildmenu" is active the following keys have special
8577 meanings:
8578
8579 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8580 <Down> - in filename/menu name completion: move into a
8581 subdirectory or submenu.
8582 <CR> - in menu completion, when the cursor is just after a
8583 dot: move into a submenu.
8584 <Up> - in filename/menu name completion: move up into
8585 parent directory or parent menu.
8586
8587 This makes the menus accessible from the console |console-menus|.
8588
8589 If you prefer the <Left> and <Right> keys to move the cursor instead
8590 of selecting a different match, use this: >
8591 :cnoremap <Left> <Space><BS><Left>
8592 :cnoremap <Right> <Space><BS><Right>
8593<
8594 The "WildMenu" highlighting is used for displaying the current match
8595 |hl-WildMenu|.
8596
8597 *'wildmode'* *'wim'*
8598'wildmode' 'wim' string (Vim default: "full")
8599 global
8600 {not in Vi}
8601 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008602 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008603 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008604 first part specifies the behavior for the first use of 'wildchar',
8605 The second part for the second use, etc.
8606 These are the possible values for each part:
8607 "" Complete only the first match.
8608 "full" Complete the next full match. After the last match,
8609 the original string is used and then the first match
8610 again.
8611 "longest" Complete till longest common string. If this doesn't
8612 result in a longer string, use the next part.
8613 "longest:full" Like "longest", but also start 'wildmenu' if it is
8614 enabled.
8615 "list" When more than one match, list all matches.
8616 "list:full" When more than one match, list all matches and
8617 complete first match.
8618 "list:longest" When more than one match, list all matches and
8619 complete till longest common string.
8620 When there is only a single match, it is fully completed in all cases.
8621
8622 Examples: >
8623 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008624< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 :set wildmode=longest,full
8626< Complete longest common string, then each full match >
8627 :set wildmode=list:full
8628< List all matches and complete each full match >
8629 :set wildmode=list,full
8630< List all matches without completing, then each full match >
8631 :set wildmode=longest,list
8632< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008633 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008635 *'wildoptions'* *'wop'*
8636'wildoptions' 'wop' string (default "")
8637 global
8638 {not in Vi}
8639 {not available when compiled without the |+wildignore|
8640 feature}
8641 A list of words that change how command line completion is done.
8642 Currently only one word is allowed:
8643 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008644 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008645 is displayed per line. Often used tag kinds are:
8646 d #define
8647 f function
8648 Also see |cmdline-completion|.
8649
Bram Moolenaar071d4272004-06-13 20:20:40 +00008650 *'winaltkeys'* *'wak'*
8651'winaltkeys' 'wak' string (default "menu")
8652 global
8653 {not in Vi}
8654 {only used in Win32, Motif, GTK and Photon GUI}
8655 Some GUI versions allow the access to menu entries by using the ALT
8656 key in combination with a character that appears underlined in the
8657 menu. This conflicts with the use of the ALT key for mappings and
8658 entering special characters. This option tells what to do:
8659 no Don't use ALT keys for menus. ALT key combinations can be
8660 mapped, but there is no automatic handling. This can then be
8661 done with the |:simalt| command.
8662 yes ALT key handling is done by the windowing system. ALT key
8663 combinations cannot be mapped.
8664 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008665 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 keys can be mapped.
8667 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8668 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008669 This option is not used for <F10>; on Win32 and with GTK <F10> will
8670 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008672 *'window'* *'wi'*
8673'window' 'wi' number (default screen height - 1)
8674 global
8675 Window height. Do not confuse this with the height of the Vim window,
8676 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008677 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8678 value is smaller than 'lines' minus one. The screen will scroll
8679 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008680 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8681 in a much smarter way, taking care of wrapping lines.
8682 When resizing the Vim window, the value is smaller than 1 or more than
8683 or equal to 'lines' it will be set to 'lines' minus 1.
8684 {Vi also uses the option to specify the number of displayed lines}
8685
Bram Moolenaar071d4272004-06-13 20:20:40 +00008686 *'winheight'* *'wh'* *E591*
8687'winheight' 'wh' number (default 1)
8688 global
8689 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008690 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008691 feature}
8692 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008693 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008694 focus goes to a window that is smaller, its size is increased, at the
8695 cost of the height of other windows.
8696 Set 'winheight' to a small number for normal editing.
8697 Set it to 999 to make the current window fill most of the screen.
8698 Other windows will be only 'winminheight' high. This has the drawback
8699 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8700 to create only two windows, set the option after startup is done,
8701 using the |VimEnter| event: >
8702 au VimEnter * set winheight=999
8703< Minimum value is 1.
8704 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 height of the current window.
8706 'winheight' applies to the current window. Use 'winminheight' to set
8707 the minimal height for other windows.
8708
8709 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8710'winfixheight' 'wfh' boolean (default off)
8711 local to window
8712 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008713 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008714 feature}
8715 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008716 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8717 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008718 The height may be changed anyway when running out of room.
8719
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008720 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8721'winfixwidth' 'wfw' boolean (default off)
8722 local to window
8723 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008724 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008725 feature}
8726 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008727 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008728 The width may be changed anyway when running out of room.
8729
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 *'winminheight'* *'wmh'*
8731'winminheight' 'wmh' number (default 1)
8732 global
8733 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008734 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 feature}
8736 The minimal height of a window, when it's not the current window.
8737 This is a hard minimum, windows will never become smaller.
8738 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8739 status bar) if necessary. They will return to at least one line when
8740 they become active (since the cursor has to have somewhere to go.)
8741 Use 'winheight' to set the minimal height of the current window.
8742 This option is only checked when making a window smaller. Don't use a
8743 large number, it will cause errors when opening more than a few
8744 windows. A value of 0 to 3 is reasonable.
8745
8746 *'winminwidth'* *'wmw'*
8747'winminwidth' 'wmw' number (default 1)
8748 global
8749 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008750 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008751 feature}
8752 The minimal width of a window, when it's not the current window.
8753 This is a hard minimum, windows will never become smaller.
8754 When set to zero, windows may be "squashed" to zero columns (i.e. just
8755 a vertical separator) if necessary. They will return to at least one
8756 line when they become active (since the cursor has to have somewhere
8757 to go.)
8758 Use 'winwidth' to set the minimal width of the current window.
8759 This option is only checked when making a window smaller. Don't use a
8760 large number, it will cause errors when opening more than a few
8761 windows. A value of 0 to 12 is reasonable.
8762
8763 *'winwidth'* *'wiw'* *E592*
8764'winwidth' 'wiw' number (default 20)
8765 global
8766 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008767 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008768 feature}
8769 Minimal number of columns for the current window. This is not a hard
8770 minimum, Vim will use fewer columns if there is not enough room. If
8771 the current window is smaller, its size is increased, at the cost of
8772 the width of other windows. Set it to 999 to make the current window
8773 always fill the screen. Set it to a small number for normal editing.
8774 The width is not adjusted after one of the commands to change the
8775 width of the current window.
8776 'winwidth' applies to the current window. Use 'winminwidth' to set
8777 the minimal width for other windows.
8778
8779 *'wrap'* *'nowrap'*
8780'wrap' boolean (default on)
8781 local to window
8782 {not in Vi}
8783 This option changes how text is displayed. It doesn't change the text
8784 in the buffer, see 'textwidth' for that.
8785 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008786 displaying continues on the next line. When off lines will not wrap
8787 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008788 moved to a part that is not shown, the screen will scroll
8789 horizontally.
8790 The line will be broken in the middle of a word if necessary. See
8791 'linebreak' to get the break at a word boundary.
8792 To make scrolling horizontally a bit more useful, try this: >
8793 :set sidescroll=5
8794 :set listchars+=precedes:<,extends:>
8795< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008796 This option can't be set from a |modeline| when the 'diff' option is
8797 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798
8799 *'wrapmargin'* *'wm'*
8800'wrapmargin' 'wm' number (default 0)
8801 local to buffer
8802 Number of characters from the right window border where wrapping
8803 starts. When typing text beyond this limit, an <EOL> will be inserted
8804 and inserting continues on the next line.
8805 Options that add a margin, such as 'number' and 'foldcolumn', cause
8806 the text width to be further reduced. This is Vi compatible.
8807 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008808 This option is set to 0 when 'paste' is set and restored when 'paste'
8809 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008810 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8811 and less usefully}
8812
8813 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8814'wrapscan' 'ws' boolean (default on) *E384* *E385*
8815 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008816 Searches wrap around the end of the file. Also applies to |]s| and
8817 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008818
8819 *'write'* *'nowrite'*
8820'write' boolean (default on)
8821 global
8822 {not in Vi}
8823 Allows writing files. When not set, writing a file is not allowed.
8824 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008825 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 argument. Filtering text is still possible, even though this requires
8827 writing a temporary file.
8828
8829 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8830'writeany' 'wa' boolean (default off)
8831 global
8832 Allows writing to any file with no need for "!" override.
8833
8834 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8835'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8836 otherwise)
8837 global
8838 {not in Vi}
8839 Make a backup before overwriting a file. The backup is removed after
8840 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008841 also on.
8842 WARNING: Switching this option off means that when Vim fails to write
8843 your buffer correctly and then, for whatever reason, Vim exits, you
8844 lose both the original file and what you were writing. Only reset
8845 this option if your file system is almost full and it makes the write
8846 fail (and make sure not to exit Vim until the write was successful).
8847 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008848 When the 'backupskip' pattern matches, a backup is not made anyway.
8849 NOTE: This option is set to the default value when 'compatible' is
8850 set.
8851
8852 *'writedelay'* *'wd'*
8853'writedelay' 'wd' number (default 0)
8854 global
8855 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008856 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 screen. When non-zero, characters are sent to the terminal one by
8858 one. For MS-DOS pcterm this does not work. For debugging purposes.
8859
8860 vim:tw=78:ts=8:ft=help:norl: