blob: d71e7f9c46bf98c95a74137cbabdb14fa8c7ac1d [file] [log] [blame]
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001*options.txt* For Vim version 8.0. Last change: 2017 Nov 18
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200373:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200383
384 When the optional FALLBACK argument is present, a
385 later :setfiletype command will override the
386 'filetype'. This is to used for filetype detections
387 that are just a guess. |did_filetype()| will return
388 false after this command.
389
Bram Moolenaar071d4272004-06-13 20:20:40 +0000390 {not in Vi}
391
Bram Moolenaard58e9292011-02-09 17:07:58 +0100392 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
394:opt[ions] Open a window for viewing and setting all options.
395 Options are grouped by function.
396 Offers short help for each option. Hit <CR> on the
397 short help to open a help window with more help for
398 the option.
399 Modify the value of the option and hit <CR> on the
400 "set" line to set the new value. For window and
401 buffer specific options, the last accessed window is
402 used to set the option value in, unless this is a help
403 window, in which case the window below help window is
404 used (skipping the option-window).
405 {not available when compiled without the |+eval| or
406 |+autocmd| features}
407
408 *$HOME*
409Using "~" is like using "$HOME", but it is only recognized at the start of an
410option and after a space or comma.
411
412On Unix systems "~user" can be used too. It is replaced by the home directory
413of user "user". Example: >
414 :set path=~mool/include,/usr/include,.
415
416On Unix systems the form "${HOME}" can be used too. The name between {} can
417contain non-id characters then. Note that if you want to use this for the
418"gf" command, you need to add the '{' and '}' characters to 'isfname'.
419
420NOTE: expanding environment variables and "~/" is only done with the ":set"
421command, not when assigning a value to an option with ":let".
422
Bram Moolenaarc572da52017-08-27 16:52:01 +0200423 *$HOME-windows*
424On MS-Windows, if $HOME is not defined as an environment variable, then
425at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200426If $HOMEDRIVE is not set then $USERPROFILE is used.
427
428This expanded value is not exported to the environment, this matters when
429running an external command: >
430 :echo system('set | findstr ^HOME=')
431and >
432 :echo luaeval('os.getenv("HOME")')
433should echo nothing (an empty string) despite exists('$HOME') being true.
434When setting $HOME to a non-empty string it will be exported to the
435subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200436
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
438Note the maximum length of an expanded option is limited. How much depends on
439the system, mostly it is something like 256 or 1024 characters.
440
441 *:fix* *:fixdel*
442:fix[del] Set the value of 't_kD':
443 't_kb' is 't_kD' becomes ~
444 CTRL-? CTRL-H
445 not CTRL-? CTRL-?
446
447 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
448
449 If your delete key terminal code is wrong, but the
450 code for backspace is alright, you can put this in
451 your .vimrc: >
452 :fixdel
453< This works no matter what the actual code for
454 backspace is.
455
456 If the backspace key terminal code is wrong you can
457 use this: >
458 :if &term == "termname"
459 : set t_kb=^V<BS>
460 : fixdel
461 :endif
462< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000463 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000464 with your terminal name.
465
466 If your <Delete> key sends a strange key sequence (not
467 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
468 :if &term == "termname"
469 : set t_kD=^V<Delete>
470 :endif
471< Where "^V" is CTRL-V and "<Delete>" is the delete key
472 (don't type eight characters!). Replace "termname"
473 with your terminal name.
474
475 *Linux-backspace*
476 Note about Linux: By default the backspace key
477 produces CTRL-?, which is wrong. You can fix it by
478 putting this line in your rc.local: >
479 echo "keycode 14 = BackSpace" | loadkeys
480<
481 *NetBSD-backspace*
482 Note about NetBSD: If your backspace doesn't produce
483 the right code, try this: >
484 xmodmap -e "keycode 22 = BackSpace"
485< If this works, add this in your .Xmodmap file: >
486 keysym 22 = BackSpace
487< You need to restart for this to take effect.
488
489==============================================================================
4902. Automatically setting options *auto-setting*
491
492Besides changing options with the ":set" command, there are three alternatives
493to set options automatically for one or more files:
494
4951. When starting Vim initializations are read from various places. See
496 |initialization|. Most of them are performed for all editing sessions,
497 and some of them depend on the directory where Vim is started.
498 You can create an initialization file with |:mkvimrc|, |:mkview| and
499 |:mksession|.
5002. If you start editing a new file, the automatic commands are executed.
501 This can be used to set options for files matching a particular pattern and
502 many other things. See |autocommand|.
5033. If you start editing a new file, and the 'modeline' option is on, a
504 number of lines at the beginning and end of the file are checked for
505 modelines. This is explained here.
506
507 *modeline* *vim:* *vi:* *ex:* *E520*
508There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200511[text] any text or empty
512{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514[white] optional white space
515{options} a list of option settings, separated with white space
516 or ':', where each part between ':' is the argument
517 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000518
Bram Moolenaar14b69452013-06-29 23:05:20 +0200519Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000520 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000522
523The second form (this is compatible with some versions of Vi):
524
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200525 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200527[text] any text or empty
528{white} at least one blank character (<Space> or <Tab>)
529{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
530[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531se[t] the string "set " or "se " (note the space); When
532 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533{options} a list of options, separated with white space, which
534 is the argument for a ":set" command
535: a colon
536[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
Bram Moolenaar14b69452013-06-29 23:05:20 +0200538Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200540 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200542The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
543chance that a normal word like "lex:" is caught. There is one exception:
544"vi:" and "vim:" can also be at the start of the line (for compatibility with
545version 3.0). Using "ex:" at the start of the line will be ignored (this
546could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547
548 *modeline-local*
549The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000550buffer and window that contain the file. Although it's possible to set global
551options from a modeline, this is unusual. If you have two windows open and
552the files in it set the same global option to a different value, the result
553depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000555When editing a file that was already loaded, only the window-local options
556from the modeline are used. Thus if you manually changed a buffer-local
557option after opening the file, it won't be changed if you edit the same buffer
558in another window. But window-local options will be set.
559
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560 *modeline-version*
561If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200562number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563 vim{vers}: version {vers} or later
564 vim<{vers}: version before {vers}
565 vim={vers}: version {vers}
566 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100567{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
568For example, to use a modeline only for Vim 7.0:
569 /* vim700: set foldmethod=marker */ ~
570To use a modeline for Vim after version 7.2:
571 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572There can be no blanks between "vim" and the ":".
573
574
575The number of lines that are checked can be set with the 'modelines' option.
576If 'modeline' is off or 'modelines' is 0 no lines are checked.
577
578Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000579like:
580 /* vi:ts=4: */ ~
581will give an error message for the trailing "*/". This line is OK:
582 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583
584If an error is detected the rest of the line is skipped.
585
586If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000587backslash in front of the ':' will be removed. Example:
588 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589This sets the 'dir' option to "c:\tmp". Only a single backslash before the
590':' is removed. Thus to include "\:" you have to specify "\\:".
591
592No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000593might create a Trojan horse text file with modelines). And not all options
594can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000595|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000596causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
597are wrapped unexpectedly. So disable modelines before editing untrusted text.
598The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
600Hint: If you would like to do something else than setting an option, you could
601define an autocommand that checks the file for a specific string. For
602example: >
603 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
604And define a function SetVar() that does something with the line containing
605"VAR".
606
607==============================================================================
6083. Options summary *option-summary*
609
610In the list below all the options are mentioned with their full name and with
611an abbreviation if there is one. Both forms may be used.
612
613In this document when a boolean option is "set" that means that ":set option"
614is entered. When an option is "reset", ":set nooption" is used.
615
616For some options there are two default values: The "Vim default", which is
617used when 'compatible' is not set, and the "Vi default", which is used when
618'compatible' is set.
619
620Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000621are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622different value in each window. For example the 'list' option can be set in
623one window and reset in another for the same text, giving both types of view
624at the same time. There are a few options that are specific to a certain
625file. These can have a different value for each file or buffer. For example
626the 'textwidth' option can be 78 for a normal text file and 0 for a C
627program.
628
629 global one option for all buffers and windows
630 local to window each window has its own copy of this option
631 local to buffer each buffer has its own copy of this option
632
633When creating a new window the option values from the currently active window
634are used as a default value for the window-specific options. For the
635buffer-specific options this depends on the 's' and 'S' flags in the
636'cpoptions' option. If 's' is included (which is the default) the values for
637buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000638first entered. If 'S' is present the options are copied each time the buffer
639is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640present, the options are copied from the currently active buffer when the
641buffer is created.
642
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000643Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000645Not all options are supported in all versions. This depends on the supported
646features and sometimes on the system. A remark about this is in curly braces
647below. When an option is not supported it may still be set without getting an
648error, this is called a hidden option. You can't get the value of a hidden
649option though, it is not stored.
650
651To test if option "foo" can be used with ":set" use something like this: >
652 if exists('&foo')
653This also returns true for a hidden option. To test if option "foo" is really
654supported use something like this: >
655 if exists('+foo')
656<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 *E355*
658A jump table for the options with a short description can be found at |Q_op|.
659
660 *'aleph'* *'al'* *aleph* *Aleph*
661'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
662 global
663 {not in Vi}
664 {only available when compiled with the |+rightleft|
665 feature}
666 The ASCII code for the first letter of the Hebrew alphabet. The
667 routine that maps the keyboard in Hebrew mode, both in Insert mode
668 (when hkmap is set) and on the command-line (when hitting CTRL-_)
669 outputs the Hebrew characters in the range [aleph..aleph+26].
670 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
671 See |rileft.txt|.
672
673 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
674'allowrevins' 'ari' boolean (default off)
675 global
676 {not in Vi}
677 {only available when compiled with the |+rightleft|
678 feature}
679 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
680 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
681 into reverse Insert mode, and don't know how to get out. See
682 'revins'.
683 NOTE: This option is reset when 'compatible' is set.
684
685 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
686'altkeymap' 'akm' boolean (default off)
687 global
688 {not in Vi}
689 {only available when compiled with the |+farsi|
690 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 the keyboard map between Farsi and English, when 'allowrevins' set.
693
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 is useful to start the Vim in native mode i.e. English (left-to-right
696 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000697 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000698
699 *'ambiwidth'* *'ambw'*
700'ambiwidth' 'ambw' string (default: "single")
701 global
702 {not in Vi}
703 {only available when compiled with the |+multi_byte|
704 feature}
705 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
706 Tells Vim what to do with characters with East Asian Width Class
707 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
708 letters, Cyrillic letters).
709
710 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000711 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 expected by most users.
713 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200714 *E834* *E835*
715 The value "double" cannot be used if 'listchars' or 'fillchars'
716 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717
718 There are a number of CJK fonts for which the width of glyphs for
719 those characters are solely based on how many octets they take in
720 legacy/traditional CJK encodings. In those encodings, Euro,
721 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000722 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000724 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000725 Vim is running inside a terminal (emulators) that uses a CJK font
726 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
727 this option should be set to "double" to match the width perceived
728 by Vim with the width of glyphs in the font. Perhaps it also has
729 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
730 when the system locale is set to one of CJK locales. See Unicode
731 Standard Annex #11 (http://www.unicode.org/reports/tr11).
732
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100733 Vim may set this option automatically at startup time when Vim is
734 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200735 escape sequence to request cursor position report. The response can
736 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100737
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
739'antialias' 'anti' boolean (default: off)
740 global
741 {not in Vi}
742 {only available when compiled with GUI enabled
743 on Mac OS X}
744 This option only has an effect in the GUI version of Vim on Mac OS X
745 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
746 which can be easier to read at certain sizes on certain displays.
747 Setting this option can sometimes cause problems if 'guifont' is set
748 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100749 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750
751 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
752'autochdir' 'acd' boolean (default off)
753 global
754 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200755 {only available when compiled with it, use
756 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000757 When on, Vim will change the current working directory whenever you
758 open a file, switch buffers, delete a buffer or open/close a window.
759 It will change to the directory containing the file which was opened
760 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000761 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762
763 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
764'arabic' 'arab' boolean (default off)
765 local to window
766 {not in Vi}
767 {only available when compiled with the |+arabic|
768 feature}
769 This option can be set to start editing Arabic text.
770 Setting this option will:
771 - Set the 'rightleft' option, unless 'termbidi' is set.
772 - Set the 'arabicshape' option, unless 'termbidi' is set.
773 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
774 between typing English and Arabic key mapping.
775 - Set the 'delcombine' option
776 Note that 'encoding' must be "utf-8" for working with Arabic text.
777
778 Resetting this option will:
779 - Reset the 'rightleft' option.
780 - Disable the use of 'keymap' (without changing its value).
781 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200782 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784 Also see |arabic.txt|.
785
786 *'arabicshape'* *'arshape'*
787 *'noarabicshape'* *'noarshape'*
788'arabicshape' 'arshape' boolean (default on)
789 global
790 {not in Vi}
791 {only available when compiled with the |+arabic|
792 feature}
793 When on and 'termbidi' is off, the required visual character
794 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200795 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796 one which encompasses:
797 a) the changing/morphing of characters based on their location
798 within a word (initial, medial, final and stand-alone).
799 b) the enabling of the ability to compose characters
800 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100801 When disabled the display shows each character's true stand-alone
802 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 Arabic is a complex language which requires other settings, for
804 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100805 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806
807 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
808'autoindent' 'ai' boolean (default off)
809 local to buffer
810 Copy indent from current line when starting a new line (typing <CR>
811 in Insert mode or when using the "o" or "O" command). If you do not
812 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000813 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
814 to another line has the same effect, unless the 'I' flag is included
815 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000816 When autoindent is on, formatting (with the "gq" command or when you
817 reach 'textwidth' in Insert mode) uses the indentation of the first
818 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 When 'smartindent' or 'cindent' is on the indent is changed in
820 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200821 The 'autoindent' option is reset when the 'paste' option is set and
822 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 {small difference from Vi: After the indent is deleted when typing
824 <Esc> or <CR>, the cursor position when moving up or down is after the
825 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
826
827 *'autoread'* *'ar'* *'noautoread'* *'noar'*
828'autoread' 'ar' boolean (default off)
829 global or local to buffer |global-local|
830 {not in Vi}
831 When a file has been detected to have been changed outside of Vim and
832 it has not been changed inside of Vim, automatically read it again.
833 When the file has been deleted this is not done. |timestamp|
834 If this option has a local value, use this command to switch back to
835 using the global value: >
836 :set autoread<
837<
838 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
839'autowrite' 'aw' boolean (default off)
840 global
841 Write the contents of the file, if it has been modified, on each
842 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000843 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
845 Note that for some commands the 'autowrite' option is not used, see
846 'autowriteall' for that.
847
848 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
849'autowriteall' 'awa' boolean (default off)
850 global
851 {not in Vi}
852 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
853 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
854 Setting this option also implies that Vim behaves like 'autowrite' has
855 been set.
856
857 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200858'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859 global
860 {not in Vi}
861 When set to "dark", Vim will try to use colors that look good on a
862 dark background. When set to "light", Vim will try to use colors that
863 look good on a light background. Any other value is illegal.
864 Vim tries to set the default value according to the terminal used.
865 This will not always be correct.
866 Setting this option does not change the background color, it tells Vim
867 what the background color looks like. For changing the background
868 color, see |:hi-normal|.
869
870 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000871 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000872 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100873 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 setting 'background' will cause the color scheme to be reloaded. If
875 the color scheme adjusts to the value of 'background' this will work.
876 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100877 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878
879 When setting 'background' to the default value with: >
880 :set background&
881< Vim will guess the value. In the GUI this should work correctly,
882 in other cases Vim might not be able to guess the right value.
883
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200884 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200885 color from the terminal. If the returned RGB value is dark/light and
886 'background' is not dark/light, 'background' will be set and the
887 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200888 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100889 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200890
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891 When starting the GUI, the default value for 'background' will be
892 "light". When the value is not set in the .gvimrc, and Vim detects
893 that the background is actually quite dark, 'background' is set to
894 "dark". But this happens only AFTER the .gvimrc file has been read
895 (because the window needs to be opened to find the actual background
896 color). To get around this, force the GUI window to be opened by
897 putting a ":gui" command in the .gvimrc file, before where the value
898 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200899
900 For MS-DOS, Windows and OS/2 the default is "dark".
901 For other systems "dark" is used when 'term' is "linux",
902 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
903 background. Otherwise the default is "light".
904
Bram Moolenaarc572da52017-08-27 16:52:01 +0200905 The |:terminal| command and the |term_start()| function use the
906 'background' value to decide whether the terminal window will start
907 with a white or black background.
908
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 Normally this option would be set in the .vimrc file. Possibly
910 depending on the terminal name. Example: >
911 :if &term == "pcterm"
912 : set background=dark
913 :endif
914< When this option is set, the default settings for the highlight groups
915 will change. To use other settings, place ":highlight" commands AFTER
916 the setting of the 'background' option.
917 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
918 to select the colors for syntax highlighting. After changing this
919 option, you must load syntax.vim again to see the result. This can be
920 done with ":syntax on".
921
922 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200923'backspace' 'bs' string (default "", set to "indent,eol,start"
924 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 global
926 {not in Vi}
927 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
928 mode. This is a list of items, separated by commas. Each item allows
929 a way to backspace over something:
930 value effect ~
931 indent allow backspacing over autoindent
932 eol allow backspacing over line breaks (join lines)
933 start allow backspacing over the start of insert; CTRL-W and CTRL-U
934 stop once at the start of insert.
935
936 When the value is empty, Vi compatible backspacing is used.
937
938 For backwards compatibility with version 5.4 and earlier:
939 value effect ~
940 0 same as ":set backspace=" (Vi compatible)
941 1 same as ":set backspace=indent,eol"
942 2 same as ":set backspace=indent,eol,start"
943
944 See |:fixdel| if your <BS> or <Del> key does not do what you want.
945 NOTE: This option is set to "" when 'compatible' is set.
946
947 *'backup'* *'bk'* *'nobackup'* *'nobk'*
948'backup' 'bk' boolean (default off)
949 global
950 {not in Vi}
951 Make a backup before overwriting a file. Leave it around after the
952 file has been successfully written. If you do not want to keep the
953 backup file, but you do want a backup while the file is being
954 written, reset this option and set the 'writebackup' option (this is
955 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000956 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000957 |backup-table| for more explanations.
958 When the 'backupskip' pattern matches, a backup is not made anyway.
959 When 'patchmode' is set, the backup may be renamed to become the
960 oldest version of a file.
961 NOTE: This option is reset when 'compatible' is set.
962
963 *'backupcopy'* *'bkc'*
964'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200965 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 {not in Vi}
967 When writing a file and a backup is made, this option tells how it's
968 done. This is a comma separated list of words.
969
970 The main values are:
971 "yes" make a copy of the file and overwrite the original one
972 "no" rename the file and write a new one
973 "auto" one of the previous, what works best
974
975 Extra values that can be combined with the ones above are:
976 "breaksymlink" always break symlinks when writing
977 "breakhardlink" always break hardlinks when writing
978
979 Making a copy and overwriting the original file:
980 - Takes extra time to copy the file.
981 + When the file has special attributes, is a (hard/symbolic) link or
982 has a resource fork, all this is preserved.
983 - When the file is a link the backup will have the name of the link,
984 not of the real file.
985
986 Renaming the file and writing a new one:
987 + It's fast.
988 - Sometimes not all attributes of the file can be copied to the new
989 file.
990 - When the file is a link the new file will not be a link.
991
992 The "auto" value is the middle way: When Vim sees that renaming file
993 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000994 the file is not a link) that is used. When problems are expected, a
995 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996
997 The "breaksymlink" and "breakhardlink" values can be used in
998 combination with any of "yes", "no" and "auto". When included, they
999 force Vim to always break either symbolic or hard links by doing
1000 exactly what the "no" option does, renaming the original file to
1001 become the backup and writing a new file in its place. This can be
1002 useful for example in source trees where all the files are symbolic or
1003 hard links and any changes should stay in the local source tree, not
1004 be propagated back to the original source.
1005 *crontab*
1006 One situation where "no" and "auto" will cause problems: A program
1007 that opens a file, invokes Vim to edit that file, and then tests if
1008 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001009 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 example.
1011
1012 When a copy is made, the original file is truncated and then filled
1013 with the new text. This means that protection bits, owner and
1014 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001015 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 group of the backup is set to the group of the original file. If this
1017 fails, the protection bits for the group are made the same as for
1018 others.
1019
1020 When the file is renamed this is the other way around: The backup has
1021 the same attributes of the original file, and the newly written file
1022 is owned by the current user. When the file was a (hard/symbolic)
1023 link, the new file will not! That's why the "auto" value doesn't
1024 rename when the file is a link. The owner and group of the newly
1025 written file will be set to the same ones as the original file, but
1026 the system may refuse to do this. In that case the "auto" value will
1027 again not rename the file.
1028
Bram Moolenaar036986f2017-03-16 17:41:02 +01001029 NOTE: This option is set to the Vi default value when 'compatible' is
1030 set and to the Vim default value when 'compatible' is reset.
1031
Bram Moolenaar071d4272004-06-13 20:20:40 +00001032 *'backupdir'* *'bdir'*
1033'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001034 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 for Unix: ".,~/tmp,~/")
1036 global
1037 {not in Vi}
1038 List of directories for the backup file, separated with commas.
1039 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001040 where this is possible. The directory must exist, Vim will not
1041 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001042 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001043 impossible!). Writing may fail because of this.
1044 - A directory "." means to put the backup file in the same directory
1045 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001046 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 put the backup file relative to where the edited file is. The
1048 leading "." is replaced with the path name of the edited file.
1049 ("." inside a directory name has no special meaning).
1050 - Spaces after the comma are ignored, other spaces are considered part
1051 of the directory name. To have a space at the start of a directory
1052 name, precede it with a backslash.
1053 - To include a comma in a directory name precede it with a backslash.
1054 - A directory name may end in an '/'.
1055 - Environment variables are expanded |:set_env|.
1056 - Careful with '\' characters, type one before a space, type two to
1057 get one in the option (see |option-backslash|), for example: >
1058 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1059< - For backwards compatibility with Vim version 3.0 a '>' at the start
1060 of the option is removed.
1061 See also 'backup' and 'writebackup' options.
1062 If you want to hide your backup files on Unix, consider this value: >
1063 :set backupdir=./.backup,~/.backup,.,/tmp
1064< You must create a ".backup" directory in each directory and in your
1065 home directory for this to work properly.
1066 The use of |:set+=| and |:set-=| is preferred when adding or removing
1067 directories from the list. This avoids problems when a future version
1068 uses another default.
1069 This option cannot be set from a |modeline| or in the |sandbox|, for
1070 security reasons.
1071
1072 *'backupext'* *'bex'* *E589*
1073'backupext' 'bex' string (default "~", for VMS: "_")
1074 global
1075 {not in Vi}
1076 String which is appended to a file name to make the name of the
1077 backup file. The default is quite unusual, because this avoids
1078 accidentally overwriting existing files with a backup file. You might
1079 prefer using ".bak", but make sure that you don't have files with
1080 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001081 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001083 If you like to keep a lot of backups, you could use a BufWritePre
1084 autocommand to change 'backupext' just before writing the file to
1085 include a timestamp. >
1086 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1087< Use 'backupdir' to put the backup in a different directory.
1088
Bram Moolenaar071d4272004-06-13 20:20:40 +00001089 *'backupskip'* *'bsk'*
1090'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1091 global
1092 {not in Vi}
1093 {not available when compiled without the |+wildignore|
1094 feature}
1095 A list of file patterns. When one of the patterns matches with the
1096 name of the file which is written, no backup file is created. Both
1097 the specified file name and the full path name of the file are used.
1098 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1099 Watch out for special characters, see |option-backslash|.
1100 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001101 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001102
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001103 WARNING: Not having a backup file means that when Vim fails to write
1104 your buffer correctly and then, for whatever reason, Vim exits, you
1105 lose both the original file and what you were writing. Only disable
1106 backups if you don't care about losing the file.
1107
Bram Moolenaar02467872007-05-06 13:22:01 +00001108 Note that environment variables are not expanded. If you want to use
1109 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001110 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001111
1112< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001113 backup would be made by renaming the original file crontab won't see
1114 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115
1116 *'balloondelay'* *'bdlay'*
1117'balloondelay' 'bdlay' number (default: 600)
1118 global
1119 {not in Vi}
1120 {only available when compiled with the |+balloon_eval|
1121 feature}
1122 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1123
1124 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1125'ballooneval' 'beval' boolean (default off)
1126 global
1127 {not in Vi}
1128 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001130 Switch on the |balloon-eval| functionality for the GUI.
1131
1132 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1133 *'nobevalterm'*
1134'balloonevalterm' 'bevalterm' boolean (default off)
1135 global
1136 {not in Vi}
1137 {only available when compiled with the
1138 |+balloon_eval_term| feature}
1139 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 *'balloonexpr'* *'bexpr'*
1142'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001143 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 {not in Vi}
1145 {only available when compiled with the |+balloon_eval|
1146 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001147 Expression for text to show in evaluation balloon. It is only used
1148 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001149
1150 v:beval_bufnr number of the buffer in which balloon is going to show
1151 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001152 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001153 v:beval_lnum line number
1154 v:beval_col column number (byte index)
1155 v:beval_text word under or after the mouse pointer
1156
1157 The evaluation of the expression must not have side effects!
1158 Example: >
1159 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001160 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001161 \', column ' . v:beval_col .
1162 \ ' of file ' . bufname(v:beval_bufnr) .
1163 \ ' on word "' . v:beval_text . '"'
1164 endfunction
1165 set bexpr=MyBalloonExpr()
1166 set ballooneval
1167<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001168 Also see |balloon_show()|, can be used if the content of the balloon
1169 is to be fetched asynchronously.
1170
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001171 NOTE: The balloon is displayed only if the cursor is on a text
1172 character. If the result of evaluating 'balloonexpr' is not empty,
1173 Vim does not try to send a message to an external debugger (Netbeans
1174 or Sun Workshop).
1175
Bram Moolenaar30b65812012-07-12 22:01:11 +02001176 The expression will be evaluated in the |sandbox| when set from a
1177 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001178
1179 It is not allowed to change text or jump to another window while
1180 evaluating 'balloonexpr' |textlock|.
1181
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001182 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001183 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001184< When they are supported "\n" characters will start a new line. If the
1185 expression evaluates to a |List| this is equal to using each List item
1186 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001187 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001188
Bram Moolenaar165bc692015-07-21 17:53:25 +02001189 *'belloff'* *'bo'*
1190'belloff' 'bo' string (default "")
1191 global
1192 {not in Vi}
1193 Specifies for which events the bell will not be rung. It is a comma
1194 separated list of items. For each item that is present, the bell
1195 will be silenced. This is most useful to specify specific events in
1196 insert mode to be silenced.
1197
1198 item meaning when present ~
1199 all All events.
1200 backspace When hitting <BS> or <Del> and deleting results in an
1201 error.
1202 cursor Fail to move around using the cursor keys or
1203 <PageUp>/<PageDown> in |Insert-mode|.
1204 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1205 |i_CTRL-X_CTRL-T|.
1206 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1207 |i_CTRL-E|.
1208 ctrlg Unknown Char after <C-G> in Insert mode.
1209 error Other Error occurred (e.g. try to join last line)
1210 (mostly used in |Normal-mode| or |Cmdline-mode|).
1211 esc hitting <Esc> in |Normal-mode|.
1212 ex In |Visual-mode|, hitting |Q| results in an error.
1213 hangul Error occurred when using hangul input.
1214 insertmode Pressing <Esc> in 'insertmode'.
1215 lang Calling the beep module for Lua/Mzscheme/TCL.
1216 mess No output available for |g<|.
1217 showmatch Error occurred for 'showmatch' function.
1218 operator Empty region error |cpo-E|.
1219 register Unknown register after <C-R> in |Insert-mode|.
1220 shell Bell from shell output |:!|.
1221 spell Error happened on spell suggest.
1222 wildmode More matches in |cmdline-completion| available
1223 (depends on the 'wildmode' setting).
1224
Bram Moolenaar036986f2017-03-16 17:41:02 +01001225 This is most useful to fine tune when in Insert mode the bell should
1226 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001227 indicate that an error occurred. It can be silenced by adding the
1228 "error" keyword.
1229
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1231'binary' 'bin' boolean (default off)
1232 local to buffer
1233 {not in Vi}
1234 This option should be set before editing a binary file. You can also
1235 use the |-b| Vim argument. When this option is switched on a few
1236 options will be changed (also when it already was on):
1237 'textwidth' will be set to 0
1238 'wrapmargin' will be set to 0
1239 'modeline' will be off
1240 'expandtab' will be off
1241 Also, 'fileformat' and 'fileformats' options will not be used, the
1242 file is read and written like 'fileformat' was "unix" (a single <NL>
1243 separates lines).
1244 The 'fileencoding' and 'fileencodings' options will not be used, the
1245 file is read without conversion.
1246 NOTE: When you start editing a(nother) file while the 'bin' option is
1247 on, settings from autocommands may change the settings again (e.g.,
1248 'textwidth'), causing trouble when editing. You might want to set
1249 'bin' again when the file has been loaded.
1250 The previous values of these options are remembered and restored when
1251 'bin' is switched from on to off. Each buffer has its own set of
1252 saved option values.
1253 To edit a file with 'binary' set you can use the |++bin| argument.
1254 This avoids you have to do ":set bin", which would have effect for all
1255 files you edit.
1256 When writing a file the <EOL> for the last line is only written if
1257 there was one in the original file (normally Vim appends an <EOL> to
1258 the last line if there is none; this would make the file longer). See
1259 the 'endofline' option.
1260
1261 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1262'bioskey' 'biosk' boolean (default on)
1263 global
1264 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001265 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266
1267 *'bomb'* *'nobomb'*
1268'bomb' boolean (default off)
1269 local to buffer
1270 {not in Vi}
1271 {only available when compiled with the |+multi_byte|
1272 feature}
1273 When writing a file and the following conditions are met, a BOM (Byte
1274 Order Mark) is prepended to the file:
1275 - this option is on
1276 - the 'binary' option is off
1277 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1278 endian variants.
1279 Some applications use the BOM to recognize the encoding of the file.
1280 Often used for UCS-2 files on MS-Windows. For other applications it
1281 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001282 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1284 check for the presence of the BOM is done and 'bomb' set accordingly.
1285 Unless 'binary' is set, it is removed from the first line, so that you
1286 don't see it when editing. When you don't change the options, the BOM
1287 will be restored when writing the file.
1288
1289 *'breakat'* *'brk'*
1290'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1291 global
1292 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001293 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294 feature}
1295 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001296 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1297 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001299 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300'breakindent' 'bri' boolean (default off)
1301 local to window
1302 {not in Vi}
1303 {not available when compiled without the |+linebreak|
1304 feature}
1305 Every wrapped line will continue visually indented (same amount of
1306 space as the beginning of that line), thus preserving horizontal blocks
1307 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001308 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309
1310 *'breakindentopt'* *'briopt'*
1311'breakindentopt' 'briopt' string (default empty)
1312 local to window
1313 {not in Vi}
1314 {not available when compiled without the |+linebreak|
1315 feature}
1316 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001317 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001318 min:{n} Minimum text width that will be kept after
1319 applying 'breakindent', even if the resulting
1320 text should normally be narrower. This prevents
1321 text indented almost to the right window border
1322 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001323 shift:{n} After applying 'breakindent', the wrapped line's
1324 beginning will be shifted by the given number of
1325 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001326 indentation (negative) or emphasizing the line
1327 continuation (positive).
1328 sbr Display the 'showbreak' value before applying the
1329 additional indent.
1330 The default value for min is 20 and shift is 0.
1331
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001333'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001335 {not in Vi} {only for Motif, Athena, GTK, Mac and
1336 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001337 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001338 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001339 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 buffer Use the directory of the related buffer.
1341 current Use the current directory.
1342 {path} Use the specified directory
1343
1344 *'bufhidden'* *'bh'*
1345'bufhidden' 'bh' string (default: "")
1346 local to buffer
1347 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 This option specifies what happens when a buffer is no longer
1349 displayed in a window:
1350 <empty> follow the global 'hidden' option
1351 hide hide the buffer (don't unload it), also when 'hidden'
1352 is not set
1353 unload unload the buffer, also when 'hidden' is set or using
1354 |:hide|
1355 delete delete the buffer from the buffer list, also when
1356 'hidden' is set or using |:hide|, like using
1357 |:bdelete|
1358 wipe wipe out the buffer from the buffer list, also when
1359 'hidden' is set or using |:hide|, like using
1360 |:bwipeout|
1361
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001362 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001363 are lost without a warning. Also, these values may break autocommands
1364 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 This option is used together with 'buftype' and 'swapfile' to specify
1366 special kinds of buffers. See |special-buffers|.
1367
1368 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1369'buflisted' 'bl' boolean (default: on)
1370 local to buffer
1371 {not in Vi}
1372 When this option is set, the buffer shows up in the buffer list. If
1373 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1374 This option is reset by Vim for buffers that are only used to remember
1375 a file name or marks. Vim sets it when starting to edit a buffer.
1376 But not when moving to a buffer with ":buffer".
1377
1378 *'buftype'* *'bt'* *E382*
1379'buftype' 'bt' string (default: "")
1380 local to buffer
1381 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382 The value of this option specifies the type of a buffer:
1383 <empty> normal buffer
1384 nofile buffer which is not related to a file and will not be
1385 written
1386 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001387 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001388 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001389 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001391 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 help help buffer (you are not supposed to set this
1393 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001394 terminal buffer for a |terminal| (you are not supposed to set
1395 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396
1397 This option is used together with 'bufhidden' and 'swapfile' to
1398 specify special kinds of buffers. See |special-buffers|.
1399
1400 Be careful with changing this option, it can have many side effects!
1401
Bram Moolenaar280f1262006-01-30 00:14:18 +00001402 A "quickfix" buffer is only used for the error list and the location
1403 list. This value is set by the |:cwindow| and |:lwindow| commands and
1404 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 "nofile" and "nowrite" buffers are similar:
1407 both: The buffer is not to be written to disk, ":w" doesn't
1408 work (":w filename" does work though).
1409 both: The buffer is never considered to be |'modified'|.
1410 There is no warning when the changes will be lost, for
1411 example when you quit Vim.
1412 both: A swap file is only created when using too much memory
1413 (when 'swapfile' has been reset there is never a swap
1414 file).
1415 nofile only: The buffer name is fixed, it is not handled like a
1416 file name. It is not modified in response to a |:cd|
1417 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001418 both: When using ":e bufname" and already editing "bufname"
1419 the buffer is made empty and autocommands are
1420 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001421 *E676*
1422 "acwrite" implies that the buffer name is not related to a file, like
1423 "nofile", but it will be written. Thus, in contrast to "nofile" and
1424 "nowrite", ":w" does work and a modified buffer can't be abandoned
1425 without saving. For writing there must be matching |BufWriteCmd|,
1426 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427
1428 *'casemap'* *'cmp'*
1429'casemap' 'cmp' string (default: "internal,keepascii")
1430 global
1431 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001432 {only available when compiled with the |+multi_byte|
1433 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 Specifies details about changing the case of letters. It may contain
1435 these words, separated by a comma:
1436 internal Use internal case mapping functions, the current
1437 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001438 matters when 'encoding' is a Unicode encoding,
1439 "latin1" or "iso-8859-15". When "internal" is
1440 omitted, the towupper() and towlower() system library
1441 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1443 case mapping, the current locale is not effective.
1444 This probably only matters for Turkish.
1445
1446 *'cdpath'* *'cd'* *E344* *E346*
1447'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1448 global
1449 {not in Vi}
1450 {not available when compiled without the
1451 |+file_in_path| feature}
1452 This is a list of directories which will be searched when using the
1453 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001454 for has a relative path, not an absolute part starting with "/", "./"
1455 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 The 'cdpath' option's value has the same form and semantics as
1457 |'path'|. Also see |file-searching|.
1458 The default value is taken from $CDPATH, with a "," prepended to look
1459 in the current directory first.
1460 If the default value taken from $CDPATH is not what you want, include
1461 a modified version of the following command in your vimrc file to
1462 override it: >
1463 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1464< This option cannot be set from a |modeline| or in the |sandbox|, for
1465 security reasons.
1466 (parts of 'cdpath' can be passed to the shell to expand file names).
1467
1468 *'cedit'*
1469'cedit' string (Vi default: "", Vim default: CTRL-F)
1470 global
1471 {not in Vi}
1472 {not available when compiled without the |+vertsplit|
1473 feature}
1474 The key used in Command-line Mode to open the command-line window.
1475 The default is CTRL-F when 'compatible' is off.
1476 Only non-printable keys are allowed.
1477 The key can be specified as a single character, but it is difficult to
1478 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001479 :exe "set cedit=\<C-Y>"
1480 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481< |Nvi| also has this option, but it only uses the first character.
1482 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001483 NOTE: This option is set to the Vim default value when 'compatible'
1484 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1487'charconvert' 'ccv' string (default "")
1488 global
1489 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001490 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 {not in Vi}
1492 An expression that is used for character encoding conversion. It is
1493 evaluated when a file that is to be read or has been written has a
1494 different encoding from what is desired.
1495 'charconvert' is not used when the internal iconv() function is
1496 supported and is able to do the conversion. Using iconv() is
1497 preferred, because it is much faster.
1498 'charconvert' is not used when reading stdin |--|, because there is no
1499 file to convert from. You will have to save the text in a file first.
1500 The expression must return zero or an empty string for success,
1501 non-zero for failure.
1502 The possible encoding names encountered are in 'encoding'.
1503 Additionally, names given in 'fileencodings' and 'fileencoding' are
1504 used.
1505 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1506 is done internally by Vim, 'charconvert' is not used for this.
1507 'charconvert' is also used to convert the viminfo file, if the 'c'
1508 flag is present in 'viminfo'. Also used for Unicode conversion.
1509 Example: >
1510 set charconvert=CharConvert()
1511 fun CharConvert()
1512 system("recode "
1513 \ . v:charconvert_from . ".." . v:charconvert_to
1514 \ . " <" . v:fname_in . " >" v:fname_out)
1515 return v:shell_error
1516 endfun
1517< The related Vim variables are:
1518 v:charconvert_from name of the current encoding
1519 v:charconvert_to name of the desired encoding
1520 v:fname_in name of the input file
1521 v:fname_out name of the output file
1522 Note that v:fname_in and v:fname_out will never be the same.
1523 Note that v:charconvert_from and v:charconvert_to may be different
1524 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1525 Encryption is not done by Vim when using 'charconvert'. If you want
1526 to encrypt the file after conversion, 'charconvert' should take care
1527 of this.
1528 This option cannot be set from a |modeline| or in the |sandbox|, for
1529 security reasons.
1530
1531 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1532'cindent' 'cin' boolean (default off)
1533 local to buffer
1534 {not in Vi}
1535 {not available when compiled without the |+cindent|
1536 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001537 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 that trigger reindenting in insert mode and 'cinoptions' to set your
1539 preferred indent style.
1540 If 'indentexpr' is not empty, it overrules 'cindent'.
1541 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1542 the "=" operator indents using this algorithm rather than calling an
1543 external program.
1544 See |C-indenting|.
1545 When you don't like the way 'cindent' works, try the 'smartindent'
1546 option or 'indentexpr'.
1547 This option is not used when 'paste' is set.
1548 NOTE: This option is reset when 'compatible' is set.
1549
1550 *'cinkeys'* *'cink'*
1551'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1552 local to buffer
1553 {not in Vi}
1554 {not available when compiled without the |+cindent|
1555 feature}
1556 A list of keys that, when typed in Insert mode, cause reindenting of
1557 the current line. Only used if 'cindent' is on and 'indentexpr' is
1558 empty.
1559 For the format of this option see |cinkeys-format|.
1560 See |C-indenting|.
1561
1562 *'cinoptions'* *'cino'*
1563'cinoptions' 'cino' string (default "")
1564 local to buffer
1565 {not in Vi}
1566 {not available when compiled without the |+cindent|
1567 feature}
1568 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1569 program. See |cinoptions-values| for the values of this option, and
1570 |C-indenting| for info on C indenting in general.
1571
1572
1573 *'cinwords'* *'cinw'*
1574'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1575 local to buffer
1576 {not in Vi}
1577 {not available when compiled without both the
1578 |+cindent| and the |+smartindent| features}
1579 These keywords start an extra indent in the next line when
1580 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1581 an appropriate place (inside {}).
1582 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1583 matter, include the keyword both the uppercase and lowercase:
1584 "if,If,IF".
1585
1586 *'clipboard'* *'cb'*
1587'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1588 for X-windows, "" otherwise)
1589 global
1590 {not in Vi}
1591 {only in GUI versions or when the |+xterm_clipboard|
1592 feature is included}
1593 This option is a list of comma separated names.
1594 These names are recognized:
1595
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001596 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 unnamed When included, Vim will use the clipboard register '*'
1598 for all yank, delete, change and put operations which
1599 would normally go to the unnamed register. When a
1600 register is explicitly specified, it will always be
1601 used regardless of whether "unnamed" is in 'clipboard'
1602 or not. The clipboard register can always be
1603 explicitly accessed using the "* notation. Also see
1604 |gui-clipboard|.
1605
Bram Moolenaar30b65812012-07-12 22:01:11 +02001606 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001607 unnamedplus A variant of the "unnamed" flag which uses the
1608 clipboard register '+' (|quoteplus|) instead of
1609 register '*' for all yank, delete, change and put
1610 operations which would normally go to the unnamed
1611 register. When "unnamed" is also included to the
1612 option, yank operations (but not delete, change or
1613 put) will additionally copy the text into register
1614 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001615 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001616 Availability can be checked with: >
1617 if has('unnamedplus')
1618<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001619 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001620 autoselect Works like the 'a' flag in 'guioptions': If present,
1621 then whenever Visual mode is started, or the Visual
1622 area extended, Vim tries to become the owner of the
1623 windowing system's global selection or put the
1624 selected text on the clipboard used by the selection
1625 register "*. See |guioptions_a| and |quotestar| for
1626 details. When the GUI is active, the 'a' flag in
1627 'guioptions' is used, when the GUI is not active, this
1628 "autoselect" flag is used.
1629 Also applies to the modeless selection.
1630
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001631 *clipboard-autoselectplus*
1632 autoselectplus Like "autoselect" but using the + register instead of
1633 the * register. Compare to the 'P' flag in
1634 'guioptions'.
1635
1636 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 autoselectml Like "autoselect", but for the modeless selection
1638 only. Compare to the 'A' flag in 'guioptions'.
1639
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001640 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001641 html When the clipboard contains HTML, use this when
1642 pasting. When putting text on the clipboard, mark it
1643 as HTML. This works to copy rendered HTML from
1644 Firefox, paste it as raw HTML in Vim, select the HTML
1645 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001646 You probably want to add this only temporarily,
1647 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001648 Only supported for GTK version 2 and later.
1649 Only available with the |+multi_byte| feature.
1650
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001651 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652 exclude:{pattern}
1653 Defines a pattern that is matched against the name of
1654 the terminal 'term'. If there is a match, no
1655 connection will be made to the X server. This is
1656 useful in this situation:
1657 - Running Vim in a console.
1658 - $DISPLAY is set to start applications on another
1659 display.
1660 - You do not want to connect to the X server in the
1661 console, but do want this in a terminal emulator.
1662 To never connect to the X server use: >
1663 exclude:.*
1664< This has the same effect as using the |-X| argument.
1665 Note that when there is no connection to the X server
1666 the window title won't be restored and the clipboard
1667 cannot be accessed.
1668 The value of 'magic' is ignored, {pattern} is
1669 interpreted as if 'magic' was on.
1670 The rest of the option value will be used for
1671 {pattern}, this must be the last entry.
1672
1673 *'cmdheight'* *'ch'*
1674'cmdheight' 'ch' number (default 1)
1675 global
1676 {not in Vi}
1677 Number of screen lines to use for the command-line. Helps avoiding
1678 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001679 The value of this option is stored with the tab page, so that each tab
1680 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681
1682 *'cmdwinheight'* *'cwh'*
1683'cmdwinheight' 'cwh' number (default 7)
1684 global
1685 {not in Vi}
1686 {not available when compiled without the |+vertsplit|
1687 feature}
1688 Number of screen lines to use for the command-line window. |cmdwin|
1689
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001690 *'colorcolumn'* *'cc'*
1691'colorcolumn' 'cc' string (default "")
1692 local to window
1693 {not in Vi}
1694 {not available when compiled without the |+syntax|
1695 feature}
1696 'colorcolumn' is a comma separated list of screen columns that are
1697 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1698 text. Will make screen redrawing slower.
1699 The screen column can be an absolute number, or a number preceded with
1700 '+' or '-', which is added to or subtracted from 'textwidth'. >
1701
1702 :set cc=+1 " highlight column after 'textwidth'
1703 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1704 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1705<
1706 When 'textwidth' is zero then the items with '-' and '+' are not used.
1707 A maximum of 256 columns are highlighted.
1708
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 *'columns'* *'co'* *E594*
1710'columns' 'co' number (default 80 or terminal width)
1711 global
1712 {not in Vi}
1713 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001714 initialization and does not have to be set by hand. Also see
1715 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 When Vim is running in the GUI or in a resizable window, setting this
1717 option will cause the window size to be changed. When you only want
1718 to use the size for the GUI, put the command in your |gvimrc| file.
1719 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001720 number of columns of the display, the display may be messed up. For
1721 the GUI it is always possible and Vim limits the number of columns to
1722 what fits on the screen. You can use this command to get the widest
1723 window possible: >
1724 :set columns=9999
1725< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726
1727 *'comments'* *'com'* *E524* *E525*
1728'comments' 'com' string (default
1729 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1730 local to buffer
1731 {not in Vi}
1732 {not available when compiled without the |+comments|
1733 feature}
1734 A comma separated list of strings that can start a comment line. See
1735 |format-comments|. See |option-backslash| about using backslashes to
1736 insert a space.
1737
1738 *'commentstring'* *'cms'* *E537*
1739'commentstring' 'cms' string (default "/*%s*/")
1740 local to buffer
1741 {not in Vi}
1742 {not available when compiled without the |+folding|
1743 feature}
1744 A template for a comment. The "%s" in the value is replaced with the
1745 comment text. Currently only used to add markers for folding, see
1746 |fold-marker|.
1747
1748 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001749'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001750 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 global
1752 {not in Vi}
1753 This option has the effect of making Vim either more Vi-compatible, or
1754 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001755
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001757 other options are also changed as a side effect.
1758 NOTE: Setting or resetting this option can have a lot of unexpected
1759 effects: Mappings are interpreted in another way, undo behaves
1760 differently, etc. If you set this option in your vimrc file, you
1761 should probably put it at the very start.
1762
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 By default this option is on and the Vi defaults are used for the
1764 options. This default was chosen for those people who want to use Vim
1765 just like Vi, and don't even (want to) know about the 'compatible'
1766 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001767 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001768 this option is switched off, and all options that have not been
1769 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001770 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001771 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001772 happen for the system-wide vimrc or gvimrc file, nor for a file given
1773 with the |-u| argument). Also see |compatible-default| and
1774 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 You can also set this option with the "-C" argument, and reset it with
1776 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001777 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaar214641f2017-03-05 17:04:09 +01001779 When this option is set, numerous other options are set to make Vim as
1780 Vi-compatible as possible. When this option is unset, various options
1781 are set to make Vim more useful. The table below lists all the
1782 options affected.
1783 The {?} column indicates when the options are affected:
1784 + Means that the option is set to the value given in {set value} when
1785 'compatible' is set.
1786 & Means that the option is set to the value given in {set value} when
1787 'compatible' is set AND is set to its Vim default value when
1788 'compatible' is unset.
1789 - Means the option is NOT changed when setting 'compatible' but IS
1790 set to its Vim default when 'compatible' is unset.
1791 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792
Bram Moolenaar036986f2017-03-16 17:41:02 +01001793 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001794
1795 'allowrevins' + off no CTRL-_ command
1796 'antialias' + off don't use antialiased fonts
1797 'arabic' + off reset arabic-related options
1798 'arabicshape' + on correct character shapes
1799 'backspace' + "" normal backspace
1800 'backup' + off no backup file
1801 'backupcopy' & Unix: "yes" backup file is a copy
1802 else: "auto" copy or rename backup file
1803 'balloonexpr' + "" text to show in evaluation balloon
1804 'breakindent' + off don't indent when wrapping lines
1805 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1806 'cindent' + off no C code indentation
1807 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1808 'copyindent' + off don't copy indent structure
1809 'cpoptions' & (all flags) Vi-compatible flags
1810 'cscopepathcomp'+ 0 don't show directories in tags list
1811 'cscoperelative'+ off
1812 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001813 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001814 'cscopeverbose' + off see |cscopeverbose|
1815 'delcombine' + off unicode: delete whole char combination
1816 'digraph' + off no digraphs
1817 'esckeys' & off no <Esc>-keys in Insert mode
1818 'expandtab' + off tabs not expanded to spaces
1819 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821 'formatexpr' + "" use 'formatprg' for auto-formatting
1822 'formatoptions' & "vt" Vi compatible formatting
1823 'gdefault' + off no default 'g' flag for ":s"
1824 'history' & 0 no commandline history
1825 'hkmap' + off no Hebrew keyboard mapping
1826 'hkmapp' + off no phonetic Hebrew keyboard mapping
1827 'hlsearch' + off no highlighting of search matches
1828 'incsearch' + off no incremental searching
1829 'indentexpr' + "" no indenting by expression
1830 'insertmode' + off do not start in Insert mode
1831 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001833 'joinspaces' + on insert 2 spaces after period
1834 'modeline' & off no modelines
1835 'more' & off no pauses in listings
1836 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1837 'numberwidth' & 8 min number of columns for line number
1838 'preserveindent'+ off don't preserve current indent structure
1839 when changing it
1840 'revins' + off no reverse insert
1841 'ruler' + off no ruler
1842 'scrolljump' + 1 no jump scroll
1843 'scrolloff' + 0 no scroll offset
1844 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1845 'shiftround' + off indent not rounded to shiftwidth
1846 'shortmess' & "" no shortening of messages
1847 'showcmd' & off command characters not shown
1848 'showmode' & off current mode not shown
1849 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1850 'smartcase' + off no automatic ignore case switch
1851 'smartindent' + off no smart indentation
1852 'smarttab' + off no smart tab size
1853 'softtabstop' + 0 tabs are always 'tabstop' positions
1854 'startofline' + on goto startofline with some commands
1855 'tagcase' & "followic" 'ignorecase' when searching tags file
1856 'tagrelative' & off tag file names are not relative
1857 'termguicolors' + off don't use highlight-(guifg|guibg)
1858 'textauto' & off no automatic textmode detection
1859 'textwidth' + 0 no automatic line wrap
1860 'tildeop' + off tilde is not an operator
1861 'ttimeout' + off no terminal timeout
1862 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001863 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001864 'virtualedit' + "" cursor can only be placed on characters
1865 'whichwrap' & "" left-right movements don't wrap
1866 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001868 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869
1870 *'complete'* *'cpt'* *E535*
1871'complete' 'cpt' string (default: ".,w,b,u,t,i")
1872 local to buffer
1873 {not in Vi}
1874 This option specifies how keyword completion |ins-completion| works
1875 when CTRL-P or CTRL-N are used. It is also used for whole-line
1876 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1877 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001878 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 w scan buffers from other windows
1880 b scan other loaded buffers that are in the buffer list
1881 u scan the unloaded buffers that are in the buffer list
1882 U scan the buffers that are not in the buffer list
1883 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001884 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 k{dict} scan the file {dict}. Several "k" flags can be given,
1886 patterns are valid too. For example: >
1887 :set cpt=k/usr/dict/*,k~/spanish
1888< s scan the files given with the 'thesaurus' option
1889 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1890 are valid too.
1891 i scan current and included files
1892 d scan current and included files for defined name or macro
1893 |i_CTRL-X_CTRL-D|
1894 ] tag completion
1895 t same as "]"
1896
1897 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1898 not executed, this may lead to unexpected completions from some files
1899 (gzipped files for example). Unloaded buffers are not scanned for
1900 whole-line completion.
1901
1902 The default is ".,w,b,u,t,i", which means to scan:
1903 1. the current buffer
1904 2. buffers in other windows
1905 3. other loaded buffers
1906 4. unloaded buffers
1907 5. tags
1908 6. included files
1909
1910 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001911 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1912 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001914 *'completefunc'* *'cfu'*
1915'completefunc' 'cfu' string (default: empty)
1916 local to buffer
1917 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001918 {not available when compiled without the |+eval|
1919 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001920 This option specifies a function to be used for Insert mode completion
1921 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001922 See |complete-functions| for an explanation of how the function is
1923 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001924 This option cannot be set from a |modeline| or in the |sandbox|, for
1925 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001926
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001927 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001928'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001929 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001930 {not available when compiled without the
1931 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001932 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001933 A comma separated list of options for Insert mode completion
1934 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001935
1936 menu Use a popup menu to show the possible completions. The
1937 menu is only shown when there is more than one match and
1938 sufficient colors are available. |ins-completion-menu|
1939
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001940 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001941 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001942 match, e.g., what file it comes from.
1943
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001944 longest Only insert the longest common text of the matches. If
1945 the menu is displayed you can use CTRL-L to add more
1946 characters. Whether case is ignored depends on the kind
1947 of completion. For buffer text the 'ignorecase' option is
1948 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001949
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001950 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001951 completion in the preview window. Only works in
1952 combination with "menu" or "menuone".
1953
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001954 noinsert Do not insert any text for a match until the user selects
1955 a match from the menu. Only works in combination with
1956 "menu" or "menuone". No effect if "longest" is present.
1957
1958 noselect Do not select a match in the menu, force the user to
1959 select one from the menu. Only works in combination with
1960 "menu" or "menuone".
1961
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001962
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001963 *'concealcursor'* *'cocu'*
1964'concealcursor' 'cocu' string (default: "")
1965 local to window
1966 {not in Vi}
1967 {not available when compiled without the |+conceal|
1968 feature}
1969 Sets the modes in which text in the cursor line can also be concealed.
1970 When the current mode is listed then concealing happens just like in
1971 other lines.
1972 n Normal mode
1973 v Visual mode
1974 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001975 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001976
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001977 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001978 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001979 are moving around text is concealed, but when starting to insert text
1980 or selecting a Visual area the concealed text is displayed, so that
1981 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001982 Keep in mind that the cursor position is not always where it's
1983 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001984
1985
1986'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 number (default 0)
1988 local to window
1989 {not in Vi}
1990 {not available when compiled without the |+conceal|
1991 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001992 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1993 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001994
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001995 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001996 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001997 1 Each block of concealed text is replaced with one
1998 character. If the syntax item does not have a custom
1999 replacement character defined (see |:syn-cchar|) the
2000 character defined in 'listchars' is used (default is a
2001 space).
2002 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002003 2 Concealed text is completely hidden unless it has a
2004 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02002005 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02002006 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002007
Bram Moolenaara7781e02010-07-19 20:13:22 +02002008 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002009 edit and copy the text. This can be changed with the 'concealcursor'
2010 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002011
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2013'confirm' 'cf' boolean (default off)
2014 global
2015 {not in Vi}
2016 When 'confirm' is on, certain operations that would normally
2017 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2018 instead raise a |dialog| asking if you wish to save the current
2019 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2020 If 'confirm' is off you can still activate confirmation for one
2021 command only (this is most useful in mappings) with the |:confirm|
2022 command.
2023 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2024
2025 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2026'conskey' 'consk' boolean (default off)
2027 global
2028 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002029 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030
2031 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2032'copyindent' 'ci' boolean (default off)
2033 local to buffer
2034 {not in Vi}
2035 Copy the structure of the existing lines indent when autoindenting a
2036 new line. Normally the new indent is reconstructed by a series of
2037 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2038 in which case only spaces are used). Enabling this option makes the
2039 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002040 existing line. 'expandtab' has no effect on these characters, a Tab
2041 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002043 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 Also see 'preserveindent'.
2045
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002046 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047'cpoptions' 'cpo' string (Vim default: "aABceFs",
2048 Vi default: all flags)
2049 global
2050 {not in Vi}
2051 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002052 this indicates Vi-compatible behavior. This is used for things where
2053 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 'cpoptions' stands for "compatible-options".
2055 Commas can be added for readability.
2056 To avoid problems with flags that are added in the future, use the
2057 "+=" and "-=" feature of ":set" |add-option-flags|.
2058 NOTE: This option is set to the Vi default value when 'compatible' is
2059 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002060 NOTE: This option is set to the POSIX default value at startup when
2061 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002062 variable exists |posix|. This means Vim tries to behave like the
2063 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064
2065 contains behavior ~
2066 *cpo-a*
2067 a When included, a ":read" command with a file name
2068 argument will set the alternate file name for the
2069 current window.
2070 *cpo-A*
2071 A When included, a ":write" command with a file name
2072 argument will set the alternate file name for the
2073 current window.
2074 *cpo-b*
2075 b "\|" in a ":map" command is recognized as the end of
2076 the map command. The '\' is included in the mapping,
2077 the text after the '|' is interpreted as the next
2078 command. Use a CTRL-V instead of a backslash to
2079 include the '|' in the mapping. Applies to all
2080 mapping, abbreviation, menu and autocmd commands.
2081 See also |map_bar|.
2082 *cpo-B*
2083 B A backslash has no special meaning in mappings,
2084 abbreviations and the "to" part of the menu commands.
2085 Remove this flag to be able to use a backslash like a
2086 CTRL-V. For example, the command ":map X \<Esc>"
2087 results in X being mapped to:
2088 'B' included: "\^[" (^[ is a real <Esc>)
2089 'B' excluded: "<Esc>" (5 characters)
2090 ('<' excluded in both cases)
2091 *cpo-c*
2092 c Searching continues at the end of any match at the
2093 cursor position, but not further than the start of the
2094 next line. When not present searching continues
2095 one character from the cursor position. With 'c'
2096 "abababababab" only gets three matches when repeating
2097 "/abab", without 'c' there are five matches.
2098 *cpo-C*
2099 C Do not concatenate sourced lines that start with a
2100 backslash. See |line-continuation|.
2101 *cpo-d*
2102 d Using "./" in the 'tags' option doesn't mean to use
2103 the tags file relative to the current file, but the
2104 tags file in the current directory.
2105 *cpo-D*
2106 D Can't use CTRL-K to enter a digraph after Normal mode
2107 commands with a character argument, like |r|, |f| and
2108 |t|.
2109 *cpo-e*
2110 e When executing a register with ":@r", always add a
2111 <CR> to the last line, also when the register is not
2112 linewise. If this flag is not present, the register
2113 is not linewise and the last line does not end in a
2114 <CR>, then the last line is put on the command-line
2115 and can be edited before hitting <CR>.
2116 *cpo-E*
2117 E It is an error when using "y", "d", "c", "g~", "gu" or
2118 "gU" on an Empty region. The operators only work when
2119 at least one character is to be operate on. Example:
2120 This makes "y0" fail in the first column.
2121 *cpo-f*
2122 f When included, a ":read" command with a file name
2123 argument will set the file name for the current buffer,
2124 if the current buffer doesn't have a file name yet.
2125 *cpo-F*
2126 F When included, a ":write" command with a file name
2127 argument will set the file name for the current
2128 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002129 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 *cpo-g*
2131 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002132 *cpo-H*
2133 H When using "I" on a line with only blanks, insert
2134 before the last blank. Without this flag insert after
2135 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 *cpo-i*
2137 i When included, interrupting the reading of a file will
2138 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002139 *cpo-I*
2140 I When moving the cursor up or down just after inserting
2141 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 *cpo-j*
2143 j When joining lines, only add two spaces after a '.',
2144 not after '!' or '?'. Also see 'joinspaces'.
2145 *cpo-J*
2146 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002147 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 white space.
2149 *cpo-k*
2150 k Disable the recognition of raw key codes in
2151 mappings, abbreviations, and the "to" part of menu
2152 commands. For example, if <Key> sends ^[OA (where ^[
2153 is <Esc>), the command ":map X ^[OA" results in X
2154 being mapped to:
2155 'k' included: "^[OA" (3 characters)
2156 'k' excluded: "<Key>" (one key code)
2157 Also see the '<' flag below.
2158 *cpo-K*
2159 K Don't wait for a key code to complete when it is
2160 halfway a mapping. This breaks mapping <F1><F1> when
2161 only part of the second <F1> has been read. It
2162 enables cancelling the mapping by typing <F1><Esc>.
2163 *cpo-l*
2164 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002165 literally, only "\]", "\^", "\-" and "\\" are special.
2166 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2168 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002169 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 *cpo-L*
2171 L When the 'list' option is set, 'wrapmargin',
2172 'textwidth', 'softtabstop' and Virtual Replace mode
2173 (see |gR|) count a <Tab> as two characters, instead of
2174 the normal behavior of a <Tab>.
2175 *cpo-m*
2176 m When included, a showmatch will always wait half a
2177 second. When not included, a showmatch will wait half
2178 a second or until a character is typed. |'showmatch'|
2179 *cpo-M*
2180 M When excluded, "%" matching will take backslashes into
2181 account. Thus in "( \( )" and "\( ( \)" the outer
2182 parenthesis match. When included "%" ignores
2183 backslashes, which is Vi compatible.
2184 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002185 n When included, the column used for 'number' and
2186 'relativenumber' will also be used for text of wrapped
2187 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 *cpo-o*
2189 o Line offset to search command is not remembered for
2190 next search.
2191 *cpo-O*
2192 O Don't complain if a file is being overwritten, even
2193 when it didn't exist when editing it. This is a
2194 protection against a file unexpectedly created by
2195 someone else. Vi didn't complain about this.
2196 *cpo-p*
2197 p Vi compatible Lisp indenting. When not present, a
2198 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002199 *cpo-P*
2200 P When included, a ":write" command that appends to a
2201 file will set the file name for the current buffer, if
2202 the current buffer doesn't have a file name yet and
2203 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002204 *cpo-q*
2205 q When joining multiple lines leave the cursor at the
2206 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 *cpo-r*
2208 r Redo ("." command) uses "/" to repeat a search
2209 command, instead of the actually used search string.
2210 *cpo-R*
2211 R Remove marks from filtered lines. Without this flag
2212 marks are kept like |:keepmarks| was used.
2213 *cpo-s*
2214 s Set buffer options when entering the buffer for the
2215 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002216 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 set when the buffer is created.
2218 *cpo-S*
2219 S Set buffer options always when entering a buffer
2220 (except 'readonly', 'fileformat', 'filetype' and
2221 'syntax'). This is the (most) Vi compatible setting.
2222 The options are set to the values in the current
2223 buffer. When you change an option and go to another
2224 buffer, the value is copied. Effectively makes the
2225 buffer options global to all buffers.
2226
2227 's' 'S' copy buffer options
2228 no no when buffer created
2229 yes no when buffer first entered (default)
2230 X yes each time when buffer entered (vi comp.)
2231 *cpo-t*
2232 t Search pattern for the tag command is remembered for
2233 "n" command. Otherwise Vim only puts the pattern in
2234 the history for search pattern, but doesn't change the
2235 last used search pattern.
2236 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002237 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 *cpo-v*
2239 v Backspaced characters remain visible on the screen in
2240 Insert mode. Without this flag the characters are
2241 erased from the screen right away. With this flag the
2242 screen newly typed text overwrites backspaced
2243 characters.
2244 *cpo-w*
2245 w When using "cw" on a blank character, only change one
2246 character and not all blanks until the start of the
2247 next word.
2248 *cpo-W*
2249 W Don't overwrite a readonly file. When omitted, ":w!"
2250 overwrites a readonly file, if possible.
2251 *cpo-x*
2252 x <Esc> on the command-line executes the command-line.
2253 The default in Vim is to abandon the command-line,
2254 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002255 *cpo-X*
2256 X When using a count with "R" the replaced text is
2257 deleted only once. Also when repeating "R" with "."
2258 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *cpo-y*
2260 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002261 *cpo-Z*
2262 Z When using "w!" while the 'readonly' option is set,
2263 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 *cpo-!*
2265 ! When redoing a filter command, use the last used
2266 external command, whatever it was. Otherwise the last
2267 used -filter- command is used.
2268 *cpo-$*
2269 $ When making a change to one line, don't redisplay the
2270 line, but put a '$' at the end of the changed text.
2271 The changed text will be overwritten when you type the
2272 new text. The line is redisplayed if you type any
2273 command that moves the cursor from the insertion
2274 point.
2275 *cpo-%*
2276 % Vi-compatible matching is done for the "%" command.
2277 Does not recognize "#if", "#endif", etc.
2278 Does not recognize "/*" and "*/".
2279 Parens inside single and double quotes are also
2280 counted, causing a string that contains a paren to
2281 disturb the matching. For example, in a line like
2282 "if (strcmp("foo(", s))" the first paren does not
2283 match the last one. When this flag is not included,
2284 parens inside single and double quotes are treated
2285 specially. When matching a paren outside of quotes,
2286 everything inside quotes is ignored. When matching a
2287 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002288 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002289 This flag is also used for other features, such as
2290 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002291 *cpo--*
2292 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002293 it would go above the first line or below the last
2294 line. Without it the cursor moves to the first or
2295 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002296 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002297 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002298 *cpo-+*
2299 + When included, a ":write file" command will reset the
2300 'modified' flag of the buffer, even though the buffer
2301 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002302 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 * Use ":*" in the same way as ":@". When not included,
2304 ":*" is an alias for ":'<,'>", select the Visual area.
2305 *cpo-<*
2306 < Disable the recognition of special key codes in |<>|
2307 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002308 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 ":map X <Tab>" results in X being mapped to:
2310 '<' included: "<Tab>" (5 characters)
2311 '<' excluded: "^I" (^I is a real <Tab>)
2312 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002313 *cpo->*
2314 > When appending to a register, put a line break before
2315 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002316 *cpo-;*
2317 ; When using |,| or |;| to repeat the last |t| search
2318 and the cursor is right in front of the searched
2319 character, the cursor won't move. When not included,
2320 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002321 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002322
2323 POSIX flags. These are not included in the Vi default value, except
2324 when $VIM_POSIX was set on startup. |posix|
2325
2326 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002327 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002328 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002329 *cpo-&*
2330 & When ":preserve" was used keep the swap file when
2331 exiting normally while this buffer is still loaded.
2332 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002333 *cpo-\*
2334 \ Backslash in a [] range in a search pattern is taken
2335 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002336 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2337 '\' excluded: "/[ \-]" finds <Space> and '-'
2338 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002339 *cpo-/*
2340 / When "%" is used as the replacement string in a |:s|
2341 command, use the previous replacement string. |:s%|
2342 *cpo-{*
2343 { The |{| and |}| commands also stop at a "{" character
2344 at the start of a line.
2345 *cpo-.*
2346 . The ":chdir" and ":cd" commands fail if the current
2347 buffer is modified, unless ! is used. Vim doesn't
2348 need this, since it remembers the full path of an
2349 opened file.
2350 *cpo-bar*
2351 | The value of the $LINES and $COLUMNS environment
2352 variables overrule the terminal size values obtained
2353 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002354
Bram Moolenaar071d4272004-06-13 20:20:40 +00002355
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002356 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002357'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002358 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002359 {not in Vi}
2360 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002361 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002362 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002363 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002364 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002365 blowfish Blowfish method. Medium strong encryption but it has
2366 an implementation flaw. Requires Vim 7.3 or later,
2367 files can NOT be read by Vim 7.2 and older. This adds
2368 a "seed" to the file, every time you write the file
2369 the encrypted bytes will be different.
2370 *blowfish2*
2371 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002372 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002373 and older. This adds a "seed" to the file, every time
2374 you write the file the encrypted bytes will be
2375 different. The whole undo file is encrypted, not just
2376 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002377
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002378 You should use "blowfish2", also to re-encrypt older files.
2379
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002380 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002381 to the detected method of the file being read. Thus if you write it
2382 without changing 'cryptmethod' the same method will be used.
2383 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002384 explicitly write it, you don't get a warning unless there are other
2385 modifications. Also see |:X|.
2386
2387 When setting the global value to an empty string, it will end up with
2388 the value "zip". When setting the local value to an empty string the
2389 buffer will use the global value.
2390
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002391 When a new encryption method is added in a later version of Vim, and
2392 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002393 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002394
2395
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 *'cscopepathcomp'* *'cspc'*
2397'cscopepathcomp' 'cspc' number (default 0)
2398 global
2399 {not available when compiled without the |+cscope|
2400 feature}
2401 {not in Vi}
2402 Determines how many components of the path to show in a list of tags.
2403 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002404 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405
2406 *'cscopeprg'* *'csprg'*
2407'cscopeprg' 'csprg' string (default "cscope")
2408 global
2409 {not available when compiled without the |+cscope|
2410 feature}
2411 {not in Vi}
2412 Specifies the command to execute cscope. See |cscopeprg|.
2413 This option cannot be set from a |modeline| or in the |sandbox|, for
2414 security reasons.
2415
2416 *'cscopequickfix'* *'csqf'*
2417'cscopequickfix' 'csqf' string (default "")
2418 global
2419 {not available when compiled without the |+cscope|
2420 or |+quickfix| features}
2421 {not in Vi}
2422 Specifies whether to use quickfix window to show cscope results.
2423 See |cscopequickfix|.
2424
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002425 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002426'cscoperelative' 'csre' boolean (default off)
2427 global
2428 {not available when compiled without the |+cscope|
2429 feature}
2430 {not in Vi}
2431 In the absence of a prefix (-P) for cscope. setting this option enables
2432 to use the basename of cscope.out path as the prefix.
2433 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002434 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002435
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2437'cscopetag' 'cst' boolean (default off)
2438 global
2439 {not available when compiled without the |+cscope|
2440 feature}
2441 {not in Vi}
2442 Use cscope for tag commands. See |cscope-options|.
2443 NOTE: This option is reset when 'compatible' is set.
2444
2445 *'cscopetagorder'* *'csto'*
2446'cscopetagorder' 'csto' number (default 0)
2447 global
2448 {not available when compiled without the |+cscope|
2449 feature}
2450 {not in Vi}
2451 Determines the order in which ":cstag" performs a search. See
2452 |cscopetagorder|.
2453 NOTE: This option is set to 0 when 'compatible' is set.
2454
2455 *'cscopeverbose'* *'csverb'*
2456 *'nocscopeverbose'* *'nocsverb'*
2457'cscopeverbose' 'csverb' boolean (default off)
2458 global
2459 {not available when compiled without the |+cscope|
2460 feature}
2461 {not in Vi}
2462 Give messages when adding a cscope database. See |cscopeverbose|.
2463 NOTE: This option is reset when 'compatible' is set.
2464
Bram Moolenaar860cae12010-06-05 23:22:07 +02002465 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2466'cursorbind' 'crb' boolean (default off)
2467 local to window
2468 {not in Vi}
2469 {not available when compiled without the |+cursorbind|
2470 feature}
2471 When this option is set, as the cursor in the current
2472 window moves other cursorbound windows (windows that also have
2473 this option set) move their cursors to the corresponding line and
2474 column. This option is useful for viewing the
2475 differences between two versions of a file (see 'diff'); in diff mode,
2476 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002477 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002478
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002479
2480 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2481'cursorcolumn' 'cuc' boolean (default off)
2482 local to window
2483 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002484 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002485 feature}
2486 Highlight the screen column of the cursor with CursorColumn
2487 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2488 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002489 If you only want the highlighting in the current window you can use
2490 these autocommands: >
2491 au WinLeave * set nocursorline nocursorcolumn
2492 au WinEnter * set cursorline cursorcolumn
2493<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002494
2495 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2496'cursorline' 'cul' boolean (default off)
2497 local to window
2498 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002499 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002500 feature}
2501 Highlight the screen line of the cursor with CursorLine
2502 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2503 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002504 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002505 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002506
2507
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 *'debug'*
2509'debug' string (default "")
2510 global
2511 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002512 These values can be used:
2513 msg Error messages that would otherwise be omitted will be given
2514 anyway.
2515 throw Error messages that would otherwise be omitted will be given
2516 anyway and also throw an exception and set |v:errmsg|.
2517 beep A message will be given when otherwise only a beep would be
2518 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002519 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002520 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2521 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522
2523 *'define'* *'def'*
2524'define' 'def' string (default "^\s*#\s*define")
2525 global or local to buffer |global-local|
2526 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 pattern, just like for the "/" command. This option is used for the
2529 commands like "[i" and "[d" |include-search|. The 'isident' option is
2530 used to recognize the defined name after the match:
2531 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2532 See |option-backslash| about inserting backslashes to include a space
2533 or backslash.
2534 The default value is for C programs. For C++ this value would be
2535 useful, to include const type declarations: >
2536 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2537< When using the ":set" command, you need to double the backslashes!
2538
2539 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2540'delcombine' 'deco' boolean (default off)
2541 global
2542 {not in Vi}
2543 {only available when compiled with the |+multi_byte|
2544 feature}
2545 If editing Unicode and this option is set, backspace and Normal mode
2546 "x" delete each combining character on its own. When it is off (the
2547 default) the character along with its combining characters are
2548 deleted.
2549 Note: When 'delcombine' is set "xx" may work different from "2x"!
2550
2551 This is useful for Arabic, Hebrew and many other languages where one
2552 may have combining characters overtop of base characters, and want
2553 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002554 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555
2556 *'dictionary'* *'dict'*
2557'dictionary' 'dict' string (default "")
2558 global or local to buffer |global-local|
2559 {not in Vi}
2560 List of file names, separated by commas, that are used to lookup words
2561 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2562 contain a list of words. This can be one word per line, or several
2563 words per line, separated by non-keyword characters (white space is
2564 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002565 When this option is empty, or an entry "spell" is present, spell
2566 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002567 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 after a comma are ignored, otherwise spaces are included in the file
2569 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002570 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 Where to find a list of words?
2572 - On FreeBSD, there is the file "/usr/share/dict/words".
2573 - In the Simtel archive, look in the "msdos/linguist" directory.
2574 - In "miscfiles" of the GNU collection.
2575 The use of |:set+=| and |:set-=| is preferred when adding or removing
2576 directories from the list. This avoids problems when a future version
2577 uses another default.
2578 Backticks cannot be used in this option for security reasons.
2579
2580 *'diff'* *'nodiff'*
2581'diff' boolean (default off)
2582 local to window
2583 {not in Vi}
2584 {not available when compiled without the |+diff|
2585 feature}
2586 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002587 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588
2589 *'dex'* *'diffexpr'*
2590'diffexpr' 'dex' string (default "")
2591 global
2592 {not in Vi}
2593 {not available when compiled without the |+diff|
2594 feature}
2595 Expression which is evaluated to obtain an ed-style diff file from two
2596 versions of a file. See |diff-diffexpr|.
2597 This option cannot be set from a |modeline| or in the |sandbox|, for
2598 security reasons.
2599
2600 *'dip'* *'diffopt'*
2601'diffopt' 'dip' string (default "filler")
2602 global
2603 {not in Vi}
2604 {not available when compiled without the |+diff|
2605 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002606 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 All are optional. Items must be separated by a comma.
2608
2609 filler Show filler lines, to keep the text
2610 synchronized with a window that has inserted
2611 lines at the same position. Mostly useful
2612 when windows are side-by-side and 'scrollbind'
2613 is set.
2614
2615 context:{n} Use a context of {n} lines between a change
2616 and a fold that contains unchanged lines.
2617 When omitted a context of six lines is used.
2618 See |fold-diff|.
2619
2620 icase Ignore changes in case of text. "a" and "A"
2621 are considered the same. Adds the "-i" flag
2622 to the "diff" command if 'diffexpr' is empty.
2623
2624 iwhite Ignore changes in amount of white space. Adds
2625 the "-b" flag to the "diff" command if
2626 'diffexpr' is empty. Check the documentation
2627 of the "diff" command for what this does
2628 exactly. It should ignore adding trailing
2629 white space, but not leading white space.
2630
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002631 horizontal Start diff mode with horizontal splits (unless
2632 explicitly specified otherwise).
2633
2634 vertical Start diff mode with vertical splits (unless
2635 explicitly specified otherwise).
2636
2637 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2638 starting diff mode. Without this 2 is used.
2639
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 Examples: >
2641
2642 :set diffopt=filler,context:4
2643 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002644 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645<
2646 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2647'digraph' 'dg' boolean (default off)
2648 global
2649 {not in Vi}
2650 {not available when compiled without the |+digraphs|
2651 feature}
2652 Enable the entering of digraphs in Insert mode with {char1} <BS>
2653 {char2}. See |digraphs|.
2654 NOTE: This option is reset when 'compatible' is set.
2655
2656 *'directory'* *'dir'*
2657'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002658 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 for Unix: ".,~/tmp,/var/tmp,/tmp")
2660 global
2661 List of directory names for the swap file, separated with commas.
2662 - The swap file will be created in the first directory where this is
2663 possible.
2664 - Empty means that no swap file will be used (recovery is
2665 impossible!).
2666 - A directory "." means to put the swap file in the same directory as
2667 the edited file. On Unix, a dot is prepended to the file name, so
2668 it doesn't show in a directory listing. On MS-Windows the "hidden"
2669 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002670 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 put the swap file relative to where the edited file is. The leading
2672 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002673 - For Unix and Win32, if a directory ends in two path separators "//"
2674 or "\\", the swap file name will be built from the complete path to
2675 the file with all path separators substituted to percent '%' signs.
2676 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002677 On Win32, when a separating comma is following, you must use "//",
2678 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 - Spaces after the comma are ignored, other spaces are considered part
2680 of the directory name. To have a space at the start of a directory
2681 name, precede it with a backslash.
2682 - To include a comma in a directory name precede it with a backslash.
2683 - A directory name may end in an ':' or '/'.
2684 - Environment variables are expanded |:set_env|.
2685 - Careful with '\' characters, type one before a space, type two to
2686 get one in the option (see |option-backslash|), for example: >
2687 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2688< - For backwards compatibility with Vim version 3.0 a '>' at the start
2689 of the option is removed.
2690 Using "." first in the list is recommended. This means that editing
2691 the same file twice will result in a warning. Using "/tmp" on Unix is
2692 discouraged: When the system crashes you lose the swap file.
2693 "/var/tmp" is often not cleared when rebooting, thus is a better
2694 choice than "/tmp". But it can contain a lot of files, your swap
2695 files get lost in the crowd. That is why a "tmp" directory in your
2696 home directory is tried first.
2697 The use of |:set+=| and |:set-=| is preferred when adding or removing
2698 directories from the list. This avoids problems when a future version
2699 uses another default.
2700 This option cannot be set from a |modeline| or in the |sandbox|, for
2701 security reasons.
2702 {Vi: directory to put temp file in, defaults to "/tmp"}
2703
2704 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002705'display' 'dy' string (default "", set to "truncate" in
2706 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 global
2708 {not in Vi}
2709 Change the way text is displayed. This is comma separated list of
2710 flags:
2711 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002712 in a window will be displayed. "@@@" is put in the
2713 last columns of the last screen line to indicate the
2714 rest of the line is not displayed.
2715 truncate Like "lastline", but "@@@" is displayed in the first
2716 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 uhex Show unprintable characters hexadecimal as <xx>
2718 instead of using ^C and ~C.
2719
Bram Moolenaard0796902016-09-16 20:02:31 +02002720 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002721 doesn't fit is replaced with "@" lines.
2722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 *'eadirection'* *'ead'*
2724'eadirection' 'ead' string (default "both")
2725 global
2726 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002727 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 feature}
2729 Tells when the 'equalalways' option applies:
2730 ver vertically, width of windows is not affected
2731 hor horizontally, height of windows is not affected
2732 both width and height of windows is affected
2733
2734 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2735'edcompatible' 'ed' boolean (default off)
2736 global
2737 Makes the 'g' and 'c' flags of the ":substitute" command to be
2738 toggled each time the flag is given. See |complex-change|. See
2739 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002740 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741
Bram Moolenaar03413f42016-04-12 21:07:15 +02002742 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002743'emoji' 'emo' boolean (default: on)
2744 global
2745 {not in Vi}
2746 {only available when compiled with the |+multi_byte|
2747 feature}
2748 When on all Unicode emoji characters are considered to be full width.
2749
2750
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 *'encoding'* *'enc'* *E543*
2752'encoding' 'enc' string (default: "latin1" or value from $LANG)
2753 global
2754 {only available when compiled with the |+multi_byte|
2755 feature}
2756 {not in Vi}
2757 Sets the character encoding used inside Vim. It applies to text in
2758 the buffers, registers, Strings in expressions, text stored in the
2759 viminfo file, etc. It sets the kind of characters which Vim can work
2760 with. See |encoding-names| for the possible values.
2761
2762 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002763 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002765 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
Bram Moolenaar865242e2010-07-14 21:12:05 +02002767 This option cannot be set from a |modeline|. It would most likely
2768 corrupt the text.
2769
Bram Moolenaar3df01732017-02-17 22:47:16 +01002770 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2771 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 'encoding', "utf-8" is the natural choice for the environment and
2773 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 versions, and to avoid changing the encoding of newly created files
2776 without your knowledge (in case 'fileencodings' is empty).
2777
2778 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 iconv() or as specified with 'charconvert'.
2781
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002782 If you need to know whether 'encoding' is a multi-byte encoding, you
2783 can use: >
2784 if has("multi_byte_encoding")
2785<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 Normally 'encoding' will be equal to your current locale. This will
2787 be the default if Vim recognizes your environment settings. If
2788 'encoding' is not set to the current locale, 'termencoding' must be
2789 set to convert typed and displayed text. See |encoding-table|.
2790
2791 When you set this option, it fires the |EncodingChanged| autocommand
2792 event so that you can set up fonts if necessary.
2793
2794 When the option is set, the value is converted to lowercase. Thus
2795 you can set it with uppercase values too. Underscores are translated
2796 to '-' signs.
2797 When the encoding is recognized, it is changed to the standard name.
2798 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2799 "iso-8859-2" and "utf8" becomes "utf-8".
2800
2801 Note: "latin1" is also used when the encoding could not be detected.
2802 This only works when editing files in the same encoding! When the
2803 actual character set is not latin1, make sure 'fileencoding' and
2804 'fileencodings' are empty. When conversion is needed, switch to using
2805 utf-8.
2806
2807 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2808 You don't notice this while editing, but it does matter for the
2809 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2810 setting 'encoding' to one of these values instead of utf-8 only has
2811 effect for encoding used for files when 'fileencoding' is empty.
2812
Bram Moolenaar661b1822005-07-28 22:36:45 +00002813 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2814 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815
2816 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2817'endofline' 'eol' boolean (default on)
2818 local to buffer
2819 {not in Vi}
2820 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002821 is on, or 'fixeol' option is off, no <EOL> will be written for the
2822 last line in the file. This option is automatically set or reset when
2823 starting to edit a new file, depending on whether file has an <EOL>
2824 for the last line in the file. Normally you don't have to set or
2825 reset this option.
2826 When 'binary' is off and 'fixeol' is on the value is not used when
2827 writing the file. When 'binary' is on or 'fixeol' is off it is used
2828 to remember the presence of a <EOL> for the last line in the file, so
2829 that when you write the file the situation from the original file can
2830 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831
2832 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2833'equalalways' 'ea' boolean (default on)
2834 global
2835 {not in Vi}
2836 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002837 splitting or closing a window. This also happens the moment the
2838 option is switched on. When off, splitting a window will reduce the
2839 size of the current window and leave the other windows the same. When
2840 closing a window the extra lines are given to the window next to it
2841 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 When mixing vertically and horizontally split windows, a minimal size
2843 is computed and some windows may be larger if there is room. The
2844 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002845 Changing the height and width of a window can be avoided by setting
2846 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002847 If a window size is specified when creating a new window sizes are
2848 currently not equalized (it's complicated, but may be implemented in
2849 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850
2851 *'equalprg'* *'ep'*
2852'equalprg' 'ep' string (default "")
2853 global or local to buffer |global-local|
2854 {not in Vi}
2855 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002856 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002857 or 'indentexpr'. When Vim was compiled without internal formatting,
2858 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002859 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 about including spaces and backslashes.
2861 This option cannot be set from a |modeline| or in the |sandbox|, for
2862 security reasons.
2863
2864 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2865'errorbells' 'eb' boolean (default off)
2866 global
2867 Ring the bell (beep or screen flash) for error messages. This only
2868 makes a difference for error messages, the bell will be used always
2869 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002870 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002871 screen flash or do nothing. See 'belloff' to finetune when to ring the
2872 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
2874 *'errorfile'* *'ef'*
2875'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2876 others: "errors.err")
2877 global
2878 {not in Vi}
2879 {not available when compiled without the |+quickfix|
2880 feature}
2881 Name of the errorfile for the QuickFix mode (see |:cf|).
2882 When the "-q" command-line argument is used, 'errorfile' is set to the
2883 following argument. See |-q|.
2884 NOT used for the ":make" command. See 'makeef' for that.
2885 Environment variables are expanded |:set_env|.
2886 See |option-backslash| about including spaces and backslashes.
2887 This option cannot be set from a |modeline| or in the |sandbox|, for
2888 security reasons.
2889
2890 *'errorformat'* *'efm'*
2891'errorformat' 'efm' string (default is very long)
2892 global or local to buffer |global-local|
2893 {not in Vi}
2894 {not available when compiled without the |+quickfix|
2895 feature}
2896 Scanf-like description of the format for the lines in the error file
2897 (see |errorformat|).
2898
2899 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2900'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2901 global
2902 {not in Vi}
2903 Function keys that start with an <Esc> are recognized in Insert
2904 mode. When this option is off, the cursor and function keys cannot be
2905 used in Insert mode if they start with an <Esc>. The advantage of
2906 this is that the single <Esc> is recognized immediately, instead of
2907 after one second. Instead of resetting this option, you might want to
2908 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2909 when 'esckeys' is off, you can still map anything, but the cursor keys
2910 won't work by default.
2911 NOTE: This option is set to the Vi default value when 'compatible' is
2912 set and to the Vim default value when 'compatible' is reset.
2913
2914 *'eventignore'* *'ei'*
2915'eventignore' 'ei' string (default "")
2916 global
2917 {not in Vi}
2918 {not available when compiled without the |+autocmd|
2919 feature}
2920 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002921 When set to "all" or when "all" is one of the items, all autocommand
2922 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 Otherwise this is a comma separated list of event names. Example: >
2924 :set ei=WinEnter,WinLeave
2925<
2926 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2927'expandtab' 'et' boolean (default off)
2928 local to buffer
2929 {not in Vi}
2930 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002931 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2933 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002934 This option is reset when the 'paste' option is set and restored when
2935 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 NOTE: This option is reset when 'compatible' is set.
2937
2938 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2939'exrc' 'ex' boolean (default off)
2940 global
2941 {not in Vi}
2942 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002943 directory.
2944
2945 Setting this option is a potential security leak. E.g., consider
2946 unpacking a package or fetching files from github, a .vimrc in there
2947 might be a trojan horse. BETTER NOT SET THIS OPTION!
2948 Instead, define an autocommand in your .vimrc to set options for a
2949 matching directory.
2950
2951 If you do switch this option on you should also consider setting the
2952 'secure' option (see |initialization|).
2953 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 This option cannot be set from a |modeline| or in the |sandbox|, for
2955 security reasons.
2956
2957 *'fileencoding'* *'fenc'* *E213*
2958'fileencoding' 'fenc' string (default: "")
2959 local to buffer
2960 {only available when compiled with the |+multi_byte|
2961 feature}
2962 {not in Vi}
2963 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002964
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002966 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 When 'fileencoding' is empty, the same value as 'encoding' will be
2968 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002969 No error will be given when the value is set, only when it is used,
2970 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002971 Conversion will also be done when 'encoding' and 'fileencoding' are
2972 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2973 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002975 'encoding' is "utf-8" or another Unicode encoding, conversion
2976 is most likely done in a way that the reverse conversion
2977 results in the same text. When 'encoding' is not "utf-8" some
2978 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002979
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 See 'encoding' for the possible values. Additionally, values may be
2981 specified that can be handled by the converter, see
2982 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002983
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 When reading a file 'fileencoding' will be set from 'fileencodings'.
2985 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002986 'fileencoding', use the |++enc| argument. One exception: when
2987 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002988 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2991 When the option is set, the value is converted to lowercase. Thus
2992 you can set it with uppercase values too. '_' characters are
2993 replaced with '-'. If a name is recognized from the list for
2994 'encoding', it is replaced by the standard name. For example
2995 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002996
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 When this option is set, after starting to edit a file, the 'modified'
2998 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002999
3000 Keep in mind that changing 'fenc' from a modeline happens
3001 AFTER the text has been read, thus it applies to when the file will be
3002 written. If you do set 'fenc' in a modeline, you might want to set
3003 'nomodified' to avoid not being able to ":q".
3004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 This option can not be changed when 'modifiable' is off.
3006
3007 *'fe'*
3008 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003009 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 old short name was 'fe', which is no longer used.
3011
3012 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003013'fileencodings' 'fencs' string (default: "ucs-bom",
3014 "ucs-bom,utf-8,default,latin1" when
3015 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 global
3017 {only available when compiled with the |+multi_byte|
3018 feature}
3019 {not in Vi}
3020 This is a list of character encodings considered when starting to edit
3021 an existing file. When a file is read, Vim tries to use the first
3022 mentioned character encoding. If an error is detected, the next one
3023 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003024 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 an empty string, which means the value of 'encoding' is used.
3026 WARNING: Conversion can cause loss of information! When
3027 'encoding' is "utf-8" (or one of the other Unicode variants)
3028 conversion is most likely done in a way that the reverse
3029 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003030 "utf-8" some non-ASCII characters may be lost! You can use
3031 the |++bad| argument to specify what is done with characters
3032 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 For an empty file or a file with only ASCII characters most encodings
3034 will work and the first entry of 'fileencodings' will be used (except
3035 "ucs-bom", which requires the BOM to be present). If you prefer
3036 another encoding use an BufReadPost autocommand event to test if your
3037 preferred encoding is to be used. Example: >
3038 au BufReadPost * if search('\S', 'w') == 0 |
3039 \ set fenc=iso-2022-jp | endif
3040< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3041 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003042 When the |++enc| argument is used then the value of 'fileencodings' is
3043 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003044 Note that 'fileencodings' is not used for a new file, the global value
3045 of 'fileencoding' is used instead. You can set it with: >
3046 :setglobal fenc=iso-8859-2
3047< This means that a non-existing file may get a different encoding than
3048 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 The special value "ucs-bom" can be used to check for a Unicode BOM
3050 (Byte Order Mark) at the start of the file. It must not be preceded
3051 by "utf-8" or another Unicode encoding for this to work properly.
3052 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3053 because Vim cannot detect an error, thus the encoding is always
3054 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003055 The special value "default" can be used for the encoding from the
3056 environment. This is the default value for 'encoding'. It is useful
3057 when 'encoding' is set to "utf-8" and your environment uses a
3058 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003059 When 'encoding' is "utf-8" and a file contains an illegal byte
3060 sequence it won't be recognized as UTF-8. You can use the |8g8|
3061 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 WRONG VALUES: WHAT'S WRONG:
3063 latin1,utf-8 "latin1" will always be used
3064 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3065 file
3066 cp1250,latin1 "cp1250" will always be used
3067 If 'fileencodings' is empty, 'fileencoding' is not modified.
3068 See 'fileencoding' for the possible values.
3069 Setting this option does not have an effect until the next time a file
3070 is read.
3071
3072 *'fileformat'* *'ff'*
3073'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3074 Unix default: "unix",
3075 Macintosh default: "mac")
3076 local to buffer
3077 {not in Vi}
3078 This gives the <EOL> of the current buffer, which is used for
3079 reading/writing the buffer from/to a file:
3080 dos <CR> <NL>
3081 unix <NL>
3082 mac <CR>
3083 When "dos" is used, CTRL-Z at the end of a file is ignored.
3084 See |file-formats| and |file-read|.
3085 For the character encoding of the file see 'fileencoding'.
3086 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003087 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 This option is set automatically when starting to edit a file and
3089 'fileformats' is not empty and 'binary' is off.
3090 When this option is set, after starting to edit a file, the 'modified'
3091 option is set, because the file would be different when written.
3092 This option can not be changed when 'modifiable' is off.
3093 For backwards compatibility: When this option is set to "dos",
3094 'textmode' is set, otherwise 'textmode' is reset.
3095
3096 *'fileformats'* *'ffs'*
3097'fileformats' 'ffs' string (default:
3098 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3099 Vim Unix: "unix,dos",
3100 Vim Mac: "mac,unix,dos",
3101 Vi Cygwin: "unix,dos",
3102 Vi others: "")
3103 global
3104 {not in Vi}
3105 This gives the end-of-line (<EOL>) formats that will be tried when
3106 starting to edit a new buffer and when reading a file into an existing
3107 buffer:
3108 - When empty, the format defined with 'fileformat' will be used
3109 always. It is not set automatically.
3110 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003111 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 'fileformats' name will be used when a file is read into an existing
3113 buffer, no matter what 'fileformat' for that buffer is set to.
3114 - When more than one name is present, separated by commas, automatic
3115 <EOL> detection will be done when reading a file. When starting to
3116 edit a file, a check is done for the <EOL>:
3117 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3118 'fileformat' is set to "dos".
3119 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003120 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003122 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3123 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003124 This means that "mac" is only chosen when:
3125 "unix" is not present or no <NL> is found in the file, and
3126 "dos" is not present or no <CR><NL> is found in the file.
3127 Except: if "unix" was chosen, but there is a <CR> before
3128 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003129 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 4. If 'fileformat' is still not set, the first name from
3131 'fileformats' is used.
3132 When reading a file into an existing buffer, the same is done, but
3133 this happens like 'fileformat' has been set appropriately for that
3134 file only, the option is not changed.
3135 When 'binary' is set, the value of 'fileformats' is not used.
3136
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003137 When Vim starts up with an empty buffer the first item is used. You
3138 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003139
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3141 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3142 done:
3143 - When 'fileformats' is empty, there is no automatic detection. Dos
3144 format will be used.
3145 - When 'fileformats' is set to one or more names, automatic detection
3146 is done. This is based on the first <NL> in the file: If there is a
3147 <CR> in front of it, Dos format is used, otherwise Unix format is
3148 used.
3149 Also see |file-formats|.
3150 For backwards compatibility: When this option is set to an empty
3151 string or one format (no comma is included), 'textauto' is reset,
3152 otherwise 'textauto' is set.
3153 NOTE: This option is set to the Vi default value when 'compatible' is
3154 set and to the Vim default value when 'compatible' is reset.
3155
Bram Moolenaarbf884932013-04-05 22:26:15 +02003156 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3157'fileignorecase' 'fic' boolean (default on for systems where case in file
3158 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003159 global
3160 {not in Vi}
3161 When set case is ignored when using file names and directories.
3162 See 'wildignorecase' for only ignoring case when doing completion.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 *'filetype'* *'ft'*
3165'filetype' 'ft' string (default: "")
3166 local to buffer
3167 {not in Vi}
3168 {not available when compiled without the |+autocmd|
3169 feature}
3170 When this option is set, the FileType autocommand event is triggered.
3171 All autocommands that match with the value of this option will be
3172 executed. Thus the value of 'filetype' is used in place of the file
3173 name.
3174 Otherwise this option does not always reflect the current file type.
3175 This option is normally set when the file type is detected. To enable
3176 this use the ":filetype on" command. |:filetype|
3177 Setting this option to a different value is most useful in a modeline,
3178 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003179 Example, for in an IDL file:
3180 /* vim: set filetype=idl : */ ~
3181 |FileType| |filetypes|
3182 When a dot appears in the value then this separates two filetype
3183 names. Example:
3184 /* vim: set filetype=c.doxygen : */ ~
3185 This will use the "c" filetype first, then the "doxygen" filetype.
3186 This works both for filetype plugins and for syntax files. More than
3187 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 This option is not copied to another buffer, independent of the 's' or
3189 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003190 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191
3192 *'fillchars'* *'fcs'*
3193'fillchars' 'fcs' string (default "vert:|,fold:-")
3194 global
3195 {not in Vi}
3196 {not available when compiled without the |+windows|
3197 and |+folding| features}
3198 Characters to fill the statuslines and vertical separators.
3199 It is a comma separated list of items:
3200
3201 item default Used for ~
3202 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003203 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 vert:c '|' vertical separators |:vsplit|
3205 fold:c '-' filling 'foldtext'
3206 diff:c '-' deleted lines of the 'diff' option
3207
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003208 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003209 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 otherwise.
3211
3212 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003213 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214< This is similar to the default, except that these characters will also
3215 be used when there is highlighting.
3216
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003217 for "stl" and "stlnc" only single-byte values are supported.
3218
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 The highlighting used for these items:
3220 item highlight group ~
3221 stl:c StatusLine |hl-StatusLine|
3222 stlnc:c StatusLineNC |hl-StatusLineNC|
3223 vert:c VertSplit |hl-VertSplit|
3224 fold:c Folded |hl-Folded|
3225 diff:c DiffDelete |hl-DiffDelete|
3226
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003227 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3228'fixendofline' 'fixeol' boolean (default on)
3229 local to buffer
3230 {not in Vi}
3231 When writing a file and this option is on, <EOL> at the end of file
3232 will be restored if missing. Turn this option off if you want to
3233 preserve the situation from the original file.
3234 When the 'binary' option is set the value of this option doesn't
3235 matter.
3236 See the 'endofline' option.
3237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3239'fkmap' 'fk' boolean (default off) *E198*
3240 global
3241 {not in Vi}
3242 {only available when compiled with the |+rightleft|
3243 feature}
3244 When on, the keyboard is mapped for the Farsi character set.
3245 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003246 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247
3248 *'foldclose'* *'fcl'*
3249'foldclose' 'fcl' string (default "")
3250 global
3251 {not in Vi}
3252 {not available when compiled without the |+folding|
3253 feature}
3254 When set to "all", a fold is closed when the cursor isn't in it and
3255 its level is higher than 'foldlevel'. Useful if you want folds to
3256 automatically close when moving out of them.
3257
3258 *'foldcolumn'* *'fdc'*
3259'foldcolumn' 'fdc' number (default 0)
3260 local to window
3261 {not in Vi}
3262 {not available when compiled without the |+folding|
3263 feature}
3264 When non-zero, a column with the specified width is shown at the side
3265 of the window which indicates open and closed folds. The maximum
3266 value is 12.
3267 See |folding|.
3268
3269 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3270'foldenable' 'fen' boolean (default on)
3271 local to window
3272 {not in Vi}
3273 {not available when compiled without the |+folding|
3274 feature}
3275 When off, all folds are open. This option can be used to quickly
3276 switch between showing all text unfolded and viewing the text with
3277 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003278 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 'foldenable' is off.
3280 This option is set by commands that create a new fold or close a fold.
3281 See |folding|.
3282
3283 *'foldexpr'* *'fde'*
3284'foldexpr' 'fde' string (default: "0")
3285 local to window
3286 {not in Vi}
3287 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003288 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003290 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003291
Bram Moolenaar30b65812012-07-12 22:01:11 +02003292 The expression will be evaluated in the |sandbox| if set from a
3293 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003294 This option can't be set from a |modeline| when the 'diff' option is
3295 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003296
3297 It is not allowed to change text or jump to another window while
3298 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299
3300 *'foldignore'* *'fdi'*
3301'foldignore' 'fdi' string (default: "#")
3302 local to window
3303 {not in Vi}
3304 {not available when compiled without the |+folding|
3305 feature}
3306 Used only when 'foldmethod' is "indent". Lines starting with
3307 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003308 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 The default "#" works well for C programs. See |fold-indent|.
3310
3311 *'foldlevel'* *'fdl'*
3312'foldlevel' 'fdl' number (default: 0)
3313 local to window
3314 {not in Vi}
3315 {not available when compiled without the |+folding|
3316 feature}
3317 Sets the fold level: Folds with a higher level will be closed.
3318 Setting this option to zero will close all folds. Higher numbers will
3319 close fewer folds.
3320 This option is set by commands like |zm|, |zM| and |zR|.
3321 See |fold-foldlevel|.
3322
3323 *'foldlevelstart'* *'fdls'*
3324'foldlevelstart' 'fdls' number (default: -1)
3325 global
3326 {not in Vi}
3327 {not available when compiled without the |+folding|
3328 feature}
3329 Sets 'foldlevel' when starting to edit another buffer in a window.
3330 Useful to always start editing with all folds closed (value zero),
3331 some folds closed (one) or no folds closed (99).
3332 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003333 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 ignores this option and closes all folds.
3335 It is also done before BufReadPre autocommands, to allow an autocmd to
3336 overrule the 'foldlevel' value for specific files.
3337 When the value is negative, it is not used.
3338
3339 *'foldmarker'* *'fmr'* *E536*
3340'foldmarker' 'fmr' string (default: "{{{,}}}")
3341 local to window
3342 {not in Vi}
3343 {not available when compiled without the |+folding|
3344 feature}
3345 The start and end marker used when 'foldmethod' is "marker". There
3346 must be one comma, which separates the start and end marker. The
3347 marker is a literal string (a regular expression would be too slow).
3348 See |fold-marker|.
3349
3350 *'foldmethod'* *'fdm'*
3351'foldmethod' 'fdm' string (default: "manual")
3352 local to window
3353 {not in Vi}
3354 {not available when compiled without the |+folding|
3355 feature}
3356 The kind of folding used for the current window. Possible values:
3357 |fold-manual| manual Folds are created manually.
3358 |fold-indent| indent Lines with equal indent form a fold.
3359 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3360 |fold-marker| marker Markers are used to specify folds.
3361 |fold-syntax| syntax Syntax highlighting items specify folds.
3362 |fold-diff| diff Fold text that is not changed.
3363
3364 *'foldminlines'* *'fml'*
3365'foldminlines' 'fml' number (default: 1)
3366 local to window
3367 {not in Vi}
3368 {not available when compiled without the |+folding|
3369 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003370 Sets the number of screen lines above which a fold can be displayed
3371 closed. Also for manually closed folds. With the default value of
3372 one a fold can only be closed if it takes up two or more screen lines.
3373 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003374 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 "zc" to close a fold, which is displayed open because it's smaller
3376 than 'foldminlines', a following "zc" may close a containing fold.
3377
3378 *'foldnestmax'* *'fdn'*
3379'foldnestmax' 'fdn' number (default: 20)
3380 local to window
3381 {not in Vi}
3382 {not available when compiled without the |+folding|
3383 feature}
3384 Sets the maximum nesting of folds for the "indent" and "syntax"
3385 methods. This avoids that too many folds will be created. Using more
3386 than 20 doesn't work, because the internal limit is 20.
3387
3388 *'foldopen'* *'fdo'*
3389'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3390 search,tag,undo")
3391 global
3392 {not in Vi}
3393 {not available when compiled without the |+folding|
3394 feature}
3395 Specifies for which type of commands folds will be opened, if the
3396 command moves the cursor into a closed fold. It is a comma separated
3397 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003398 NOTE: When the command is part of a mapping this option is not used.
3399 Add the |zv| command to the mapping to get the same effect.
3400 (rationale: the mapping may want to control opening folds itself)
3401
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 item commands ~
3403 all any
3404 block "(", "{", "[[", "[{", etc.
3405 hor horizontal movements: "l", "w", "fx", etc.
3406 insert any command in Insert mode
3407 jump far jumps: "G", "gg", etc.
3408 mark jumping to a mark: "'m", CTRL-O, etc.
3409 percent "%"
3410 quickfix ":cn", ":crew", ":make", etc.
3411 search search for a pattern: "/", "n", "*", "gd", etc.
3412 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003413 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 tag jumping to a tag: ":ta", CTRL-T, etc.
3415 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 When a movement command is used for an operator (e.g., "dl" or "y%")
3417 this option is not used. This means the operator will include the
3418 whole closed fold.
3419 Note that vertical movements are not here, because it would make it
3420 very difficult to move onto a closed fold.
3421 In insert mode the folds containing the cursor will always be open
3422 when text is inserted.
3423 To close folds you can re-apply 'foldlevel' with the |zx| command or
3424 set the 'foldclose' option to "all".
3425
3426 *'foldtext'* *'fdt'*
3427'foldtext' 'fdt' string (default: "foldtext()")
3428 local to window
3429 {not in Vi}
3430 {not available when compiled without the |+folding|
3431 feature}
3432 An expression which is used to specify the text displayed for a closed
3433 fold. See |fold-foldtext|.
3434
Bram Moolenaar30b65812012-07-12 22:01:11 +02003435 The expression will be evaluated in the |sandbox| if set from a
3436 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003437
3438 It is not allowed to change text or jump to another window while
3439 evaluating 'foldtext' |textlock|.
3440
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003441 *'formatexpr'* *'fex'*
3442'formatexpr' 'fex' string (default "")
3443 local to buffer
3444 {not in Vi}
3445 {not available when compiled without the |+eval|
3446 feature}
3447 Expression which is evaluated to format a range of lines for the |gq|
3448 operator or automatic formatting (see 'formatoptions'). When this
3449 option is empty 'formatprg' is used.
3450
3451 The |v:lnum| variable holds the first line to be formatted.
3452 The |v:count| variable holds the number of lines to be formatted.
3453 The |v:char| variable holds the character that is going to be
3454 inserted if the expression is being evaluated due to
3455 automatic formatting. This can be empty. Don't insert
3456 it yet!
3457
3458 Example: >
3459 :set formatexpr=mylang#Format()
3460< This will invoke the mylang#Format() function in the
3461 autoload/mylang.vim file in 'runtimepath'. |autoload|
3462
3463 The expression is also evaluated when 'textwidth' is set and adding
3464 text beyond that limit. This happens under the same conditions as
3465 when internal formatting is used. Make sure the cursor is kept in the
3466 same spot relative to the text then! The |mode()| function will
3467 return "i" or "R" in this situation.
3468
3469 When the expression evaluates to non-zero Vim will fall back to using
3470 the internal format mechanism.
3471
3472 The expression will be evaluated in the |sandbox| when set from a
3473 modeline, see |sandbox-option|. That stops the option from working,
3474 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003475 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003476
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 *'formatoptions'* *'fo'*
3478'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3479 local to buffer
3480 {not in Vi}
3481 This is a sequence of letters which describes how automatic
3482 formatting is to be done. See |fo-table|. When the 'paste' option is
3483 on, no formatting is done (like 'formatoptions' is empty). Commas can
3484 be inserted for readability.
3485 To avoid problems with flags that are added in the future, use the
3486 "+=" and "-=" feature of ":set" |add-option-flags|.
3487 NOTE: This option is set to the Vi default value when 'compatible' is
3488 set and to the Vim default value when 'compatible' is reset.
3489
Bram Moolenaar86b68352004-12-27 21:59:20 +00003490 *'formatlistpat'* *'flp'*
3491'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3492 local to buffer
3493 {not in Vi}
3494 A pattern that is used to recognize a list header. This is used for
3495 the "n" flag in 'formatoptions'.
3496 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003497 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003498 while still checking more characters. There must be a character
3499 following the pattern, when it matches the whole line it is handled
3500 like there is no match.
3501 The default recognizes a number, followed by an optional punctuation
3502 character and white space.
3503
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 *'formatprg'* *'fp'*
3505'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003506 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 {not in Vi}
3508 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003509 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003511 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003512 If the 'formatexpr' option is not empty it will be used instead.
3513 Otherwise, if 'formatprg' option is an empty string, the internal
3514 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003515 Environment variables are expanded |:set_env|. See |option-backslash|
3516 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003517 This option cannot be set from a |modeline| or in the |sandbox|, for
3518 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519
Bram Moolenaard94464e2015-11-02 15:28:18 +01003520 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003521'fsync' 'fs' boolean (default on)
3522 global
3523 {not in Vi}
3524 When on, the library function fsync() will be called after writing a
3525 file. This will flush a file to disk, ensuring that it is safely
3526 written even on filesystems which do metadata-only journaling. This
3527 will force the harddrive to spin up on Linux systems running in laptop
3528 mode, so it may be undesirable in some situations. Be warned that
3529 turning this off increases the chances of data loss after a crash. On
3530 systems without an fsync() implementation, this variable is always
3531 off.
3532 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003533 'fsync' also applies to |writefile()|, unless a flag is used to
3534 overrule it.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003535
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3537'gdefault' 'gd' boolean (default off)
3538 global
3539 {not in Vi}
3540 When on, the ":substitute" flag 'g' is default on. This means that
3541 all matches in a line are substituted instead of one. When a 'g' flag
3542 is given to a ":substitute" command, this will toggle the substitution
3543 of all or one match. See |complex-change|.
3544
3545 command 'gdefault' on 'gdefault' off ~
3546 :s/// subst. all subst. one
3547 :s///g subst. one subst. all
3548 :s///gg subst. all subst. one
3549
3550 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003551 DEPRECATED: Setting this option may break plugins that are not aware
3552 of this option. Also, many users get confused that adding the /g flag
3553 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554
3555 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003556'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 global
3558 {not in Vi}
3559 Format to recognize for the ":grep" command output.
3560 This is a scanf-like string that uses the same format as the
3561 'errorformat' option: see |errorformat|.
3562
3563 *'grepprg'* *'gp'*
3564'grepprg' 'gp' string (default "grep -n ",
3565 Unix: "grep -n $* /dev/null",
3566 Win32: "findstr /n" or "grep -n",
3567 VMS: "SEARCH/NUMBERS ")
3568 global or local to buffer |global-local|
3569 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003570 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 and '#' characters, which are expanded like when used in a command-
3572 line. The placeholder "$*" is allowed to specify where the arguments
3573 will be included. Environment variables are expanded |:set_env|. See
3574 |option-backslash| about including spaces and backslashes.
3575 When your "grep" accepts the "-H" argument, use this to make ":grep"
3576 also work well with a single file: >
3577 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003578< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003579 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3580 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003581 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 apply equally to 'grepprg'.
3583 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3584 otherwise it's "grep -n".
3585 This option cannot be set from a |modeline| or in the |sandbox|, for
3586 security reasons.
3587
3588 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3589'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3590 ve:ver35-Cursor,
3591 o:hor50-Cursor,
3592 i-ci:ver25-Cursor/lCursor,
3593 r-cr:hor20-Cursor/lCursor,
3594 sm:block-Cursor
3595 -blinkwait175-blinkoff150-blinkon175",
3596 for MS-DOS and Win32 console:
3597 "n-v-c:block,o:hor50,i-ci:hor15,
3598 r-cr:hor30,sm:block")
3599 global
3600 {not in Vi}
3601 {only available when compiled with GUI enabled, and
3602 for MS-DOS and Win32 console}
3603 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003604 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 the height of the cursor can be changed. This can be done by
3606 specifying a block cursor, or a percentage for a vertical or
3607 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003608 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3609 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003611 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 mode-list and an argument-list:
3613 mode-list:argument-list,mode-list:argument-list,..
3614 The mode-list is a dash separated list of these modes:
3615 n Normal mode
3616 v Visual mode
3617 ve Visual mode with 'selection' "exclusive" (same as 'v',
3618 if not specified)
3619 o Operator-pending mode
3620 i Insert mode
3621 r Replace mode
3622 c Command-line Normal (append) mode
3623 ci Command-line Insert mode
3624 cr Command-line Replace mode
3625 sm showmatch in Insert mode
3626 a all modes
3627 The argument-list is a dash separated list of these arguments:
3628 hor{N} horizontal bar, {N} percent of the character height
3629 ver{N} vertical bar, {N} percent of the character width
3630 block block cursor, fills the whole character
3631 [only one of the above three should be present]
3632 blinkwait{N} *cursor-blinking*
3633 blinkon{N}
3634 blinkoff{N}
3635 blink times for cursor: blinkwait is the delay before
3636 the cursor starts blinking, blinkon is the time that
3637 the cursor is shown and blinkoff is the time that the
3638 cursor is not shown. The times are in msec. When one
3639 of the numbers is zero, there is no blinking. The
3640 default is: "blinkwait700-blinkon400-blinkoff250".
3641 These numbers are used for a missing entry. This
3642 means that blinking is enabled by default. To switch
3643 blinking off you can use "blinkon0". The cursor only
3644 blinks when Vim is waiting for input, not while
3645 executing a command.
3646 To make the cursor blink in an xterm, see
3647 |xterm-blink|.
3648 {group-name}
3649 a highlight group name, that sets the color and font
3650 for the cursor
3651 {group-name}/{group-name}
3652 Two highlight group names, the first is used when
3653 no language mappings are used, the other when they
3654 are. |language-mapping|
3655
3656 Examples of parts:
3657 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3658 block cursor with colors from the "nCursor"
3659 highlight group
3660 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3661 In Insert and Command-line Insert mode, use a
3662 30% vertical bar cursor with colors from the
3663 "iCursor" highlight group. Blink a bit
3664 faster.
3665
3666 The 'a' mode is different. It will set the given argument-list for
3667 all modes. It does not reset anything to defaults. This can be used
3668 to do a common setting for all modes. For example, to switch off
3669 blinking: "a:blinkon0"
3670
3671 Examples of cursor highlighting: >
3672 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3673 :highlight Cursor gui=NONE guifg=bg guibg=fg
3674<
3675 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003676 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677'guifont' 'gfn' string (default "")
3678 global
3679 {not in Vi}
3680 {only available when compiled with GUI enabled}
3681 This is a list of fonts which will be used for the GUI version of Vim.
3682 In its simplest form the value is just one font name. When
3683 the font cannot be found you will get an error message. To try other
3684 font names a list can be specified, font names separated with commas.
3685 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003686
Bram Moolenaar05159a02005-02-26 23:04:13 +00003687 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3688 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003689
Bram Moolenaar3df01732017-02-17 22:47:16 +01003690 Note: As to the GTK GUIs, no error is given against any invalid names,
3691 and the first element of the list is always picked up and made use of.
3692 This is because, instead of identifying a given name with a font, the
3693 GTK GUIs use it to construct a pattern and try to look up a font which
3694 best matches the pattern among available fonts, and this way, the
3695 matching never fails. An invalid name doesn't matter because a number
3696 of font properties other than name will do to get the matching done.
3697
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 Spaces after a comma are ignored. To include a comma in a font name
3699 precede it with a backslash. Setting an option requires an extra
3700 backslash before a space and a backslash. See also
3701 |option-backslash|. For example: >
3702 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003703< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003705
3706 If none of the fonts can be loaded, Vim will keep the current setting.
3707 If an empty font list is given, Vim will try using other resource
3708 settings (for X, it will use the Vim.font resource), and finally it
3709 will try some builtin default which should always be there ("7x13" in
3710 the case of X). The font names given should be "normal" fonts. Vim
3711 will try to find the related bold and italic fonts.
3712
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003713 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003714 :set guifont=*
3715< will bring up a font requester, where you can pick the font you want.
3716
3717 The font name depends on the GUI used. See |setting-guifont| for a
3718 way to set 'guifont' for various systems.
3719
Bram Moolenaar3df01732017-02-17 22:47:16 +01003720 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003722< That's all. XLFDs are not used. For Chinese this is reported to work
3723 well: >
3724 if has("gui_gtk2")
3725 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3726 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3727 endif
3728<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003729 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3730
Bram Moolenaar05159a02005-02-26 23:04:13 +00003731 For Mac OSX you can use something like this: >
3732 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003733< Also see 'macatsui', it can help fix display problems.
3734 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003736 width). An exception is GTK: all fonts are accepted, but mono-spaced
3737 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003738
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 To preview a font on X11, you might be able to use the "xfontsel"
3740 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003741
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 For the Win32 GUI *E244* *E245*
3743 - takes these options in the font name:
3744 hXX - height is XX (points, can be floating-point)
3745 wXX - width is XX (points, can be floating-point)
3746 b - bold
3747 i - italic
3748 u - underline
3749 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003750 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3752 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3753 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003754 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003755 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003756 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003757 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003758 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759
3760 Use a ':' to separate the options.
3761 - A '_' can be used in the place of a space, so you don't need to use
3762 backslashes to escape the spaces.
3763 - Examples: >
3764 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3765 :set guifont=Andale_Mono:h7.5:w4.5
3766< See also |font-sizes|.
3767
3768 *'guifontset'* *'gfs'*
3769 *E250* *E252* *E234* *E597* *E598*
3770'guifontset' 'gfs' string (default "")
3771 global
3772 {not in Vi}
3773 {only available when compiled with GUI enabled and
3774 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003775 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 When not empty, specifies two (or more) fonts to be used. The first
3777 one for normal English, the second one for your special language. See
3778 |xfontset|.
3779 Setting this option also means that all font names will be handled as
3780 a fontset name. Also the ones used for the "font" argument of the
3781 |:highlight| command.
3782 The fonts must match with the current locale. If fonts for the
3783 character sets that the current locale uses are not included, setting
3784 'guifontset' will fail.
3785 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3786 the comma-separated names are alternative names, one of which will be
3787 used. In 'guifontset' the whole string is one fontset name,
3788 including the commas. It is not possible to specify alternative
3789 fontset names.
3790 This example works on many X11 systems: >
3791 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3792<
3793 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3794'guifontwide' 'gfw' string (default "")
3795 global
3796 {not in Vi}
3797 {only available when compiled with GUI enabled}
3798 When not empty, specifies a comma-separated list of fonts to be used
3799 for double-width characters. The first font that can be loaded is
3800 used.
3801 Note: The size of these fonts must be exactly twice as wide as the one
3802 specified with 'guifont' and the same height.
3803
Bram Moolenaar3df01732017-02-17 22:47:16 +01003804 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805
3806 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3807 'guifontset' is empty or invalid.
3808 When 'guifont' is set and a valid font is found in it and
3809 'guifontwide' is empty Vim will attempt to find a matching
3810 double-width font and set 'guifontwide' to it.
3811
Bram Moolenaar3df01732017-02-17 22:47:16 +01003812 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813
3814 If set and valid, 'guifontwide' is always used for double width
3815 characters, even if 'encoding' is not set to "utf-8".
3816 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003817 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 font for characters not available in 'guifont'. Thus you do not need
3819 to set 'guifontwide' at all unless you want to override the choice
3820 made by Pango/Xft.
3821
Bram Moolenaar0f272122013-01-23 18:37:40 +01003822 Windows +multibyte only: *guifontwide_win_mbyte*
3823
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003824 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003825
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 *'guiheadroom'* *'ghr'*
3827'guiheadroom' 'ghr' number (default 50)
3828 global
3829 {not in Vi} {only for GTK and X11 GUI}
3830 The number of pixels subtracted from the screen height when fitting
3831 the GUI window on the screen. Set this before the GUI is started,
3832 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 lines will be left for window decorations and other items on the
3835 screen. Set it to a negative value to allow windows taller than the
3836 screen.
3837
3838 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003839'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3840 removed in |defaults.vim|),
3841 "aegimrLtT" (GTK, Motif and Athena),
3842 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 global
3844 {not in Vi}
3845 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003846 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 sequence of letters which describes what components and options of the
3848 GUI should be used.
3849 To avoid problems with flags that are added in the future, use the
3850 "+=" and "-=" feature of ":set" |add-option-flags|.
3851
3852 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003853 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 'a' Autoselect: If present, then whenever VISUAL mode is started,
3855 or the Visual area extended, Vim tries to become the owner of
3856 the windowing system's global selection. This means that the
3857 Visually highlighted text is available for pasting into other
3858 applications as well as into Vim itself. When the Visual mode
3859 ends, possibly due to an operation on the text, or when an
3860 application wants to paste the selection, the highlighted text
3861 is automatically yanked into the "* selection register.
3862 Thus the selection is still available for pasting into other
3863 applications after the VISUAL mode has ended.
3864 If not present, then Vim won't become the owner of the
3865 windowing system's global selection unless explicitly told to
3866 by a yank or delete operation for the "* register.
3867 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003868 *'go-P'*
3869 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003870 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003871 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003872 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 applies to the modeless selection.
3874
3875 'guioptions' autoselect Visual autoselect modeless ~
3876 "" - -
3877 "a" yes yes
3878 "A" - yes
3879 "aA" yes yes
3880
Bram Moolenaar02467872007-05-06 13:22:01 +00003881 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 'c' Use console dialogs instead of popup dialogs for simple
3883 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003884 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003885 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003886 'guitablabel' can be used to change the text in the labels.
3887 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003888 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003889 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003890 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 'f' Foreground: Don't use fork() to detach the GUI from the shell
3892 where it was started. Use this for programs that wait for the
3893 editor to finish (e.g., an e-mail program). Alternatively you
3894 can use "gvim -f" or ":gui -f" to start the GUI in the
3895 foreground. |gui-fork|
3896 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003898 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3900 corner of the window. It's black&white on non-GTK, because of
3901 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003902 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003904 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003905 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003907 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003909 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003910 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 'g' Grey menu items: Make menu items that are not active grey. If
3912 'g' is not included inactive menu items are not shown at all.
3913 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003914 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 't' Include tearoff menu items. Currently only works for Win32,
3916 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003917 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003918 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003919 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003920 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003922 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 'R' Right-hand scrollbar is present when there is a vertically
3924 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003925 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003927 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003928 'L' Left-hand scrollbar is present when there is a vertically
3929 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003930 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3932 the longest visible line, or on the cursor line if the 'h'
3933 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003934 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 'h' Limit horizontal scrollbar size to the length of the cursor
3936 line. Reduces computations. |gui-horiz-scroll|
3937
3938 And yes, you may even have scrollbars on the left AND the right if
3939 you really want to :-). See |gui-scrollbars| for more information.
3940
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003941 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 'v' Use a vertical button layout for dialogs. When not included,
3943 a horizontal layout is preferred, but when it doesn't fit a
3944 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003945 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 'p' Use Pointer callbacks for X11 GUI. This is required for some
3947 window managers. If the cursor is not blinking or hollow at
3948 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003949 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003951 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003952 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003953 *'go-k'*
3954 'k' Keep the GUI window size when adding/removing a scrollbar, or
3955 toolbar, tabline, etc. Instead, the behavior is similar to
3956 when the window is maximized and will adjust 'lines' and
3957 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003958 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003959 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003960
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 *'guipty'* *'noguipty'*
3962'guipty' boolean (default on)
3963 global
3964 {not in Vi}
3965 {only available when compiled with GUI enabled}
3966 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3967 I/O to/from shell commands. See |gui-pty|.
3968
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003969 *'guitablabel'* *'gtl'*
3970'guitablabel' 'gtl' string (default empty)
3971 global
3972 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003973 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003974 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003975 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003976 pages line. When empty and when the result is empty Vim will use a
3977 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003978
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003979 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003980 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003981 The expression will be evaluated in the |sandbox| when set from a
3982 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003983
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003984 Only used when the GUI tab pages line is displayed. 'e' must be
3985 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3986 used.
3987
Bram Moolenaar57657d82006-04-21 22:12:41 +00003988 *'guitabtooltip'* *'gtt'*
3989'guitabtooltip' 'gtt' string (default empty)
3990 global
3991 {not in Vi}
3992 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003993 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003994 When nonempty describes the text to use in a tooltip for the GUI tab
3995 pages line. When empty Vim will use a default tooltip.
3996 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003997 You can include a line break. Simplest method is to use |:let|: >
3998 :let &guitabtooltip = "line one\nline two"
3999<
Bram Moolenaar57657d82006-04-21 22:12:41 +00004000
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 *'helpfile'* *'hf'*
4002'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
4003 (others) "$VIMRUNTIME/doc/help.txt")
4004 global
4005 {not in Vi}
4006 Name of the main help file. All distributed help files should be
4007 placed together in one directory. Additionally, all "doc" directories
4008 in 'runtimepath' will be used.
4009 Environment variables are expanded |:set_env|. For example:
4010 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004011 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 spaces and backslashes.
4013 This option cannot be set from a |modeline| or in the |sandbox|, for
4014 security reasons.
4015
4016 *'helpheight'* *'hh'*
4017'helpheight' 'hh' number (default 20)
4018 global
4019 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004020 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 feature}
4022 Minimal initial height of the help window when it is opened with the
4023 ":help" command. The initial height of the help window is half of the
4024 current window, or (when the 'ea' option is on) the same as other
4025 windows. When the height is less than 'helpheight', the height is
4026 set to 'helpheight'. Set to zero to disable.
4027
4028 *'helplang'* *'hlg'*
4029'helplang' 'hlg' string (default: messages language or empty)
4030 global
4031 {only available when compiled with the |+multi_lang|
4032 feature}
4033 {not in Vi}
4034 Comma separated list of languages. Vim will use the first language
4035 for which the desired help can be found. The English help will always
4036 be used as a last resort. You can add "en" to prefer English over
4037 another language, but that will only find tags that exist in that
4038 language and not in the English help.
4039 Example: >
4040 :set helplang=de,it
4041< This will first search German, then Italian and finally English help
4042 files.
4043 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4044 try to find the tag in the current language before using this option.
4045 See |help-translated|.
4046
4047 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4048'hidden' 'hid' boolean (default off)
4049 global
4050 {not in Vi}
4051 When off a buffer is unloaded when it is |abandon|ed. When on a
4052 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4053 displayed in another window, it does not become hidden, of course.
4054 The commands that move through the buffer list sometimes make a buffer
4055 hidden although the 'hidden' option is off: When the buffer is
4056 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004057 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004058 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 This option is set for one command with ":hide {command}" |:hide|.
4060 WARNING: It's easy to forget that you have changes in hidden buffers.
4061 Think twice when using ":q!" or ":qa!".
4062
4063 *'highlight'* *'hl'*
4064'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004065 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4066 d:Directory,e:ErrorMsg,i:IncSearch,
4067 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4068 N:CursorLineNr,r:Question,s:StatusLine,
4069 S:StatusLineNC,c:VertSplit,t:Title,
4070 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4071 F:FoldColumn,A:DiffAdd,C:DiffChange,
4072 D:DiffDelete,T:DiffText,>:SignColumn,
4073 B:SpellBad,P:SpellCap,R:SpellRare,
4074 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004075 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4076 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004077 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004078 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 global
4080 {not in Vi}
4081 This option can be used to set highlighting mode for various
4082 occasions. It is a comma separated list of character pairs. The
4083 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004084 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004086 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4087 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 characters from 'showbreak'
4089 |hl-Directory| d directories in CTRL-D listing and other special
4090 things in listings
4091 |hl-ErrorMsg| e error messages
4092 h (obsolete, ignored)
4093 |hl-IncSearch| i 'incsearch' highlighting
4094 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4095 |hl-MoreMsg| m |more-prompt|
4096 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004097 |hl-LineNr| n line number for ":number" and ":#" commands, and
4098 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004099 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4100 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 |hl-Question| r |hit-enter| prompt and yes/no questions
4102 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01004103 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4105 |hl-VertSplit| c column used to separate vertically split windows
4106 |hl-Visual| v Visual mode
4107 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4108 Selection" Only X11 Gui's |gui-x11| and
4109 |xterm-clipboard|.
4110 |hl-WarningMsg| w warning messages
4111 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4112 |hl-Folded| f line used for closed folds
4113 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004114 |hl-DiffAdd| A added line in diff mode
4115 |hl-DiffChange| C changed line in diff mode
4116 |hl-DiffDelete| D deleted line in diff mode
4117 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004119 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004120 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004121 |hl-SpellRare| R rare word |spell|
4122 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004123 |hl-Conceal| - the placeholders used for concealed characters
4124 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004125 |hl-Pmenu| + popup menu normal line
4126 |hl-PmenuSel| = popup menu normal line
4127 |hl-PmenuSbar| x popup menu scrollbar
4128 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129
4130 The display modes are:
4131 r reverse (termcap entry "mr" and "me")
4132 i italic (termcap entry "ZH" and "ZR")
4133 b bold (termcap entry "md" and "me")
4134 s standout (termcap entry "so" and "se")
4135 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004136 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004137 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 n no highlighting
4139 - no highlighting
4140 : use a highlight group
4141 The default is used for occasions that are not included.
4142 If you want to change what the display modes do, see |dos-colors|
4143 for an example.
4144 When using the ':' display mode, this must be followed by the name of
4145 a highlight group. A highlight group can be used to define any type
4146 of highlighting, including using color. See |:highlight| on how to
4147 define one. The default uses a different group for each occasion.
4148 See |highlight-default| for the default highlight groups.
4149
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004151'history' 'hi' number (Vim default: 50, Vi default: 0,
4152 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 global
4154 {not in Vi}
4155 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004156 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004158 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 NOTE: This option is set to the Vi default value when 'compatible' is
4160 set and to the Vim default value when 'compatible' is reset.
4161
4162 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4163'hkmap' 'hk' boolean (default off)
4164 global
4165 {not in Vi}
4166 {only available when compiled with the |+rightleft|
4167 feature}
4168 When on, the keyboard is mapped for the Hebrew character set.
4169 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4170 toggle this option. See |rileft.txt|.
4171 NOTE: This option is reset when 'compatible' is set.
4172
4173 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4174'hkmapp' 'hkp' boolean (default off)
4175 global
4176 {not in Vi}
4177 {only available when compiled with the |+rightleft|
4178 feature}
4179 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4180 This is useful if you have a non-Hebrew keyboard.
4181 See |rileft.txt|.
4182 NOTE: This option is reset when 'compatible' is set.
4183
Bram Moolenaar036986f2017-03-16 17:41:02 +01004184 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4185'hlsearch' 'hls' boolean (default off)
4186 global
4187 {not in Vi}
4188 {not available when compiled without the
4189 |+extra_search| feature}
4190 When there is a previous search pattern, highlight all its matches.
4191 The type of highlighting used can be set with the 'l' occasion in the
4192 'highlight' option. This uses the "Search" highlight group by
4193 default. Note that only the matching text is highlighted, any offsets
4194 are not applied.
4195 See also: 'incsearch' and |:match|.
4196 When you get bored looking at the highlighted matches, you can turn it
4197 off with |:nohlsearch|. This does not change the option value, as
4198 soon as you use a search command, the highlighting comes back.
4199 'redrawtime' specifies the maximum time spent on finding matches.
4200 When the search pattern can match an end-of-line, Vim will try to
4201 highlight all of the matched text. However, this depends on where the
4202 search starts. This will be the first line in the window or the first
4203 line below a closed fold. A match in a previous line which is not
4204 drawn may not continue in a newly drawn line.
4205 You can specify whether the highlight status is restored on startup
4206 with the 'h' flag in 'viminfo' |viminfo-h|.
4207 NOTE: This option is reset when 'compatible' is set.
4208
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 *'icon'* *'noicon'*
4210'icon' boolean (default off, on when title can be restored)
4211 global
4212 {not in Vi}
4213 {not available when compiled without the |+title|
4214 feature}
4215 When on, the icon text of the window will be set to the value of
4216 'iconstring' (if it is not empty), or to the name of the file
4217 currently being edited. Only the last part of the name is used.
4218 Overridden by the 'iconstring' option.
4219 Only works if the terminal supports setting window icons (currently
4220 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4221 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4222 builtin termcap).
4223 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004224 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004226 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227
4228 *'iconstring'*
4229'iconstring' string (default "")
4230 global
4231 {not in Vi}
4232 {not available when compiled without the |+title|
4233 feature}
4234 When this option is not empty, it will be used for the icon text of
4235 the window. This happens only when the 'icon' option is on.
4236 Only works if the terminal supports setting window icon text
4237 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4238 Does not work for MS Windows.
4239 When Vim was compiled with HAVE_X11 defined, the original icon will be
4240 restored if possible |X11|.
4241 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004242 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 'titlestring' for example settings.
4244 {not available when compiled without the |+statusline| feature}
4245
4246 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4247'ignorecase' 'ic' boolean (default off)
4248 global
4249 Ignore case in search patterns. Also used when searching in the tags
4250 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004251 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 Can be overruled by using "\c" or "\C" in the pattern, see
4253 |/ignorecase|.
4254
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004255 *'imactivatefunc'* *'imaf'*
4256'imactivatefunc' 'imaf' string (default "")
4257 global
4258 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004259 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004260 This option specifies a function that will be called to
4261 activate/inactivate Input Method.
4262
4263 Example: >
4264 function ImActivateFunc(active)
4265 if a:active
4266 ... do something
4267 else
4268 ... do something
4269 endif
4270 " return value is not used
4271 endfunction
4272 set imactivatefunc=ImActivateFunc
4273<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 *'imactivatekey'* *'imak'*
4275'imactivatekey' 'imak' string (default "")
4276 global
4277 {not in Vi}
4278 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004279 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 Specifies the key that your Input Method in X-Windows uses for
4281 activation. When this is specified correctly, vim can fully control
4282 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4283 You can't use this option to change the activation key, the option
4284 tells Vim what the key is.
4285 Format:
4286 [MODIFIER_FLAG-]KEY_STRING
4287
4288 These characters can be used for MODIFIER_FLAG (case is ignored):
4289 S Shift key
4290 L Lock key
4291 C Control key
4292 1 Mod1 key
4293 2 Mod2 key
4294 3 Mod3 key
4295 4 Mod4 key
4296 5 Mod5 key
4297 Combinations are allowed, for example "S-C-space" or "SC-space" are
4298 both shift+ctrl+space.
4299 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4300
4301 Example: >
4302 :set imactivatekey=S-space
4303< "S-space" means shift+space. This is the activation key for kinput2 +
4304 canna (Japanese), and ami (Korean).
4305
4306 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4307'imcmdline' 'imc' boolean (default off)
4308 global
4309 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004310 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 When set the Input Method is always on when starting to edit a command
4312 line, unless entering a search pattern (see 'imsearch' for that).
4313 Setting this option is useful when your input method allows entering
4314 English characters directly, e.g., when it's used to type accented
4315 characters with dead keys.
4316
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004317 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4319 global
4320 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004321 {only available when compiled with |+mbyte|}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 When set the Input Method is never used. This is useful to disable
4323 the IM when it doesn't work properly.
4324 Currently this option is on by default for SGI/IRIX machines. This
4325 may change in later releases.
4326
4327 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004328'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 local to buffer
4330 {not in Vi}
4331 Specifies whether :lmap or an Input Method (IM) is to be used in
4332 Insert mode. Valid values:
4333 0 :lmap is off and IM is off
4334 1 :lmap is ON and IM is off
4335 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 To always reset the option to zero when leaving Insert mode with <Esc>
4337 this can be used: >
4338 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4339< This makes :lmap and IM turn off automatically when leaving Insert
4340 mode.
4341 Note that this option changes when using CTRL-^ in Insert mode
4342 |i_CTRL-^|.
4343 The value is set to 1 when setting 'keymap' to a valid keymap name.
4344 It is also used for the argument of commands like "r" and "f".
4345 The value 0 may not work correctly with Athena and Motif with some XIM
4346 methods. Use 'imdisable' to disable XIM then.
4347
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004348 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
4349 via external command if vim is not compiled with the |+xim|,
4350 |+multi_byte_ime| or |global-ime|.
4351
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004353'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 local to buffer
4355 {not in Vi}
4356 Specifies whether :lmap or an Input Method (IM) is to be used when
4357 entering a search pattern. Valid values:
4358 -1 the value of 'iminsert' is used, makes it look like
4359 'iminsert' is also used when typing a search pattern
4360 0 :lmap is off and IM is off
4361 1 :lmap is ON and IM is off
4362 2 :lmap is off and IM is ON
4363 Note that this option changes when using CTRL-^ in Command-line mode
4364 |c_CTRL-^|.
4365 The value is set to 1 when it is not -1 and setting the 'keymap'
4366 option to a valid keymap name.
4367 The value 0 may not work correctly with Athena and Motif with some XIM
4368 methods. Use 'imdisable' to disable XIM then.
4369
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004370 *'imstatusfunc'* *'imsf'*
4371'imstatusfunc' 'imsf' string (default "")
4372 global
4373 {not in Vi}
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004374 {only available when compiled with |+mbyte|}
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004375 This option specifies a function that is called to obtain the status
4376 of Input Method. It must return a positive number when IME is active.
4377
4378 Example: >
4379 function ImStatusFunc()
4380 let is_active = ...do something
4381 return is_active ? 1 : 0
4382 endfunction
4383 set imstatusfunc=ImStatusFunc
4384<
4385 NOTE: This function is invoked very often. Keep it fast.
4386
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004387 *'imstyle'* *'imst'*
4388'imstyle' 'imst' number (default 1)
4389 global
4390 {not in Vi}
4391 {only available when compiled with |+xim| and
4392 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004393 This option specifies the input style of Input Method:
4394 0 use on-the-spot style
4395 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004396 See: |xim-input-style|
4397
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004398 For a long time on-the-spot style had been used in the GTK version of
4399 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004400 |single-repeat|, etc. Therefore over-the-spot style becomes the
4401 default now. This should work fine for most people, however if you
4402 have any problem with it, try using on-the-spot style.
4403
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 *'include'* *'inc'*
4405'include' 'inc' string (default "^\s*#\s*include")
4406 global or local to buffer |global-local|
4407 {not in Vi}
4408 {not available when compiled without the
4409 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004410 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 pattern, just like for the "/" command (See |pattern|). The default
4412 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004413 "]I", "[d", etc.
4414 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004415 comes after the matched pattern. But if "\zs" appears in the pattern
4416 then the text matched from "\zs" to the end, or until "\ze" if it
4417 appears, is used as the file name. Use this to include characters
4418 that are not in 'isfname', such as a space. You can then use
4419 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004420 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421
4422 *'includeexpr'* *'inex'*
4423'includeexpr' 'inex' string (default "")
4424 local to buffer
4425 {not in Vi}
4426 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004427 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004429 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 :set includeexpr=substitute(v:fname,'\\.','/','g')
4431< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004432
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004434 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 Also used for |<cfile>|.
4436
Bram Moolenaar30b65812012-07-12 22:01:11 +02004437 The expression will be evaluated in the |sandbox| when set from a
4438 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004439
4440 It is not allowed to change text or jump to another window while
4441 evaluating 'includeexpr' |textlock|.
4442
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004444'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4445 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 global
4447 {not in Vi}
4448 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004449 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004450 While typing a search command, show where the pattern, as it was typed
4451 so far, matches. The matched string is highlighted. If the pattern
4452 is invalid or not found, nothing is shown. The screen will be updated
4453 often, this is only useful on fast terminals.
4454 Note that the match will be shown, but the cursor will return to its
4455 original position when no match is found and when pressing <Esc>. You
4456 still need to finish the search command with <Enter> to move the
4457 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004458 You can use the CTRL-G and CTRL-T keys to move to the next and
4459 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004460 When compiled with the |+reltime| feature Vim only searches for about
4461 half a second. With a complicated pattern and/or a lot of text the
4462 match may not be found. This is to avoid that Vim hangs while you
4463 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004464 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004465 When 'hlsearch' is on, all matched strings are highlighted too while typing
4466 a search command. See also: 'hlsearch'.
4467 If you don't want turn 'hlsearch' on, but want to highlight all matches
4468 while searching, you can turn on and off 'hlsearch' with autocmd.
4469 Example: >
4470 augroup vimrc-incsearch-highlight
4471 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004472 autocmd CmdlineEnter /,\? :set hlsearch
4473 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004474 augroup END
4475<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004476 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004477 to the command line. If 'ignorecase' and 'smartcase' are set and the
4478 command line has no uppercase characters, the added character is
4479 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004480 CTRL-R CTRL-W can be used to add the word at the end of the current
4481 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 NOTE: This option is reset when 'compatible' is set.
4483
4484 *'indentexpr'* *'inde'*
4485'indentexpr' 'inde' string (default "")
4486 local to buffer
4487 {not in Vi}
4488 {not available when compiled without the |+cindent|
4489 or |+eval| features}
4490 Expression which is evaluated to obtain the proper indent for a line.
4491 It is used when a new line is created, for the |=| operator and
4492 in Insert mode as specified with the 'indentkeys' option.
4493 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004494 'smartindent' indenting. When 'lisp' is set, this option is
4495 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 When 'paste' is set this option is not used for indenting.
4497 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004498 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 when the expression is evaluated (but it may be moved around).
4500 The expression must return the number of spaces worth of indent. It
4501 can return "-1" to keep the current indent (this means 'autoindent' is
4502 used for the indent).
4503 Functions useful for computing the indent are |indent()|, |cindent()|
4504 and |lispindent()|.
4505 The evaluation of the expression must not have side effects! It must
4506 not change the text, jump to another window, etc. Afterwards the
4507 cursor position is always restored, thus the cursor may be moved.
4508 Normally this option would be set to call a function: >
4509 :set indentexpr=GetMyIndent()
4510< Error messages will be suppressed, unless the 'debug' option contains
4511 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004512 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004513 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514
Bram Moolenaar30b65812012-07-12 22:01:11 +02004515 The expression will be evaluated in the |sandbox| when set from a
4516 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004517
4518 It is not allowed to change text or jump to another window while
4519 evaluating 'indentexpr' |textlock|.
4520
4521
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 *'indentkeys'* *'indk'*
4523'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4524 local to buffer
4525 {not in Vi}
4526 {not available when compiled without the |+cindent|
4527 feature}
4528 A list of keys that, when typed in Insert mode, cause reindenting of
4529 the current line. Only happens if 'indentexpr' isn't empty.
4530 The format is identical to 'cinkeys', see |indentkeys-format|.
4531 See |C-indenting| and |indent-expression|.
4532
4533 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4534'infercase' 'inf' boolean (default off)
4535 local to buffer
4536 {not in Vi}
4537 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004538 'ignorecase' is also on, the case of the match is adjusted depending
4539 on the typed text. If the typed text contains a lowercase letter
4540 where the match has an upper case letter, the completed part is made
4541 lowercase. If the typed text has no lowercase letters and the match
4542 has a lowercase letter where the typed text has an uppercase letter,
4543 and there is a letter before it, the completed part is made uppercase.
4544 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545
4546 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4547'insertmode' 'im' boolean (default off)
4548 global
4549 {not in Vi}
4550 Makes Vim work in a way that Insert mode is the default mode. Useful
4551 if you want to use Vim as a modeless editor. Used for |evim|.
4552 These Insert mode commands will be useful:
4553 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004554 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 this is a mapping, it is executed as if 'insertmode' was off.
4556 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004558 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4559 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560
4561 These items change when 'insertmode' is set:
4562 - when starting to edit of a file, Vim goes to Insert mode.
4563 - <Esc> in Insert mode is a no-op and beeps.
4564 - <Esc> in Normal mode makes Vim go to Insert mode.
4565 - CTRL-L in Insert mode is a command, it is not inserted.
4566 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4567 However, when <Esc> is used inside a mapping, it behaves like
4568 'insertmode' was not set. This was done to be able to use the same
4569 mappings with 'insertmode' set or not set.
4570 When executing commands with |:normal| 'insertmode' is not used.
4571
4572 NOTE: This option is reset when 'compatible' is set.
4573
4574 *'isfname'* *'isf'*
4575'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4576 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4577 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4578 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4579 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4580 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4581 global
4582 {not in Vi}
4583 The characters specified by this option are included in file names and
4584 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004585 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 Multi-byte characters 256 and above are always included, only the
4587 characters up to 255 are specified with this option.
4588 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004589 Think twice before adding white space to this option. Although a
4590 space may appear inside a file name, the effect will be that Vim
4591 doesn't know where a file name starts or ends when doing completion.
4592 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593
4594 Note that on systems using a backslash as path separator, Vim tries to
4595 do its best to make it work as you would expect. That is a bit
4596 tricky, since Vi originally used the backslash to escape special
4597 characters. Vim will not remove a backslash in front of a normal file
4598 name character on these systems, but it will on Unix and alikes. The
4599 '&' and '^' are not included by default, because these are special for
4600 cmd.exe.
4601
4602 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004603 Each part can be a single character number or a range. A range is two
4604 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 decimal number between 0 and 255 or the ASCII character itself (does
4606 not work for digits). Example:
4607 "_,-,128-140,#-43" (include '_' and '-' and the range
4608 128 to 140 and '#' to 43)
4609 If a part starts with '^', the following character number or range
4610 will be excluded from the option. The option is interpreted from left
4611 to right. Put the excluded character after the range where it is
4612 included. To include '^' itself use it as the last character of the
4613 option or the end of a range. Example:
4614 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4615 If the character is '@', all characters where isalpha() returns TRUE
4616 are included. Normally these are the characters a to z and A to Z,
4617 plus accented characters. To include '@' itself use "@-@". Examples:
4618 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004619 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 "a-z,A-Z,@-@" All letters plus the '@' character.
4621 A comma can be included by using it where a character number is
4622 expected. Example:
4623 "48-57,,,_" Digits, comma and underscore.
4624 A comma can be excluded by prepending a '^'. Example:
4625 " -~,^,,9" All characters from space to '~', excluding
4626 comma, plus <Tab>.
4627 See |option-backslash| about including spaces and backslashes.
4628
4629 *'isident'* *'isi'*
4630'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4631 "@,48-57,_,128-167,224-235"
4632 otherwise: "@,48-57,_,192-255")
4633 global
4634 {not in Vi}
4635 The characters given by this option are included in identifiers.
4636 Identifiers are used in recognizing environment variables and after a
4637 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004638 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 option.
4640 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004641 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4643
4644 *'iskeyword'* *'isk'*
4645'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4646 "@,48-57,_,128-167,224-235"
4647 otherwise: "@,48-57,_,192-255"
4648 Vi default: "@,48-57,_")
4649 local to buffer
4650 {not in Vi}
4651 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004652 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 'isfname' for a description of the format of this option. For C
4654 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4655 For a help file it is set to all non-blank printable characters except
4656 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4657 command).
4658 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004659 This option also influences syntax highlighting, unless the syntax
4660 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661 NOTE: This option is set to the Vi default value when 'compatible' is
4662 set and to the Vim default value when 'compatible' is reset.
4663
4664 *'isprint'* *'isp'*
4665'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4666 "@,~-255"; otherwise: "@,161-255")
4667 global
4668 {not in Vi}
4669 The characters given by this option are displayed directly on the
4670 screen. It is also used for "\p" in a |pattern|. The characters from
4671 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4672 even when they are not included in 'isprint' or excluded. See
4673 'isfname' for a description of the format of this option.
4674
4675 Non-printable characters are displayed with two characters:
4676 0 - 31 "^@" - "^_"
4677 32 - 126 always single characters
4678 127 "^?"
4679 128 - 159 "~@" - "~_"
4680 160 - 254 "| " - "|~"
4681 255 "~?"
4682 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4683 displayed as <xx>, with the hexadecimal value of the byte.
4684 When 'display' contains "uhex" all unprintable characters are
4685 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004686 The SpecialKey highlighting will be used for unprintable characters.
4687 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
4689 Multi-byte characters 256 and above are always included, only the
4690 characters up to 255 are specified with this option. When a character
4691 is printable but it is not available in the current font, a
4692 replacement character will be shown.
4693 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4694 There is no option to specify these characters.
4695
4696 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4697'joinspaces' 'js' boolean (default on)
4698 global
4699 {not in Vi}
4700 Insert two spaces after a '.', '?' and '!' with a join command.
4701 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4702 Otherwise only one space is inserted.
4703 NOTE: This option is set when 'compatible' is set.
4704
4705 *'key'*
4706'key' string (default "")
4707 local to buffer
4708 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004709 {only available when compiled with the |+cryptv|
4710 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004712 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004713 Careful: Do not set the key value by hand, someone might see the typed
4714 key. Use the |:X| command. But you can make 'key' empty: >
4715 :set key=
4716< It is not possible to get the value of this option with ":set key" or
4717 "echo &key". This is to avoid showing it to someone who shouldn't
4718 know. It also means you cannot see it yourself once you have set it,
4719 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004720 You can use "&key" in an expression to detect whether encryption is
4721 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722
4723 *'keymap'* *'kmp'* *E544*
4724'keymap' 'kmp' string (default "")
4725 local to buffer
4726 {not in Vi}
4727 {only available when compiled with the |+keymap|
4728 feature}
4729 Name of a keyboard mapping. See |mbyte-keymap|.
4730 Setting this option to a valid keymap name has the side effect of
4731 setting 'iminsert' to one, so that the keymap becomes effective.
4732 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004733 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
4735 *'keymodel'* *'km'*
4736'keymodel' 'km' string (default "")
4737 global
4738 {not in Vi}
4739 List of comma separated words, which enable special things that keys
4740 can do. These values can be used:
4741 startsel Using a shifted special key starts selection (either
4742 Select mode or Visual mode, depending on "key" being
4743 present in 'selectmode').
4744 stopsel Using a not-shifted special key stops selection.
4745 Special keys in this context are the cursor keys, <End>, <Home>,
4746 <PageUp> and <PageDown>.
4747 The 'keymodel' option is set by the |:behave| command.
4748
4749 *'keywordprg'* *'kp'*
4750'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004751 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 global or local to buffer |global-local|
4753 {not in Vi}
4754 Program to use for the |K| command. Environment variables are
4755 expanded |:set_env|. ":help" may be used to access the Vim internal
4756 help. (Note that previously setting the global option to the empty
4757 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004758 When the first character is ":", the command is invoked as a Vim
4759 Ex command prefixed with [count].
4760 When "man", "man -s" or an Ex command is used, Vim will automatically
4761 translate a count for the "K" command and pass it as the first
4762 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763 See |option-backslash| about including spaces and backslashes.
4764 Example: >
4765 :set keywordprg=man\ -s
4766< This option cannot be set from a |modeline| or in the |sandbox|, for
4767 security reasons.
4768
4769 *'langmap'* *'lmap'* *E357* *E358*
4770'langmap' 'lmap' string (default "")
4771 global
4772 {not in Vi}
4773 {only available when compiled with the |+langmap|
4774 feature}
4775 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004776 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004777 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 care of translating these special characters to the original meaning
4779 of the key. This means you don't have to change the keyboard mode to
4780 be able to execute Normal mode commands.
4781 This is the opposite of the 'keymap' option, where characters are
4782 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004783 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004784 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004785 This option cannot be set from a |modeline| or in the |sandbox|, for
4786 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004788 Example (for Greek, in UTF-8): *greek* >
4789 :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 +00004790< Example (exchanges meaning of z and y for commands): >
4791 :set langmap=zy,yz,ZY,YZ
4792<
4793 The 'langmap' option is a list of parts, separated with commas. Each
4794 part can be in one of two forms:
4795 1. A list of pairs. Each pair is a "from" character immediately
4796 followed by the "to" character. Examples: "aA", "aAbBcC".
4797 2. A list of "from" characters, a semi-colon and a list of "to"
4798 characters. Example: "abc;ABC"
4799 Example: "aA,fgh;FGH,cCdDeE"
4800 Special characters need to be preceded with a backslash. These are
4801 ";", ',' and backslash itself.
4802
4803 This will allow you to activate vim actions without having to switch
4804 back and forth between the languages. Your language characters will
4805 be understood as normal vim English characters (according to the
4806 langmap mappings) in the following cases:
4807 o Normal/Visual mode (commands, buffer/register names, user mappings)
4808 o Insert/Replace Mode: Register names after CTRL-R
4809 o Insert/Replace Mode: Mappings
4810 Characters entered in Command-line mode will NOT be affected by
4811 this option. Note that this option can be changed at any time
4812 allowing to switch between mappings for different languages/encodings.
4813 Use a mapping to avoid having to type it each time!
4814
4815 *'langmenu'* *'lm'*
4816'langmenu' 'lm' string (default "")
4817 global
4818 {not in Vi}
4819 {only available when compiled with the |+menu| and
4820 |+multi_lang| features}
4821 Language to use for menu translation. Tells which file is loaded
4822 from the "lang" directory in 'runtimepath': >
4823 "lang/menu_" . &langmenu . ".vim"
4824< (without the spaces). For example, to always use the Dutch menus, no
4825 matter what $LANG is set to: >
4826 :set langmenu=nl_NL.ISO_8859-1
4827< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004828 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 If your $LANG is set to a non-English language but you do want to use
4830 the English menus: >
4831 :set langmenu=none
4832< This option must be set before loading menus, switching on filetype
4833 detection or syntax highlighting. Once the menus are defined setting
4834 this option has no effect. But you could do this: >
4835 :source $VIMRUNTIME/delmenu.vim
4836 :set langmenu=de_DE.ISO_8859-1
4837 :source $VIMRUNTIME/menu.vim
4838< Warning: This deletes all menus that you defined yourself!
4839
Bram Moolenaard94464e2015-11-02 15:28:18 +01004840 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004841'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004842 global
4843 {not in Vi}
4844 {only available when compiled with the |+langmap|
4845 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004846 This is just like 'langremap' but with the value inverted. It only
4847 exists for backwards compatibility. When setting 'langremap' then
4848 'langnoremap' is set to the inverted value, and the other way around.
4849
4850 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4851'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4852 global
4853 {not in Vi}
4854 {only available when compiled with the |+langmap|
4855 feature}
4856 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004857 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004858 'langmap' disables some of your mappings, try resetting this option.
4859 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004860 that works for you to avoid mappings to break.
4861
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 *'laststatus'* *'ls'*
4863'laststatus' 'ls' number (default 1)
4864 global
4865 {not in Vi}
4866 The value of this option influences when the last window will have a
4867 status line:
4868 0: never
4869 1: only if there are at least two windows
4870 2: always
4871 The screen looks nicer with a status line if you have several
4872 windows, but it takes another screen line. |status-line|
4873
4874 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4875'lazyredraw' 'lz' boolean (default off)
4876 global
4877 {not in Vi}
4878 When this option is set, the screen will not be redrawn while
4879 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004880 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 update use |:redraw|.
4882
4883 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4884'linebreak' 'lbr' boolean (default off)
4885 local to window
4886 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004887 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004889 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 than at the last character that fits on the screen. Unlike
4891 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004892 it only affects the way the file is displayed, not its contents.
4893 If 'breakindent' is set, line is visually indented. Then, the value
4894 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004895 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 Note that <Tab> characters after an <EOL> are mostly not displayed
4897 with the right amount of white space.
4898
4899 *'lines'* *E593*
4900'lines' number (default 24 or terminal height)
4901 global
4902 Number of lines of the Vim window.
4903 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004904 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 When Vim is running in the GUI or in a resizable window, setting this
4906 option will cause the window size to be changed. When you only want
4907 to use the size for the GUI, put the command in your |gvimrc| file.
4908 Vim limits the number of lines to what fits on the screen. You can
4909 use this command to get the tallest window possible: >
4910 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004911< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004912 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 When you set this option and Vim is unable to change the physical
4914 number of lines of the display, the display may be messed up.
4915
4916 *'linespace'* *'lsp'*
4917'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4918 global
4919 {not in Vi}
4920 {only in the GUI}
4921 Number of pixel lines inserted between characters. Useful if the font
4922 uses the full character cell height, making lines touch each other.
4923 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004924 With some fonts there can be too much room between lines (to have
4925 space for ascents and descents). Then it makes sense to set
4926 'linespace' to a negative value. This may cause display problems
4927 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928
4929 *'lisp'* *'nolisp'*
4930'lisp' boolean (default off)
4931 local to buffer
4932 {not available when compiled without the |+lispindent|
4933 feature}
4934 Lisp mode: When <Enter> is typed in insert mode set the indent for
4935 the next line to Lisp standards (well, sort of). Also happens with
4936 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4937 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4938 better. Also see 'lispwords'.
4939 The '-' character is included in keyword characters. Redefines the
4940 "=" operator to use this same indentation algorithm rather than
4941 calling an external program if 'equalprg' is empty.
4942 This option is not used when 'paste' is set.
4943 {Vi: Does it a little bit differently}
4944
4945 *'lispwords'* *'lw'*
4946'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004947 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 {not in Vi}
4949 {not available when compiled without the |+lispindent|
4950 feature}
4951 Comma separated list of words that influence the Lisp indenting.
4952 |'lisp'|
4953
4954 *'list'* *'nolist'*
4955'list' boolean (default off)
4956 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004957 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4958 line. Useful to see the difference between tabs and spaces and for
4959 trailing blanks. Further changed by the 'listchars' option.
4960
4961 The cursor is displayed at the start of the space a Tab character
4962 occupies, not at the end as usual in Normal mode. To get this cursor
4963 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004964 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004965<
4966 Note that list mode will also affect formatting (set with 'textwidth'
4967 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 changing the way tabs are displayed.
4969
4970 *'listchars'* *'lcs'*
4971'listchars' 'lcs' string (default "eol:$")
4972 global
4973 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004974 Strings to use in 'list' mode and for the |:list| command. It is a
4975 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004976 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 eol:c Character to show at the end of each line. When
4978 omitted, there is no extra character at the end of the
4979 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004980 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004981 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004983 fill the space that the tab normally occupies.
4984 "tab:>-" will show a tab that takes four spaces as
4985 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004986 *lcs-space*
4987 space:c Character to show for a space. When omitted, spaces
4988 are left blank.
4989 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004990 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004991 trailing spaces are blank. Overrides the "space"
4992 setting for trailing spaces.
4993 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 extends:c Character to show in the last column, when 'wrap' is
4995 off and the line continues beyond the right of the
4996 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004997 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 precedes:c Character to show in the first column, when 'wrap'
4999 is off and there is text preceding the character
5000 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02005001 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02005002 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02005003 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02005004 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02005005 nbsp:c Character to show for a non-breakable space character
5006 (0xA0 (160 decimal) and U+202F). Left blank when
5007 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005009 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005011 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012
5013 Examples: >
5014 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005015 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 :set lcs=extends:>,precedes:<
5017< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02005018 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00005019 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
5022'loadplugins' 'lpl' boolean (default on)
5023 global
5024 {not in Vi}
5025 When on the plugin scripts are loaded when starting up |load-plugins|.
5026 This option can be reset in your |vimrc| file to disable the loading
5027 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005028 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5029 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030
Bram Moolenaard94464e2015-11-02 15:28:18 +01005031 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005032'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005033 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005034 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005035 {only available when compiled with the |+lua/dyn|
5036 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005037 Specifies the name of the Lua shared library. The default is
5038 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005039 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005040 This option cannot be set from a |modeline| or in the |sandbox|, for
5041 security reasons.
5042
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005043 *'macatsui'* *'nomacatsui'*
5044'macatsui' boolean (default on)
5045 global
5046 {only available in Mac GUI version}
5047 This is a workaround for when drawing doesn't work properly. When set
5048 and compiled with multi-byte support ATSUI text drawing is used. When
5049 not set ATSUI text drawing is not used. Switch this option off when
5050 you experience drawing problems. In a future version the problems may
5051 be solved and this option becomes obsolete. Therefore use this method
5052 to unset it: >
5053 if exists('&macatsui')
5054 set nomacatsui
5055 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005056< Another option to check if you have drawing problems is
5057 'termencoding'.
5058
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 *'magic'* *'nomagic'*
5060'magic' boolean (default on)
5061 global
5062 Changes the special characters that can be used in search patterns.
5063 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005064 WARNING: Switching this option off most likely breaks plugins! That
5065 is because many patterns assume it's on and will fail when it's off.
5066 Only switch it off when working with old Vi scripts. In any other
5067 situation write patterns that work when 'magic' is on. Include "\M"
5068 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069
5070 *'makeef'* *'mef'*
5071'makeef' 'mef' string (default: "")
5072 global
5073 {not in Vi}
5074 {not available when compiled without the |+quickfix|
5075 feature}
5076 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5077 and the |:grep| command.
5078 When it is empty, an internally generated temp file will be used.
5079 When "##" is included, it is replaced by a number to make the name
5080 unique. This makes sure that the ":make" command doesn't overwrite an
5081 existing file.
5082 NOT used for the ":cf" command. See 'errorfile' for that.
5083 Environment variables are expanded |:set_env|.
5084 See |option-backslash| about including spaces and backslashes.
5085 This option cannot be set from a |modeline| or in the |sandbox|, for
5086 security reasons.
5087
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005088 *'makeencoding'* *'menc'*
5089'makeencoding' 'menc' string (default "")
5090 global or local to buffer |global-local|
5091 {only available when compiled with the |+multi_byte|
5092 feature}
5093 {not in Vi}
5094 Encoding used for reading the output of external commands. When empty,
5095 encoding is not converted.
5096 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5097 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5098 and `:laddfile`.
5099
5100 This would be mostly useful when you use MS-Windows and set 'encoding'
5101 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5102 'makeencoding' to "char" has the same effect as setting to the system
5103 locale encoding. Example: >
5104 :set encoding=utf-8
5105 :set makeencoding=char " system locale is used
5106<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 *'makeprg'* *'mp'*
5108'makeprg' 'mp' string (default "make", VMS: "MMS")
5109 global or local to buffer |global-local|
5110 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005111 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005112 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5113 which are expanded to the current and alternate file name. Use |::S|
5114 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005115 Environment variables are expanded |:set_env|. See |option-backslash|
5116 about including spaces and backslashes.
5117 Note that a '|' must be escaped twice: once for ":set" and once for
5118 the interpretation of a command. When you use a filter called
5119 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 :set makeprg=gmake\ \\\|\ myfilter
5121< The placeholder "$*" can be given (even multiple times) to specify
5122 where the arguments will be included, for example: >
5123 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5124< This option cannot be set from a |modeline| or in the |sandbox|, for
5125 security reasons.
5126
5127 *'matchpairs'* *'mps'*
5128'matchpairs' 'mps' string (default "(:),{:},[:]")
5129 local to buffer
5130 {not in Vi}
5131 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005132 other.
5133 Only character pairs are allowed that are different, thus you cannot
5134 jump between two double quotes.
5135 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005136 The pairs must be separated by a comma. Example for including '<' and
5137 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 :set mps+=<:>
5139
5140< A more exotic example, to jump between the '=' and ';' in an
5141 assignment, useful for languages like C and Java: >
5142 :au FileType c,cpp,java set mps+==:;
5143
5144< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005145 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005146
5147 *'matchtime'* *'mat'*
5148'matchtime' 'mat' number (default 5)
5149 global
5150 {not in Vi}{in Nvi}
5151 Tenths of a second to show the matching paren, when 'showmatch' is
5152 set. Note that this is not in milliseconds, like other options that
5153 set a time. This is to be compatible with Nvi.
5154
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005155 *'maxcombine'* *'mco'*
5156'maxcombine' 'mco' number (default 2)
5157 global
5158 {not in Vi}
5159 {only available when compiled with the |+multi_byte|
5160 feature}
5161 The maximum number of combining characters supported for displaying.
5162 Only used when 'encoding' is "utf-8".
5163 The default is OK for most languages. Hebrew may require 4.
5164 Maximum value is 6.
5165 Even when this option is set to 2 you can still edit text with more
5166 combining characters, you just can't see them. Use |g8| or |ga|.
5167 See |mbyte-combining|.
5168
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 *'maxfuncdepth'* *'mfd'*
5170'maxfuncdepth' 'mfd' number (default 100)
5171 global
5172 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005173 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005174 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Maximum depth of function calls for user functions. This normally
5176 catches endless recursion. When using a recursive function with
5177 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5178 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005179 Increasing this limit above 200 also changes the maximum for Ex
5180 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 See also |:function|.
5182
5183 *'maxmapdepth'* *'mmd'* *E223*
5184'maxmapdepth' 'mmd' number (default 1000)
5185 global
5186 {not in Vi}
5187 Maximum number of times a mapping is done without resulting in a
5188 character to be used. This normally catches endless mappings, like
5189 ":map x y" with ":map y x". It still does not catch ":map g wg",
5190 because the 'w' is used before the next mapping is done. See also
5191 |key-mapping|.
5192
5193 *'maxmem'* *'mm'*
5194'maxmem' 'mm' number (default between 256 to 5120 (system
5195 dependent) or half the amount of memory
5196 available)
5197 global
5198 {not in Vi}
5199 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5200 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005201 other memory to be freed. The maximum usable value is about 2000000.
5202 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005204 *'maxmempattern'* *'mmp'*
5205'maxmempattern' 'mmp' number (default 1000)
5206 global
5207 {not in Vi}
5208 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005209 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005210 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005211 When Vim runs into the limit it gives an error message and mostly
5212 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005213 Running into the limit often means that the pattern is very
5214 inefficient or too complex. This may already happen with the pattern
5215 "\(.\)*" on a very long line. ".*" works much better.
5216 Vim may run out of memory before hitting the 'maxmempattern' limit.
5217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 *'maxmemtot'* *'mmt'*
5219'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5220 dependent) or half the amount of memory
5221 available)
5222 global
5223 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005224 Maximum amount of memory in Kbyte to use for all buffers together.
5225 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005226 without a limit.
5227 On 64 bit machines higher values might work. But hey, do you really
5228 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005229 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005230 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005231 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
5233 *'menuitems'* *'mis'*
5234'menuitems' 'mis' number (default 25)
5235 global
5236 {not in Vi}
5237 {not available when compiled without the |+menu|
5238 feature}
5239 Maximum number of items to use in a menu. Used for menus that are
5240 generated from a list of items, e.g., the Buffers menu. Changing this
5241 option has no direct effect, the menu must be refreshed first.
5242
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005243 *'mkspellmem'* *'msm'*
5244'mkspellmem' 'msm' string (default "460000,2000,500")
5245 global
5246 {not in Vi}
5247 {not available when compiled without the |+syntax|
5248 feature}
5249 Parameters for |:mkspell|. This tunes when to start compressing the
5250 word tree. Compression can be slow when there are many words, but
5251 it's needed to avoid running out of memory. The amount of memory used
5252 per word depends very much on how similar the words are, that's why
5253 this tuning is complicated.
5254
5255 There are three numbers, separated by commas:
5256 {start},{inc},{added}
5257
5258 For most languages the uncompressed word tree fits in memory. {start}
5259 gives the amount of memory in Kbyte that can be used before any
5260 compression is done. It should be a bit smaller than the amount of
5261 memory that is available to Vim.
5262
5263 When going over the {start} limit the {inc} number specifies the
5264 amount of memory in Kbyte that can be allocated before another
5265 compression is done. A low number means compression is done after
5266 less words are added, which is slow. A high number means more memory
5267 will be allocated.
5268
5269 After doing compression, {added} times 1024 words can be added before
5270 the {inc} limit is ignored and compression is done when any extra
5271 amount of memory is needed. A low number means there is a smaller
5272 chance of hitting the {inc} limit, less memory is used but it's
5273 slower.
5274
5275 The languages for which these numbers are important are Italian and
5276 Hungarian. The default works for when you have about 512 Mbyte. If
5277 you have 1 Gbyte you could use: >
5278 :set mkspellmem=900000,3000,800
5279< If you have less than 512 Mbyte |:mkspell| may fail for some
5280 languages, no matter what you set 'mkspellmem' to.
5281
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005283'modeline' 'ml' boolean (Vim default: on (off for root),
5284 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 local to buffer
5286 *'modelines'* *'mls'*
5287'modelines' 'mls' number (default 5)
5288 global
5289 {not in Vi}
5290 If 'modeline' is on 'modelines' gives the number of lines that is
5291 checked for set commands. If 'modeline' is off or 'modelines' is zero
5292 no lines are checked. See |modeline|.
5293 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5294 set and to the Vim default value when 'compatible' is reset.
5295
5296 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5297'modifiable' 'ma' boolean (default on)
5298 local to buffer
5299 {not in Vi} *E21*
5300 When off the buffer contents cannot be changed. The 'fileformat' and
5301 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005302 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303
5304 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5305'modified' 'mod' boolean (default off)
5306 local to buffer
5307 {not in Vi}
5308 When on, the buffer is considered to be modified. This option is set
5309 when:
5310 1. A change was made to the text since it was last written. Using the
5311 |undo| command to go back to the original text will reset the
5312 option. But undoing changes that were made before writing the
5313 buffer will set the option again, since the text is different from
5314 when it was written.
5315 2. 'fileformat' or 'fileencoding' is different from its original
5316 value. The original value is set when the buffer is read or
5317 written. A ":set nomodified" command also resets the original
5318 values to the current values and the 'modified' option will be
5319 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005320 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005321 This option is not set when a change is made to the buffer as the
5322 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5323 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5324 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5326 will be ignored.
5327
5328 *'more'* *'nomore'*
5329'more' boolean (Vim default: on, Vi default: off)
5330 global
5331 {not in Vi}
5332 When on, listings pause when the whole screen is filled. You will get
5333 the |more-prompt|. When this option is off there are no pauses, the
5334 listing continues until finished.
5335 NOTE: This option is set to the Vi default value when 'compatible' is
5336 set and to the Vim default value when 'compatible' is reset.
5337
5338 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005339'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5340 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 global
5342 {not in Vi}
5343 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005344 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5345 sysmouse and Linux console with gpm). For using the mouse in the
5346 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005348 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005349 v Visual mode
5350 i Insert mode
5351 c Command-line mode
5352 h all previous modes when editing a help file
5353 a all previous modes
5354 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 Normally you would enable the mouse in all four modes with: >
5356 :set mouse=a
5357< When the mouse is not enabled, the GUI will still use the mouse for
5358 modeless selection. This doesn't move the text cursor.
5359
5360 See |mouse-using|. Also see |'clipboard'|.
5361
5362 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005363 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 the mouse buttons can still be used by keeping the shift key pressed.
5365 Also see the 'clipboard' option.
5366
5367 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5368'mousefocus' 'mousef' boolean (default off)
5369 global
5370 {not in Vi}
5371 {only works in the GUI}
5372 The window that the mouse pointer is on is automatically activated.
5373 When changing the window layout or window focus in another way, the
5374 mouse pointer is moved to the window with keyboard focus. Off is the
5375 default because it makes using the pull down menus a little goofy, as
5376 a pointer transit may activate a window unintentionally.
5377
5378 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5379'mousehide' 'mh' boolean (default on)
5380 global
5381 {not in Vi}
5382 {only works in the GUI}
5383 When on, the mouse pointer is hidden when characters are typed.
5384 The mouse pointer is restored when the mouse is moved.
5385
5386 *'mousemodel'* *'mousem'*
5387'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5388 global
5389 {not in Vi}
5390 Sets the model to use for the mouse. The name mostly specifies what
5391 the right mouse button is used for:
5392 extend Right mouse button extends a selection. This works
5393 like in an xterm.
5394 popup Right mouse button pops up a menu. The shifted left
5395 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005396 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 popup_setpos Like "popup", but the cursor will be moved to the
5398 position where the mouse was clicked, and thus the
5399 selected operation will act upon the clicked object.
5400 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005401 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 course, that right clicking outside a selection will
5403 end Visual mode.
5404 Overview of what button does what for each model:
5405 mouse extend popup(_setpos) ~
5406 left click place cursor place cursor
5407 left drag start selection start selection
5408 shift-left search word extend selection
5409 right click extend selection popup menu (place cursor)
5410 right drag extend selection -
5411 middle click paste paste
5412
5413 In the "popup" model the right mouse button produces a pop-up menu.
5414 You need to define this first, see |popup-menu|.
5415
5416 Note that you can further refine the meaning of buttons with mappings.
5417 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5418 selection (because that's handled in the GUI code directly).
5419
5420 The 'mousemodel' option is set by the |:behave| command.
5421
5422 *'mouseshape'* *'mouses'* *E547*
5423'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005424 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 global
5426 {not in Vi}
5427 {only available when compiled with the |+mouseshape|
5428 feature}
5429 This option tells Vim what the mouse pointer should look like in
5430 different modes. The option is a comma separated list of parts, much
5431 like used for 'guicursor'. Each part consist of a mode/location-list
5432 and an argument-list:
5433 mode-list:shape,mode-list:shape,..
5434 The mode-list is a dash separated list of these modes/locations:
5435 In a normal window: ~
5436 n Normal mode
5437 v Visual mode
5438 ve Visual mode with 'selection' "exclusive" (same as 'v',
5439 if not specified)
5440 o Operator-pending mode
5441 i Insert mode
5442 r Replace mode
5443
5444 Others: ~
5445 c appending to the command-line
5446 ci inserting in the command-line
5447 cr replacing in the command-line
5448 m at the 'Hit ENTER' or 'More' prompts
5449 ml idem, but cursor in the last line
5450 e any mode, pointer below last window
5451 s any mode, pointer on a status line
5452 sd any mode, while dragging a status line
5453 vs any mode, pointer on a vertical separator line
5454 vd any mode, while dragging a vertical separator line
5455 a everywhere
5456
5457 The shape is one of the following:
5458 avail name looks like ~
5459 w x arrow Normal mouse pointer
5460 w x blank no pointer at all (use with care!)
5461 w x beam I-beam
5462 w x updown up-down sizing arrows
5463 w x leftright left-right sizing arrows
5464 w x busy The system's usual busy pointer
5465 w x no The system's usual 'no input' pointer
5466 x udsizing indicates up-down resizing
5467 x lrsizing indicates left-right resizing
5468 x crosshair like a big thin +
5469 x hand1 black hand
5470 x hand2 white hand
5471 x pencil what you write with
5472 x question big ?
5473 x rightup-arrow arrow pointing right-up
5474 w x up-arrow arrow pointing up
5475 x <number> any X11 pointer number (see X11/cursorfont.h)
5476
5477 The "avail" column contains a 'w' if the shape is available for Win32,
5478 x for X11.
5479 Any modes not specified or shapes not available use the normal mouse
5480 pointer.
5481
5482 Example: >
5483 :set mouseshape=s:udsizing,m:no
5484< will make the mouse turn to a sizing arrow over the status lines and
5485 indicate no input when the hit-enter prompt is displayed (since
5486 clicking the mouse has no effect in this state.)
5487
5488 *'mousetime'* *'mouset'*
5489'mousetime' 'mouset' number (default 500)
5490 global
5491 {not in Vi}
5492 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5493 time in msec between two mouse clicks for the second click to be
5494 recognized as a multi click.
5495
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005496 *'mzschemedll'*
5497'mzschemedll' string (default depends on the build)
5498 global
5499 {not in Vi}
5500 {only available when compiled with the |+mzscheme/dyn|
5501 feature}
5502 Specifies the name of the MzScheme shared library. The default is
5503 DYNAMIC_MZSCH_DLL which was specified at compile time.
5504 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005505 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005506 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005507 This option cannot be set from a |modeline| or in the |sandbox|, for
5508 security reasons.
5509
5510 *'mzschemegcdll'*
5511'mzschemegcdll' string (default depends on the build)
5512 global
5513 {not in Vi}
5514 {only available when compiled with the |+mzscheme/dyn|
5515 feature}
5516 Specifies the name of the MzScheme GC shared library. The default is
5517 DYNAMIC_MZGC_DLL which was specified at compile time.
5518 The value can be equal to 'mzschemedll' if it includes the GC code.
5519 Environment variables are expanded |:set_env|.
5520 This option cannot be set from a |modeline| or in the |sandbox|, for
5521 security reasons.
5522
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005523 *'mzquantum'* *'mzq'*
5524'mzquantum' 'mzq' number (default 100)
5525 global
5526 {not in Vi}
5527 {not available when compiled without the |+mzscheme|
5528 feature}
5529 The number of milliseconds between polls for MzScheme threads.
5530 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005531 NOTE: This option is set to the Vim default value when 'compatible'
5532 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005533
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005535'nrformats' 'nf' string (default "bin,octal,hex",
5536 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 local to buffer
5538 {not in Vi}
5539 This defines what bases Vim will consider for numbers when using the
5540 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5541 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005542 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005544 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005545 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005547 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 considered to be hexadecimal. Example: Using CTRL-X on
5549 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005550 bin If included, numbers starting with "0b" or "0B" will be
5551 considered to be binary. Example: Using CTRL-X on
5552 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 Numbers which simply begin with a digit in the range 1-9 are always
5554 considered decimal. This also happens for numbers that are not
5555 recognized as octal or hex.
5556
5557 *'number'* *'nu'* *'nonumber'* *'nonu'*
5558'number' 'nu' boolean (default off)
5559 local to window
5560 Print the line number in front of each line. When the 'n' option is
5561 excluded from 'cpoptions' a wrapped line will not use the column of
5562 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005563 The 'numberwidth' option can be used to set the room used for the line
5564 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 When a long, wrapped line doesn't start with the first character, '-'
5566 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005567 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5568 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005569 *number_relativenumber*
5570 The 'relativenumber' option changes the displayed number to be
5571 relative to the cursor. Together with 'number' there are these
5572 four combinations (cursor in line 3):
5573
Bram Moolenaar3848e002016-03-19 18:42:29 +01005574 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005575 'nornu' 'nornu' 'rnu' 'rnu'
5576
5577 |apple | 1 apple | 2 apple | 2 apple
5578 |pear | 2 pear | 1 pear | 1 pear
5579 |nobody | 3 nobody | 0 nobody |3 nobody
5580 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005581
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005582 *'numberwidth'* *'nuw'*
5583'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5584 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005585 {not in Vi}
5586 {only available when compiled with the |+linebreak|
5587 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005588 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005589 when the 'number' or 'relativenumber' option is set or printing lines
5590 with a line number. Since one space is always between the number and
5591 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005592 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005593 fit the highest line number in the buffer respectively the number of
5594 rows in the window, depending on whether 'number' or 'relativenumber'
5595 is set. Thus with the Vim default of 4 there is room for a line number
5596 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005597 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005598 NOTE: This option is set to the Vi default value when 'compatible' is
5599 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005600
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005601 *'omnifunc'* *'ofu'*
5602'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005603 local to buffer
5604 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005605 {not available when compiled without the |+eval|
5606 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005607 This option specifies a function to be used for Insert mode omni
5608 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005609 See |complete-functions| for an explanation of how the function is
5610 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005611 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005612 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005613 This option cannot be set from a |modeline| or in the |sandbox|, for
5614 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005615
5616
Bram Moolenaar02467872007-05-06 13:22:01 +00005617 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005618'opendevice' 'odev' boolean (default off)
5619 global
5620 {not in Vi}
5621 {only for MS-DOS, MS-Windows and OS/2}
5622 Enable reading and writing from devices. This may get Vim stuck on a
5623 device that can be opened but doesn't actually do the I/O. Therefore
5624 it is off by default.
5625 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5626 result in editing a device.
5627
5628
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005629 *'operatorfunc'* *'opfunc'*
5630'operatorfunc' 'opfunc' string (default: empty)
5631 global
5632 {not in Vi}
5633 This option specifies a function to be called by the |g@| operator.
5634 See |:map-operator| for more info and an example.
5635
5636 This option cannot be set from a |modeline| or in the |sandbox|, for
5637 security reasons.
5638
5639
Bram Moolenaar251e1912011-06-19 05:09:16 +02005640 *'osfiletype'* *'oft'*
5641'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 local to buffer
5643 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005644 This option was supported on RISC OS, which has been removed.
5645
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005647 *'packpath'* *'pp'*
5648'packpath' 'pp' string (default: see 'runtimepath')
5649 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005650 Directories used to find packages. See |packages|.
5651
5652
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005654'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 global
5656 Specifies the nroff macros that separate paragraphs. These are pairs
5657 of two letters (see |object-motions|).
5658
5659 *'paste'* *'nopaste'*
5660'paste' boolean (default off)
5661 global
5662 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005663 Put Vim in Paste mode. This is useful if you want to cut or copy
5664 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 unexpected effects.
5666 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005667 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 knows about pasting and will mostly do the right thing without 'paste'
5669 being set. The same is true for a terminal where Vim handles the
5670 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005671 This option is reset when starting the GUI. Thus if you set it in
5672 your .vimrc it will work in a terminal, but not in the GUI. Setting
5673 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5674 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 When the 'paste' option is switched on (also when it was already on):
5676 - mapping in Insert mode and Command-line mode is disabled
5677 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005679 - 'expandtab' is reset
5680 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 - 'revins' is reset
5682 - 'ruler' is reset
5683 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005684 - 'smartindent' is reset
5685 - 'smarttab' is reset
5686 - 'softtabstop' is set to 0
5687 - 'textwidth' is set to 0
5688 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005691 - 'indentexpr'
5692 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 NOTE: When you start editing another file while the 'paste' option is
5694 on, settings from the modelines or autocommands may change the
5695 settings again, causing trouble when pasting text. You might want to
5696 set the 'paste' option again.
5697 When the 'paste' option is reset the mentioned options are restored to
5698 the value before the moment 'paste' was switched from off to on.
5699 Resetting 'paste' before ever setting it does not have any effect.
5700 Since mapping doesn't work while 'paste' is active, you need to use
5701 the 'pastetoggle' option to toggle the 'paste' option with some key.
5702
5703 *'pastetoggle'* *'pt'*
5704'pastetoggle' 'pt' string (default "")
5705 global
5706 {not in Vi}
5707 When non-empty, specifies the key sequence that toggles the 'paste'
5708 option. This is like specifying a mapping: >
5709 :map {keys} :set invpaste<CR>
5710< Where {keys} is the value of 'pastetoggle'.
5711 The difference is that it will work even when 'paste' is set.
5712 'pastetoggle' works in Insert mode and Normal mode, but not in
5713 Command-line mode.
5714 Mappings are checked first, thus overrule 'pastetoggle'. However,
5715 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5716 this: >
5717 :map <F10> :set paste<CR>
5718 :map <F11> :set nopaste<CR>
5719 :imap <F10> <C-O>:set paste<CR>
5720 :imap <F11> <nop>
5721 :set pastetoggle=<F11>
5722< This will make <F10> start paste mode and <F11> stop paste mode.
5723 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5724 mode everything is inserted literally, except the 'pastetoggle' key
5725 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005726 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727
5728 *'pex'* *'patchexpr'*
5729'patchexpr' 'pex' string (default "")
5730 global
5731 {not in Vi}
5732 {not available when compiled without the |+diff|
5733 feature}
5734 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005735 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736
Bram Moolenaardbc28022014-07-26 13:40:44 +02005737 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738'patchmode' 'pm' string (default "")
5739 global
5740 {not in Vi}
5741 When non-empty the oldest version of a file is kept. This can be used
5742 to keep the original version of a file if you are changing files in a
5743 source distribution. Only the first time that a file is written a
5744 copy of the original file will be kept. The name of the copy is the
5745 name of the original file with the string in the 'patchmode' option
5746 appended. This option should start with a dot. Use a string like
5747 ".org". 'backupdir' must not be empty for this to work (Detail: The
5748 backup file is renamed to the patchmode file after the new file has
5749 been successfully written, that's why it must be possible to write a
5750 backup file). If there was no file to be backed up, an empty file is
5751 created.
5752 When the 'backupskip' pattern matches, a patchmode file is not made.
5753 Using 'patchmode' for compressed files appends the extension at the
5754 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5755 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005756 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005758 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759'path' 'pa' string (default on Unix: ".,/usr/include,,"
5760 on OS/2: ".,/emx/include,,"
5761 other systems: ".,,")
5762 global or local to buffer |global-local|
5763 {not in Vi}
5764 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005765 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5766 provided that the file being searched for has a relative path (not
5767 starting with "/", "./" or "../"). The directories in the 'path'
5768 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 - Use commas to separate directory names: >
5770 :set path=.,/usr/local/include,/usr/include
5771< - Spaces can also be used to separate directory names (for backwards
5772 compatibility with version 3.0). To have a space in a directory
5773 name, precede it with an extra backslash, and escape the space: >
5774 :set path=.,/dir/with\\\ space
5775< - To include a comma in a directory name precede it with an extra
5776 backslash: >
5777 :set path=.,/dir/with\\,comma
5778< - To search relative to the directory of the current file, use: >
5779 :set path=.
5780< - To search in the current directory use an empty string between two
5781 commas: >
5782 :set path=,,
5783< - A directory name may end in a ':' or '/'.
5784 - Environment variables are expanded |:set_env|.
5785 - When using |netrw.vim| URLs can be used. For example, adding
5786 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005787 - Search upwards and downwards in a directory tree using "*", "**" and
5788 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 {not available when compiled without the |+path_extra| feature}
5790 - Careful with '\' characters, type two to get one in the option: >
5791 :set path=.,c:\\include
5792< Or just use '/' instead: >
5793 :set path=.,c:/include
5794< Don't forget "." or files won't even be found in the same directory as
5795 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005796 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 it is something like 256 or 1024 characters.
5798 You can check if all the include files are found, using the value of
5799 'path', see |:checkpath|.
5800 The use of |:set+=| and |:set-=| is preferred when adding or removing
5801 directories from the list. This avoids problems when a future version
5802 uses another default. To remove the current directory use: >
5803 :set path-=
5804< To add the current directory use: >
5805 :set path+=
5806< To use an environment variable, you probably need to replace the
5807 separator. Here is an example to append $INCL, in which directory
5808 names are separated with a semi-colon: >
5809 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5810< Replace the ';' with a ':' or whatever separator is used. Note that
5811 this doesn't work when $INCL contains a comma or white space.
5812
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005813 *'perldll'*
5814'perldll' string (default depends on the build)
5815 global
5816 {not in Vi}
5817 {only available when compiled with the |+perl/dyn|
5818 feature}
5819 Specifies the name of the Perl shared library. The default is
5820 DYNAMIC_PERL_DLL, which was specified at compile time.
5821 Environment variables are expanded |:set_env|.
5822 This option cannot be set from a |modeline| or in the |sandbox|, for
5823 security reasons.
5824
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5826'preserveindent' 'pi' boolean (default off)
5827 local to buffer
5828 {not in Vi}
5829 When changing the indent of the current line, preserve as much of the
5830 indent structure as possible. Normally the indent is replaced by a
5831 series of tabs followed by spaces as required (unless |'expandtab'| is
5832 enabled, in which case only spaces are used). Enabling this option
5833 means the indent will preserve as many existing characters as possible
5834 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005835 'expandtab' does not apply to the preserved white space, a Tab remains
5836 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005837 NOTE: When using ">>" multiple times the resulting indent is a mix of
5838 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005839 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005840 Also see 'copyindent'.
5841 Use |:retab| to clean up white space.
5842
5843 *'previewheight'* *'pvh'*
5844'previewheight' 'pvh' number (default 12)
5845 global
5846 {not in Vi}
5847 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005848 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 Default height for a preview window. Used for |:ptag| and associated
5850 commands. Used for |CTRL-W_}| when no count is given.
5851
5852 *'previewwindow'* *'nopreviewwindow'*
5853 *'pvw'* *'nopvw'* *E590*
5854'previewwindow' 'pvw' boolean (default off)
5855 local to window
5856 {not in Vi}
5857 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005858 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005859 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005860 set. It's normally not set directly, but by using one of the commands
5861 |:ptag|, |:pedit|, etc.
5862
5863 *'printdevice'* *'pdev'*
5864'printdevice' 'pdev' string (default empty)
5865 global
5866 {not in Vi}
5867 {only available when compiled with the |+printer|
5868 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005869 The name of the printer to be used for |:hardcopy|.
5870 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005871 This option cannot be set from a |modeline| or in the |sandbox|, for
5872 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873
Bram Moolenaar8299df92004-07-10 09:47:34 +00005874 *'printencoding'* *'penc'*
5875'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 global
5877 {not in Vi}
5878 {only available when compiled with the |+printer|
5879 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005880 Sets the character encoding used when printing.
5881 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882
5883 *'printexpr'* *'pexpr'*
5884'printexpr' 'pexpr' String (default: see below)
5885 global
5886 {not in Vi}
5887 {only available when compiled with the |+printer|
5888 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005889 Expression used to print the PostScript produced with |:hardcopy|.
5890 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005891 This option cannot be set from a |modeline| or in the |sandbox|, for
5892 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893
Bram Moolenaar8299df92004-07-10 09:47:34 +00005894 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895'printfont' 'pfn' string (default "courier")
5896 global
5897 {not in Vi}
5898 {only available when compiled with the |+printer|
5899 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005900 The name of the font that will be used for |:hardcopy|.
5901 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902
5903 *'printheader'* *'pheader'*
5904'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5905 global
5906 {not in Vi}
5907 {only available when compiled with the |+printer|
5908 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005909 The format of the header produced in |:hardcopy| output.
5910 See |pheader-option|.
5911
5912 *'printmbcharset'* *'pmbcs'*
5913'printmbcharset' 'pmbcs' string (default "")
5914 global
5915 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005916 {only available when compiled with the |+printer|,
5917 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005918 The CJK character set to be used for CJK output from |:hardcopy|.
5919 See |pmbcs-option|.
5920
5921 *'printmbfont'* *'pmbfn'*
5922'printmbfont' 'pmbfn' string (default "")
5923 global
5924 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005925 {only available when compiled with the |+printer|,
5926 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005927 List of font names to be used for CJK output from |:hardcopy|.
5928 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929
5930 *'printoptions'* *'popt'*
5931'printoptions' 'popt' string (default "")
5932 global
5933 {not in Vi}
5934 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005935 List of items that control the format of the output of |:hardcopy|.
5936 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005938 *'prompt'* *'noprompt'*
5939'prompt' boolean (default on)
5940 global
5941 When on a ":" prompt is used in Ex mode.
5942
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005943 *'pumheight'* *'ph'*
5944'pumheight' 'ph' number (default 0)
5945 global
5946 {not available when compiled without the
5947 |+insert_expand| feature}
5948 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005949 Determines the maximum number of items to show in the popup menu for
5950 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005951 |ins-completion-menu|.
5952
Bram Moolenaard94464e2015-11-02 15:28:18 +01005953 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005954'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005955 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005956 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005957 {only available when compiled with the |+python/dyn|
5958 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005959 Specifies the name of the Python 2.x shared library. The default is
5960 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005961 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005962 This option cannot be set from a |modeline| or in the |sandbox|, for
5963 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005964
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005965 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005966'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005967 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005968 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005969 {only available when compiled with the |+python3/dyn|
5970 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005971 Specifies the name of the Python 3 shared library. The default is
5972 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005973 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005974 This option cannot be set from a |modeline| or in the |sandbox|, for
5975 security reasons.
5976
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005977 *'pyxversion'* *'pyx'*
5978'pyxversion' 'pyx' number (default depends on the build)
5979 global
5980 {not in Vi}
5981 {only available when compiled with the |+python| or
5982 the |+python3| feature}
5983 Specifies the python version used for pyx* functions and commands
5984 |python_x|. The default value is as follows:
5985
5986 Compiled with Default ~
5987 |+python| and |+python3| 0
5988 only |+python| 2
5989 only |+python3| 3
5990
5991 Available values are 0, 2 and 3.
5992 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5993 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5994 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5995 to 2 if Python 2 is available.
5996 See also: |has-pythonx|
5997
5998 If Vim is compiled with only |+python| or |+python3| setting
5999 'pyxversion' has no effect. The pyx* functions and commands are
6000 always the same as the compiled version.
6001
6002 This option cannot be set from a |modeline| or in the |sandbox|, for
6003 security reasons.
6004
Bram Moolenaar677ee682005-01-27 14:41:15 +00006005 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00006006'quoteescape' 'qe' string (default "\")
6007 local to buffer
6008 {not in Vi}
6009 The characters that are used to escape quotes in a string. Used for
6010 objects like a', a" and a` |a'|.
6011 When one of the characters in this option is found inside a string,
6012 the following character will be skipped. The default value makes the
6013 text "foo\"bar\\" considered to be one string.
6014
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
6016'readonly' 'ro' boolean (default off)
6017 local to buffer
6018 If on, writes fail unless you use a '!'. Protects you from
6019 accidentally overwriting a file. Default on when Vim is started
6020 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006021 When using ":w!" the 'readonly' option is reset for the current
6022 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006024 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01006025 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006027 *'redrawtime'* *'rdt'*
6028'redrawtime' 'rdt' number (default 2000)
6029 global
6030 {not in Vi}
6031 {only available when compiled with the |+reltime|
6032 feature}
6033 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006034 searching for patterns for 'hlsearch', |:match| highlighting an syntax
6035 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006036 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02006037 matches will be highlighted.
6038 For syntax highlighting the time applies per window. When over the
6039 limit syntax highlighting is disabled until |CTRL-L| is used.
6040 This is used to avoid that Vim hangs when using a very complicated
6041 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00006042
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02006043 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006044'regexpengine' 're' number (default 0)
6045 global
6046 {not in Vi}
6047 This selects the default regexp engine. |two-engines|
6048 The possible values are:
6049 0 automatic selection
6050 1 old engine
6051 2 NFA engine
6052 Note that when using the NFA engine and the pattern contains something
6053 that is not supported the pattern will not match. This is only useful
6054 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006055 Using automatic selection enables Vim to switch the engine, if the
6056 default engine becomes too costly. E.g., when the NFA engine uses too
6057 many states. This should prevent Vim from hanging on a combination of
6058 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006059
Bram Moolenaar64486672010-05-16 15:46:46 +02006060 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6061'relativenumber' 'rnu' boolean (default off)
6062 local to window
6063 {not in Vi}
6064 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006065 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006066 precede some vertical motion commands (e.g. j k + -) with, without
6067 having to calculate it yourself. Especially useful in combination with
6068 other commands (e.g. y d c < > gq gw =).
6069 When the 'n' option is excluded from 'cpoptions' a wrapped
6070 line will not use the column of line numbers (this is the default when
6071 'compatible' isn't set).
6072 The 'numberwidth' option can be used to set the room used for the line
6073 number.
6074 When a long, wrapped line doesn't start with the first character, '-'
6075 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006076 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6077 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006078
6079 The number in front of the cursor line also depends on the value of
6080 'number', see |number_relativenumber| for all combinations of the two
6081 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006082
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 *'remap'* *'noremap'*
6084'remap' boolean (default on)
6085 global
6086 Allows for mappings to work recursively. If you do not want this for
6087 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006088 NOTE: To avoid portability problems with Vim scripts, always keep
6089 this option at the default "on". Only switch it off when working with
6090 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006092 *'renderoptions'* *'rop'*
6093'renderoptions' 'rop' string (default: empty)
6094 global
6095 {not in Vi}
6096 {only available when compiled with GUI and DIRECTX on
6097 MS-Windows}
6098 Select a text renderer and set its options. The options depend on the
6099 renderer.
6100
6101 Syntax: >
6102 set rop=type:{renderer}(,{name}:{value})*
6103<
6104 Currently, only one optional renderer is available.
6105
6106 render behavior ~
6107 directx Vim will draw text using DirectX (DirectWrite). It makes
6108 drawn glyphs more beautiful than default GDI.
6109 It requires 'encoding' is "utf-8", and only works on
6110 MS-Windows Vista or newer version.
6111
6112 Options:
6113 name meaning type value ~
6114 gamma gamma float 1.0 - 2.2 (maybe)
6115 contrast enhancedContrast float (unknown)
6116 level clearTypeLevel float (unknown)
6117 geom pixelGeometry int 0 - 2 (see below)
6118 renmode renderingMode int 0 - 6 (see below)
6119 taamode textAntialiasMode int 0 - 3 (see below)
6120
6121 See this URL for detail:
6122 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6123
6124 For geom: structure of a device pixel.
6125 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6126 1 - DWRITE_PIXEL_GEOMETRY_RGB
6127 2 - DWRITE_PIXEL_GEOMETRY_BGR
6128
6129 See this URL for detail:
6130 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6131
6132 For renmode: method of rendering glyphs.
6133 0 - DWRITE_RENDERING_MODE_DEFAULT
6134 1 - DWRITE_RENDERING_MODE_ALIASED
6135 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6136 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6137 4 - DWRITE_RENDERING_MODE_NATURAL
6138 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6139 6 - DWRITE_RENDERING_MODE_OUTLINE
6140
6141 See this URL for detail:
6142 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6143
6144 For taamode: antialiasing mode used for drawing text.
6145 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6146 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6147 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6148 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6149
6150 See this URL for detail:
6151 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6152
6153 Example: >
6154 set encoding=utf-8
6155 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6156 set rop=type:directx
6157<
6158 If select a raster font (Courier, Terminal or FixedSys) to
6159 'guifont', it fallbacks to be drawn by GDI automatically.
6160
6161 Other render types are currently not supported.
6162
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 *'report'*
6164'report' number (default 2)
6165 global
6166 Threshold for reporting number of lines changed. When the number of
6167 changed lines is more than 'report' a message will be given for most
6168 ":" commands. If you want it always, set 'report' to 0.
6169 For the ":substitute" command the number of substitutions is used
6170 instead of the number of lines.
6171
6172 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6173'restorescreen' 'rs' boolean (default on)
6174 global
6175 {not in Vi} {only in Windows 95/NT console version}
6176 When set, the screen contents is restored when exiting Vim. This also
6177 happens when executing external commands.
6178
6179 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6180 options in your .vimrc. To disable restoring:
6181 set t_ti= t_te=
6182 To enable restoring (for an xterm):
6183 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6184 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6185
6186 *'revins'* *'ri'* *'norevins'* *'nori'*
6187'revins' 'ri' boolean (default off)
6188 global
6189 {not in Vi}
6190 {only available when compiled with the |+rightleft|
6191 feature}
6192 Inserting characters in Insert mode will work backwards. See "typing
6193 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6194 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006195 NOTE: This option is reset when 'compatible' is set.
6196 This option is reset when 'paste' is set and restored when 'paste' is
6197 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198
6199 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6200'rightleft' 'rl' boolean (default off)
6201 local to window
6202 {not in Vi}
6203 {only available when compiled with the |+rightleft|
6204 feature}
6205 When on, display orientation becomes right-to-left, i.e., characters
6206 that are stored in the file appear from the right to the left.
6207 Using this option, it is possible to edit files for languages that
6208 are written from the right to the left such as Hebrew and Arabic.
6209 This option is per window, so it is possible to edit mixed files
6210 simultaneously, or to view the same file in both ways (this is
6211 useful whenever you have a mixed text file with both right-to-left
6212 and left-to-right strings so that both sets are displayed properly
6213 in different windows). Also see |rileft.txt|.
6214
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006215 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216'rightleftcmd' 'rlc' string (default "search")
6217 local to window
6218 {not in Vi}
6219 {only available when compiled with the |+rightleft|
6220 feature}
6221 Each word in this option enables the command line editing to work in
6222 right-to-left mode for a group of commands:
6223
6224 search "/" and "?" commands
6225
6226 This is useful for languages such as Hebrew, Arabic and Farsi.
6227 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6228
Bram Moolenaard94464e2015-11-02 15:28:18 +01006229 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006230'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006231 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006232 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006233 {only available when compiled with the |+ruby/dyn|
6234 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006235 Specifies the name of the Ruby shared library. The default is
6236 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006237 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006238 This option cannot be set from a |modeline| or in the |sandbox|, for
6239 security reasons.
6240
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006242'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 global
6244 {not in Vi}
6245 {not available when compiled without the
6246 |+cmdline_info| feature}
6247 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006248 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 text in the file is shown on the far right:
6250 Top first line is visible
6251 Bot last line is visible
6252 All first and last line are visible
6253 45% relative position in the file
6254 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006255 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006257 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006258 this option takes precedence over 'ruler' and 'rulerformat'
6259 If the number of characters displayed is different from the number of
6260 bytes in the text (e.g., for a TAB or a multi-byte character), both
6261 the text column (byte number) and the screen column are shown,
6262 separated with a dash.
6263 For an empty line "0-1" is shown.
6264 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006265 This option is reset when 'paste' is set and restored when 'paste' is
6266 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 If you don't want to see the ruler all the time but want to know where
6268 you are, use "g CTRL-G" |g_CTRL-G|.
6269 NOTE: This option is reset when 'compatible' is set.
6270
6271 *'rulerformat'* *'ruf'*
6272'rulerformat' 'ruf' string (default empty)
6273 global
6274 {not in Vi}
6275 {not available when compiled without the |+statusline|
6276 feature}
6277 When this option is not empty, it determines the content of the ruler
6278 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006279 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 The default ruler width is 17 characters. To make the ruler 15
6281 characters wide, put "%15(" at the start and "%)" at the end.
6282 Example: >
6283 :set rulerformat=%15(%c%V\ %p%%%)
6284<
6285 *'runtimepath'* *'rtp'* *vimfiles*
6286'runtimepath' 'rtp' string (default:
6287 Unix: "$HOME/.vim,
6288 $VIM/vimfiles,
6289 $VIMRUNTIME,
6290 $VIM/vimfiles/after,
6291 $HOME/.vim/after"
6292 Amiga: "home:vimfiles,
6293 $VIM/vimfiles,
6294 $VIMRUNTIME,
6295 $VIM/vimfiles/after,
6296 home:vimfiles/after"
6297 PC, OS/2: "$HOME/vimfiles,
6298 $VIM/vimfiles,
6299 $VIMRUNTIME,
6300 $VIM/vimfiles/after,
6301 $HOME/vimfiles/after"
6302 Macintosh: "$VIM:vimfiles,
6303 $VIMRUNTIME,
6304 $VIM:vimfiles:after"
6305 RISC-OS: "Choices:vimfiles,
6306 $VIMRUNTIME,
6307 Choices:vimfiles/after"
6308 VMS: "sys$login:vimfiles,
6309 $VIM/vimfiles,
6310 $VIMRUNTIME,
6311 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006312 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313 global
6314 {not in Vi}
6315 This is a list of directories which will be searched for runtime
6316 files:
6317 filetype.vim filetypes by file name |new-filetype|
6318 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006319 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 colors/ color scheme files |:colorscheme|
6321 compiler/ compiler files |:compiler|
6322 doc/ documentation |write-local-help|
6323 ftplugin/ filetype plugins |write-filetype-plugin|
6324 indent/ indent scripts |indent-expression|
6325 keymap/ key mapping files |mbyte-keymap|
6326 lang/ menu translations |:menutrans|
6327 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006328 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 plugin/ plugin scripts |write-plugin|
6330 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006331 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 syntax/ syntax files |mysyntaxfile|
6333 tutor/ files for vimtutor |tutor|
6334
6335 And any other file searched for with the |:runtime| command.
6336
6337 The defaults for most systems are setup to search five locations:
6338 1. In your home directory, for your personal preferences.
6339 2. In a system-wide Vim directory, for preferences from the system
6340 administrator.
6341 3. In $VIMRUNTIME, for files distributed with Vim.
6342 *after-directory*
6343 4. In the "after" directory in the system-wide Vim directory. This is
6344 for the system administrator to overrule or add to the distributed
6345 defaults (rarely needed)
6346 5. In the "after" directory in your home directory. This is for
6347 personal preferences to overrule or add to the distributed defaults
6348 or system-wide settings (rarely needed).
6349
Bram Moolenaard0796902016-09-16 20:02:31 +02006350 More entries are added when using |packages|. If it gets very long
6351 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6352 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006353
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6355 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006356 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 wildcards.
6358 See |:runtime|.
6359 Example: >
6360 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6361< This will use the directory "~/vimruntime" first (containing your
6362 personal Vim runtime files), then "/mygroup/vim" (shared between a
6363 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6364 files).
6365 You probably should always include $VIMRUNTIME somewhere, to use the
6366 distributed runtime files. You can put a directory before $VIMRUNTIME
6367 to find files which replace a distributed runtime files. You can put
6368 a directory after $VIMRUNTIME to find files which add to distributed
6369 runtime files.
6370 This option cannot be set from a |modeline| or in the |sandbox|, for
6371 security reasons.
6372
6373 *'scroll'* *'scr'*
6374'scroll' 'scr' number (default: half the window height)
6375 local to window
6376 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6377 set to half the number of lines in the window when the window size
6378 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6381 the number of screen lines instead of file lines, makes a difference
6382 when lines wrap}
6383
6384 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6385'scrollbind' 'scb' boolean (default off)
6386 local to window
6387 {not in Vi}
6388 {not available when compiled without the |+scrollbind|
6389 feature}
6390 See also |scroll-binding|. When this option is set, the current
6391 window scrolls as other scrollbind windows (windows that also have
6392 this option set) scroll. This option is useful for viewing the
6393 differences between two versions of a file, see 'diff'.
6394 See |'scrollopt'| for options that determine how this option should be
6395 interpreted.
6396 This option is mostly reset when splitting a window to edit another
6397 file. This means that ":split | edit file" results in two windows
6398 with scroll-binding, but ":split file" does not.
6399
6400 *'scrolljump'* *'sj'*
6401'scrolljump' 'sj' number (default 1)
6402 global
6403 {not in Vi}
6404 Minimal number of lines to scroll when the cursor gets off the
6405 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6406 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006407 When set to a negative number from -1 to -100 this is used as the
6408 percentage of the window height. Thus -50 scrolls half the window
6409 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 NOTE: This option is set to 1 when 'compatible' is set.
6411
6412 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006413'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 global
6415 {not in Vi}
6416 Minimal number of screen lines to keep above and below the cursor.
6417 This will make some context visible around where you are working. If
6418 you set it to a very large value (999) the cursor line will always be
6419 in the middle of the window (except at the start or end of the file or
6420 when long lines wrap).
6421 For scrolling horizontally see 'sidescrolloff'.
6422 NOTE: This option is set to 0 when 'compatible' is set.
6423
6424 *'scrollopt'* *'sbo'*
6425'scrollopt' 'sbo' string (default "ver,jump")
6426 global
6427 {not available when compiled without the |+scrollbind|
6428 feature}
6429 {not in Vi}
6430 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006431 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6432 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 The following words are available:
6434 ver Bind vertical scrolling for 'scrollbind' windows
6435 hor Bind horizontal scrolling for 'scrollbind' windows
6436 jump Applies to the offset between two windows for vertical
6437 scrolling. This offset is the difference in the first
6438 displayed line of the bound windows. When moving
6439 around in a window, another 'scrollbind' window may
6440 reach a position before the start or after the end of
6441 the buffer. The offset is not changed though, when
6442 moving back the 'scrollbind' window will try to scroll
6443 to the desired position when possible.
6444 When now making that window the current one, two
6445 things can be done with the relative offset:
6446 1. When "jump" is not included, the relative offset is
6447 adjusted for the scroll position in the new current
6448 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006449 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 2. When "jump" is included, the other windows are
6451 scrolled to keep the same relative offset. When
6452 going back to the other window, it still uses the
6453 same relative offset.
6454 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006455 When 'diff' mode is active there always is vertical scroll binding,
6456 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457
6458 *'sections'* *'sect'*
6459'sections' 'sect' string (default "SHNHH HUnhsh")
6460 global
6461 Specifies the nroff macros that separate sections. These are pairs of
6462 two letters (See |object-motions|). The default makes a section start
6463 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6464
6465 *'secure'* *'nosecure'* *E523*
6466'secure' boolean (default off)
6467 global
6468 {not in Vi}
6469 When on, ":autocmd", shell and write commands are not allowed in
6470 ".vimrc" and ".exrc" in the current directory and map commands are
6471 displayed. Switch it off only if you know that you will not run into
6472 problems, or when the 'exrc' option is off. On Unix this option is
6473 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 'secure' at the end of your ~/.vimrc then.
6476 This option cannot be set from a |modeline| or in the |sandbox|, for
6477 security reasons.
6478
6479 *'selection'* *'sel'*
6480'selection' 'sel' string (default "inclusive")
6481 global
6482 {not in Vi}
6483 This option defines the behavior of the selection. It is only used
6484 in Visual and Select mode.
6485 Possible values:
6486 value past line inclusive ~
6487 old no yes
6488 inclusive yes yes
6489 exclusive yes no
6490 "past line" means that the cursor is allowed to be positioned one
6491 character past the line.
6492 "inclusive" means that the last character of the selection is included
6493 in an operation. For example, when "x" is used to delete the
6494 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006495 When "old" is used and 'virtualedit' allows the cursor to move past
6496 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006497 Note that when "exclusive" is used and selecting from the end
6498 backwards, you cannot include the last character of a line, when
6499 starting in Normal mode and 'virtualedit' empty.
6500
6501 The 'selection' option is set by the |:behave| command.
6502
6503 *'selectmode'* *'slm'*
6504'selectmode' 'slm' string (default "")
6505 global
6506 {not in Vi}
6507 This is a comma separated list of words, which specifies when to start
6508 Select mode instead of Visual mode, when a selection is started.
6509 Possible values:
6510 mouse when using the mouse
6511 key when using shifted special keys
6512 cmd when using "v", "V" or CTRL-V
6513 See |Select-mode|.
6514 The 'selectmode' option is set by the |:behave| command.
6515
6516 *'sessionoptions'* *'ssop'*
6517'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006518 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 global
6520 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006521 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 feature}
6523 Changes the effect of the |:mksession| command. It is a comma
6524 separated list of words. Each word enables saving and restoring
6525 something:
6526 word save and restore ~
6527 blank empty windows
6528 buffers hidden and unloaded buffers, not just those in windows
6529 curdir the current directory
6530 folds manually created folds, opened/closed folds and local
6531 fold options
6532 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006533 and contain at least one lowercase letter. Only
6534 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 help the help window
6536 localoptions options and mappings local to a window or buffer (not
6537 global values for local options)
6538 options all options and mappings (also global values for local
6539 options)
6540 resize size of the Vim window: 'lines' and 'columns'
6541 sesdir the directory in which the session file is located
6542 will become the current directory (useful with
6543 projects accessed over a network from different
6544 systems)
6545 slash backslashes in file names replaced with forward
6546 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006547 tabpages all tab pages; without this only the current tab page
6548 is restored, so that you can make a session for each
6549 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 unix with Unix end-of-line format (single <NL>), even when
6551 on Windows or DOS
6552 winpos position of the whole Vim window
6553 winsize window sizes
6554
6555 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006556 When neither "curdir" nor "sesdir" is included, file names are stored
6557 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006558 "slash" and "unix" are useful on Windows when sharing session files
6559 with Unix. The Unix version of Vim cannot source dos format scripts,
6560 but the Windows version of Vim can source unix format scripts.
6561
6562 *'shell'* *'sh'* *E91*
6563'shell' 'sh' string (default $SHELL or "sh",
6564 MS-DOS and Win32: "command.com" or
6565 "cmd.exe", OS/2: "cmd")
6566 global
6567 Name of the shell to use for ! and :! commands. When changing the
6568 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6569 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006570 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 See |option-backslash| about including spaces and backslashes.
6572 Environment variables are expanded |:set_env|.
6573 If the name of the shell contains a space, you might need to enclose
6574 it in quotes. Example: >
6575 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6576< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006577 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 "-f" is not inside the quotes, because it is not part of the command
6579 name. And Vim automagically recognizes the backslashes that are path
6580 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 Under MS-Windows, when the executable ends in ".com" it must be
6582 included. Thus setting the shell to "command.com" or "4dos.com"
6583 works, but "command" and "4dos" do not work for all commands (e.g.,
6584 filtering).
6585 For unknown reasons, when using "4dos.com" the current directory is
6586 changed to "C:\". To avoid this set 'shell' like this: >
6587 :set shell=command.com\ /c\ 4dos
6588< This option cannot be set from a |modeline| or in the |sandbox|, for
6589 security reasons.
6590
6591 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006592'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006593 MS-DOS and Win32, when 'shell' does not
6594 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 global
6596 {not in Vi}
6597 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6598 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6599 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006600 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006601 On Unix it can have more than one flag. Each white space separated
6602 part is passed as an argument to the shell command.
6603 See |option-backslash| about including spaces and backslashes.
6604 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 This option cannot be set from a |modeline| or in the |sandbox|, for
6606 security reasons.
6607
6608 *'shellpipe'* *'sp'*
6609'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6610 global
6611 {not in Vi}
6612 {not available when compiled without the |+quickfix|
6613 feature}
6614 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006615 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 including spaces and backslashes.
6617 The name of the temporary file can be represented by "%s" if necessary
6618 (the file name is appended automatically if no %s appears in the value
6619 of this option).
6620 For the Amiga and MS-DOS the default is ">". The output is directly
6621 saved in a file and not echoed to the screen.
6622 For Unix the default it "| tee". The stdout of the compiler is saved
6623 in a file and echoed to the screen. If the 'shell' option is "csh" or
6624 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006625 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6626 default becomes "2>&1| tee". This means that stderr is also included.
6627 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6628 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 The initialization of this option is done after reading the ".vimrc"
6630 and the other initializations, so that when the 'shell' option is set
6631 there, the 'shellpipe' option changes automatically, unless it was
6632 explicitly set before.
6633 When 'shellpipe' is set to an empty string, no redirection of the
6634 ":make" output will be done. This is useful if you use a 'makeprg'
6635 that writes to 'makeef' by itself. If you want no piping, but do
6636 want to include the 'makeef', set 'shellpipe' to a single space.
6637 Don't forget to precede the space with a backslash: ":set sp=\ ".
6638 In the future pipes may be used for filtering and this option will
6639 become obsolete (at least for Unix).
6640 This option cannot be set from a |modeline| or in the |sandbox|, for
6641 security reasons.
6642
6643 *'shellquote'* *'shq'*
6644'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6645 contains "sh" somewhere: "\"")
6646 global
6647 {not in Vi}
6648 Quoting character(s), put around the command passed to the shell, for
6649 the "!" and ":!" commands. The redirection is kept outside of the
6650 quoting. See 'shellxquote' to include the redirection. It's
6651 probably not useful to set both options.
6652 This is an empty string by default. Only known to be useful for
6653 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6654 or bash, where it should be "\"". The default is adjusted according
6655 the value of 'shell', to reduce the need to set this option by the
6656 user. See |dos-shell|.
6657 This option cannot be set from a |modeline| or in the |sandbox|, for
6658 security reasons.
6659
6660 *'shellredir'* *'srr'*
6661'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6662 global
6663 {not in Vi}
6664 String to be used to put the output of a filter command in a temporary
6665 file. See also |:!|. See |option-backslash| about including spaces
6666 and backslashes.
6667 The name of the temporary file can be represented by "%s" if necessary
6668 (the file name is appended automatically if no %s appears in the value
6669 of this option).
6670 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6671 or "zsh" during initializations, the default becomes ">&". If the
6672 'shell' option is "sh", "ksh" or "bash" the default becomes
6673 ">%s 2>&1". This means that stderr is also included.
6674 For Win32, the Unix checks are done and additionally "cmd" is checked
6675 for, which makes the default ">%s 2>&1". Also, the same names with
6676 ".exe" appended are checked for.
6677 The initialization of this option is done after reading the ".vimrc"
6678 and the other initializations, so that when the 'shell' option is set
6679 there, the 'shellredir' option changes automatically unless it was
6680 explicitly set before.
6681 In the future pipes may be used for filtering and this option will
6682 become obsolete (at least for Unix).
6683 This option cannot be set from a |modeline| or in the |sandbox|, for
6684 security reasons.
6685
6686 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6687'shellslash' 'ssl' boolean (default off)
6688 global
6689 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6690 When set, a forward slash is used when expanding file names. This is
6691 useful when a Unix-like shell is used instead of command.com or
6692 cmd.exe. Backward slashes can still be typed, but they are changed to
6693 forward slashes by Vim.
6694 Note that setting or resetting this option has no effect for some
6695 existing file names, thus this option needs to be set before opening
6696 any file for best results. This might change in the future.
6697 'shellslash' only works when a backslash can be used as a path
6698 separator. To test if this is so use: >
6699 if exists('+shellslash')
6700<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006701 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6702'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6703 global
6704 {not in Vi}
6705 When on, use temp files for shell commands. When off use a pipe.
6706 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006707 Currently a pipe is only supported on Unix and MS-Windows 2K and
6708 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006709 :if has("filterpipe")
6710< The advantage of using a pipe is that nobody can read the temp file
6711 and the 'shell' command does not need to support redirection.
6712 The advantage of using a temp file is that the file type and encoding
6713 can be detected.
6714 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6715 |FilterWritePost| autocommands event are not triggered when
6716 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006717 The `system()` function does not respect this option and always uses
6718 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006719 NOTE: This option is set to the Vim default value when 'compatible'
6720 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006721
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 *'shelltype'* *'st'*
6723'shelltype' 'st' number (default 0)
6724 global
6725 {not in Vi} {only for the Amiga}
6726 On the Amiga this option influences the way how the commands work
6727 which use a shell.
6728 0 and 1: always use the shell
6729 2 and 3: use the shell only to filter lines
6730 4 and 5: use shell only for ':sh' command
6731 When not using the shell, the command is executed directly.
6732
6733 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6734 1 and 3: use "shell cmd" to start external commands
6735
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006736 *'shellxescape'* *'sxe'*
6737'shellxescape' 'sxe' string (default: "";
6738 for MS-DOS and MS-Windows: "\"&|<>()@^")
6739 global
6740 {not in Vi}
6741 When 'shellxquote' is set to "(" then the characters listed in this
6742 option will be escaped with a '^' character. This makes it possible
6743 to execute most external commands with cmd.exe.
6744
Bram Moolenaar071d4272004-06-13 20:20:40 +00006745 *'shellxquote'* *'sxq'*
6746'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006747 for Win32, when 'shell' is cmd.exe: "("
6748 for Win32, when 'shell' contains "sh"
6749 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 for Unix, when using system(): "\"")
6751 global
6752 {not in Vi}
6753 Quoting character(s), put around the command passed to the shell, for
6754 the "!" and ":!" commands. Includes the redirection. See
6755 'shellquote' to exclude the redirection. It's probably not useful
6756 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006757 When the value is '(' then ')' is appended. When the value is '"('
6758 then ')"' is appended.
6759 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006760 This is an empty string by default on most systems, but is known to be
6761 useful for on Win32 version, either for cmd.exe which automatically
6762 strips off the first and last quote on a command, or 3rd-party shells
6763 such as the MKS Korn Shell or bash, where it should be "\"". The
6764 default is adjusted according the value of 'shell', to reduce the need
6765 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 This option cannot be set from a |modeline| or in the |sandbox|, for
6767 security reasons.
6768
6769 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6770'shiftround' 'sr' boolean (default off)
6771 global
6772 {not in Vi}
6773 Round indent to multiple of 'shiftwidth'. Applies to > and <
6774 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6775 a multiple of 'shiftwidth' (this is Vi compatible).
6776 NOTE: This option is reset when 'compatible' is set.
6777
6778 *'shiftwidth'* *'sw'*
6779'shiftwidth' 'sw' number (default 8)
6780 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006781 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006783 When zero the 'ts' value will be used. Use the |shiftwidth()|
6784 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785
6786 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006787'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6788 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 global
6790 {not in Vi}
6791 This option helps to avoid all the |hit-enter| prompts caused by file
6792 messages, for example with CTRL-G, and to avoid some other messages.
6793 It is a list of flags:
6794 flag meaning when present ~
6795 f use "(3 of 5)" instead of "(file 3 of 5)"
6796 i use "[noeol]" instead of "[Incomplete last line]"
6797 l use "999L, 888C" instead of "999 lines, 888 characters"
6798 m use "[+]" instead of "[Modified]"
6799 n use "[New]" instead of "[New File]"
6800 r use "[RO]" instead of "[readonly]"
6801 w use "[w]" instead of "written" for file write message
6802 and "[a]" instead of "appended" for ':w >> file' command
6803 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6804 "[unix format]" and "[mac]" instead of "[mac format]".
6805 a all of the above abbreviations
6806
6807 o overwrite message for writing a file with subsequent message
6808 for reading a file (useful for ":wn" or when 'autowrite' on)
6809 O message for reading a file overwrites any previous message.
6810 Also for quickfix message (e.g., ":cn").
6811 s don't give "search hit BOTTOM, continuing at TOP" or "search
6812 hit TOP, continuing at BOTTOM" messages
6813 t truncate file message at the start if it is too long to fit
6814 on the command-line, "<" will appear in the left most column.
6815 Ignored in Ex mode.
6816 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006817 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 Ignored in Ex mode.
6819 W don't give "written" or "[w]" when writing a file
6820 A don't give the "ATTENTION" message when an existing swap file
6821 is found.
6822 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006823 c don't give |ins-completion-menu| messages. For example,
6824 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6825 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006826 q use "recording" instead of "recording @a"
6827 F don't give the file info when editing a file, like `:silent`
6828 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829
6830 This gives you the opportunity to avoid that a change between buffers
6831 requires you to hit <Enter>, but still gives as useful a message as
6832 possible for the space available. To get the whole message that you
6833 would have got with 'shm' empty, use ":file!"
6834 Useful values:
6835 shm= No abbreviation of message.
6836 shm=a Abbreviation, but no loss of information.
6837 shm=at Abbreviation, and truncate message when necessary.
6838
6839 NOTE: This option is set to the Vi default value when 'compatible' is
6840 set and to the Vim default value when 'compatible' is reset.
6841
6842 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6843'shortname' 'sn' boolean (default off)
6844 local to buffer
6845 {not in Vi, not in MS-DOS versions}
6846 Filenames are assumed to be 8 characters plus one extension of 3
6847 characters. Multiple dots in file names are not allowed. When this
6848 option is on, dots in file names are replaced with underscores when
6849 adding an extension (".~" or ".swp"). This option is not available
6850 for MS-DOS, because then it would always be on. This option is useful
6851 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6852 or crossdos. When running the Win32 GUI version under Win32s, this
6853 option is always on by default.
6854
6855 *'showbreak'* *'sbr'* *E595*
6856'showbreak' 'sbr' string (default "")
6857 global
6858 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006859 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 feature}
6861 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006862 values are "> " or "+++ ": >
6863 :set showbreak=>\
6864< Note the backslash to escape the trailing space. It's easier like
6865 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006866 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006867< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 comma (in a future version the comma might be used to separate the
6869 part that is shown at the end and at the start of a line).
6870 The characters are highlighted according to the '@' flag in
6871 'highlight'.
6872 Note that tabs after the showbreak will be displayed differently.
6873 If you want the 'showbreak' to appear in between line numbers, add the
6874 "n" flag to 'cpoptions'.
6875
6876 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006877'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6878 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 global
6880 {not in Vi}
6881 {not available when compiled without the
6882 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006883 Show (partial) command in the last line of the screen. Set this
6884 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 In Visual mode the size of the selected area is shown:
6886 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006887 If the number of bytes is different it is also displayed: "2-6"
6888 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006890 - When selecting a block, the size in screen characters:
6891 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 NOTE: This option is set to the Vi default value when 'compatible' is
6893 set and to the Vim default value when 'compatible' is reset.
6894
6895 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6896'showfulltag' 'sft' boolean (default off)
6897 global
6898 {not in Vi}
6899 When completing a word in insert mode (see |ins-completion|) from the
6900 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006901 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 matched a C function, you can see a template for what arguments are
6903 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006904 Note that this doesn't work well together with having "longest" in
6905 'completeopt', because the completion from the search pattern may not
6906 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907
6908 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6909'showmatch' 'sm' boolean (default off)
6910 global
6911 When a bracket is inserted, briefly jump to the matching one. The
6912 jump is only done if the match can be seen on the screen. The time to
6913 show the match can be set with 'matchtime'.
6914 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006915 seen or not).
6916 This option is reset when 'paste' is set and restored when 'paste' is
6917 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 When the 'm' flag is not included in 'cpoptions', typing a character
6919 will immediately move the cursor back to where it belongs.
6920 See the "sm" field in 'guicursor' for setting the cursor shape and
6921 blinking when showing the match.
6922 The 'matchpairs' option can be used to specify the characters to show
6923 matches for. 'rightleft' and 'revins' are used to look for opposite
6924 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006925 Also see the matchparen plugin for highlighting the match when moving
6926 around |pi_paren.txt|.
6927 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928
6929 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6930'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6931 global
6932 If in Insert, Replace or Visual mode put a message on the last line.
6933 Use the 'M' flag in 'highlight' to set the type of highlighting for
6934 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006935 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 doesn't mean XIM is really active, especially when 'imactivatekey' is
6937 not set.
6938 NOTE: This option is set to the Vi default value when 'compatible' is
6939 set and to the Vim default value when 'compatible' is reset.
6940
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006941 *'showtabline'* *'stal'*
6942'showtabline' 'stal' number (default 1)
6943 global
6944 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006945 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006946 feature}
6947 The value of this option specifies when the line with tab page labels
6948 will be displayed:
6949 0: never
6950 1: only if there are at least two tab pages
6951 2: always
6952 This is both for the GUI and non-GUI implementation of the tab pages
6953 line.
6954 See |tab-page| for more information about tab pages.
6955
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 *'sidescroll'* *'ss'*
6957'sidescroll' 'ss' number (default 0)
6958 global
6959 {not in Vi}
6960 The minimal number of columns to scroll horizontally. Used only when
6961 the 'wrap' option is off and the cursor is moved off of the screen.
6962 When it is zero the cursor will be put in the middle of the screen.
6963 When using a slow terminal set it to a large number or 0. When using
6964 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6965 commands.
6966
6967 *'sidescrolloff'* *'siso'*
6968'sidescrolloff' 'siso' number (default 0)
6969 global
6970 {not in Vi}
6971 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006972 right of the cursor if 'nowrap' is set. Setting this option to a
6973 value greater than 0 while having |'sidescroll'| also at a non-zero
6974 value makes some context visible in the line you are scrolling in
6975 horizontally (except at beginning of the line). Setting this option
6976 to a large value (like 999) has the effect of keeping the cursor
6977 horizontally centered in the window, as long as one does not come too
6978 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006979 NOTE: This option is set to 0 when 'compatible' is set.
6980
6981 Example: Try this together with 'sidescroll' and 'listchars' as
6982 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006983 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984
6985 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6986 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006987<
6988 *'signcolumn'* *'scl'*
6989'signcolumn' 'scl' string (default "auto")
6990 local to window
6991 {not in Vi}
6992 {not available when compiled without the |+signs|
6993 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006994 Whether or not to draw the signcolumn. Valid values are:
6995 "auto" only when there is a sign to display
6996 "no" never
6997 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998
6999
7000 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
7001'smartcase' 'scs' boolean (default off)
7002 global
7003 {not in Vi}
7004 Override the 'ignorecase' option if the search pattern contains upper
7005 case characters. Only used when the search pattern is typed and
7006 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02007007 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 "*" and "#" you can make 'smartcase' used by doing a "/" command,
7009 recalling the search pattern from history and hitting <Enter>.
7010 NOTE: This option is reset when 'compatible' is set.
7011
7012 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
7013'smartindent' 'si' boolean (default off)
7014 local to buffer
7015 {not in Vi}
7016 {not available when compiled without the
7017 |+smartindent| feature}
7018 Do smart autoindenting when starting a new line. Works for C-like
7019 programs, but can also be used for other languages. 'cindent' does
7020 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01007021 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007022 setting 'si' has no effect. 'indentexpr' is a more advanced
7023 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 Normally 'autoindent' should also be on when using 'smartindent'.
7025 An indent is automatically inserted:
7026 - After a line ending in '{'.
7027 - After a line starting with a keyword from 'cinwords'.
7028 - Before a line starting with '}' (only with the "O" command).
7029 When typing '}' as the first character in a new line, that line is
7030 given the same indent as the matching '{'.
7031 When typing '#' as the first character in a new line, the indent for
7032 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
7035 When using the ">>" command, lines starting with '#' are not shifted
7036 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007037 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02007038 This option is reset when 'paste' is set and restored when 'paste' is
7039 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040
7041 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
7042'smarttab' 'sta' boolean (default off)
7043 global
7044 {not in Vi}
7045 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00007046 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
7047 <BS> will delete a 'shiftwidth' worth of space at the start of the
7048 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007049 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00007050 'softtabstop'. 'shiftwidth' is only used for shifting text left or
7051 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007052 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007054 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007055 This option is reset when 'paste' is set and restored when 'paste' is
7056 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 NOTE: This option is reset when 'compatible' is set.
7058
7059 *'softtabstop'* *'sts'*
7060'softtabstop' 'sts' number (default 0)
7061 local to buffer
7062 {not in Vi}
7063 Number of spaces that a <Tab> counts for while performing editing
7064 operations, like inserting a <Tab> or using <BS>. It "feels" like
7065 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7066 used. This is useful to keep the 'ts' setting at its standard value
7067 of 8, while being able to edit like it is set to 'sts'. However,
7068 commands like "x" still work on the actual characters.
7069 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007070 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007071 'softtabstop' is set to 0 when the 'paste' option is set and restored
7072 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007073 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7074 spaces is minimized by using <Tab>s.
7075 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7076 set.
7077 NOTE: This option is set to 0 when 'compatible' is set.
7078
Bram Moolenaar217ad922005-03-20 22:37:15 +00007079 *'spell'* *'nospell'*
7080'spell' boolean (default off)
7081 local to window
7082 {not in Vi}
7083 {not available when compiled without the |+syntax|
7084 feature}
7085 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007086 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007087
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007088 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007089'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007090 local to buffer
7091 {not in Vi}
7092 {not available when compiled without the |+syntax|
7093 feature}
7094 Pattern to locate the end of a sentence. The following word will be
7095 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007096 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007097 When this check is not wanted make this option empty.
7098 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007099 Be careful with special characters, see |option-backslash| about
7100 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007101 To set this option automatically depending on the language, see
7102 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007103
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007104 *'spellfile'* *'spf'*
7105'spellfile' 'spf' string (default empty)
7106 local to buffer
7107 {not in Vi}
7108 {not available when compiled without the |+syntax|
7109 feature}
7110 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007111 commands. It must end in ".{encoding}.add". You need to include the
7112 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007113 *E765*
7114 It may also be a comma separated list of names. A count before the
7115 |zg| and |zw| commands can be used to access each. This allows using
7116 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007117 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007118 you: Using the first directory in 'runtimepath' that is writable. If
7119 there is no "spell" directory yet it will be created. For the file
7120 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007121 ignoring the region.
7122 The resulting ".spl" file will be used for spell checking, it does not
7123 have to appear in 'spelllang'.
7124 Normally one file is used for all regions, but you can add the region
7125 name if you want to. However, it will then only be used when
7126 'spellfile' is set to it, for entries in 'spelllang' only files
7127 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007128 This option cannot be set from a |modeline| or in the |sandbox|, for
7129 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007130
Bram Moolenaar217ad922005-03-20 22:37:15 +00007131 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007132'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007133 local to buffer
7134 {not in Vi}
7135 {not available when compiled without the |+syntax|
7136 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007137 A comma separated list of word list names. When the 'spell' option is
7138 on spellchecking will be done for these languages. Example: >
7139 set spelllang=en_us,nl,medical
7140< This means US English, Dutch and medical words are recognized. Words
7141 that are not recognized will be highlighted.
7142 The word list name must not include a comma or dot. Using a dash is
7143 recommended to separate the two letter language name from a
7144 specification. Thus "en-rare" is used for rare English words.
7145 A region name must come last and have the form "_xx", where "xx" is
7146 the two-letter, lower case region name. You can use more than one
7147 region by listing them: "en_us,en_ca" supports both US and Canadian
7148 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007149 Britain. (Note: currently en_au and en_nz dictionaries are older than
7150 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007151 If the name "cjk" is included East Asian characters are excluded from
7152 spell checking. This is useful when editing text that also has Asian
7153 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007154 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007155 As a special case the name of a .spl file can be given as-is. The
7156 first "_xx" in the name is removed and used as the region name
7157 (_xx is an underscore, two letters and followed by a non-letter).
7158 This is mainly for testing purposes. You must make sure the correct
7159 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007160 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007161 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7162 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007163 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007164
Bram Moolenaar98692072006-02-04 00:57:42 +00007165 If the |spellfile.vim| plugin is active and you use a language name
7166 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7167 will ask you if you want to download the file.
7168
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007169 After this option has been set successfully, Vim will source the files
7170 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007171 up to the first comma, dot or underscore.
7172 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007173
7174
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007175 *'spellsuggest'* *'sps'*
7176'spellsuggest' 'sps' string (default "best")
7177 global
7178 {not in Vi}
7179 {not available when compiled without the |+syntax|
7180 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007181 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007182 the |spellsuggest()| function. This is a comma-separated list of
7183 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007184
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007185 best Internal method that works best for English. Finds
7186 changes like "fast" and uses a bit of sound-a-like
7187 scoring to improve the ordering.
7188
7189 double Internal method that uses two methods and mixes the
7190 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007191 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007192 word. That only works when the language specifies
7193 sound folding. Can be slow and doesn't always give
7194 better results.
7195
7196 fast Internal method that only checks for simple changes:
7197 character inserts/deletes/swaps. Works well for
7198 simple typing mistakes.
7199
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007200 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007201 Not used for |spellsuggest()|. The number of
7202 suggestions is never more than the value of 'lines'
7203 minus two.
7204
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007205 file:{filename} Read file {filename}, which must have two columns,
7206 separated by a slash. The first column contains the
7207 bad word, the second column the suggested good word.
7208 Example:
7209 theribal/terrible ~
7210 Use this for common mistakes that do not appear at the
7211 top of the suggestion list with the internal methods.
7212 Lines without a slash are ignored, use this for
7213 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007214 The word in the second column must be correct,
7215 otherwise it will not be used. Add the word to an
7216 ".add" file if it is currently flagged as a spelling
7217 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007218 The file is used for all languages.
7219
7220 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7221 trouble with spaces. |v:val| holds the badly spelled
7222 word. The expression must evaluate to a List of
7223 Lists, each with a suggestion and a score.
7224 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007225 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007226 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007227 internal methods use. A lower score is better.
7228 This may invoke |spellsuggest()| if you temporarily
7229 set 'spellsuggest' to exclude the "expr:" part.
7230 Errors are silently ignored, unless you set the
7231 'verbose' option to a non-zero value.
7232
7233 Only one of "best", "double" or "fast" may be used. The others may
7234 appear several times in any order. Example: >
7235 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7236<
7237 This option cannot be set from a |modeline| or in the |sandbox|, for
7238 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007239
7240
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7242'splitbelow' 'sb' boolean (default off)
7243 global
7244 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007245 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 feature}
7247 When on, splitting a window will put the new window below the current
7248 one. |:split|
7249
7250 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7251'splitright' 'spr' boolean (default off)
7252 global
7253 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007254 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 feature}
7256 When on, splitting a window will put the new window right of the
7257 current one. |:vsplit|
7258
7259 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7260'startofline' 'sol' boolean (default on)
7261 global
7262 {not in Vi}
7263 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007264 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007265 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007266 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 with a linewise operator, with "%" with a count and to buffer changing
7268 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7269 only has a line number, e.g., ":25" or ":+".
7270 In case of buffer changing commands the cursor is placed at the column
7271 where it was the last time the buffer was edited.
7272 NOTE: This option is set when 'compatible' is set.
7273
Bram Moolenaar00654022011-02-25 14:42:19 +01007274 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007276 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 {not in Vi}
7278 {not available when compiled without the |+statusline|
7279 feature}
7280 When nonempty, this option determines the content of the status line.
7281 Also see |status-line|.
7282
7283 The option consists of printf style '%' items interspersed with
7284 normal text. Each status line item is of the form:
7285 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007286 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007287 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288
Bram Moolenaar238a5642006-02-21 22:12:05 +00007289 When the option starts with "%!" then it is used as an expression,
7290 evaluated and the result is used as the option value. Example: >
7291 :set statusline=%!MyStatusLine()
7292< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007293 Note that the "%!" expression is evaluated in the context of the
7294 current window and buffer, while %{} items are evaluated in the
7295 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007296
7297 When there is error while evaluating the option then it will be made
7298 empty to avoid further errors. Otherwise screen updating would loop.
7299
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 Note that the only effect of 'ruler' when this option is set (and
7301 'laststatus' is 2) is controlling the output of |CTRL-G|.
7302
7303 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007304 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007306 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 minwid Minimum width of the item, padding as set by '-' & '0'.
7308 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007309 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 on the left for text items. Numeric items will be
7311 shifted down to maxwid-2 digits followed by '>'number
7312 where number is the amount of missing digits, much like
7313 an exponential notation.
7314 item A one letter code as described below.
7315
7316 Following is a description of the possible statusline items. The
7317 second character in "item" is the type:
7318 N for number
7319 S for string
7320 F for flags as described below
7321 - not applicable
7322
7323 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007324 f S Path to the file in the buffer, as typed or relative to current
7325 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 F S Full path to the file in the buffer.
7327 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007328 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007330 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007332 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007334 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007336 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7338 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007339 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7341 being used: "<keymap>"
7342 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007343 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 B N As above, in hexadecimal.
7345 o N Byte number in file of byte under cursor, first byte is 1.
7346 Mnemonic: Offset from start of file (with one added)
7347 {not available when compiled without |+byte_offset| feature}
7348 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007349 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 l N Line number.
7351 L N Number of lines in buffer.
7352 c N Column number.
7353 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007354 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355 p N Percentage through file in lines as in |CTRL-G|.
7356 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007357 percentage described for 'ruler'. Always 3 in length, unless
7358 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007359 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007361 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007362 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363 ( - Start of item group. Can be used for setting the width and
7364 alignment of a section. Must be followed by %) somewhere.
7365 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007366 T N For 'tabline': start of tab page N label. Use %T after the last
7367 label. This information is used for mouse clicks.
7368 X N For 'tabline': start of close tab N label. Use %X after the
7369 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7370 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 < - Where to truncate line if too long. Default is at the start.
7372 No width fields allowed.
7373 = - Separation point between left and right aligned items.
7374 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007375 # - Set highlight group. The name must follow and then a # again.
7376 Thus use %#HLname# for highlight group HLname. The same
7377 highlighting is used, also for the statusline of non-current
7378 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007380 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 The difference between User{N} and StatusLine will be applied
7382 to StatusLineNC for the statusline of non-current windows.
7383 The number N must be between 1 and 9. See |hl-User1..9|
7384
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007385 When displaying a flag, Vim removes the leading comma, if any, when
7386 that flag comes right after plaintext. This will make a nice display
7387 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388
Bram Moolenaar582fd852005-03-28 20:58:01 +00007389 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007390 not set) and a minwid is not set for the group, the whole group will
7391 become empty. This will make a group like the following disappear
7392 completely from the statusline when none of the flags are set. >
7393 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007394< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 Beware that an expression is evaluated each and every time the status
7396 line is displayed. The current buffer and current window will be set
7397 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007398 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007400 real current buffer.
7401
Bram Moolenaar30b65812012-07-12 22:01:11 +02007402 The 'statusline' option will be evaluated in the |sandbox| if set from
7403 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007404
7405 It is not allowed to change text or jump to another window while
7406 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407
7408 If the statusline is not updated when you want it (e.g., after setting
7409 a variable that's used in an expression), you can force an update by
7410 setting an option without changing its value. Example: >
7411 :let &ro = &ro
7412
7413< A result of all digits is regarded a number for display purposes.
7414 Otherwise the result is taken as flag text and applied to the rules
7415 described above.
7416
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007417 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007419 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420
7421 Examples:
7422 Emulate standard status line with 'ruler' set >
7423 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7424< Similar, but add ASCII value of char under the cursor (like "ga") >
7425 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7426< Display byte count and byte value, modified flag in red. >
7427 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7428 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7429< Display a ,GZ flag if a compressed file is loaded >
7430 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7431< In the |:autocmd|'s: >
7432 :let b:gzflag = 1
7433< And: >
7434 :unlet b:gzflag
7435< And define this function: >
7436 :function VarExists(var, val)
7437 : if exists(a:var) | return a:val | else | return '' | endif
7438 :endfunction
7439<
7440 *'suffixes'* *'su'*
7441'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7442 global
7443 {not in Vi}
7444 Files with these suffixes get a lower priority when multiple files
7445 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007446 suffixes. Spaces after the comma are ignored. A dot is also seen as
7447 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 separator, precede it with a backslash (see |option-backslash| about
7449 including spaces and backslashes).
7450 See 'wildignore' for completely ignoring files.
7451 The use of |:set+=| and |:set-=| is preferred when adding or removing
7452 suffixes from the list. This avoids problems when a future version
7453 uses another default.
7454
7455 *'suffixesadd'* *'sua'*
7456'suffixesadd' 'sua' string (default "")
7457 local to buffer
7458 {not in Vi}
7459 {not available when compiled without the
7460 |+file_in_path| feature}
7461 Comma separated list of suffixes, which are used when searching for a
7462 file for the "gf", "[I", etc. commands. Example: >
7463 :set suffixesadd=.java
7464<
7465 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7466'swapfile' 'swf' boolean (default on)
7467 local to buffer
7468 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007469 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 swapfile is not wanted for a specific buffer. For example, with
7471 confidential information that even root must not be able to access.
7472 Careful: All text will be in memory:
7473 - Don't use this for big files.
7474 - Recovery will be impossible!
7475 A swapfile will only be present when |'updatecount'| is non-zero and
7476 'swapfile' is set.
7477 When 'swapfile' is reset, the swap file for the current buffer is
7478 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7479 non-zero, a swap file is immediately created.
7480 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007481 If you want to open a new buffer without creating a swap file for it,
7482 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483
7484 This option is used together with 'bufhidden' and 'buftype' to
7485 specify special kinds of buffers. See |special-buffers|.
7486
7487 *'swapsync'* *'sws'*
7488'swapsync' 'sws' string (default "fsync")
7489 global
7490 {not in Vi}
7491 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007492 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 When this option is empty parts of the swap file may be in memory and
7494 not written to disk. When the system crashes you may lose more work.
7495 On Unix the system does a sync now and then without Vim asking for it,
7496 so the disadvantage of setting this option off is small. On some
7497 systems the swap file will not be written at all. For a unix system
7498 setting it to "sync" will use the sync() call instead of the default
7499 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007500 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501
7502 *'switchbuf'* *'swb'*
7503'switchbuf' 'swb' string (default "")
7504 global
7505 {not in Vi}
7506 This option controls the behavior when switching between buffers.
7507 Possible values (comma separated list):
7508 useopen If included, jump to the first open window that
7509 contains the specified buffer (if there is one).
7510 Otherwise: Do not examine other windows.
7511 This setting is checked with |quickfix| commands, when
7512 jumping to errors (":cc", ":cn", "cp", etc.). It is
7513 also used in all buffer related split commands, for
7514 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007515 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007516 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007518 a buffer for a |quickfix| command that display errors.
7519 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007520 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007521 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007522 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007524 *'synmaxcol'* *'smc'*
7525'synmaxcol' 'smc' number (default 3000)
7526 local to buffer
7527 {not in Vi}
7528 {not available when compiled without the |+syntax|
7529 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007530 Maximum column in which to search for syntax items. In long lines the
7531 text after this column is not highlighted and following lines may not
7532 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007533 This helps to avoid very slow redrawing for an XML file that is one
7534 long line.
7535 Set to zero to remove the limit.
7536
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 *'syntax'* *'syn'*
7538'syntax' 'syn' string (default empty)
7539 local to buffer
7540 {not in Vi}
7541 {not available when compiled without the |+syntax|
7542 feature}
7543 When this option is set, the syntax with this name is loaded, unless
7544 syntax highlighting has been switched off with ":syntax off".
7545 Otherwise this option does not always reflect the current syntax (the
7546 b:current_syntax variable does).
7547 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007548 not automatically recognized. Example, in an IDL file:
7549 /* vim: set syntax=idl : */ ~
7550 When a dot appears in the value then this separates two filetype
7551 names. Example:
7552 /* vim: set syntax=c.doxygen : */ ~
7553 This will use the "c" syntax first, then the "doxygen" syntax.
7554 Note that the second one must be prepared to be loaded as an addition,
7555 otherwise it will be skipped. More than one dot may appear.
7556 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 :set syntax=OFF
7558< To switch syntax highlighting on according to the current value of the
7559 'filetype' option: >
7560 :set syntax=ON
7561< What actually happens when setting the 'syntax' option is that the
7562 Syntax autocommand event is triggered with the value as argument.
7563 This option is not copied to another buffer, independent of the 's' or
7564 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007565 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007567 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007568'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007569 global
7570 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007571 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007572 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007573 When nonempty, this option determines the content of the tab pages
7574 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007575 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007576
7577 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007578 option and only when there is no GUI tab line. When 'e' is in
7579 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007580 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007581
7582 The value is evaluated like with 'statusline'. You can use
7583 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007584 the text to be displayed. Use "%1T" for the first label, "%2T" for
7585 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007586
7587 Keep in mind that only one of the tab pages is the current one, others
7588 are invisible and you can't jump to their windows.
7589
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007590
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007591 *'tabpagemax'* *'tpm'*
7592'tabpagemax' 'tpm' number (default 10)
7593 global
7594 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007595 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007596 feature}
7597 Maximum number of tab pages to be opened by the |-p| command line
7598 argument or the ":tab all" command. |tabpage|
7599
7600
7601 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602'tabstop' 'ts' number (default 8)
7603 local to buffer
7604 Number of spaces that a <Tab> in the file counts for. Also see
7605 |:retab| command, and 'softtabstop' option.
7606
7607 Note: Setting 'tabstop' to any other value than 8 can make your file
7608 appear wrong in many places (e.g., when printing it).
7609
7610 There are four main ways to use tabs in Vim:
7611 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7612 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007613 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 behave like a tab appears every 4 (or 3) characters.
7615 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7616 'expandtab'. This way you will always insert spaces. The
7617 formatting will never be messed up when 'tabstop' is changed.
7618 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007619 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 works when using Vim to edit the file.
7621 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7622 'noexpandtab'. This should then work (for initial indents only)
7623 for any tabstop setting that people use. It might be nice to have
7624 tabs after the first non-blank inserted as spaces if you do this
7625 though. Otherwise aligned comments will be wrong when 'tabstop' is
7626 changed.
7627
7628 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7629'tagbsearch' 'tbs' boolean (default on)
7630 global
7631 {not in Vi}
7632 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007633 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 searching makes searching for a tag a LOT faster, but a linear search
7635 will find more tags if the tags file wasn't properly sorted.
7636 Vim normally assumes that your tags files are sorted, or indicate that
7637 they are not sorted. Only when this is not the case does the
7638 'tagbsearch' option need to be switched off.
7639
7640 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007641 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 certain files, or retry all files with a linear search. When
7643 'tagbsearch' is off, only a linear search is done.
7644
7645 Linear searching is done anyway, for one file, when Vim finds a line
7646 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007647 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648< [The whitespace before and after the '0' must be a single <Tab>]
7649
7650 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007651 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 instead of a normal tag name, a retry is done with a linear search.
7653 Tags in unsorted tags files, and matches with different case will only
7654 be found in the retry.
7655
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007656 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007657 linear search can be avoided when case is ignored. Use a value of '2'
7658 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7659 sorted with the -f switch to "sort" in most unices, as in the command:
7660 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7661 (at least 5.5) the --sort=foldcase switch can be used for this as
7662 well. Note that case must be folded to uppercase for this to work.
7663
7664 By default, tag searches are case-sensitive. Case is ignored when
7665 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7666 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007667 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7668 'tagcase' is "smart", and the pattern contains only lowercase
7669 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670
7671 When 'tagbsearch' is off, tags searching is slower when a full match
7672 exists, but faster when no full match exists. Tags in unsorted tags
7673 files may only be found with 'tagbsearch' off.
7674 When the tags file is not sorted, or sorted in a wrong way (not on
7675 ASCII byte value), 'tagbsearch' should be off, or the line given above
7676 must be included in the tags file.
7677 This option doesn't affect commands that find all matching tags (e.g.,
7678 command-line completion and ":help").
7679 {Vi: always uses binary search in some versions}
7680
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007681 *'tagcase'* *'tc'*
7682'tagcase' 'tc' string (default "followic")
7683 global or local to buffer |global-local|
7684 {not in Vi}
7685 This option specifies how case is handled when searching the tags
7686 file:
7687 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007688 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007689 ignore Ignore case
7690 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007691 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007692 NOTE: This option is set to the Vi default value when 'compatible' is
7693 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007694
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 *'taglength'* *'tl'*
7696'taglength' 'tl' number (default 0)
7697 global
7698 If non-zero, tags are significant up to this number of characters.
7699
7700 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7701'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7702 global
7703 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007704 If on and using a tags file in another directory, file names in that
7705 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 NOTE: This option is set to the Vi default value when 'compatible' is
7707 set and to the Vim default value when 'compatible' is reset.
7708
7709 *'tags'* *'tag'* *E433*
7710'tags' 'tag' string (default "./tags,tags", when compiled with
7711 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7712 global or local to buffer |global-local|
7713 Filenames for the tag command, separated by spaces or commas. To
7714 include a space or comma in a file name, precede it with a backslash
7715 (see |option-backslash| about including spaces and backslashes).
7716 When a file name starts with "./", the '.' is replaced with the path
7717 of the current file. But only when the 'd' flag is not included in
7718 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7719 |tags-option|.
7720 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007721 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7722 find all files named "tags" below "/lib". The filename itself cannot
7723 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7724 files called "tags?". {not available when compiled without the
7725 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007726 The |tagfiles()| function can be used to get a list of the file names
7727 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7729 files are also supported. They are automatically recognized. The
7730 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7731 differences are ignored (MS-Windows). |emacs-tags|
7732 The use of |:set+=| and |:set-=| is preferred when adding or removing
7733 file names from the list. This avoids problems when a future version
7734 uses another default.
7735 {Vi: default is "tags /usr/lib/tags"}
7736
7737 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7738'tagstack' 'tgst' boolean (default on)
7739 global
7740 {not in all versions of Vi}
7741 When on, the |tagstack| is used normally. When off, a ":tag" or
7742 ":tselect" command with an argument will not push the tag onto the
7743 tagstack. A following ":tag" without an argument, a ":pop" command or
7744 any other command that uses the tagstack will use the unmodified
7745 tagstack, but does change the pointer to the active entry.
7746 Resetting this option is useful when using a ":tag" command in a
7747 mapping which should not change the tagstack.
7748
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007749 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007750'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007751 global
7752 {not in Vi}
7753 {only available when compiled with the |+tcl/dyn|
7754 feature}
7755 Specifies the name of the Tcl shared library. The default is
7756 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007757 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007758 This option cannot be set from a |modeline| or in the |sandbox|, for
7759 security reasons.
7760
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 *'term'* *E529* *E530* *E531*
7762'term' string (default is $TERM, if that fails:
7763 in the GUI: "builtin_gui"
7764 on Amiga: "amiga"
7765 on BeOS: "beos-ansi"
7766 on Mac: "mac-ansi"
7767 on MiNT: "vt52"
7768 on MS-DOS: "pcterm"
7769 on OS/2: "os2ansi"
7770 on Unix: "ansi"
7771 on VMS: "ansi"
7772 on Win 32: "win32")
7773 global
7774 Name of the terminal. Used for choosing the terminal control
7775 characters. Environment variables are expanded |:set_env|.
7776 For example: >
7777 :set term=$TERM
7778< See |termcap|.
7779
7780 *'termbidi'* *'tbidi'*
7781 *'notermbidi'* *'notbidi'*
7782'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7783 global
7784 {not in Vi}
7785 {only available when compiled with the |+arabic|
7786 feature}
7787 The terminal is in charge of Bi-directionality of text (as specified
7788 by Unicode). The terminal is also expected to do the required shaping
7789 that some languages (such as Arabic) require.
7790 Setting this option implies that 'rightleft' will not be set when
7791 'arabic' is set and the value of 'arabicshape' will be ignored.
7792 Note that setting 'termbidi' has the immediate effect that
7793 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7794 This option is reset when the GUI is started.
7795 For further details see |arabic.txt|.
7796
7797 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007798'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 Macintosh GUI: "macroman")
7800 global
7801 {only available when compiled with the |+multi_byte|
7802 feature}
7803 {not in Vi}
7804 Encoding used for the terminal. This specifies what character
7805 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007806 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007807 display). Except for the Mac when 'macatsui' is off, then
7808 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007810 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7812 Any attempts to set a different value will be rejected, and an error
7813 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007814 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 because the Win32 system always passes Unicode characters.
7816 When empty, the same encoding is used as for the 'encoding' option.
7817 This is the normal value.
7818 Not all combinations for 'termencoding' and 'encoding' are valid. See
7819 |encoding-table|.
7820 The value for this option must be supported by internal conversions or
7821 iconv(). When this is not possible no conversion will be done and you
7822 will probably experience problems with non-ASCII characters.
7823 Example: You are working with the locale set to euc-jp (Japanese) and
7824 want to edit a UTF-8 file: >
7825 :let &termencoding = &encoding
7826 :set encoding=utf-8
7827< You need to do this when your system has no locale support for UTF-8.
7828
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007829 *'termguicolors'* *'tgc'*
7830'termguicolors' 'tgc' boolean (default off)
7831 global
7832 {not in Vi}
7833 {not available when compiled without the
7834 |+termguicolors| feature}
7835 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7836 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7837 compatible terminal.
7838 If setting this option does not work (produces a colorless UI)
7839 reading |xterm-true-color| might help.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007840 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007841 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007842
Bram Moolenaar74675a62017-07-15 13:53:23 +02007843 *'termkey'* *'tk'*
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007844'termkey' 'tk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007845 local to window
7846 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007847 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007848 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007849 The <> notation can be used, e.g.: >
7850 :set termkey=<C-L>
7851< The string must be one key stroke but can be multiple bytes.
7852 When not set CTRL-W is used, so that CTRL-W : gets you to the command
7853 line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the
7854 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007855
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007856 *'termsize'* *'tms'*
Bram Moolenaar74675a62017-07-15 13:53:23 +02007857'termsize' 'tms' string (default "")
7858 local to window
7859 {not in Vi}
7860 Size of the |terminal| window. Format: {rows}x{columns}.
7861 - When empty the terminal gets the size from the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007862 - When set (e.g., "24x80") the terminal size is not adjusted to the
7863 window size. If the window is smaller only the top-left part is
7864 displayed.
7865 When rows is zero then use the height of the window.
7866 When columns is zero then use the width of the window.
7867 For example: "30x0" uses 30 rows with the current window width.
7868 Using "0x0" is the same as empty.
7869 Note that the command running in the terminal window may still change
7870 the size of the terminal. In that case the Vim window will be
7871 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007872
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873 *'terse'* *'noterse'*
7874'terse' boolean (default off)
7875 global
7876 When set: Add 's' flag to 'shortmess' option (this makes the message
7877 for a search that hits the start or end of the file not being
7878 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7879 shortens a lot of messages}
7880
7881 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7882'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7883 global
7884 {not in Vi}
7885 This option is obsolete. Use 'fileformats'.
7886 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7887 set to the default value for the current system. When 'textauto' is
7888 reset, 'fileformats' is made empty.
7889 NOTE: This option is set to the Vi default value when 'compatible' is
7890 set and to the Vim default value when 'compatible' is reset.
7891
7892 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7893'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7894 others: default off)
7895 local to buffer
7896 {not in Vi}
7897 This option is obsolete. Use 'fileformat'.
7898 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7899 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7900 "unix".
7901
7902 *'textwidth'* *'tw'*
7903'textwidth' 'tw' number (default 0)
7904 local to buffer
7905 {not in Vi}
7906 Maximum width of text that is being inserted. A longer line will be
7907 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007908 this.
7909 'textwidth' is set to 0 when the 'paste' option is set and restored
7910 when 'paste' is reset.
7911 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007913 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 NOTE: This option is set to 0 when 'compatible' is set.
7915
7916 *'thesaurus'* *'tsr'*
7917'thesaurus' 'tsr' string (default "")
7918 global or local to buffer |global-local|
7919 {not in Vi}
7920 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007921 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 the file should contain words with similar meaning, separated by
7923 non-keyword characters (white space is preferred). Maximum line
7924 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007925 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007926 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007927 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007928 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 after a comma are ignored, otherwise spaces are included in the file
7930 name. See |option-backslash| about using backslashes.
7931 The use of |:set+=| and |:set-=| is preferred when adding or removing
7932 directories from the list. This avoids problems when a future version
7933 uses another default.
7934 Backticks cannot be used in this option for security reasons.
7935
7936 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7937'tildeop' 'top' boolean (default off)
7938 global
7939 {not in Vi}
7940 When on: The tilde command "~" behaves like an operator.
7941 NOTE: This option is reset when 'compatible' is set.
7942
7943 *'timeout'* *'to'* *'notimeout'* *'noto'*
7944'timeout' 'to' boolean (default on)
7945 global
7946 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007947'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 global
7949 {not in Vi}
7950 These two options together determine the behavior when part of a
7951 mapped key sequence or keyboard code has been received:
7952
7953 'timeout' 'ttimeout' action ~
7954 off off do not time out
7955 on on or off time out on :mappings and key codes
7956 off on time out on key codes
7957
7958 If both options are off, Vim will wait until either the complete
7959 mapping or key sequence has been received, or it is clear that there
7960 is no mapping or key sequence for the received characters. For
7961 example: if you have mapped "vl" and Vim has received 'v', the next
7962 character is needed to see if the 'v' is followed by an 'l'.
7963 When one of the options is on, Vim will wait for about 1 second for
7964 the next character to arrive. After that the already received
7965 characters are interpreted as single characters. The waiting time can
7966 be changed with the 'timeoutlen' option.
7967 On slow terminals or very busy systems timing out may cause
7968 malfunctioning cursor keys. If both options are off, Vim waits
7969 forever after an entered <Esc> if there are key codes that start
7970 with <Esc>. You will have to type <Esc> twice. If you do not have
7971 problems with key codes, but would like to have :mapped key
7972 sequences not timing out in 1 second, set the 'ttimeout' option and
7973 reset the 'timeout' option.
7974
7975 NOTE: 'ttimeout' is reset when 'compatible' is set.
7976
7977 *'timeoutlen'* *'tm'*
7978'timeoutlen' 'tm' number (default 1000)
7979 global
7980 {not in all versions of Vi}
7981 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007982'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 global
7984 {not in Vi}
7985 The time in milliseconds that is waited for a key code or mapped key
7986 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7987 when part of a command has been typed.
7988 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7989 different timeout value for key codes is desired set 'ttimeoutlen' to
7990 a non-negative number.
7991
7992 ttimeoutlen mapping delay key code delay ~
7993 < 0 'timeoutlen' 'timeoutlen'
7994 >= 0 'timeoutlen' 'ttimeoutlen'
7995
7996 The timeout only happens when the 'timeout' and 'ttimeout' options
7997 tell so. A useful setting would be >
7998 :set timeout timeoutlen=3000 ttimeoutlen=100
7999< (time out on mapping after three seconds, time out on key codes after
8000 a tenth of a second).
8001
8002 *'title'* *'notitle'*
8003'title' boolean (default off, on when title can be restored)
8004 global
8005 {not in Vi}
8006 {not available when compiled without the |+title|
8007 feature}
8008 When on, the title of the window will be set to the value of
8009 'titlestring' (if it is not empty), or to:
8010 filename [+=-] (path) - VIM
8011 Where:
8012 filename the name of the file being edited
8013 - indicates the file cannot be modified, 'ma' off
8014 + indicates the file was modified
8015 = indicates the file is read-only
8016 =+ indicates the file is read-only and modified
8017 (path) is the path of the file being edited
8018 - VIM the server name |v:servername| or "VIM"
8019 Only works if the terminal supports setting window titles
8020 (currently Amiga console, Win32 console, all GUI versions and
8021 terminals with a non- empty 't_ts' option - these are Unix xterm and
8022 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
8023 *X11*
8024 When Vim was compiled with HAVE_X11 defined, the original title will
8025 be restored if possible. The output of ":version" will include "+X11"
8026 when HAVE_X11 was defined, otherwise it will be "-X11". This also
8027 works for the icon name |'icon'|.
8028 But: When Vim was started with the |-X| argument, restoring the title
8029 will not work (except in the GUI).
8030 If the title cannot be restored, it is set to the value of 'titleold'.
8031 You might want to restore the title outside of Vim then.
8032 When using an xterm from a remote machine you can use this command:
8033 rsh machine_name xterm -display $DISPLAY &
8034 then the WINDOWID environment variable should be inherited and the
8035 title of the window should change back to what it should be after
8036 exiting Vim.
8037
8038 *'titlelen'*
8039'titlelen' number (default 85)
8040 global
8041 {not in Vi}
8042 {not available when compiled without the |+title|
8043 feature}
8044 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008045 title. When the title is longer, only the end of the path name is
8046 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008047 Using a percentage makes this adapt to the width of the window. But
8048 it won't work perfectly, because the actual number of characters
8049 available also depends on the font used and other things in the title
8050 bar. When 'titlelen' is zero the full path is used. Otherwise,
8051 values from 1 to 30000 percent can be used.
8052 'titlelen' is also used for the 'titlestring' option.
8053
8054 *'titleold'*
8055'titleold' string (default "Thanks for flying Vim")
8056 global
8057 {not in Vi}
8058 {only available when compiled with the |+title|
8059 feature}
8060 This option will be used for the window title when exiting Vim if the
8061 original title cannot be restored. Only happens if 'title' is on or
8062 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008063 This option cannot be set from a |modeline| or in the |sandbox|, for
8064 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 *'titlestring'*
8066'titlestring' string (default "")
8067 global
8068 {not in Vi}
8069 {not available when compiled without the |+title|
8070 feature}
8071 When this option is not empty, it will be used for the title of the
8072 window. This happens only when the 'title' option is on.
8073 Only works if the terminal supports setting window titles (currently
8074 Amiga console, Win32 console, all GUI versions and terminals with a
8075 non-empty 't_ts' option).
8076 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008077 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 When this option contains printf-style '%' items, they will be
8079 expanded according to the rules used for 'statusline'.
8080 Example: >
8081 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8082 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8083< The value of 'titlelen' is used to align items in the middle or right
8084 of the available space.
8085 Some people prefer to have the file name first: >
8086 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8087< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008088 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 separating space only when needed.
8090 NOTE: Use of special characters in 'titlestring' may cause the display
8091 to be garbled (e.g., when it contains a CR or NL character).
8092 {not available when compiled without the |+statusline| feature}
8093
8094 *'toolbar'* *'tb'*
8095'toolbar' 'tb' string (default "icons,tooltips")
8096 global
8097 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8098 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008099 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 possible values are:
8101 icons Toolbar buttons are shown with icons.
8102 text Toolbar buttons shown with text.
8103 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008104 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 tooltips Tooltips are active for toolbar buttons.
8106 Tooltips refer to the popup help text which appears after the mouse
8107 cursor is placed over a toolbar button for a brief moment.
8108
8109 If you want the toolbar to be shown with icons as well as text, do the
8110 following: >
8111 :set tb=icons,text
8112< Motif and Athena cannot display icons and text at the same time. They
8113 will show icons if both are requested.
8114
8115 If none of the strings specified in 'toolbar' are valid or if
8116 'toolbar' is empty, this option is ignored. If you want to disable
8117 the toolbar, you need to set the 'guioptions' option. For example: >
8118 :set guioptions-=T
8119< Also see |gui-toolbar|.
8120
8121 *'toolbariconsize'* *'tbis'*
8122'toolbariconsize' 'tbis' string (default "small")
8123 global
8124 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008125 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008127 tiny Use tiny icons.
8128 small Use small icons (default).
8129 medium Use medium-sized icons.
8130 large Use large icons.
8131 huge Use even larger icons.
8132 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008134 the current theme. Common dimensions are giant=48x48, huge=32x32,
8135 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008136
8137 If 'toolbariconsize' is empty, the global default size as determined
8138 by user preferences or the current theme is used.
8139
8140 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8141'ttybuiltin' 'tbi' boolean (default on)
8142 global
8143 {not in Vi}
8144 When on, the builtin termcaps are searched before the external ones.
8145 When off the builtin termcaps are searched after the external ones.
8146 When this option is changed, you should set the 'term' option next for
8147 the change to take effect, for example: >
8148 :set notbi term=$TERM
8149< See also |termcap|.
8150 Rationale: The default for this option is "on", because the builtin
8151 termcap entries are generally better (many systems contain faulty
8152 xterm entries...).
8153
8154 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8155'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8156 sun-cmd, screen, rxvt, dtterm or
8157 iris-ansi; also on when running Vim in
8158 a DOS console)
8159 global
8160 {not in Vi}
8161 Indicates a fast terminal connection. More characters will be sent to
8162 the screen for redrawing, instead of using insert/delete line
8163 commands. Improves smoothness of redrawing when there are multiple
8164 windows and the terminal does not support a scrolling region.
8165 Also enables the extra writing of characters at the end of each screen
8166 line for lines that wrap. This helps when using copy/paste with the
8167 mouse in an xterm and other terminals.
8168
8169 *'ttymouse'* *'ttym'*
8170'ttymouse' 'ttym' string (default depends on 'term')
8171 global
8172 {not in Vi}
8173 {only in Unix and VMS, doesn't work in the GUI; not
8174 available when compiled without |+mouse|}
8175 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008176 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008177 *xterm-mouse*
8178 xterm xterm-like mouse handling. The mouse generates
8179 "<Esc>[Mscr", where "scr" is three bytes:
8180 "s" = button state
8181 "c" = column plus 33
8182 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008183 This only works up to 223 columns! See "dec",
8184 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 xterm2 Works like "xterm", but with the xterm reporting the
8186 mouse position while the mouse is dragged. This works
8187 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008188 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008189 work. See below for how Vim detects this
8190 automatically.
8191 *netterm-mouse*
8192 netterm NetTerm mouse handling. The mouse generates
8193 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8194 for the row and column.
8195 *dec-mouse*
8196 dec DEC terminal mouse handling. The mouse generates a
8197 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008198 This is also available for an Xterm, if it was
8199 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 *jsbterm-mouse*
8201 jsbterm JSB term mouse handling.
8202 *pterm-mouse*
8203 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008204 *urxvt-mouse*
8205 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008206 The mouse works only if the terminal supports this
8207 encoding style, but it does not have 223 columns limit
8208 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008209 *sgr-mouse*
8210 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008211 mouse reporting. The mouse works even in columns
8212 beyond 223. This option is backward compatible with
8213 "xterm2" because it can also decode "xterm2" style
8214 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215
8216 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008217 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8218 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8220 recognized, if enabled at compile time. DEC terminal mouse codes
8221 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008222 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8223 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008225 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8226 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8227 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008228 Additionally, if vim is compiled with the |+termresponse| feature and
8229 |t_RV| is set to the escape sequence to request the xterm version
8230 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008232 from 95 to 276. The "sgr" value will be set if the xterm version is
Bram Moolenaar51b0f372017-11-18 18:52:04 +01008233 277 or highter and when Vim detects Mac Terminal.app or Iterm2.
Bram Moolenaare968e362014-05-13 20:23:24 +02008234 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8235 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 :set t_RV=
8237<
8238 *'ttyscroll'* *'tsl'*
8239'ttyscroll' 'tsl' number (default 999)
8240 global
8241 Maximum number of lines to scroll the screen. If there are more lines
8242 to scroll the window is redrawn. For terminals where scrolling is
8243 very slow and redrawing is not slow this can be set to a small number,
8244 e.g., 3, to speed up displaying.
8245
8246 *'ttytype'* *'tty'*
8247'ttytype' 'tty' string (default from $TERM)
8248 global
8249 Alias for 'term', see above.
8250
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008251 *'undodir'* *'udir'*
8252'undodir' 'udir' string (default ".")
8253 global
8254 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008255 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008256 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008257 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008258 "." means using the directory of the file. The undo file name for
8259 "file.txt" is ".file.txt.un~".
8260 For other directories the file name is the full path of the edited
8261 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008262 When writing: The first directory that exists is used. "." always
8263 works, no directories after "." will be used for writing.
8264 When reading all entries are tried to find an undo file. The first
8265 undo file that exists is used. When it cannot be read an error is
8266 given, no further entry is used.
8267 See |undo-persistence|.
8268
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008269 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008270'undofile' 'udf' boolean (default off)
8271 local to buffer
8272 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008273 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008274 When on, Vim automatically saves undo history to an undo file when
8275 writing a buffer to a file, and restores undo history from the same
8276 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008277 The directory where the undo file is stored is specified by 'undodir'.
8278 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008279 The undo file is not read when 'undoreload' causes the buffer from
8280 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008281 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008282 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008283
Bram Moolenaar071d4272004-06-13 20:20:40 +00008284 *'undolevels'* *'ul'*
8285'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8286 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008287 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 {not in Vi}
8289 Maximum number of changes that can be undone. Since undo information
8290 is kept in memory, higher numbers will cause more memory to be used
8291 (nevertheless, a single change can use an unlimited amount of memory).
8292 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8293 itself: >
8294 set ul=0
8295< But you can also get Vi compatibility by including the 'u' flag in
8296 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008297 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008298 Set to -1 for no undo at all. You might want to do this only for the
8299 current buffer: >
8300 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008301< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008302
8303 The local value is set to -123456 when the global value is to be used.
8304
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008305 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008307 *'undoreload'* *'ur'*
8308'undoreload' 'ur' number (default 10000)
8309 global
8310 {not in Vi}
8311 Save the whole buffer for undo when reloading it. This applies to the
8312 ":e!" command and reloading for when the buffer changed outside of
8313 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008314 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008315 of lines is smaller than the value of this option.
8316 Set this option to zero to disable undo for a reload.
8317
8318 When saving undo for a reload, any undo file is not read.
8319
8320 Note that this causes the whole buffer to be stored in memory. Set
8321 this option to a lower value if you run out of memory.
8322
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 *'updatecount'* *'uc'*
8324'updatecount' 'uc' number (default: 200)
8325 global
8326 {not in Vi}
8327 After typing this many characters the swap file will be written to
8328 disk. When zero, no swap file will be created at all (see chapter on
8329 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8330 Vim with the "-n" option, see |startup|. When editing in readonly
8331 mode this option will be initialized to 10000.
8332 The swapfile can be disabled per buffer with |'swapfile'|.
8333 When 'updatecount' is set from zero to non-zero, swap files are
8334 created for all buffers that have 'swapfile' set. When 'updatecount'
8335 is set to zero, existing swap files are not deleted.
8336 Also see |'swapsync'|.
8337 This option has no meaning in buffers where |'buftype'| is "nofile"
8338 or "nowrite".
8339
8340 *'updatetime'* *'ut'*
8341'updatetime' 'ut' number (default 4000)
8342 global
8343 {not in Vi}
8344 If this many milliseconds nothing is typed the swap file will be
8345 written to disk (see |crash-recovery|). Also used for the
8346 |CursorHold| autocommand event.
8347
8348 *'verbose'* *'vbs'*
8349'verbose' 'vbs' number (default 0)
8350 global
8351 {not in Vi, although some versions have a boolean
8352 verbose option}
8353 When bigger than zero, Vim will give messages about what it is doing.
8354 Currently, these messages are given:
8355 >= 1 When the viminfo file is read or written.
8356 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008357 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 >= 8 Files for which a group of autocommands is executed.
8359 >= 9 Every executed autocommand.
8360 >= 12 Every executed function.
8361 >= 13 When an exception is thrown, caught, finished, or discarded.
8362 >= 14 Anything pending in a ":finally" clause.
8363 >= 15 Every executed Ex command (truncated at 200 characters).
8364
8365 This option can also be set with the "-V" argument. See |-V|.
8366 This option is also set by the |:verbose| command.
8367
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008368 When the 'verbosefile' option is set then the verbose messages are not
8369 displayed.
8370
8371 *'verbosefile'* *'vfile'*
8372'verbosefile' 'vfile' string (default empty)
8373 global
8374 {not in Vi}
8375 When not empty all messages are written in a file with this name.
8376 When the file exists messages are appended.
8377 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008378 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008379 Setting 'verbosefile' to a new value is like making it empty first.
8380 The difference with |:redir| is that verbose messages are not
8381 displayed when 'verbosefile' is set.
8382
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 *'viewdir'* *'vdir'*
8384'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8385 "$VIM/vimfiles/view",
8386 for Unix: "~/.vim/view",
8387 for Macintosh: "$VIM:vimfiles:view"
8388 for VMS: "sys$login:vimfiles/view"
8389 for RiscOS: "Choices:vimfiles/view")
8390 global
8391 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008392 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 feature}
8394 Name of the directory where to store files for |:mkview|.
8395 This option cannot be set from a |modeline| or in the |sandbox|, for
8396 security reasons.
8397
8398 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008399'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 global
8401 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008402 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 feature}
8404 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008405 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 word save and restore ~
8407 cursor cursor position in file and in window
8408 folds manually created folds, opened/closed folds and local
8409 fold options
8410 options options and mappings local to a window or buffer (not
8411 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008412 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 slash backslashes in file names replaced with forward
8414 slashes
8415 unix with Unix end-of-line format (single <NL>), even when
8416 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008417 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418
8419 "slash" and "unix" are useful on Windows when sharing view files
8420 with Unix. The Unix version of Vim cannot source dos format scripts,
8421 but the Windows version of Vim can source unix format scripts.
8422
8423 *'viminfo'* *'vi'* *E526* *E527* *E528*
8424'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008425 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8426 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8427 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008428 global
8429 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008430 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 feature}
8432 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008433 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8434 "NONE".
8435 The string should be a comma separated list of parameters, each
8436 consisting of a single character identifying the particular parameter,
8437 followed by a number or string which specifies the value of that
8438 parameter. If a particular character is left out, then the default
8439 value is used for that parameter. The following is a list of the
8440 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008442 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008443 ! When included, save and restore global variables that start
8444 with an uppercase letter, and don't contain a lowercase
8445 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008446 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008447 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008448 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 " Maximum number of lines saved for each register. Old name of
8450 the '<' item, with the disadvantage that you need to put a
8451 backslash before the ", otherwise it will be recognized as the
8452 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008453 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 % When included, save and restore the buffer list. If Vim is
8455 started with a file name argument, the buffer list is not
8456 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008457 buffer list is restored from the viminfo file. Quickfix
8458 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8459 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008460 When followed by a number, the number specifies the maximum
8461 number of buffers that are stored. Without a number all
8462 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008463 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 ' Maximum number of previously edited files for which the marks
8465 are remembered. This parameter must always be included when
8466 'viminfo' is non-empty.
8467 Including this item also means that the |jumplist| and the
8468 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008469 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008470 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008471 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 patterns are also saved. When not included, the value of
8473 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008474 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008476 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008477 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 < Maximum number of lines saved for each register. If zero then
8479 registers are not saved. When not included, all lines are
8480 saved. '"' is the old name for this item.
8481 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008482 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008484 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008485 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486 c When included, convert the text in the viminfo file from the
8487 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008488 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008489 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008490 f Whether file marks need to be stored. If zero, file marks ('0
8491 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008492 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008493 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008494 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 h Disable the effect of 'hlsearch' when loading the viminfo
8496 file. When not included, it depends on whether ":nohlsearch"
8497 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008498 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008500 the 'n'. Must be at the end of the option! If the
8501 'viminfofile' option is set, that file name overrides the one
8502 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008503 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008504 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 r Removable media. The argument is a string (up to the next
8506 ','). This parameter can be given several times. Each
8507 specifies the start of a path for which no marks will be
8508 stored. This is to avoid removable media. For MS-DOS you
8509 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8510 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8511 ignored. Maximum length of each 'r' argument is 50
8512 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008513 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 s Maximum size of an item in Kbyte. If zero then registers are
8515 not saved. Currently only applies to registers. The default
8516 "s10" will exclude registers with more than 10 Kbyte of text.
8517 Also see the '<' item above: line count limit.
8518
8519 Example: >
8520 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8521<
8522 '50 Marks will be remembered for the last 50 files you
8523 edited.
8524 <1000 Contents of registers (up to 1000 lines each) will be
8525 remembered.
8526 s100 Registers with more than 100 Kbyte text are skipped.
8527 :0 Command-line history will not be saved.
8528 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8529 no / Since '/' is not specified, the default will be used,
8530 that is, save all of the search history, and also the
8531 previous search and substitute patterns.
8532 no % The buffer list will not be saved nor read back.
8533 no h 'hlsearch' highlighting will be restored.
8534
8535 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8536 load the contents of the file, this is not done automatically.
8537
8538 This option cannot be set from a |modeline| or in the |sandbox|, for
8539 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008540 NOTE: This option is set to the Vim default value when 'compatible'
8541 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008543 *'viminfofile'* *'vif'*
8544'viminfofile' 'vif' string (default: "")
8545 global
8546 {not in Vi}
8547 {not available when compiled without the |+viminfo|
8548 feature}
8549 When non-empty, overrides the file name used for viminfo.
8550 When equal to "NONE" no viminfo file will be read or written.
8551 This option can be set with the |-i| command line flag. The |--clean|
8552 command line flag sets it to "NONE".
8553
Bram Moolenaar071d4272004-06-13 20:20:40 +00008554 *'virtualedit'* *'ve'*
8555'virtualedit' 've' string (default "")
8556 global
8557 {not in Vi}
8558 {not available when compiled without the
8559 |+virtualedit| feature}
8560 A comma separated list of these words:
8561 block Allow virtual editing in Visual block mode.
8562 insert Allow virtual editing in Insert mode.
8563 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008564 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008565
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008567 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008568 of the line. Useful for selecting a rectangle in Visual mode and
8569 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008570 "onemore" is not the same, it will only allow moving the cursor just
8571 after the last character of the line. This makes some commands more
8572 consistent. Previously the cursor was always past the end of the line
8573 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008574 break some plugins or Vim scripts. For example because |l| can move
8575 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008576 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008577 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008578 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008579 It doesn't make sense to combine "all" with "onemore", but you will
8580 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008581 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582
8583 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8584'visualbell' 'vb' boolean (default off)
8585 global
8586 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008587 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008588 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008589 use: >
8590 :set vb t_vb=
8591< If you want a short flash, you can use this on many terminals: >
8592 :set vb t_vb=[?5h$<100>[?5l
8593< Here $<100> specifies the time, you can use a smaller or bigger value
8594 to get a shorter or longer flash.
8595
8596 Note: Vim will limit the bell to once per half a second. This avoids
8597 having to wait for the flashing to finish when there are lots of
8598 bells, e.g. on key repeat. This also happens without 'visualbell'
8599 set.
8600
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8602 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8603 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008604
8605 Note: When the GUI starts, 't_vb' is reset to its default value. You
8606 might want to set it again in your |gvimrc|.
8607
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 Does not work on the Amiga, you always get a screen flash.
8609 Also see 'errorbells'.
8610
8611 *'warn'* *'nowarn'*
8612'warn' boolean (default on)
8613 global
8614 Give a warning message when a shell command is used while the buffer
8615 has been changed.
8616
8617 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8618'weirdinvert' 'wiv' boolean (default off)
8619 global
8620 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008621 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008622 It is provided for backwards compatibility with version 4.x.
8623 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8624 vice versa. Has no effect when the GUI is running.
8625
8626 *'whichwrap'* *'ww'*
8627'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8628 global
8629 {not in Vi}
8630 Allow specified keys that move the cursor left/right to move to the
8631 previous/next line when the cursor is on the first/last character in
8632 the line. Concatenate characters to allow this for these keys:
8633 char key mode ~
8634 b <BS> Normal and Visual
8635 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008636 h "h" Normal and Visual (not recommended)
8637 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638 < <Left> Normal and Visual
8639 > <Right> Normal and Visual
8640 ~ "~" Normal
8641 [ <Left> Insert and Replace
8642 ] <Right> Insert and Replace
8643 For example: >
8644 :set ww=<,>,[,]
8645< allows wrap only when cursor keys are used.
8646 When the movement keys are used in combination with a delete or change
8647 operator, the <EOL> also counts for a character. This makes "3h"
8648 different from "3dh" when the cursor crosses the end of a line. This
8649 is also true for "x" and "X", because they do the same as "dl" and
8650 "dh". If you use this, you may also want to use the mapping
8651 ":map <BS> X" to make backspace delete the character in front of the
8652 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008653 When 'l' is included and it is used after an operator at the end of a
8654 line then it will not move to the next line. This makes "dl", "cl",
8655 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 NOTE: This option is set to the Vi default value when 'compatible' is
8657 set and to the Vim default value when 'compatible' is reset.
8658
8659 *'wildchar'* *'wc'*
8660'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8661 global
8662 {not in Vi}
8663 Character you have to type to start wildcard expansion in the
8664 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008665 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 The character is not recognized when used inside a macro. See
8667 'wildcharm' for that.
8668 Although 'wc' is a number option, you can set it to a special key: >
8669 :set wc=<Esc>
8670< NOTE: This option is set to the Vi default value when 'compatible' is
8671 set and to the Vim default value when 'compatible' is reset.
8672
8673 *'wildcharm'* *'wcm'*
8674'wildcharm' 'wcm' number (default: none (0))
8675 global
8676 {not in Vi}
8677 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008678 recognized when used inside a macro. You can find "spare" command-line
8679 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 you'll never actually type 'wildcharm', just use it in mappings that
8681 automatically invoke completion mode, e.g.: >
8682 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008683 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008684< Then after typing :ss you can use CTRL-P & CTRL-N.
8685
8686 *'wildignore'* *'wig'*
8687'wildignore' 'wig' string (default "")
8688 global
8689 {not in Vi}
8690 {not available when compiled without the |+wildignore|
8691 feature}
8692 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008693 patterns is ignored when expanding |wildcards|, completing file or
8694 directory names, and influences the result of |expand()|, |glob()| and
8695 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8697 Also see 'suffixes'.
8698 Example: >
8699 :set wildignore=*.o,*.obj
8700< The use of |:set+=| and |:set-=| is preferred when adding or removing
8701 a pattern from the list. This avoids problems when a future version
8702 uses another default.
8703
Bram Moolenaar94950a92010-12-02 16:01:29 +01008704
Bram Moolenaar81af9252010-12-10 20:35:50 +01008705 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008706'wildignorecase' 'wic' boolean (default off)
8707 global
8708 {not in Vi}
8709 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008710 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008711 Does not apply when the shell is used to expand wildcards, which
8712 happens when there are special characters.
8713
8714
Bram Moolenaar071d4272004-06-13 20:20:40 +00008715 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008716'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008717 global
8718 {not in Vi}
8719 {not available if compiled without the |+wildmenu|
8720 feature}
8721 When 'wildmenu' is on, command-line completion operates in an enhanced
8722 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8723 the possible matches are shown just above the command line, with the
8724 first match highlighted (overwriting the status line, if there is
8725 one). Keys that show the previous/next match, such as <Tab> or
8726 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8727 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8728 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008729 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008730 If there are more matches than can fit in the line, a ">" is shown on
8731 the right and/or a "<" is shown on the left. The status line scrolls
8732 as needed.
8733 The "wildmenu" mode is abandoned when a key is hit that is not used
8734 for selecting a completion.
8735 While the "wildmenu" is active the following keys have special
8736 meanings:
8737
8738 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8739 <Down> - in filename/menu name completion: move into a
8740 subdirectory or submenu.
8741 <CR> - in menu completion, when the cursor is just after a
8742 dot: move into a submenu.
8743 <Up> - in filename/menu name completion: move up into
8744 parent directory or parent menu.
8745
8746 This makes the menus accessible from the console |console-menus|.
8747
8748 If you prefer the <Left> and <Right> keys to move the cursor instead
8749 of selecting a different match, use this: >
8750 :cnoremap <Left> <Space><BS><Left>
8751 :cnoremap <Right> <Space><BS><Right>
8752<
8753 The "WildMenu" highlighting is used for displaying the current match
8754 |hl-WildMenu|.
8755
8756 *'wildmode'* *'wim'*
8757'wildmode' 'wim' string (Vim default: "full")
8758 global
8759 {not in Vi}
8760 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008761 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008762 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 first part specifies the behavior for the first use of 'wildchar',
8764 The second part for the second use, etc.
8765 These are the possible values for each part:
8766 "" Complete only the first match.
8767 "full" Complete the next full match. After the last match,
8768 the original string is used and then the first match
8769 again.
8770 "longest" Complete till longest common string. If this doesn't
8771 result in a longer string, use the next part.
8772 "longest:full" Like "longest", but also start 'wildmenu' if it is
8773 enabled.
8774 "list" When more than one match, list all matches.
8775 "list:full" When more than one match, list all matches and
8776 complete first match.
8777 "list:longest" When more than one match, list all matches and
8778 complete till longest common string.
8779 When there is only a single match, it is fully completed in all cases.
8780
8781 Examples: >
8782 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008783< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008784 :set wildmode=longest,full
8785< Complete longest common string, then each full match >
8786 :set wildmode=list:full
8787< List all matches and complete each full match >
8788 :set wildmode=list,full
8789< List all matches without completing, then each full match >
8790 :set wildmode=longest,list
8791< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008792 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008793
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008794 *'wildoptions'* *'wop'*
8795'wildoptions' 'wop' string (default "")
8796 global
8797 {not in Vi}
8798 {not available when compiled without the |+wildignore|
8799 feature}
8800 A list of words that change how command line completion is done.
8801 Currently only one word is allowed:
8802 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008803 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008804 is displayed per line. Often used tag kinds are:
8805 d #define
8806 f function
8807 Also see |cmdline-completion|.
8808
Bram Moolenaar071d4272004-06-13 20:20:40 +00008809 *'winaltkeys'* *'wak'*
8810'winaltkeys' 'wak' string (default "menu")
8811 global
8812 {not in Vi}
8813 {only used in Win32, Motif, GTK and Photon GUI}
8814 Some GUI versions allow the access to menu entries by using the ALT
8815 key in combination with a character that appears underlined in the
8816 menu. This conflicts with the use of the ALT key for mappings and
8817 entering special characters. This option tells what to do:
8818 no Don't use ALT keys for menus. ALT key combinations can be
8819 mapped, but there is no automatic handling. This can then be
8820 done with the |:simalt| command.
8821 yes ALT key handling is done by the windowing system. ALT key
8822 combinations cannot be mapped.
8823 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008824 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008825 keys can be mapped.
8826 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8827 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008828 This option is not used for <F10>; on Win32 and with GTK <F10> will
8829 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008830
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008831 *'window'* *'wi'*
8832'window' 'wi' number (default screen height - 1)
8833 global
8834 Window height. Do not confuse this with the height of the Vim window,
8835 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008836 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8837 value is smaller than 'lines' minus one. The screen will scroll
8838 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008839 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8840 in a much smarter way, taking care of wrapping lines.
8841 When resizing the Vim window, the value is smaller than 1 or more than
8842 or equal to 'lines' it will be set to 'lines' minus 1.
8843 {Vi also uses the option to specify the number of displayed lines}
8844
Bram Moolenaar071d4272004-06-13 20:20:40 +00008845 *'winheight'* *'wh'* *E591*
8846'winheight' 'wh' number (default 1)
8847 global
8848 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008849 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850 feature}
8851 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008852 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008853 focus goes to a window that is smaller, its size is increased, at the
8854 cost of the height of other windows.
8855 Set 'winheight' to a small number for normal editing.
8856 Set it to 999 to make the current window fill most of the screen.
8857 Other windows will be only 'winminheight' high. This has the drawback
8858 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8859 to create only two windows, set the option after startup is done,
8860 using the |VimEnter| event: >
8861 au VimEnter * set winheight=999
8862< Minimum value is 1.
8863 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008864 height of the current window.
8865 'winheight' applies to the current window. Use 'winminheight' to set
8866 the minimal height for other windows.
8867
8868 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8869'winfixheight' 'wfh' boolean (default off)
8870 local to window
8871 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008872 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 feature}
8874 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008875 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8876 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008877 The height may be changed anyway when running out of room.
8878
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008879 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8880'winfixwidth' 'wfw' boolean (default off)
8881 local to window
8882 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008883 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008884 feature}
8885 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008886 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008887 The width may be changed anyway when running out of room.
8888
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 *'winminheight'* *'wmh'*
8890'winminheight' 'wmh' number (default 1)
8891 global
8892 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008893 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008894 feature}
8895 The minimal height of a window, when it's not the current window.
8896 This is a hard minimum, windows will never become smaller.
8897 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8898 status bar) if necessary. They will return to at least one line when
8899 they become active (since the cursor has to have somewhere to go.)
8900 Use 'winheight' to set the minimal height of the current window.
8901 This option is only checked when making a window smaller. Don't use a
8902 large number, it will cause errors when opening more than a few
8903 windows. A value of 0 to 3 is reasonable.
8904
8905 *'winminwidth'* *'wmw'*
8906'winminwidth' 'wmw' number (default 1)
8907 global
8908 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008909 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008910 feature}
8911 The minimal width of a window, when it's not the current window.
8912 This is a hard minimum, windows will never become smaller.
8913 When set to zero, windows may be "squashed" to zero columns (i.e. just
8914 a vertical separator) if necessary. They will return to at least one
8915 line when they become active (since the cursor has to have somewhere
8916 to go.)
8917 Use 'winwidth' to set the minimal width of the current window.
8918 This option is only checked when making a window smaller. Don't use a
8919 large number, it will cause errors when opening more than a few
8920 windows. A value of 0 to 12 is reasonable.
8921
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008922 *'winptydll'*
8923'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8924 global
8925 {not in Vi}
8926 {only available when compiled with the |terminal|
8927 feature on MS-Windows}
8928 Specifies the name of the winpty shared library, used for the
8929 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008930 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008931 a fallback.
8932 Environment variables are expanded |:set_env|.
8933 This option cannot be set from a |modeline| or in the |sandbox|, for
8934 security reasons.
8935
Bram Moolenaar071d4272004-06-13 20:20:40 +00008936 *'winwidth'* *'wiw'* *E592*
8937'winwidth' 'wiw' number (default 20)
8938 global
8939 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008940 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008941 feature}
8942 Minimal number of columns for the current window. This is not a hard
8943 minimum, Vim will use fewer columns if there is not enough room. If
8944 the current window is smaller, its size is increased, at the cost of
8945 the width of other windows. Set it to 999 to make the current window
8946 always fill the screen. Set it to a small number for normal editing.
8947 The width is not adjusted after one of the commands to change the
8948 width of the current window.
8949 'winwidth' applies to the current window. Use 'winminwidth' to set
8950 the minimal width for other windows.
8951
8952 *'wrap'* *'nowrap'*
8953'wrap' boolean (default on)
8954 local to window
8955 {not in Vi}
8956 This option changes how text is displayed. It doesn't change the text
8957 in the buffer, see 'textwidth' for that.
8958 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008959 displaying continues on the next line. When off lines will not wrap
8960 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008961 moved to a part that is not shown, the screen will scroll
8962 horizontally.
8963 The line will be broken in the middle of a word if necessary. See
8964 'linebreak' to get the break at a word boundary.
8965 To make scrolling horizontally a bit more useful, try this: >
8966 :set sidescroll=5
8967 :set listchars+=precedes:<,extends:>
8968< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008969 This option can't be set from a |modeline| when the 'diff' option is
8970 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008971
8972 *'wrapmargin'* *'wm'*
8973'wrapmargin' 'wm' number (default 0)
8974 local to buffer
8975 Number of characters from the right window border where wrapping
8976 starts. When typing text beyond this limit, an <EOL> will be inserted
8977 and inserting continues on the next line.
8978 Options that add a margin, such as 'number' and 'foldcolumn', cause
8979 the text width to be further reduced. This is Vi compatible.
8980 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008981 This option is set to 0 when 'paste' is set and restored when 'paste'
8982 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008983 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8984 and less usefully}
8985
8986 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8987'wrapscan' 'ws' boolean (default on) *E384* *E385*
8988 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008989 Searches wrap around the end of the file. Also applies to |]s| and
8990 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008991
8992 *'write'* *'nowrite'*
8993'write' boolean (default on)
8994 global
8995 {not in Vi}
8996 Allows writing files. When not set, writing a file is not allowed.
8997 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008998 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008999 argument. Filtering text is still possible, even though this requires
9000 writing a temporary file.
9001
9002 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
9003'writeany' 'wa' boolean (default off)
9004 global
9005 Allows writing to any file with no need for "!" override.
9006
9007 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
9008'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
9009 otherwise)
9010 global
9011 {not in Vi}
9012 Make a backup before overwriting a file. The backup is removed after
9013 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02009014 also on.
9015 WARNING: Switching this option off means that when Vim fails to write
9016 your buffer correctly and then, for whatever reason, Vim exits, you
9017 lose both the original file and what you were writing. Only reset
9018 this option if your file system is almost full and it makes the write
9019 fail (and make sure not to exit Vim until the write was successful).
9020 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00009021 When the 'backupskip' pattern matches, a backup is not made anyway.
9022 NOTE: This option is set to the default value when 'compatible' is
9023 set.
9024
9025 *'writedelay'* *'wd'*
9026'writedelay' 'wd' number (default 0)
9027 global
9028 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02009029 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00009030 screen. When non-zero, characters are sent to the terminal one by
9031 one. For MS-DOS pcterm this does not work. For debugging purposes.
9032
9033 vim:tw=78:ts=8:ft=help:norl: