blob: b5e5847ada734a816e762078b2aad06105785fb1 [file] [log] [blame]
Bram Moolenaar37c64c72017-09-19 22:06:03 +02001*options.txt* For Vim version 8.0. Last change: 2017 Sep 16
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
889 be found in |v:termrgbresp|.
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 Moolenaar071d4272004-06-13 20:20:40 +00001130 Switch on the |balloon-eval| functionality.
1131
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 *'balloonexpr'* *'bexpr'*
1133'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001134 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001135 {not in Vi}
1136 {only available when compiled with the |+balloon_eval|
1137 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001138 Expression for text to show in evaluation balloon. It is only used
1139 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140
1141 v:beval_bufnr number of the buffer in which balloon is going to show
1142 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001143 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 v:beval_lnum line number
1145 v:beval_col column number (byte index)
1146 v:beval_text word under or after the mouse pointer
1147
1148 The evaluation of the expression must not have side effects!
1149 Example: >
1150 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001151 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001152 \', column ' . v:beval_col .
1153 \ ' of file ' . bufname(v:beval_bufnr) .
1154 \ ' on word "' . v:beval_text . '"'
1155 endfunction
1156 set bexpr=MyBalloonExpr()
1157 set ballooneval
1158<
Bram Moolenaar214641f2017-03-05 17:04:09 +01001159 Also see |balloon_show()|, can be used if the content of the balloon
1160 is to be fetched asynchronously.
1161
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001162 NOTE: The balloon is displayed only if the cursor is on a text
1163 character. If the result of evaluating 'balloonexpr' is not empty,
1164 Vim does not try to send a message to an external debugger (Netbeans
1165 or Sun Workshop).
1166
Bram Moolenaar30b65812012-07-12 22:01:11 +02001167 The expression will be evaluated in the |sandbox| when set from a
1168 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001169
1170 It is not allowed to change text or jump to another window while
1171 evaluating 'balloonexpr' |textlock|.
1172
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001173 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001174 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001175< When they are supported "\n" characters will start a new line. If the
1176 expression evaluates to a |List| this is equal to using each List item
1177 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001178 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001179
Bram Moolenaar165bc692015-07-21 17:53:25 +02001180 *'belloff'* *'bo'*
1181'belloff' 'bo' string (default "")
1182 global
1183 {not in Vi}
1184 Specifies for which events the bell will not be rung. It is a comma
1185 separated list of items. For each item that is present, the bell
1186 will be silenced. This is most useful to specify specific events in
1187 insert mode to be silenced.
1188
1189 item meaning when present ~
1190 all All events.
1191 backspace When hitting <BS> or <Del> and deleting results in an
1192 error.
1193 cursor Fail to move around using the cursor keys or
1194 <PageUp>/<PageDown> in |Insert-mode|.
1195 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1196 |i_CTRL-X_CTRL-T|.
1197 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1198 |i_CTRL-E|.
1199 ctrlg Unknown Char after <C-G> in Insert mode.
1200 error Other Error occurred (e.g. try to join last line)
1201 (mostly used in |Normal-mode| or |Cmdline-mode|).
1202 esc hitting <Esc> in |Normal-mode|.
1203 ex In |Visual-mode|, hitting |Q| results in an error.
1204 hangul Error occurred when using hangul input.
1205 insertmode Pressing <Esc> in 'insertmode'.
1206 lang Calling the beep module for Lua/Mzscheme/TCL.
1207 mess No output available for |g<|.
1208 showmatch Error occurred for 'showmatch' function.
1209 operator Empty region error |cpo-E|.
1210 register Unknown register after <C-R> in |Insert-mode|.
1211 shell Bell from shell output |:!|.
1212 spell Error happened on spell suggest.
1213 wildmode More matches in |cmdline-completion| available
1214 (depends on the 'wildmode' setting).
1215
Bram Moolenaar036986f2017-03-16 17:41:02 +01001216 This is most useful to fine tune when in Insert mode the bell should
1217 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001218 indicate that an error occurred. It can be silenced by adding the
1219 "error" keyword.
1220
Bram Moolenaar071d4272004-06-13 20:20:40 +00001221 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1222'binary' 'bin' boolean (default off)
1223 local to buffer
1224 {not in Vi}
1225 This option should be set before editing a binary file. You can also
1226 use the |-b| Vim argument. When this option is switched on a few
1227 options will be changed (also when it already was on):
1228 'textwidth' will be set to 0
1229 'wrapmargin' will be set to 0
1230 'modeline' will be off
1231 'expandtab' will be off
1232 Also, 'fileformat' and 'fileformats' options will not be used, the
1233 file is read and written like 'fileformat' was "unix" (a single <NL>
1234 separates lines).
1235 The 'fileencoding' and 'fileencodings' options will not be used, the
1236 file is read without conversion.
1237 NOTE: When you start editing a(nother) file while the 'bin' option is
1238 on, settings from autocommands may change the settings again (e.g.,
1239 'textwidth'), causing trouble when editing. You might want to set
1240 'bin' again when the file has been loaded.
1241 The previous values of these options are remembered and restored when
1242 'bin' is switched from on to off. Each buffer has its own set of
1243 saved option values.
1244 To edit a file with 'binary' set you can use the |++bin| argument.
1245 This avoids you have to do ":set bin", which would have effect for all
1246 files you edit.
1247 When writing a file the <EOL> for the last line is only written if
1248 there was one in the original file (normally Vim appends an <EOL> to
1249 the last line if there is none; this would make the file longer). See
1250 the 'endofline' option.
1251
1252 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1253'bioskey' 'biosk' boolean (default on)
1254 global
1255 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001256 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257
1258 *'bomb'* *'nobomb'*
1259'bomb' boolean (default off)
1260 local to buffer
1261 {not in Vi}
1262 {only available when compiled with the |+multi_byte|
1263 feature}
1264 When writing a file and the following conditions are met, a BOM (Byte
1265 Order Mark) is prepended to the file:
1266 - this option is on
1267 - the 'binary' option is off
1268 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1269 endian variants.
1270 Some applications use the BOM to recognize the encoding of the file.
1271 Often used for UCS-2 files on MS-Windows. For other applications it
1272 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001273 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1275 check for the presence of the BOM is done and 'bomb' set accordingly.
1276 Unless 'binary' is set, it is removed from the first line, so that you
1277 don't see it when editing. When you don't change the options, the BOM
1278 will be restored when writing the file.
1279
1280 *'breakat'* *'brk'*
1281'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1282 global
1283 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001284 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 feature}
1286 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001287 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1288 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001290 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001291'breakindent' 'bri' boolean (default off)
1292 local to window
1293 {not in Vi}
1294 {not available when compiled without the |+linebreak|
1295 feature}
1296 Every wrapped line will continue visually indented (same amount of
1297 space as the beginning of that line), thus preserving horizontal blocks
1298 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001299 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001300
1301 *'breakindentopt'* *'briopt'*
1302'breakindentopt' 'briopt' string (default empty)
1303 local to window
1304 {not in Vi}
1305 {not available when compiled without the |+linebreak|
1306 feature}
1307 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001308 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001309 min:{n} Minimum text width that will be kept after
1310 applying 'breakindent', even if the resulting
1311 text should normally be narrower. This prevents
1312 text indented almost to the right window border
1313 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001314 shift:{n} After applying 'breakindent', the wrapped line's
1315 beginning will be shifted by the given number of
1316 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001317 indentation (negative) or emphasizing the line
1318 continuation (positive).
1319 sbr Display the 'showbreak' value before applying the
1320 additional indent.
1321 The default value for min is 20 and shift is 0.
1322
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001324'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001326 {not in Vi} {only for Motif, Athena, GTK, Mac and
1327 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001329 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001330 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 buffer Use the directory of the related buffer.
1332 current Use the current directory.
1333 {path} Use the specified directory
1334
1335 *'bufhidden'* *'bh'*
1336'bufhidden' 'bh' string (default: "")
1337 local to buffer
1338 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option specifies what happens when a buffer is no longer
1340 displayed in a window:
1341 <empty> follow the global 'hidden' option
1342 hide hide the buffer (don't unload it), also when 'hidden'
1343 is not set
1344 unload unload the buffer, also when 'hidden' is set or using
1345 |:hide|
1346 delete delete the buffer from the buffer list, also when
1347 'hidden' is set or using |:hide|, like using
1348 |:bdelete|
1349 wipe wipe out the buffer from the buffer list, also when
1350 'hidden' is set or using |:hide|, like using
1351 |:bwipeout|
1352
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001353 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001354 are lost without a warning. Also, these values may break autocommands
1355 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 This option is used together with 'buftype' and 'swapfile' to specify
1357 special kinds of buffers. See |special-buffers|.
1358
1359 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1360'buflisted' 'bl' boolean (default: on)
1361 local to buffer
1362 {not in Vi}
1363 When this option is set, the buffer shows up in the buffer list. If
1364 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1365 This option is reset by Vim for buffers that are only used to remember
1366 a file name or marks. Vim sets it when starting to edit a buffer.
1367 But not when moving to a buffer with ":buffer".
1368
1369 *'buftype'* *'bt'* *E382*
1370'buftype' 'bt' string (default: "")
1371 local to buffer
1372 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001373 The value of this option specifies the type of a buffer:
1374 <empty> normal buffer
1375 nofile buffer which is not related to a file and will not be
1376 written
1377 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001378 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001379 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001380 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001382 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383 help help buffer (you are not supposed to set this
1384 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001385 terminal buffer for a |terminal| (you are not supposed to set
1386 this manually)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387
1388 This option is used together with 'bufhidden' and 'swapfile' to
1389 specify special kinds of buffers. See |special-buffers|.
1390
1391 Be careful with changing this option, it can have many side effects!
1392
Bram Moolenaar280f1262006-01-30 00:14:18 +00001393 A "quickfix" buffer is only used for the error list and the location
1394 list. This value is set by the |:cwindow| and |:lwindow| commands and
1395 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396
1397 "nofile" and "nowrite" buffers are similar:
1398 both: The buffer is not to be written to disk, ":w" doesn't
1399 work (":w filename" does work though).
1400 both: The buffer is never considered to be |'modified'|.
1401 There is no warning when the changes will be lost, for
1402 example when you quit Vim.
1403 both: A swap file is only created when using too much memory
1404 (when 'swapfile' has been reset there is never a swap
1405 file).
1406 nofile only: The buffer name is fixed, it is not handled like a
1407 file name. It is not modified in response to a |:cd|
1408 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001409 both: When using ":e bufname" and already editing "bufname"
1410 the buffer is made empty and autocommands are
1411 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001412 *E676*
1413 "acwrite" implies that the buffer name is not related to a file, like
1414 "nofile", but it will be written. Thus, in contrast to "nofile" and
1415 "nowrite", ":w" does work and a modified buffer can't be abandoned
1416 without saving. For writing there must be matching |BufWriteCmd|,
1417 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418
1419 *'casemap'* *'cmp'*
1420'casemap' 'cmp' string (default: "internal,keepascii")
1421 global
1422 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001423 {only available when compiled with the |+multi_byte|
1424 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 Specifies details about changing the case of letters. It may contain
1426 these words, separated by a comma:
1427 internal Use internal case mapping functions, the current
1428 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001429 matters when 'encoding' is a Unicode encoding,
1430 "latin1" or "iso-8859-15". When "internal" is
1431 omitted, the towupper() and towlower() system library
1432 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1434 case mapping, the current locale is not effective.
1435 This probably only matters for Turkish.
1436
1437 *'cdpath'* *'cd'* *E344* *E346*
1438'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1439 global
1440 {not in Vi}
1441 {not available when compiled without the
1442 |+file_in_path| feature}
1443 This is a list of directories which will be searched when using the
1444 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001445 for has a relative path, not an absolute part starting with "/", "./"
1446 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 The 'cdpath' option's value has the same form and semantics as
1448 |'path'|. Also see |file-searching|.
1449 The default value is taken from $CDPATH, with a "," prepended to look
1450 in the current directory first.
1451 If the default value taken from $CDPATH is not what you want, include
1452 a modified version of the following command in your vimrc file to
1453 override it: >
1454 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1455< This option cannot be set from a |modeline| or in the |sandbox|, for
1456 security reasons.
1457 (parts of 'cdpath' can be passed to the shell to expand file names).
1458
1459 *'cedit'*
1460'cedit' string (Vi default: "", Vim default: CTRL-F)
1461 global
1462 {not in Vi}
1463 {not available when compiled without the |+vertsplit|
1464 feature}
1465 The key used in Command-line Mode to open the command-line window.
1466 The default is CTRL-F when 'compatible' is off.
1467 Only non-printable keys are allowed.
1468 The key can be specified as a single character, but it is difficult to
1469 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001470 :exe "set cedit=\<C-Y>"
1471 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472< |Nvi| also has this option, but it only uses the first character.
1473 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001474 NOTE: This option is set to the Vim default value when 'compatible'
1475 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476
1477 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1478'charconvert' 'ccv' string (default "")
1479 global
1480 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001481 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 {not in Vi}
1483 An expression that is used for character encoding conversion. It is
1484 evaluated when a file that is to be read or has been written has a
1485 different encoding from what is desired.
1486 'charconvert' is not used when the internal iconv() function is
1487 supported and is able to do the conversion. Using iconv() is
1488 preferred, because it is much faster.
1489 'charconvert' is not used when reading stdin |--|, because there is no
1490 file to convert from. You will have to save the text in a file first.
1491 The expression must return zero or an empty string for success,
1492 non-zero for failure.
1493 The possible encoding names encountered are in 'encoding'.
1494 Additionally, names given in 'fileencodings' and 'fileencoding' are
1495 used.
1496 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1497 is done internally by Vim, 'charconvert' is not used for this.
1498 'charconvert' is also used to convert the viminfo file, if the 'c'
1499 flag is present in 'viminfo'. Also used for Unicode conversion.
1500 Example: >
1501 set charconvert=CharConvert()
1502 fun CharConvert()
1503 system("recode "
1504 \ . v:charconvert_from . ".." . v:charconvert_to
1505 \ . " <" . v:fname_in . " >" v:fname_out)
1506 return v:shell_error
1507 endfun
1508< The related Vim variables are:
1509 v:charconvert_from name of the current encoding
1510 v:charconvert_to name of the desired encoding
1511 v:fname_in name of the input file
1512 v:fname_out name of the output file
1513 Note that v:fname_in and v:fname_out will never be the same.
1514 Note that v:charconvert_from and v:charconvert_to may be different
1515 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1516 Encryption is not done by Vim when using 'charconvert'. If you want
1517 to encrypt the file after conversion, 'charconvert' should take care
1518 of this.
1519 This option cannot be set from a |modeline| or in the |sandbox|, for
1520 security reasons.
1521
1522 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1523'cindent' 'cin' boolean (default off)
1524 local to buffer
1525 {not in Vi}
1526 {not available when compiled without the |+cindent|
1527 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001528 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 that trigger reindenting in insert mode and 'cinoptions' to set your
1530 preferred indent style.
1531 If 'indentexpr' is not empty, it overrules 'cindent'.
1532 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1533 the "=" operator indents using this algorithm rather than calling an
1534 external program.
1535 See |C-indenting|.
1536 When you don't like the way 'cindent' works, try the 'smartindent'
1537 option or 'indentexpr'.
1538 This option is not used when 'paste' is set.
1539 NOTE: This option is reset when 'compatible' is set.
1540
1541 *'cinkeys'* *'cink'*
1542'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1543 local to buffer
1544 {not in Vi}
1545 {not available when compiled without the |+cindent|
1546 feature}
1547 A list of keys that, when typed in Insert mode, cause reindenting of
1548 the current line. Only used if 'cindent' is on and 'indentexpr' is
1549 empty.
1550 For the format of this option see |cinkeys-format|.
1551 See |C-indenting|.
1552
1553 *'cinoptions'* *'cino'*
1554'cinoptions' 'cino' string (default "")
1555 local to buffer
1556 {not in Vi}
1557 {not available when compiled without the |+cindent|
1558 feature}
1559 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1560 program. See |cinoptions-values| for the values of this option, and
1561 |C-indenting| for info on C indenting in general.
1562
1563
1564 *'cinwords'* *'cinw'*
1565'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1566 local to buffer
1567 {not in Vi}
1568 {not available when compiled without both the
1569 |+cindent| and the |+smartindent| features}
1570 These keywords start an extra indent in the next line when
1571 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1572 an appropriate place (inside {}).
1573 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1574 matter, include the keyword both the uppercase and lowercase:
1575 "if,If,IF".
1576
1577 *'clipboard'* *'cb'*
1578'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1579 for X-windows, "" otherwise)
1580 global
1581 {not in Vi}
1582 {only in GUI versions or when the |+xterm_clipboard|
1583 feature is included}
1584 This option is a list of comma separated names.
1585 These names are recognized:
1586
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001587 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 unnamed When included, Vim will use the clipboard register '*'
1589 for all yank, delete, change and put operations which
1590 would normally go to the unnamed register. When a
1591 register is explicitly specified, it will always be
1592 used regardless of whether "unnamed" is in 'clipboard'
1593 or not. The clipboard register can always be
1594 explicitly accessed using the "* notation. Also see
1595 |gui-clipboard|.
1596
Bram Moolenaar30b65812012-07-12 22:01:11 +02001597 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001598 unnamedplus A variant of the "unnamed" flag which uses the
1599 clipboard register '+' (|quoteplus|) instead of
1600 register '*' for all yank, delete, change and put
1601 operations which would normally go to the unnamed
1602 register. When "unnamed" is also included to the
1603 option, yank operations (but not delete, change or
1604 put) will additionally copy the text into register
1605 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001606 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001607 Availability can be checked with: >
1608 if has('unnamedplus')
1609<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001610 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 autoselect Works like the 'a' flag in 'guioptions': If present,
1612 then whenever Visual mode is started, or the Visual
1613 area extended, Vim tries to become the owner of the
1614 windowing system's global selection or put the
1615 selected text on the clipboard used by the selection
1616 register "*. See |guioptions_a| and |quotestar| for
1617 details. When the GUI is active, the 'a' flag in
1618 'guioptions' is used, when the GUI is not active, this
1619 "autoselect" flag is used.
1620 Also applies to the modeless selection.
1621
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001622 *clipboard-autoselectplus*
1623 autoselectplus Like "autoselect" but using the + register instead of
1624 the * register. Compare to the 'P' flag in
1625 'guioptions'.
1626
1627 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 autoselectml Like "autoselect", but for the modeless selection
1629 only. Compare to the 'A' flag in 'guioptions'.
1630
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001631 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001632 html When the clipboard contains HTML, use this when
1633 pasting. When putting text on the clipboard, mark it
1634 as HTML. This works to copy rendered HTML from
1635 Firefox, paste it as raw HTML in Vim, select the HTML
1636 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001637 You probably want to add this only temporarily,
1638 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001639 Only supported for GTK version 2 and later.
1640 Only available with the |+multi_byte| feature.
1641
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001642 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 exclude:{pattern}
1644 Defines a pattern that is matched against the name of
1645 the terminal 'term'. If there is a match, no
1646 connection will be made to the X server. This is
1647 useful in this situation:
1648 - Running Vim in a console.
1649 - $DISPLAY is set to start applications on another
1650 display.
1651 - You do not want to connect to the X server in the
1652 console, but do want this in a terminal emulator.
1653 To never connect to the X server use: >
1654 exclude:.*
1655< This has the same effect as using the |-X| argument.
1656 Note that when there is no connection to the X server
1657 the window title won't be restored and the clipboard
1658 cannot be accessed.
1659 The value of 'magic' is ignored, {pattern} is
1660 interpreted as if 'magic' was on.
1661 The rest of the option value will be used for
1662 {pattern}, this must be the last entry.
1663
1664 *'cmdheight'* *'ch'*
1665'cmdheight' 'ch' number (default 1)
1666 global
1667 {not in Vi}
1668 Number of screen lines to use for the command-line. Helps avoiding
1669 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001670 The value of this option is stored with the tab page, so that each tab
1671 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672
1673 *'cmdwinheight'* *'cwh'*
1674'cmdwinheight' 'cwh' number (default 7)
1675 global
1676 {not in Vi}
1677 {not available when compiled without the |+vertsplit|
1678 feature}
1679 Number of screen lines to use for the command-line window. |cmdwin|
1680
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001681 *'colorcolumn'* *'cc'*
1682'colorcolumn' 'cc' string (default "")
1683 local to window
1684 {not in Vi}
1685 {not available when compiled without the |+syntax|
1686 feature}
1687 'colorcolumn' is a comma separated list of screen columns that are
1688 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1689 text. Will make screen redrawing slower.
1690 The screen column can be an absolute number, or a number preceded with
1691 '+' or '-', which is added to or subtracted from 'textwidth'. >
1692
1693 :set cc=+1 " highlight column after 'textwidth'
1694 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1695 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1696<
1697 When 'textwidth' is zero then the items with '-' and '+' are not used.
1698 A maximum of 256 columns are highlighted.
1699
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 *'columns'* *'co'* *E594*
1701'columns' 'co' number (default 80 or terminal width)
1702 global
1703 {not in Vi}
1704 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001705 initialization and does not have to be set by hand. Also see
1706 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 When Vim is running in the GUI or in a resizable window, setting this
1708 option will cause the window size to be changed. When you only want
1709 to use the size for the GUI, put the command in your |gvimrc| file.
1710 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001711 number of columns of the display, the display may be messed up. For
1712 the GUI it is always possible and Vim limits the number of columns to
1713 what fits on the screen. You can use this command to get the widest
1714 window possible: >
1715 :set columns=9999
1716< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717
1718 *'comments'* *'com'* *E524* *E525*
1719'comments' 'com' string (default
1720 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1721 local to buffer
1722 {not in Vi}
1723 {not available when compiled without the |+comments|
1724 feature}
1725 A comma separated list of strings that can start a comment line. See
1726 |format-comments|. See |option-backslash| about using backslashes to
1727 insert a space.
1728
1729 *'commentstring'* *'cms'* *E537*
1730'commentstring' 'cms' string (default "/*%s*/")
1731 local to buffer
1732 {not in Vi}
1733 {not available when compiled without the |+folding|
1734 feature}
1735 A template for a comment. The "%s" in the value is replaced with the
1736 comment text. Currently only used to add markers for folding, see
1737 |fold-marker|.
1738
1739 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001740'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001741 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 global
1743 {not in Vi}
1744 This option has the effect of making Vim either more Vi-compatible, or
1745 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001748 other options are also changed as a side effect.
1749 NOTE: Setting or resetting this option can have a lot of unexpected
1750 effects: Mappings are interpreted in another way, undo behaves
1751 differently, etc. If you set this option in your vimrc file, you
1752 should probably put it at the very start.
1753
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 By default this option is on and the Vi defaults are used for the
1755 options. This default was chosen for those people who want to use Vim
1756 just like Vi, and don't even (want to) know about the 'compatible'
1757 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001758 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001759 this option is switched off, and all options that have not been
1760 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001761 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001762 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001763 happen for the system-wide vimrc or gvimrc file, nor for a file given
1764 with the |-u| argument). Also see |compatible-default| and
1765 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 You can also set this option with the "-C" argument, and reset it with
1767 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001768 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769
Bram Moolenaar214641f2017-03-05 17:04:09 +01001770 When this option is set, numerous other options are set to make Vim as
1771 Vi-compatible as possible. When this option is unset, various options
1772 are set to make Vim more useful. The table below lists all the
1773 options affected.
1774 The {?} column indicates when the options are affected:
1775 + Means that the option is set to the value given in {set value} when
1776 'compatible' is set.
1777 & Means that the option is set to the value given in {set value} when
1778 'compatible' is set AND is set to its Vim default value when
1779 'compatible' is unset.
1780 - Means the option is NOT changed when setting 'compatible' but IS
1781 set to its Vim default when 'compatible' is unset.
1782 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001783
Bram Moolenaar036986f2017-03-16 17:41:02 +01001784 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785
1786 'allowrevins' + off no CTRL-_ command
1787 'antialias' + off don't use antialiased fonts
1788 'arabic' + off reset arabic-related options
1789 'arabicshape' + on correct character shapes
1790 'backspace' + "" normal backspace
1791 'backup' + off no backup file
1792 'backupcopy' & Unix: "yes" backup file is a copy
1793 else: "auto" copy or rename backup file
1794 'balloonexpr' + "" text to show in evaluation balloon
1795 'breakindent' + off don't indent when wrapping lines
1796 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1797 'cindent' + off no C code indentation
1798 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1799 'copyindent' + off don't copy indent structure
1800 'cpoptions' & (all flags) Vi-compatible flags
1801 'cscopepathcomp'+ 0 don't show directories in tags list
1802 'cscoperelative'+ off
1803 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001804 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001805 'cscopeverbose' + off see |cscopeverbose|
1806 'delcombine' + off unicode: delete whole char combination
1807 'digraph' + off no digraphs
1808 'esckeys' & off no <Esc>-keys in Insert mode
1809 'expandtab' + off tabs not expanded to spaces
1810 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001812 'formatexpr' + "" use 'formatprg' for auto-formatting
1813 'formatoptions' & "vt" Vi compatible formatting
1814 'gdefault' + off no default 'g' flag for ":s"
1815 'history' & 0 no commandline history
1816 'hkmap' + off no Hebrew keyboard mapping
1817 'hkmapp' + off no phonetic Hebrew keyboard mapping
1818 'hlsearch' + off no highlighting of search matches
1819 'incsearch' + off no incremental searching
1820 'indentexpr' + "" no indenting by expression
1821 'insertmode' + off do not start in Insert mode
1822 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001824 'joinspaces' + on insert 2 spaces after period
1825 'modeline' & off no modelines
1826 'more' & off no pauses in listings
1827 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1828 'numberwidth' & 8 min number of columns for line number
1829 'preserveindent'+ off don't preserve current indent structure
1830 when changing it
1831 'revins' + off no reverse insert
1832 'ruler' + off no ruler
1833 'scrolljump' + 1 no jump scroll
1834 'scrolloff' + 0 no scroll offset
1835 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1836 'shiftround' + off indent not rounded to shiftwidth
1837 'shortmess' & "" no shortening of messages
1838 'showcmd' & off command characters not shown
1839 'showmode' & off current mode not shown
1840 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1841 'smartcase' + off no automatic ignore case switch
1842 'smartindent' + off no smart indentation
1843 'smarttab' + off no smart tab size
1844 'softtabstop' + 0 tabs are always 'tabstop' positions
1845 'startofline' + on goto startofline with some commands
1846 'tagcase' & "followic" 'ignorecase' when searching tags file
1847 'tagrelative' & off tag file names are not relative
1848 'termguicolors' + off don't use highlight-(guifg|guibg)
1849 'textauto' & off no automatic textmode detection
1850 'textwidth' + 0 no automatic line wrap
1851 'tildeop' + off tilde is not an operator
1852 'ttimeout' + off no terminal timeout
1853 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001854 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001855 'virtualedit' + "" cursor can only be placed on characters
1856 'whichwrap' & "" left-right movements don't wrap
1857 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001859 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860
1861 *'complete'* *'cpt'* *E535*
1862'complete' 'cpt' string (default: ".,w,b,u,t,i")
1863 local to buffer
1864 {not in Vi}
1865 This option specifies how keyword completion |ins-completion| works
1866 when CTRL-P or CTRL-N are used. It is also used for whole-line
1867 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1868 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001869 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 w scan buffers from other windows
1871 b scan other loaded buffers that are in the buffer list
1872 u scan the unloaded buffers that are in the buffer list
1873 U scan the buffers that are not in the buffer list
1874 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001875 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 k{dict} scan the file {dict}. Several "k" flags can be given,
1877 patterns are valid too. For example: >
1878 :set cpt=k/usr/dict/*,k~/spanish
1879< s scan the files given with the 'thesaurus' option
1880 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1881 are valid too.
1882 i scan current and included files
1883 d scan current and included files for defined name or macro
1884 |i_CTRL-X_CTRL-D|
1885 ] tag completion
1886 t same as "]"
1887
1888 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1889 not executed, this may lead to unexpected completions from some files
1890 (gzipped files for example). Unloaded buffers are not scanned for
1891 whole-line completion.
1892
1893 The default is ".,w,b,u,t,i", which means to scan:
1894 1. the current buffer
1895 2. buffers in other windows
1896 3. other loaded buffers
1897 4. unloaded buffers
1898 5. tags
1899 6. included files
1900
1901 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001902 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1903 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001905 *'completefunc'* *'cfu'*
1906'completefunc' 'cfu' string (default: empty)
1907 local to buffer
1908 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001909 {not available when compiled without the |+eval|
1910 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001911 This option specifies a function to be used for Insert mode completion
1912 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001913 See |complete-functions| for an explanation of how the function is
1914 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001915 This option cannot be set from a |modeline| or in the |sandbox|, for
1916 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001917
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001918 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001919'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001920 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001921 {not available when compiled without the
1922 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001923 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001924 A comma separated list of options for Insert mode completion
1925 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001926
1927 menu Use a popup menu to show the possible completions. The
1928 menu is only shown when there is more than one match and
1929 sufficient colors are available. |ins-completion-menu|
1930
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001931 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001932 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001933 match, e.g., what file it comes from.
1934
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001935 longest Only insert the longest common text of the matches. If
1936 the menu is displayed you can use CTRL-L to add more
1937 characters. Whether case is ignored depends on the kind
1938 of completion. For buffer text the 'ignorecase' option is
1939 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001940
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001941 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001942 completion in the preview window. Only works in
1943 combination with "menu" or "menuone".
1944
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001945 noinsert Do not insert any text for a match until the user selects
1946 a match from the menu. Only works in combination with
1947 "menu" or "menuone". No effect if "longest" is present.
1948
1949 noselect Do not select a match in the menu, force the user to
1950 select one from the menu. Only works in combination with
1951 "menu" or "menuone".
1952
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001953
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001954 *'concealcursor'* *'cocu'*
1955'concealcursor' 'cocu' string (default: "")
1956 local to window
1957 {not in Vi}
1958 {not available when compiled without the |+conceal|
1959 feature}
1960 Sets the modes in which text in the cursor line can also be concealed.
1961 When the current mode is listed then concealing happens just like in
1962 other lines.
1963 n Normal mode
1964 v Visual mode
1965 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001966 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001967
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001968 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001969 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001970 are moving around text is concealed, but when starting to insert text
1971 or selecting a Visual area the concealed text is displayed, so that
1972 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001973 Keep in mind that the cursor position is not always where it's
1974 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001975
1976
1977'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978 number (default 0)
1979 local to window
1980 {not in Vi}
1981 {not available when compiled without the |+conceal|
1982 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001983 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1984 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001985
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001986 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001988 1 Each block of concealed text is replaced with one
1989 character. If the syntax item does not have a custom
1990 replacement character defined (see |:syn-cchar|) the
1991 character defined in 'listchars' is used (default is a
1992 space).
1993 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001994 2 Concealed text is completely hidden unless it has a
1995 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001996 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001997 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001998
Bram Moolenaara7781e02010-07-19 20:13:22 +02001999 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02002000 edit and copy the text. This can be changed with the 'concealcursor'
2001 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002002
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
2004'confirm' 'cf' boolean (default off)
2005 global
2006 {not in Vi}
2007 When 'confirm' is on, certain operations that would normally
2008 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2009 instead raise a |dialog| asking if you wish to save the current
2010 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2011 If 'confirm' is off you can still activate confirmation for one
2012 command only (this is most useful in mappings) with the |:confirm|
2013 command.
2014 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2015
2016 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2017'conskey' 'consk' boolean (default off)
2018 global
2019 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01002020 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
2022 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2023'copyindent' 'ci' boolean (default off)
2024 local to buffer
2025 {not in Vi}
2026 Copy the structure of the existing lines indent when autoindenting a
2027 new line. Normally the new indent is reconstructed by a series of
2028 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2029 in which case only spaces are used). Enabling this option makes the
2030 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002031 existing line. 'expandtab' has no effect on these characters, a Tab
2032 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002034 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 Also see 'preserveindent'.
2036
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002037 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038'cpoptions' 'cpo' string (Vim default: "aABceFs",
2039 Vi default: all flags)
2040 global
2041 {not in Vi}
2042 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002043 this indicates Vi-compatible behavior. This is used for things where
2044 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 'cpoptions' stands for "compatible-options".
2046 Commas can be added for readability.
2047 To avoid problems with flags that are added in the future, use the
2048 "+=" and "-=" feature of ":set" |add-option-flags|.
2049 NOTE: This option is set to the Vi default value when 'compatible' is
2050 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002051 NOTE: This option is set to the POSIX default value at startup when
2052 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002053 variable exists |posix|. This means Vim tries to behave like the
2054 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055
2056 contains behavior ~
2057 *cpo-a*
2058 a When included, a ":read" command with a file name
2059 argument will set the alternate file name for the
2060 current window.
2061 *cpo-A*
2062 A When included, a ":write" command with a file name
2063 argument will set the alternate file name for the
2064 current window.
2065 *cpo-b*
2066 b "\|" in a ":map" command is recognized as the end of
2067 the map command. The '\' is included in the mapping,
2068 the text after the '|' is interpreted as the next
2069 command. Use a CTRL-V instead of a backslash to
2070 include the '|' in the mapping. Applies to all
2071 mapping, abbreviation, menu and autocmd commands.
2072 See also |map_bar|.
2073 *cpo-B*
2074 B A backslash has no special meaning in mappings,
2075 abbreviations and the "to" part of the menu commands.
2076 Remove this flag to be able to use a backslash like a
2077 CTRL-V. For example, the command ":map X \<Esc>"
2078 results in X being mapped to:
2079 'B' included: "\^[" (^[ is a real <Esc>)
2080 'B' excluded: "<Esc>" (5 characters)
2081 ('<' excluded in both cases)
2082 *cpo-c*
2083 c Searching continues at the end of any match at the
2084 cursor position, but not further than the start of the
2085 next line. When not present searching continues
2086 one character from the cursor position. With 'c'
2087 "abababababab" only gets three matches when repeating
2088 "/abab", without 'c' there are five matches.
2089 *cpo-C*
2090 C Do not concatenate sourced lines that start with a
2091 backslash. See |line-continuation|.
2092 *cpo-d*
2093 d Using "./" in the 'tags' option doesn't mean to use
2094 the tags file relative to the current file, but the
2095 tags file in the current directory.
2096 *cpo-D*
2097 D Can't use CTRL-K to enter a digraph after Normal mode
2098 commands with a character argument, like |r|, |f| and
2099 |t|.
2100 *cpo-e*
2101 e When executing a register with ":@r", always add a
2102 <CR> to the last line, also when the register is not
2103 linewise. If this flag is not present, the register
2104 is not linewise and the last line does not end in a
2105 <CR>, then the last line is put on the command-line
2106 and can be edited before hitting <CR>.
2107 *cpo-E*
2108 E It is an error when using "y", "d", "c", "g~", "gu" or
2109 "gU" on an Empty region. The operators only work when
2110 at least one character is to be operate on. Example:
2111 This makes "y0" fail in the first column.
2112 *cpo-f*
2113 f When included, a ":read" command with a file name
2114 argument will set the file name for the current buffer,
2115 if the current buffer doesn't have a file name yet.
2116 *cpo-F*
2117 F When included, a ":write" command with a file name
2118 argument will set the file name for the current
2119 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002120 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 *cpo-g*
2122 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002123 *cpo-H*
2124 H When using "I" on a line with only blanks, insert
2125 before the last blank. Without this flag insert after
2126 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *cpo-i*
2128 i When included, interrupting the reading of a file will
2129 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002130 *cpo-I*
2131 I When moving the cursor up or down just after inserting
2132 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-j*
2134 j When joining lines, only add two spaces after a '.',
2135 not after '!' or '?'. Also see 'joinspaces'.
2136 *cpo-J*
2137 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002138 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 white space.
2140 *cpo-k*
2141 k Disable the recognition of raw key codes in
2142 mappings, abbreviations, and the "to" part of menu
2143 commands. For example, if <Key> sends ^[OA (where ^[
2144 is <Esc>), the command ":map X ^[OA" results in X
2145 being mapped to:
2146 'k' included: "^[OA" (3 characters)
2147 'k' excluded: "<Key>" (one key code)
2148 Also see the '<' flag below.
2149 *cpo-K*
2150 K Don't wait for a key code to complete when it is
2151 halfway a mapping. This breaks mapping <F1><F1> when
2152 only part of the second <F1> has been read. It
2153 enables cancelling the mapping by typing <F1><Esc>.
2154 *cpo-l*
2155 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002156 literally, only "\]", "\^", "\-" and "\\" are special.
2157 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2159 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002160 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 *cpo-L*
2162 L When the 'list' option is set, 'wrapmargin',
2163 'textwidth', 'softtabstop' and Virtual Replace mode
2164 (see |gR|) count a <Tab> as two characters, instead of
2165 the normal behavior of a <Tab>.
2166 *cpo-m*
2167 m When included, a showmatch will always wait half a
2168 second. When not included, a showmatch will wait half
2169 a second or until a character is typed. |'showmatch'|
2170 *cpo-M*
2171 M When excluded, "%" matching will take backslashes into
2172 account. Thus in "( \( )" and "\( ( \)" the outer
2173 parenthesis match. When included "%" ignores
2174 backslashes, which is Vi compatible.
2175 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002176 n When included, the column used for 'number' and
2177 'relativenumber' will also be used for text of wrapped
2178 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 *cpo-o*
2180 o Line offset to search command is not remembered for
2181 next search.
2182 *cpo-O*
2183 O Don't complain if a file is being overwritten, even
2184 when it didn't exist when editing it. This is a
2185 protection against a file unexpectedly created by
2186 someone else. Vi didn't complain about this.
2187 *cpo-p*
2188 p Vi compatible Lisp indenting. When not present, a
2189 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002190 *cpo-P*
2191 P When included, a ":write" command that appends to a
2192 file will set the file name for the current buffer, if
2193 the current buffer doesn't have a file name yet and
2194 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002195 *cpo-q*
2196 q When joining multiple lines leave the cursor at the
2197 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 *cpo-r*
2199 r Redo ("." command) uses "/" to repeat a search
2200 command, instead of the actually used search string.
2201 *cpo-R*
2202 R Remove marks from filtered lines. Without this flag
2203 marks are kept like |:keepmarks| was used.
2204 *cpo-s*
2205 s Set buffer options when entering the buffer for the
2206 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002207 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 set when the buffer is created.
2209 *cpo-S*
2210 S Set buffer options always when entering a buffer
2211 (except 'readonly', 'fileformat', 'filetype' and
2212 'syntax'). This is the (most) Vi compatible setting.
2213 The options are set to the values in the current
2214 buffer. When you change an option and go to another
2215 buffer, the value is copied. Effectively makes the
2216 buffer options global to all buffers.
2217
2218 's' 'S' copy buffer options
2219 no no when buffer created
2220 yes no when buffer first entered (default)
2221 X yes each time when buffer entered (vi comp.)
2222 *cpo-t*
2223 t Search pattern for the tag command is remembered for
2224 "n" command. Otherwise Vim only puts the pattern in
2225 the history for search pattern, but doesn't change the
2226 last used search pattern.
2227 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002228 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 *cpo-v*
2230 v Backspaced characters remain visible on the screen in
2231 Insert mode. Without this flag the characters are
2232 erased from the screen right away. With this flag the
2233 screen newly typed text overwrites backspaced
2234 characters.
2235 *cpo-w*
2236 w When using "cw" on a blank character, only change one
2237 character and not all blanks until the start of the
2238 next word.
2239 *cpo-W*
2240 W Don't overwrite a readonly file. When omitted, ":w!"
2241 overwrites a readonly file, if possible.
2242 *cpo-x*
2243 x <Esc> on the command-line executes the command-line.
2244 The default in Vim is to abandon the command-line,
2245 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002246 *cpo-X*
2247 X When using a count with "R" the replaced text is
2248 deleted only once. Also when repeating "R" with "."
2249 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *cpo-y*
2251 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002252 *cpo-Z*
2253 Z When using "w!" while the 'readonly' option is set,
2254 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 *cpo-!*
2256 ! When redoing a filter command, use the last used
2257 external command, whatever it was. Otherwise the last
2258 used -filter- command is used.
2259 *cpo-$*
2260 $ When making a change to one line, don't redisplay the
2261 line, but put a '$' at the end of the changed text.
2262 The changed text will be overwritten when you type the
2263 new text. The line is redisplayed if you type any
2264 command that moves the cursor from the insertion
2265 point.
2266 *cpo-%*
2267 % Vi-compatible matching is done for the "%" command.
2268 Does not recognize "#if", "#endif", etc.
2269 Does not recognize "/*" and "*/".
2270 Parens inside single and double quotes are also
2271 counted, causing a string that contains a paren to
2272 disturb the matching. For example, in a line like
2273 "if (strcmp("foo(", s))" the first paren does not
2274 match the last one. When this flag is not included,
2275 parens inside single and double quotes are treated
2276 specially. When matching a paren outside of quotes,
2277 everything inside quotes is ignored. When matching a
2278 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002279 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002280 This flag is also used for other features, such as
2281 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002282 *cpo--*
2283 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002284 it would go above the first line or below the last
2285 line. Without it the cursor moves to the first or
2286 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002287 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002288 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002289 *cpo-+*
2290 + When included, a ":write file" command will reset the
2291 'modified' flag of the buffer, even though the buffer
2292 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002293 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 * Use ":*" in the same way as ":@". When not included,
2295 ":*" is an alias for ":'<,'>", select the Visual area.
2296 *cpo-<*
2297 < Disable the recognition of special key codes in |<>|
2298 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002299 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 ":map X <Tab>" results in X being mapped to:
2301 '<' included: "<Tab>" (5 characters)
2302 '<' excluded: "^I" (^I is a real <Tab>)
2303 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002304 *cpo->*
2305 > When appending to a register, put a line break before
2306 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002307 *cpo-;*
2308 ; When using |,| or |;| to repeat the last |t| search
2309 and the cursor is right in front of the searched
2310 character, the cursor won't move. When not included,
2311 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002312 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002313
2314 POSIX flags. These are not included in the Vi default value, except
2315 when $VIM_POSIX was set on startup. |posix|
2316
2317 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002318 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002319 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002320 *cpo-&*
2321 & When ":preserve" was used keep the swap file when
2322 exiting normally while this buffer is still loaded.
2323 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002324 *cpo-\*
2325 \ Backslash in a [] range in a search pattern is taken
2326 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002327 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2328 '\' excluded: "/[ \-]" finds <Space> and '-'
2329 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002330 *cpo-/*
2331 / When "%" is used as the replacement string in a |:s|
2332 command, use the previous replacement string. |:s%|
2333 *cpo-{*
2334 { The |{| and |}| commands also stop at a "{" character
2335 at the start of a line.
2336 *cpo-.*
2337 . The ":chdir" and ":cd" commands fail if the current
2338 buffer is modified, unless ! is used. Vim doesn't
2339 need this, since it remembers the full path of an
2340 opened file.
2341 *cpo-bar*
2342 | The value of the $LINES and $COLUMNS environment
2343 variables overrule the terminal size values obtained
2344 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002345
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002347 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002348'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002349 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002350 {not in Vi}
2351 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002352 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002353 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002354 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002355 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002356 blowfish Blowfish method. Medium strong encryption but it has
2357 an implementation flaw. Requires Vim 7.3 or later,
2358 files can NOT be read by Vim 7.2 and older. This adds
2359 a "seed" to the file, every time you write the file
2360 the encrypted bytes will be different.
2361 *blowfish2*
2362 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002363 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002364 and older. This adds a "seed" to the file, every time
2365 you write the file the encrypted bytes will be
2366 different. The whole undo file is encrypted, not just
2367 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002368
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002369 You should use "blowfish2", also to re-encrypt older files.
2370
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002371 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002372 to the detected method of the file being read. Thus if you write it
2373 without changing 'cryptmethod' the same method will be used.
2374 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002375 explicitly write it, you don't get a warning unless there are other
2376 modifications. Also see |:X|.
2377
2378 When setting the global value to an empty string, it will end up with
2379 the value "zip". When setting the local value to an empty string the
2380 buffer will use the global value.
2381
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002382 When a new encryption method is added in a later version of Vim, and
2383 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002384 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002385
2386
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 *'cscopepathcomp'* *'cspc'*
2388'cscopepathcomp' 'cspc' number (default 0)
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
2392 {not in Vi}
2393 Determines how many components of the path to show in a list of tags.
2394 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002395 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396
2397 *'cscopeprg'* *'csprg'*
2398'cscopeprg' 'csprg' string (default "cscope")
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
2402 {not in Vi}
2403 Specifies the command to execute cscope. See |cscopeprg|.
2404 This option cannot be set from a |modeline| or in the |sandbox|, for
2405 security reasons.
2406
2407 *'cscopequickfix'* *'csqf'*
2408'cscopequickfix' 'csqf' string (default "")
2409 global
2410 {not available when compiled without the |+cscope|
2411 or |+quickfix| features}
2412 {not in Vi}
2413 Specifies whether to use quickfix window to show cscope results.
2414 See |cscopequickfix|.
2415
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002416 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002417'cscoperelative' 'csre' boolean (default off)
2418 global
2419 {not available when compiled without the |+cscope|
2420 feature}
2421 {not in Vi}
2422 In the absence of a prefix (-P) for cscope. setting this option enables
2423 to use the basename of cscope.out path as the prefix.
2424 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002425 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002426
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2428'cscopetag' 'cst' boolean (default off)
2429 global
2430 {not available when compiled without the |+cscope|
2431 feature}
2432 {not in Vi}
2433 Use cscope for tag commands. See |cscope-options|.
2434 NOTE: This option is reset when 'compatible' is set.
2435
2436 *'cscopetagorder'* *'csto'*
2437'cscopetagorder' 'csto' number (default 0)
2438 global
2439 {not available when compiled without the |+cscope|
2440 feature}
2441 {not in Vi}
2442 Determines the order in which ":cstag" performs a search. See
2443 |cscopetagorder|.
2444 NOTE: This option is set to 0 when 'compatible' is set.
2445
2446 *'cscopeverbose'* *'csverb'*
2447 *'nocscopeverbose'* *'nocsverb'*
2448'cscopeverbose' 'csverb' boolean (default off)
2449 global
2450 {not available when compiled without the |+cscope|
2451 feature}
2452 {not in Vi}
2453 Give messages when adding a cscope database. See |cscopeverbose|.
2454 NOTE: This option is reset when 'compatible' is set.
2455
Bram Moolenaar860cae12010-06-05 23:22:07 +02002456 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2457'cursorbind' 'crb' boolean (default off)
2458 local to window
2459 {not in Vi}
2460 {not available when compiled without the |+cursorbind|
2461 feature}
2462 When this option is set, as the cursor in the current
2463 window moves other cursorbound windows (windows that also have
2464 this option set) move their cursors to the corresponding line and
2465 column. This option is useful for viewing the
2466 differences between two versions of a file (see 'diff'); in diff mode,
2467 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002468 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002469
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470
2471 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2472'cursorcolumn' 'cuc' boolean (default off)
2473 local to window
2474 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002475 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002476 feature}
2477 Highlight the screen column of the cursor with CursorColumn
2478 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2479 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002480 If you only want the highlighting in the current window you can use
2481 these autocommands: >
2482 au WinLeave * set nocursorline nocursorcolumn
2483 au WinEnter * set cursorline cursorcolumn
2484<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002485
2486 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2487'cursorline' 'cul' boolean (default off)
2488 local to window
2489 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002490 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002491 feature}
2492 Highlight the screen line of the cursor with CursorLine
2493 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2494 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002495 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002496 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002497
2498
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 *'debug'*
2500'debug' string (default "")
2501 global
2502 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002503 These values can be used:
2504 msg Error messages that would otherwise be omitted will be given
2505 anyway.
2506 throw Error messages that would otherwise be omitted will be given
2507 anyway and also throw an exception and set |v:errmsg|.
2508 beep A message will be given when otherwise only a beep would be
2509 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002510 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002511 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2512 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513
2514 *'define'* *'def'*
2515'define' 'def' string (default "^\s*#\s*define")
2516 global or local to buffer |global-local|
2517 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002518 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 pattern, just like for the "/" command. This option is used for the
2520 commands like "[i" and "[d" |include-search|. The 'isident' option is
2521 used to recognize the defined name after the match:
2522 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2523 See |option-backslash| about inserting backslashes to include a space
2524 or backslash.
2525 The default value is for C programs. For C++ this value would be
2526 useful, to include const type declarations: >
2527 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2528< When using the ":set" command, you need to double the backslashes!
2529
2530 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2531'delcombine' 'deco' boolean (default off)
2532 global
2533 {not in Vi}
2534 {only available when compiled with the |+multi_byte|
2535 feature}
2536 If editing Unicode and this option is set, backspace and Normal mode
2537 "x" delete each combining character on its own. When it is off (the
2538 default) the character along with its combining characters are
2539 deleted.
2540 Note: When 'delcombine' is set "xx" may work different from "2x"!
2541
2542 This is useful for Arabic, Hebrew and many other languages where one
2543 may have combining characters overtop of base characters, and want
2544 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002545 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'dictionary'* *'dict'*
2548'dictionary' 'dict' string (default "")
2549 global or local to buffer |global-local|
2550 {not in Vi}
2551 List of file names, separated by commas, that are used to lookup words
2552 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2553 contain a list of words. This can be one word per line, or several
2554 words per line, separated by non-keyword characters (white space is
2555 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002556 When this option is empty, or an entry "spell" is present, spell
2557 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002558 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 after a comma are ignored, otherwise spaces are included in the file
2560 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002561 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 Where to find a list of words?
2563 - On FreeBSD, there is the file "/usr/share/dict/words".
2564 - In the Simtel archive, look in the "msdos/linguist" directory.
2565 - In "miscfiles" of the GNU collection.
2566 The use of |:set+=| and |:set-=| is preferred when adding or removing
2567 directories from the list. This avoids problems when a future version
2568 uses another default.
2569 Backticks cannot be used in this option for security reasons.
2570
2571 *'diff'* *'nodiff'*
2572'diff' boolean (default off)
2573 local to window
2574 {not in Vi}
2575 {not available when compiled without the |+diff|
2576 feature}
2577 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002578 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579
2580 *'dex'* *'diffexpr'*
2581'diffexpr' 'dex' string (default "")
2582 global
2583 {not in Vi}
2584 {not available when compiled without the |+diff|
2585 feature}
2586 Expression which is evaluated to obtain an ed-style diff file from two
2587 versions of a file. See |diff-diffexpr|.
2588 This option cannot be set from a |modeline| or in the |sandbox|, for
2589 security reasons.
2590
2591 *'dip'* *'diffopt'*
2592'diffopt' 'dip' string (default "filler")
2593 global
2594 {not in Vi}
2595 {not available when compiled without the |+diff|
2596 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002597 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 All are optional. Items must be separated by a comma.
2599
2600 filler Show filler lines, to keep the text
2601 synchronized with a window that has inserted
2602 lines at the same position. Mostly useful
2603 when windows are side-by-side and 'scrollbind'
2604 is set.
2605
2606 context:{n} Use a context of {n} lines between a change
2607 and a fold that contains unchanged lines.
2608 When omitted a context of six lines is used.
2609 See |fold-diff|.
2610
2611 icase Ignore changes in case of text. "a" and "A"
2612 are considered the same. Adds the "-i" flag
2613 to the "diff" command if 'diffexpr' is empty.
2614
2615 iwhite Ignore changes in amount of white space. Adds
2616 the "-b" flag to the "diff" command if
2617 'diffexpr' is empty. Check the documentation
2618 of the "diff" command for what this does
2619 exactly. It should ignore adding trailing
2620 white space, but not leading white space.
2621
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002622 horizontal Start diff mode with horizontal splits (unless
2623 explicitly specified otherwise).
2624
2625 vertical Start diff mode with vertical splits (unless
2626 explicitly specified otherwise).
2627
2628 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2629 starting diff mode. Without this 2 is used.
2630
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 Examples: >
2632
2633 :set diffopt=filler,context:4
2634 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002635 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636<
2637 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2638'digraph' 'dg' boolean (default off)
2639 global
2640 {not in Vi}
2641 {not available when compiled without the |+digraphs|
2642 feature}
2643 Enable the entering of digraphs in Insert mode with {char1} <BS>
2644 {char2}. See |digraphs|.
2645 NOTE: This option is reset when 'compatible' is set.
2646
2647 *'directory'* *'dir'*
2648'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002649 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 for Unix: ".,~/tmp,/var/tmp,/tmp")
2651 global
2652 List of directory names for the swap file, separated with commas.
2653 - The swap file will be created in the first directory where this is
2654 possible.
2655 - Empty means that no swap file will be used (recovery is
2656 impossible!).
2657 - A directory "." means to put the swap file in the same directory as
2658 the edited file. On Unix, a dot is prepended to the file name, so
2659 it doesn't show in a directory listing. On MS-Windows the "hidden"
2660 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002661 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 put the swap file relative to where the edited file is. The leading
2663 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002664 - For Unix and Win32, if a directory ends in two path separators "//"
2665 or "\\", the swap file name will be built from the complete path to
2666 the file with all path separators substituted to percent '%' signs.
2667 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002668 On Win32, when a separating comma is following, you must use "//",
2669 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 - Spaces after the comma are ignored, other spaces are considered part
2671 of the directory name. To have a space at the start of a directory
2672 name, precede it with a backslash.
2673 - To include a comma in a directory name precede it with a backslash.
2674 - A directory name may end in an ':' or '/'.
2675 - Environment variables are expanded |:set_env|.
2676 - Careful with '\' characters, type one before a space, type two to
2677 get one in the option (see |option-backslash|), for example: >
2678 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2679< - For backwards compatibility with Vim version 3.0 a '>' at the start
2680 of the option is removed.
2681 Using "." first in the list is recommended. This means that editing
2682 the same file twice will result in a warning. Using "/tmp" on Unix is
2683 discouraged: When the system crashes you lose the swap file.
2684 "/var/tmp" is often not cleared when rebooting, thus is a better
2685 choice than "/tmp". But it can contain a lot of files, your swap
2686 files get lost in the crowd. That is why a "tmp" directory in your
2687 home directory is tried first.
2688 The use of |:set+=| and |:set-=| is preferred when adding or removing
2689 directories from the list. This avoids problems when a future version
2690 uses another default.
2691 This option cannot be set from a |modeline| or in the |sandbox|, for
2692 security reasons.
2693 {Vi: directory to put temp file in, defaults to "/tmp"}
2694
2695 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002696'display' 'dy' string (default "", set to "truncate" in
2697 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 global
2699 {not in Vi}
2700 Change the way text is displayed. This is comma separated list of
2701 flags:
2702 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002703 in a window will be displayed. "@@@" is put in the
2704 last columns of the last screen line to indicate the
2705 rest of the line is not displayed.
2706 truncate Like "lastline", but "@@@" is displayed in the first
2707 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 uhex Show unprintable characters hexadecimal as <xx>
2709 instead of using ^C and ~C.
2710
Bram Moolenaard0796902016-09-16 20:02:31 +02002711 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002712 doesn't fit is replaced with "@" lines.
2713
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 *'eadirection'* *'ead'*
2715'eadirection' 'ead' string (default "both")
2716 global
2717 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002718 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 feature}
2720 Tells when the 'equalalways' option applies:
2721 ver vertically, width of windows is not affected
2722 hor horizontally, height of windows is not affected
2723 both width and height of windows is affected
2724
2725 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2726'edcompatible' 'ed' boolean (default off)
2727 global
2728 Makes the 'g' and 'c' flags of the ":substitute" command to be
2729 toggled each time the flag is given. See |complex-change|. See
2730 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002731 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732
Bram Moolenaar03413f42016-04-12 21:07:15 +02002733 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002734'emoji' 'emo' boolean (default: on)
2735 global
2736 {not in Vi}
2737 {only available when compiled with the |+multi_byte|
2738 feature}
2739 When on all Unicode emoji characters are considered to be full width.
2740
2741
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 *'encoding'* *'enc'* *E543*
2743'encoding' 'enc' string (default: "latin1" or value from $LANG)
2744 global
2745 {only available when compiled with the |+multi_byte|
2746 feature}
2747 {not in Vi}
2748 Sets the character encoding used inside Vim. It applies to text in
2749 the buffers, registers, Strings in expressions, text stored in the
2750 viminfo file, etc. It sets the kind of characters which Vim can work
2751 with. See |encoding-names| for the possible values.
2752
2753 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002754 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002756 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757
Bram Moolenaar865242e2010-07-14 21:12:05 +02002758 This option cannot be set from a |modeline|. It would most likely
2759 corrupt the text.
2760
Bram Moolenaar3df01732017-02-17 22:47:16 +01002761 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2762 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 'encoding', "utf-8" is the natural choice for the environment and
2764 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002765 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 versions, and to avoid changing the encoding of newly created files
2767 without your knowledge (in case 'fileencodings' is empty).
2768
2769 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002770 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 iconv() or as specified with 'charconvert'.
2772
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002773 If you need to know whether 'encoding' is a multi-byte encoding, you
2774 can use: >
2775 if has("multi_byte_encoding")
2776<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 Normally 'encoding' will be equal to your current locale. This will
2778 be the default if Vim recognizes your environment settings. If
2779 'encoding' is not set to the current locale, 'termencoding' must be
2780 set to convert typed and displayed text. See |encoding-table|.
2781
2782 When you set this option, it fires the |EncodingChanged| autocommand
2783 event so that you can set up fonts if necessary.
2784
2785 When the option is set, the value is converted to lowercase. Thus
2786 you can set it with uppercase values too. Underscores are translated
2787 to '-' signs.
2788 When the encoding is recognized, it is changed to the standard name.
2789 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2790 "iso-8859-2" and "utf8" becomes "utf-8".
2791
2792 Note: "latin1" is also used when the encoding could not be detected.
2793 This only works when editing files in the same encoding! When the
2794 actual character set is not latin1, make sure 'fileencoding' and
2795 'fileencodings' are empty. When conversion is needed, switch to using
2796 utf-8.
2797
2798 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2799 You don't notice this while editing, but it does matter for the
2800 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2801 setting 'encoding' to one of these values instead of utf-8 only has
2802 effect for encoding used for files when 'fileencoding' is empty.
2803
Bram Moolenaar661b1822005-07-28 22:36:45 +00002804 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2805 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806
2807 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2808'endofline' 'eol' boolean (default on)
2809 local to buffer
2810 {not in Vi}
2811 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002812 is on, or 'fixeol' option is off, no <EOL> will be written for the
2813 last line in the file. This option is automatically set or reset when
2814 starting to edit a new file, depending on whether file has an <EOL>
2815 for the last line in the file. Normally you don't have to set or
2816 reset this option.
2817 When 'binary' is off and 'fixeol' is on the value is not used when
2818 writing the file. When 'binary' is on or 'fixeol' is off it is used
2819 to remember the presence of a <EOL> for the last line in the file, so
2820 that when you write the file the situation from the original file can
2821 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822
2823 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2824'equalalways' 'ea' boolean (default on)
2825 global
2826 {not in Vi}
2827 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002828 splitting or closing a window. This also happens the moment the
2829 option is switched on. When off, splitting a window will reduce the
2830 size of the current window and leave the other windows the same. When
2831 closing a window the extra lines are given to the window next to it
2832 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 When mixing vertically and horizontally split windows, a minimal size
2834 is computed and some windows may be larger if there is room. The
2835 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002836 Changing the height and width of a window can be avoided by setting
2837 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002838 If a window size is specified when creating a new window sizes are
2839 currently not equalized (it's complicated, but may be implemented in
2840 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841
2842 *'equalprg'* *'ep'*
2843'equalprg' 'ep' string (default "")
2844 global or local to buffer |global-local|
2845 {not in Vi}
2846 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002847 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002848 or 'indentexpr'. When Vim was compiled without internal formatting,
2849 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002850 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851 about including spaces and backslashes.
2852 This option cannot be set from a |modeline| or in the |sandbox|, for
2853 security reasons.
2854
2855 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2856'errorbells' 'eb' boolean (default off)
2857 global
2858 Ring the bell (beep or screen flash) for error messages. This only
2859 makes a difference for error messages, the bell will be used always
2860 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002861 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002862 screen flash or do nothing. See 'belloff' to finetune when to ring the
2863 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864
2865 *'errorfile'* *'ef'*
2866'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2867 others: "errors.err")
2868 global
2869 {not in Vi}
2870 {not available when compiled without the |+quickfix|
2871 feature}
2872 Name of the errorfile for the QuickFix mode (see |:cf|).
2873 When the "-q" command-line argument is used, 'errorfile' is set to the
2874 following argument. See |-q|.
2875 NOT used for the ":make" command. See 'makeef' for that.
2876 Environment variables are expanded |:set_env|.
2877 See |option-backslash| about including spaces and backslashes.
2878 This option cannot be set from a |modeline| or in the |sandbox|, for
2879 security reasons.
2880
2881 *'errorformat'* *'efm'*
2882'errorformat' 'efm' string (default is very long)
2883 global or local to buffer |global-local|
2884 {not in Vi}
2885 {not available when compiled without the |+quickfix|
2886 feature}
2887 Scanf-like description of the format for the lines in the error file
2888 (see |errorformat|).
2889
2890 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2891'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2892 global
2893 {not in Vi}
2894 Function keys that start with an <Esc> are recognized in Insert
2895 mode. When this option is off, the cursor and function keys cannot be
2896 used in Insert mode if they start with an <Esc>. The advantage of
2897 this is that the single <Esc> is recognized immediately, instead of
2898 after one second. Instead of resetting this option, you might want to
2899 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2900 when 'esckeys' is off, you can still map anything, but the cursor keys
2901 won't work by default.
2902 NOTE: This option is set to the Vi default value when 'compatible' is
2903 set and to the Vim default value when 'compatible' is reset.
2904
2905 *'eventignore'* *'ei'*
2906'eventignore' 'ei' string (default "")
2907 global
2908 {not in Vi}
2909 {not available when compiled without the |+autocmd|
2910 feature}
2911 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002912 When set to "all" or when "all" is one of the items, all autocommand
2913 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 Otherwise this is a comma separated list of event names. Example: >
2915 :set ei=WinEnter,WinLeave
2916<
2917 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2918'expandtab' 'et' boolean (default off)
2919 local to buffer
2920 {not in Vi}
2921 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002922 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2924 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002925 This option is reset when the 'paste' option is set and restored when
2926 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 NOTE: This option is reset when 'compatible' is set.
2928
2929 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2930'exrc' 'ex' boolean (default off)
2931 global
2932 {not in Vi}
2933 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002934 directory.
2935
2936 Setting this option is a potential security leak. E.g., consider
2937 unpacking a package or fetching files from github, a .vimrc in there
2938 might be a trojan horse. BETTER NOT SET THIS OPTION!
2939 Instead, define an autocommand in your .vimrc to set options for a
2940 matching directory.
2941
2942 If you do switch this option on you should also consider setting the
2943 'secure' option (see |initialization|).
2944 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 This option cannot be set from a |modeline| or in the |sandbox|, for
2946 security reasons.
2947
2948 *'fileencoding'* *'fenc'* *E213*
2949'fileencoding' 'fenc' string (default: "")
2950 local to buffer
2951 {only available when compiled with the |+multi_byte|
2952 feature}
2953 {not in Vi}
2954 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002955
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002957 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 When 'fileencoding' is empty, the same value as 'encoding' will be
2959 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002960 No error will be given when the value is set, only when it is used,
2961 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002962 Conversion will also be done when 'encoding' and 'fileencoding' are
2963 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2964 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002966 'encoding' is "utf-8" or another Unicode encoding, conversion
2967 is most likely done in a way that the reverse conversion
2968 results in the same text. When 'encoding' is not "utf-8" some
2969 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 See 'encoding' for the possible values. Additionally, values may be
2972 specified that can be handled by the converter, see
2973 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002974
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 When reading a file 'fileencoding' will be set from 'fileencodings'.
2976 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002977 'fileencoding', use the |++enc| argument. One exception: when
2978 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002979 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2982 When the option is set, the value is converted to lowercase. Thus
2983 you can set it with uppercase values too. '_' characters are
2984 replaced with '-'. If a name is recognized from the list for
2985 'encoding', it is replaced by the standard name. For example
2986 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002987
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 When this option is set, after starting to edit a file, the 'modified'
2989 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002990
2991 Keep in mind that changing 'fenc' from a modeline happens
2992 AFTER the text has been read, thus it applies to when the file will be
2993 written. If you do set 'fenc' in a modeline, you might want to set
2994 'nomodified' to avoid not being able to ":q".
2995
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 This option can not be changed when 'modifiable' is off.
2997
2998 *'fe'*
2999 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003000 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 old short name was 'fe', which is no longer used.
3002
3003 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003004'fileencodings' 'fencs' string (default: "ucs-bom",
3005 "ucs-bom,utf-8,default,latin1" when
3006 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 global
3008 {only available when compiled with the |+multi_byte|
3009 feature}
3010 {not in Vi}
3011 This is a list of character encodings considered when starting to edit
3012 an existing file. When a file is read, Vim tries to use the first
3013 mentioned character encoding. If an error is detected, the next one
3014 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 an empty string, which means the value of 'encoding' is used.
3017 WARNING: Conversion can cause loss of information! When
3018 'encoding' is "utf-8" (or one of the other Unicode variants)
3019 conversion is most likely done in a way that the reverse
3020 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003021 "utf-8" some non-ASCII characters may be lost! You can use
3022 the |++bad| argument to specify what is done with characters
3023 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 For an empty file or a file with only ASCII characters most encodings
3025 will work and the first entry of 'fileencodings' will be used (except
3026 "ucs-bom", which requires the BOM to be present). If you prefer
3027 another encoding use an BufReadPost autocommand event to test if your
3028 preferred encoding is to be used. Example: >
3029 au BufReadPost * if search('\S', 'w') == 0 |
3030 \ set fenc=iso-2022-jp | endif
3031< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3032 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003033 When the |++enc| argument is used then the value of 'fileencodings' is
3034 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003035 Note that 'fileencodings' is not used for a new file, the global value
3036 of 'fileencoding' is used instead. You can set it with: >
3037 :setglobal fenc=iso-8859-2
3038< This means that a non-existing file may get a different encoding than
3039 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 The special value "ucs-bom" can be used to check for a Unicode BOM
3041 (Byte Order Mark) at the start of the file. It must not be preceded
3042 by "utf-8" or another Unicode encoding for this to work properly.
3043 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3044 because Vim cannot detect an error, thus the encoding is always
3045 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003046 The special value "default" can be used for the encoding from the
3047 environment. This is the default value for 'encoding'. It is useful
3048 when 'encoding' is set to "utf-8" and your environment uses a
3049 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003050 When 'encoding' is "utf-8" and a file contains an illegal byte
3051 sequence it won't be recognized as UTF-8. You can use the |8g8|
3052 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 WRONG VALUES: WHAT'S WRONG:
3054 latin1,utf-8 "latin1" will always be used
3055 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3056 file
3057 cp1250,latin1 "cp1250" will always be used
3058 If 'fileencodings' is empty, 'fileencoding' is not modified.
3059 See 'fileencoding' for the possible values.
3060 Setting this option does not have an effect until the next time a file
3061 is read.
3062
3063 *'fileformat'* *'ff'*
3064'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
3065 Unix default: "unix",
3066 Macintosh default: "mac")
3067 local to buffer
3068 {not in Vi}
3069 This gives the <EOL> of the current buffer, which is used for
3070 reading/writing the buffer from/to a file:
3071 dos <CR> <NL>
3072 unix <NL>
3073 mac <CR>
3074 When "dos" is used, CTRL-Z at the end of a file is ignored.
3075 See |file-formats| and |file-read|.
3076 For the character encoding of the file see 'fileencoding'.
3077 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003078 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 This option is set automatically when starting to edit a file and
3080 'fileformats' is not empty and 'binary' is off.
3081 When this option is set, after starting to edit a file, the 'modified'
3082 option is set, because the file would be different when written.
3083 This option can not be changed when 'modifiable' is off.
3084 For backwards compatibility: When this option is set to "dos",
3085 'textmode' is set, otherwise 'textmode' is reset.
3086
3087 *'fileformats'* *'ffs'*
3088'fileformats' 'ffs' string (default:
3089 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3090 Vim Unix: "unix,dos",
3091 Vim Mac: "mac,unix,dos",
3092 Vi Cygwin: "unix,dos",
3093 Vi others: "")
3094 global
3095 {not in Vi}
3096 This gives the end-of-line (<EOL>) formats that will be tried when
3097 starting to edit a new buffer and when reading a file into an existing
3098 buffer:
3099 - When empty, the format defined with 'fileformat' will be used
3100 always. It is not set automatically.
3101 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003102 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 'fileformats' name will be used when a file is read into an existing
3104 buffer, no matter what 'fileformat' for that buffer is set to.
3105 - When more than one name is present, separated by commas, automatic
3106 <EOL> detection will be done when reading a file. When starting to
3107 edit a file, a check is done for the <EOL>:
3108 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3109 'fileformat' is set to "dos".
3110 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003111 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003113 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3114 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003115 This means that "mac" is only chosen when:
3116 "unix" is not present or no <NL> is found in the file, and
3117 "dos" is not present or no <CR><NL> is found in the file.
3118 Except: if "unix" was chosen, but there is a <CR> before
3119 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003120 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 4. If 'fileformat' is still not set, the first name from
3122 'fileformats' is used.
3123 When reading a file into an existing buffer, the same is done, but
3124 this happens like 'fileformat' has been set appropriately for that
3125 file only, the option is not changed.
3126 When 'binary' is set, the value of 'fileformats' is not used.
3127
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003128 When Vim starts up with an empty buffer the first item is used. You
3129 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3132 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3133 done:
3134 - When 'fileformats' is empty, there is no automatic detection. Dos
3135 format will be used.
3136 - When 'fileformats' is set to one or more names, automatic detection
3137 is done. This is based on the first <NL> in the file: If there is a
3138 <CR> in front of it, Dos format is used, otherwise Unix format is
3139 used.
3140 Also see |file-formats|.
3141 For backwards compatibility: When this option is set to an empty
3142 string or one format (no comma is included), 'textauto' is reset,
3143 otherwise 'textauto' is set.
3144 NOTE: This option is set to the Vi default value when 'compatible' is
3145 set and to the Vim default value when 'compatible' is reset.
3146
Bram Moolenaarbf884932013-04-05 22:26:15 +02003147 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3148'fileignorecase' 'fic' boolean (default on for systems where case in file
3149 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003150 global
3151 {not in Vi}
3152 When set case is ignored when using file names and directories.
3153 See 'wildignorecase' for only ignoring case when doing completion.
3154
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 *'filetype'* *'ft'*
3156'filetype' 'ft' string (default: "")
3157 local to buffer
3158 {not in Vi}
3159 {not available when compiled without the |+autocmd|
3160 feature}
3161 When this option is set, the FileType autocommand event is triggered.
3162 All autocommands that match with the value of this option will be
3163 executed. Thus the value of 'filetype' is used in place of the file
3164 name.
3165 Otherwise this option does not always reflect the current file type.
3166 This option is normally set when the file type is detected. To enable
3167 this use the ":filetype on" command. |:filetype|
3168 Setting this option to a different value is most useful in a modeline,
3169 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003170 Example, for in an IDL file:
3171 /* vim: set filetype=idl : */ ~
3172 |FileType| |filetypes|
3173 When a dot appears in the value then this separates two filetype
3174 names. Example:
3175 /* vim: set filetype=c.doxygen : */ ~
3176 This will use the "c" filetype first, then the "doxygen" filetype.
3177 This works both for filetype plugins and for syntax files. More than
3178 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 This option is not copied to another buffer, independent of the 's' or
3180 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003181 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
3183 *'fillchars'* *'fcs'*
3184'fillchars' 'fcs' string (default "vert:|,fold:-")
3185 global
3186 {not in Vi}
3187 {not available when compiled without the |+windows|
3188 and |+folding| features}
3189 Characters to fill the statuslines and vertical separators.
3190 It is a comma separated list of items:
3191
3192 item default Used for ~
3193 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003194 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 vert:c '|' vertical separators |:vsplit|
3196 fold:c '-' filling 'foldtext'
3197 diff:c '-' deleted lines of the 'diff' option
3198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003199 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003200 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 otherwise.
3202
3203 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003204 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205< This is similar to the default, except that these characters will also
3206 be used when there is highlighting.
3207
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003208 for "stl" and "stlnc" only single-byte values are supported.
3209
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 The highlighting used for these items:
3211 item highlight group ~
3212 stl:c StatusLine |hl-StatusLine|
3213 stlnc:c StatusLineNC |hl-StatusLineNC|
3214 vert:c VertSplit |hl-VertSplit|
3215 fold:c Folded |hl-Folded|
3216 diff:c DiffDelete |hl-DiffDelete|
3217
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003218 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3219'fixendofline' 'fixeol' boolean (default on)
3220 local to buffer
3221 {not in Vi}
3222 When writing a file and this option is on, <EOL> at the end of file
3223 will be restored if missing. Turn this option off if you want to
3224 preserve the situation from the original file.
3225 When the 'binary' option is set the value of this option doesn't
3226 matter.
3227 See the 'endofline' option.
3228
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3230'fkmap' 'fk' boolean (default off) *E198*
3231 global
3232 {not in Vi}
3233 {only available when compiled with the |+rightleft|
3234 feature}
3235 When on, the keyboard is mapped for the Farsi character set.
3236 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003237 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238
3239 *'foldclose'* *'fcl'*
3240'foldclose' 'fcl' string (default "")
3241 global
3242 {not in Vi}
3243 {not available when compiled without the |+folding|
3244 feature}
3245 When set to "all", a fold is closed when the cursor isn't in it and
3246 its level is higher than 'foldlevel'. Useful if you want folds to
3247 automatically close when moving out of them.
3248
3249 *'foldcolumn'* *'fdc'*
3250'foldcolumn' 'fdc' number (default 0)
3251 local to window
3252 {not in Vi}
3253 {not available when compiled without the |+folding|
3254 feature}
3255 When non-zero, a column with the specified width is shown at the side
3256 of the window which indicates open and closed folds. The maximum
3257 value is 12.
3258 See |folding|.
3259
3260 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3261'foldenable' 'fen' boolean (default on)
3262 local to window
3263 {not in Vi}
3264 {not available when compiled without the |+folding|
3265 feature}
3266 When off, all folds are open. This option can be used to quickly
3267 switch between showing all text unfolded and viewing the text with
3268 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 'foldenable' is off.
3271 This option is set by commands that create a new fold or close a fold.
3272 See |folding|.
3273
3274 *'foldexpr'* *'fde'*
3275'foldexpr' 'fde' string (default: "0")
3276 local to window
3277 {not in Vi}
3278 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003279 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003281 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003282
Bram Moolenaar30b65812012-07-12 22:01:11 +02003283 The expression will be evaluated in the |sandbox| if set from a
3284 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003285 This option can't be set from a |modeline| when the 'diff' option is
3286 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003287
3288 It is not allowed to change text or jump to another window while
3289 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290
3291 *'foldignore'* *'fdi'*
3292'foldignore' 'fdi' string (default: "#")
3293 local to window
3294 {not in Vi}
3295 {not available when compiled without the |+folding|
3296 feature}
3297 Used only when 'foldmethod' is "indent". Lines starting with
3298 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003299 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 The default "#" works well for C programs. See |fold-indent|.
3301
3302 *'foldlevel'* *'fdl'*
3303'foldlevel' 'fdl' number (default: 0)
3304 local to window
3305 {not in Vi}
3306 {not available when compiled without the |+folding|
3307 feature}
3308 Sets the fold level: Folds with a higher level will be closed.
3309 Setting this option to zero will close all folds. Higher numbers will
3310 close fewer folds.
3311 This option is set by commands like |zm|, |zM| and |zR|.
3312 See |fold-foldlevel|.
3313
3314 *'foldlevelstart'* *'fdls'*
3315'foldlevelstart' 'fdls' number (default: -1)
3316 global
3317 {not in Vi}
3318 {not available when compiled without the |+folding|
3319 feature}
3320 Sets 'foldlevel' when starting to edit another buffer in a window.
3321 Useful to always start editing with all folds closed (value zero),
3322 some folds closed (one) or no folds closed (99).
3323 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003324 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 ignores this option and closes all folds.
3326 It is also done before BufReadPre autocommands, to allow an autocmd to
3327 overrule the 'foldlevel' value for specific files.
3328 When the value is negative, it is not used.
3329
3330 *'foldmarker'* *'fmr'* *E536*
3331'foldmarker' 'fmr' string (default: "{{{,}}}")
3332 local to window
3333 {not in Vi}
3334 {not available when compiled without the |+folding|
3335 feature}
3336 The start and end marker used when 'foldmethod' is "marker". There
3337 must be one comma, which separates the start and end marker. The
3338 marker is a literal string (a regular expression would be too slow).
3339 See |fold-marker|.
3340
3341 *'foldmethod'* *'fdm'*
3342'foldmethod' 'fdm' string (default: "manual")
3343 local to window
3344 {not in Vi}
3345 {not available when compiled without the |+folding|
3346 feature}
3347 The kind of folding used for the current window. Possible values:
3348 |fold-manual| manual Folds are created manually.
3349 |fold-indent| indent Lines with equal indent form a fold.
3350 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3351 |fold-marker| marker Markers are used to specify folds.
3352 |fold-syntax| syntax Syntax highlighting items specify folds.
3353 |fold-diff| diff Fold text that is not changed.
3354
3355 *'foldminlines'* *'fml'*
3356'foldminlines' 'fml' number (default: 1)
3357 local to window
3358 {not in Vi}
3359 {not available when compiled without the |+folding|
3360 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003361 Sets the number of screen lines above which a fold can be displayed
3362 closed. Also for manually closed folds. With the default value of
3363 one a fold can only be closed if it takes up two or more screen lines.
3364 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003365 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 "zc" to close a fold, which is displayed open because it's smaller
3367 than 'foldminlines', a following "zc" may close a containing fold.
3368
3369 *'foldnestmax'* *'fdn'*
3370'foldnestmax' 'fdn' number (default: 20)
3371 local to window
3372 {not in Vi}
3373 {not available when compiled without the |+folding|
3374 feature}
3375 Sets the maximum nesting of folds for the "indent" and "syntax"
3376 methods. This avoids that too many folds will be created. Using more
3377 than 20 doesn't work, because the internal limit is 20.
3378
3379 *'foldopen'* *'fdo'*
3380'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3381 search,tag,undo")
3382 global
3383 {not in Vi}
3384 {not available when compiled without the |+folding|
3385 feature}
3386 Specifies for which type of commands folds will be opened, if the
3387 command moves the cursor into a closed fold. It is a comma separated
3388 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003389 NOTE: When the command is part of a mapping this option is not used.
3390 Add the |zv| command to the mapping to get the same effect.
3391 (rationale: the mapping may want to control opening folds itself)
3392
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 item commands ~
3394 all any
3395 block "(", "{", "[[", "[{", etc.
3396 hor horizontal movements: "l", "w", "fx", etc.
3397 insert any command in Insert mode
3398 jump far jumps: "G", "gg", etc.
3399 mark jumping to a mark: "'m", CTRL-O, etc.
3400 percent "%"
3401 quickfix ":cn", ":crew", ":make", etc.
3402 search search for a pattern: "/", "n", "*", "gd", etc.
3403 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003404 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 tag jumping to a tag: ":ta", CTRL-T, etc.
3406 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 When a movement command is used for an operator (e.g., "dl" or "y%")
3408 this option is not used. This means the operator will include the
3409 whole closed fold.
3410 Note that vertical movements are not here, because it would make it
3411 very difficult to move onto a closed fold.
3412 In insert mode the folds containing the cursor will always be open
3413 when text is inserted.
3414 To close folds you can re-apply 'foldlevel' with the |zx| command or
3415 set the 'foldclose' option to "all".
3416
3417 *'foldtext'* *'fdt'*
3418'foldtext' 'fdt' string (default: "foldtext()")
3419 local to window
3420 {not in Vi}
3421 {not available when compiled without the |+folding|
3422 feature}
3423 An expression which is used to specify the text displayed for a closed
3424 fold. See |fold-foldtext|.
3425
Bram Moolenaar30b65812012-07-12 22:01:11 +02003426 The expression will be evaluated in the |sandbox| if set from a
3427 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003428
3429 It is not allowed to change text or jump to another window while
3430 evaluating 'foldtext' |textlock|.
3431
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003432 *'formatexpr'* *'fex'*
3433'formatexpr' 'fex' string (default "")
3434 local to buffer
3435 {not in Vi}
3436 {not available when compiled without the |+eval|
3437 feature}
3438 Expression which is evaluated to format a range of lines for the |gq|
3439 operator or automatic formatting (see 'formatoptions'). When this
3440 option is empty 'formatprg' is used.
3441
3442 The |v:lnum| variable holds the first line to be formatted.
3443 The |v:count| variable holds the number of lines to be formatted.
3444 The |v:char| variable holds the character that is going to be
3445 inserted if the expression is being evaluated due to
3446 automatic formatting. This can be empty. Don't insert
3447 it yet!
3448
3449 Example: >
3450 :set formatexpr=mylang#Format()
3451< This will invoke the mylang#Format() function in the
3452 autoload/mylang.vim file in 'runtimepath'. |autoload|
3453
3454 The expression is also evaluated when 'textwidth' is set and adding
3455 text beyond that limit. This happens under the same conditions as
3456 when internal formatting is used. Make sure the cursor is kept in the
3457 same spot relative to the text then! The |mode()| function will
3458 return "i" or "R" in this situation.
3459
3460 When the expression evaluates to non-zero Vim will fall back to using
3461 the internal format mechanism.
3462
3463 The expression will be evaluated in the |sandbox| when set from a
3464 modeline, see |sandbox-option|. That stops the option from working,
3465 since changing the buffer text is not allowed.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003466 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 *'formatoptions'* *'fo'*
3469'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3470 local to buffer
3471 {not in Vi}
3472 This is a sequence of letters which describes how automatic
3473 formatting is to be done. See |fo-table|. When the 'paste' option is
3474 on, no formatting is done (like 'formatoptions' is empty). Commas can
3475 be inserted for readability.
3476 To avoid problems with flags that are added in the future, use the
3477 "+=" and "-=" feature of ":set" |add-option-flags|.
3478 NOTE: This option is set to the Vi default value when 'compatible' is
3479 set and to the Vim default value when 'compatible' is reset.
3480
Bram Moolenaar86b68352004-12-27 21:59:20 +00003481 *'formatlistpat'* *'flp'*
3482'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3483 local to buffer
3484 {not in Vi}
3485 A pattern that is used to recognize a list header. This is used for
3486 the "n" flag in 'formatoptions'.
3487 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003488 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003489 while still checking more characters. There must be a character
3490 following the pattern, when it matches the whole line it is handled
3491 like there is no match.
3492 The default recognizes a number, followed by an optional punctuation
3493 character and white space.
3494
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 *'formatprg'* *'fp'*
3496'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003497 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 {not in Vi}
3499 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003500 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003502 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003503 If the 'formatexpr' option is not empty it will be used instead.
3504 Otherwise, if 'formatprg' option is an empty string, the internal
3505 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003506 Environment variables are expanded |:set_env|. See |option-backslash|
3507 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003508 This option cannot be set from a |modeline| or in the |sandbox|, for
3509 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510
Bram Moolenaard94464e2015-11-02 15:28:18 +01003511 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003512'fsync' 'fs' boolean (default on)
3513 global
3514 {not in Vi}
3515 When on, the library function fsync() will be called after writing a
3516 file. This will flush a file to disk, ensuring that it is safely
3517 written even on filesystems which do metadata-only journaling. This
3518 will force the harddrive to spin up on Linux systems running in laptop
3519 mode, so it may be undesirable in some situations. Be warned that
3520 turning this off increases the chances of data loss after a crash. On
3521 systems without an fsync() implementation, this variable is always
3522 off.
3523 Also see 'swapsync' for controlling fsync() on swap files.
3524
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3526'gdefault' 'gd' boolean (default off)
3527 global
3528 {not in Vi}
3529 When on, the ":substitute" flag 'g' is default on. This means that
3530 all matches in a line are substituted instead of one. When a 'g' flag
3531 is given to a ":substitute" command, this will toggle the substitution
3532 of all or one match. See |complex-change|.
3533
3534 command 'gdefault' on 'gdefault' off ~
3535 :s/// subst. all subst. one
3536 :s///g subst. one subst. all
3537 :s///gg subst. all subst. one
3538
3539 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003540 DEPRECATED: Setting this option may break plugins that are not aware
3541 of this option. Also, many users get confused that adding the /g flag
3542 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543
3544 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003545'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 global
3547 {not in Vi}
3548 Format to recognize for the ":grep" command output.
3549 This is a scanf-like string that uses the same format as the
3550 'errorformat' option: see |errorformat|.
3551
3552 *'grepprg'* *'gp'*
3553'grepprg' 'gp' string (default "grep -n ",
3554 Unix: "grep -n $* /dev/null",
3555 Win32: "findstr /n" or "grep -n",
3556 VMS: "SEARCH/NUMBERS ")
3557 global or local to buffer |global-local|
3558 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003559 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 and '#' characters, which are expanded like when used in a command-
3561 line. The placeholder "$*" is allowed to specify where the arguments
3562 will be included. Environment variables are expanded |:set_env|. See
3563 |option-backslash| about including spaces and backslashes.
3564 When your "grep" accepts the "-H" argument, use this to make ":grep"
3565 also work well with a single file: >
3566 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003567< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003568 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3569 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003570 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 apply equally to 'grepprg'.
3572 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3573 otherwise it's "grep -n".
3574 This option cannot be set from a |modeline| or in the |sandbox|, for
3575 security reasons.
3576
3577 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3578'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3579 ve:ver35-Cursor,
3580 o:hor50-Cursor,
3581 i-ci:ver25-Cursor/lCursor,
3582 r-cr:hor20-Cursor/lCursor,
3583 sm:block-Cursor
3584 -blinkwait175-blinkoff150-blinkon175",
3585 for MS-DOS and Win32 console:
3586 "n-v-c:block,o:hor50,i-ci:hor15,
3587 r-cr:hor30,sm:block")
3588 global
3589 {not in Vi}
3590 {only available when compiled with GUI enabled, and
3591 for MS-DOS and Win32 console}
3592 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003593 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 the height of the cursor can be changed. This can be done by
3595 specifying a block cursor, or a percentage for a vertical or
3596 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003597 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3598 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003600 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 mode-list and an argument-list:
3602 mode-list:argument-list,mode-list:argument-list,..
3603 The mode-list is a dash separated list of these modes:
3604 n Normal mode
3605 v Visual mode
3606 ve Visual mode with 'selection' "exclusive" (same as 'v',
3607 if not specified)
3608 o Operator-pending mode
3609 i Insert mode
3610 r Replace mode
3611 c Command-line Normal (append) mode
3612 ci Command-line Insert mode
3613 cr Command-line Replace mode
3614 sm showmatch in Insert mode
3615 a all modes
3616 The argument-list is a dash separated list of these arguments:
3617 hor{N} horizontal bar, {N} percent of the character height
3618 ver{N} vertical bar, {N} percent of the character width
3619 block block cursor, fills the whole character
3620 [only one of the above three should be present]
3621 blinkwait{N} *cursor-blinking*
3622 blinkon{N}
3623 blinkoff{N}
3624 blink times for cursor: blinkwait is the delay before
3625 the cursor starts blinking, blinkon is the time that
3626 the cursor is shown and blinkoff is the time that the
3627 cursor is not shown. The times are in msec. When one
3628 of the numbers is zero, there is no blinking. The
3629 default is: "blinkwait700-blinkon400-blinkoff250".
3630 These numbers are used for a missing entry. This
3631 means that blinking is enabled by default. To switch
3632 blinking off you can use "blinkon0". The cursor only
3633 blinks when Vim is waiting for input, not while
3634 executing a command.
3635 To make the cursor blink in an xterm, see
3636 |xterm-blink|.
3637 {group-name}
3638 a highlight group name, that sets the color and font
3639 for the cursor
3640 {group-name}/{group-name}
3641 Two highlight group names, the first is used when
3642 no language mappings are used, the other when they
3643 are. |language-mapping|
3644
3645 Examples of parts:
3646 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3647 block cursor with colors from the "nCursor"
3648 highlight group
3649 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3650 In Insert and Command-line Insert mode, use a
3651 30% vertical bar cursor with colors from the
3652 "iCursor" highlight group. Blink a bit
3653 faster.
3654
3655 The 'a' mode is different. It will set the given argument-list for
3656 all modes. It does not reset anything to defaults. This can be used
3657 to do a common setting for all modes. For example, to switch off
3658 blinking: "a:blinkon0"
3659
3660 Examples of cursor highlighting: >
3661 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3662 :highlight Cursor gui=NONE guifg=bg guibg=fg
3663<
3664 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003665 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666'guifont' 'gfn' string (default "")
3667 global
3668 {not in Vi}
3669 {only available when compiled with GUI enabled}
3670 This is a list of fonts which will be used for the GUI version of Vim.
3671 In its simplest form the value is just one font name. When
3672 the font cannot be found you will get an error message. To try other
3673 font names a list can be specified, font names separated with commas.
3674 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003675
Bram Moolenaar05159a02005-02-26 23:04:13 +00003676 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3677 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003678
Bram Moolenaar3df01732017-02-17 22:47:16 +01003679 Note: As to the GTK GUIs, no error is given against any invalid names,
3680 and the first element of the list is always picked up and made use of.
3681 This is because, instead of identifying a given name with a font, the
3682 GTK GUIs use it to construct a pattern and try to look up a font which
3683 best matches the pattern among available fonts, and this way, the
3684 matching never fails. An invalid name doesn't matter because a number
3685 of font properties other than name will do to get the matching done.
3686
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 Spaces after a comma are ignored. To include a comma in a font name
3688 precede it with a backslash. Setting an option requires an extra
3689 backslash before a space and a backslash. See also
3690 |option-backslash|. For example: >
3691 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003692< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003694
3695 If none of the fonts can be loaded, Vim will keep the current setting.
3696 If an empty font list is given, Vim will try using other resource
3697 settings (for X, it will use the Vim.font resource), and finally it
3698 will try some builtin default which should always be there ("7x13" in
3699 the case of X). The font names given should be "normal" fonts. Vim
3700 will try to find the related bold and italic fonts.
3701
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003702 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003703 :set guifont=*
3704< will bring up a font requester, where you can pick the font you want.
3705
3706 The font name depends on the GUI used. See |setting-guifont| for a
3707 way to set 'guifont' for various systems.
3708
Bram Moolenaar3df01732017-02-17 22:47:16 +01003709 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003711< That's all. XLFDs are not used. For Chinese this is reported to work
3712 well: >
3713 if has("gui_gtk2")
3714 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3715 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3716 endif
3717<
Bram Moolenaar3df01732017-02-17 22:47:16 +01003718 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3719
Bram Moolenaar05159a02005-02-26 23:04:13 +00003720 For Mac OSX you can use something like this: >
3721 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003722< Also see 'macatsui', it can help fix display problems.
3723 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaar3df01732017-02-17 22:47:16 +01003725 width). An exception is GTK: all fonts are accepted, but mono-spaced
3726 fonts look best.
Bram Moolenaared203462004-06-16 11:19:22 +00003727
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 To preview a font on X11, you might be able to use the "xfontsel"
3729 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003730
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 For the Win32 GUI *E244* *E245*
3732 - takes these options in the font name:
3733 hXX - height is XX (points, can be floating-point)
3734 wXX - width is XX (points, can be floating-point)
3735 b - bold
3736 i - italic
3737 u - underline
3738 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003739 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3741 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3742 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003743 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003744 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003745 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003746 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003747 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748
3749 Use a ':' to separate the options.
3750 - A '_' can be used in the place of a space, so you don't need to use
3751 backslashes to escape the spaces.
3752 - Examples: >
3753 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3754 :set guifont=Andale_Mono:h7.5:w4.5
3755< See also |font-sizes|.
3756
3757 *'guifontset'* *'gfs'*
3758 *E250* *E252* *E234* *E597* *E598*
3759'guifontset' 'gfs' string (default "")
3760 global
3761 {not in Vi}
3762 {only available when compiled with GUI enabled and
3763 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003764 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 When not empty, specifies two (or more) fonts to be used. The first
3766 one for normal English, the second one for your special language. See
3767 |xfontset|.
3768 Setting this option also means that all font names will be handled as
3769 a fontset name. Also the ones used for the "font" argument of the
3770 |:highlight| command.
3771 The fonts must match with the current locale. If fonts for the
3772 character sets that the current locale uses are not included, setting
3773 'guifontset' will fail.
3774 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3775 the comma-separated names are alternative names, one of which will be
3776 used. In 'guifontset' the whole string is one fontset name,
3777 including the commas. It is not possible to specify alternative
3778 fontset names.
3779 This example works on many X11 systems: >
3780 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3781<
3782 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3783'guifontwide' 'gfw' string (default "")
3784 global
3785 {not in Vi}
3786 {only available when compiled with GUI enabled}
3787 When not empty, specifies a comma-separated list of fonts to be used
3788 for double-width characters. The first font that can be loaded is
3789 used.
3790 Note: The size of these fonts must be exactly twice as wide as the one
3791 specified with 'guifont' and the same height.
3792
Bram Moolenaar3df01732017-02-17 22:47:16 +01003793 All GUI versions but GTK+:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794
3795 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3796 'guifontset' is empty or invalid.
3797 When 'guifont' is set and a valid font is found in it and
3798 'guifontwide' is empty Vim will attempt to find a matching
3799 double-width font and set 'guifontwide' to it.
3800
Bram Moolenaar3df01732017-02-17 22:47:16 +01003801 GTK+ GUI only: *guifontwide_gtk*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802
3803 If set and valid, 'guifontwide' is always used for double width
3804 characters, even if 'encoding' is not set to "utf-8".
3805 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003806 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 font for characters not available in 'guifont'. Thus you do not need
3808 to set 'guifontwide' at all unless you want to override the choice
3809 made by Pango/Xft.
3810
Bram Moolenaar0f272122013-01-23 18:37:40 +01003811 Windows +multibyte only: *guifontwide_win_mbyte*
3812
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003813 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003814
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 *'guiheadroom'* *'ghr'*
3816'guiheadroom' 'ghr' number (default 50)
3817 global
3818 {not in Vi} {only for GTK and X11 GUI}
3819 The number of pixels subtracted from the screen height when fitting
3820 the GUI window on the screen. Set this before the GUI is started,
3821 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003822 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 lines will be left for window decorations and other items on the
3824 screen. Set it to a negative value to allow windows taller than the
3825 screen.
3826
3827 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003828'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3829 removed in |defaults.vim|),
3830 "aegimrLtT" (GTK, Motif and Athena),
3831 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 global
3833 {not in Vi}
3834 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003835 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 sequence of letters which describes what components and options of the
3837 GUI should be used.
3838 To avoid problems with flags that are added in the future, use the
3839 "+=" and "-=" feature of ":set" |add-option-flags|.
3840
3841 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003842 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 'a' Autoselect: If present, then whenever VISUAL mode is started,
3844 or the Visual area extended, Vim tries to become the owner of
3845 the windowing system's global selection. This means that the
3846 Visually highlighted text is available for pasting into other
3847 applications as well as into Vim itself. When the Visual mode
3848 ends, possibly due to an operation on the text, or when an
3849 application wants to paste the selection, the highlighted text
3850 is automatically yanked into the "* selection register.
3851 Thus the selection is still available for pasting into other
3852 applications after the VISUAL mode has ended.
3853 If not present, then Vim won't become the owner of the
3854 windowing system's global selection unless explicitly told to
3855 by a yank or delete operation for the "* register.
3856 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003857 *'go-P'*
3858 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003859 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003860 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003861 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 applies to the modeless selection.
3863
3864 'guioptions' autoselect Visual autoselect modeless ~
3865 "" - -
3866 "a" yes yes
3867 "A" - yes
3868 "aA" yes yes
3869
Bram Moolenaar02467872007-05-06 13:22:01 +00003870 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 'c' Use console dialogs instead of popup dialogs for simple
3872 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003873 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003874 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003875 'guitablabel' can be used to change the text in the labels.
3876 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003877 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003878 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003879 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 'f' Foreground: Don't use fork() to detach the GUI from the shell
3881 where it was started. Use this for programs that wait for the
3882 editor to finish (e.g., an e-mail program). Alternatively you
3883 can use "gvim -f" or ":gui -f" to start the GUI in the
3884 foreground. |gui-fork|
3885 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003886 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003887 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3889 corner of the window. It's black&white on non-GTK, because of
3890 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003891 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003893 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003894 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003896 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 file is sourced the system menu has already been loaded; the
3898 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003899 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 'g' Grey menu items: Make menu items that are not active grey. If
3901 'g' is not included inactive menu items are not shown at all.
3902 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003903 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 't' Include tearoff menu items. Currently only works for Win32,
3905 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003906 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003907 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003908 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003909 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003911 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 'R' Right-hand scrollbar is present when there is a vertically
3913 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003914 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003916 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 'L' Left-hand scrollbar is present when there is a vertically
3918 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003919 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3921 the longest visible line, or on the cursor line if the 'h'
3922 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003923 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 'h' Limit horizontal scrollbar size to the length of the cursor
3925 line. Reduces computations. |gui-horiz-scroll|
3926
3927 And yes, you may even have scrollbars on the left AND the right if
3928 you really want to :-). See |gui-scrollbars| for more information.
3929
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003930 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 'v' Use a vertical button layout for dialogs. When not included,
3932 a horizontal layout is preferred, but when it doesn't fit a
3933 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003934 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 'p' Use Pointer callbacks for X11 GUI. This is required for some
3936 window managers. If the cursor is not blinking or hollow at
3937 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003938 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003940 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003941 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942
Bram Moolenaar02467872007-05-06 13:22:01 +00003943
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 *'guipty'* *'noguipty'*
3945'guipty' boolean (default on)
3946 global
3947 {not in Vi}
3948 {only available when compiled with GUI enabled}
3949 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3950 I/O to/from shell commands. See |gui-pty|.
3951
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003952 *'guitablabel'* *'gtl'*
3953'guitablabel' 'gtl' string (default empty)
3954 global
3955 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003956 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003957 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003958 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003959 pages line. When empty and when the result is empty Vim will use a
3960 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003961
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003962 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003963 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003964 The expression will be evaluated in the |sandbox| when set from a
3965 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003966
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003967 Only used when the GUI tab pages line is displayed. 'e' must be
3968 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3969 used.
3970
Bram Moolenaar57657d82006-04-21 22:12:41 +00003971 *'guitabtooltip'* *'gtt'*
3972'guitabtooltip' 'gtt' string (default empty)
3973 global
3974 {not in Vi}
3975 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003976 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003977 When nonempty describes the text to use in a tooltip for the GUI tab
3978 pages line. When empty Vim will use a default tooltip.
3979 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003980 You can include a line break. Simplest method is to use |:let|: >
3981 :let &guitabtooltip = "line one\nline two"
3982<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003983
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 *'helpfile'* *'hf'*
3985'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3986 (others) "$VIMRUNTIME/doc/help.txt")
3987 global
3988 {not in Vi}
3989 Name of the main help file. All distributed help files should be
3990 placed together in one directory. Additionally, all "doc" directories
3991 in 'runtimepath' will be used.
3992 Environment variables are expanded |:set_env|. For example:
3993 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003994 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 spaces and backslashes.
3996 This option cannot be set from a |modeline| or in the |sandbox|, for
3997 security reasons.
3998
3999 *'helpheight'* *'hh'*
4000'helpheight' 'hh' number (default 20)
4001 global
4002 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004003 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 feature}
4005 Minimal initial height of the help window when it is opened with the
4006 ":help" command. The initial height of the help window is half of the
4007 current window, or (when the 'ea' option is on) the same as other
4008 windows. When the height is less than 'helpheight', the height is
4009 set to 'helpheight'. Set to zero to disable.
4010
4011 *'helplang'* *'hlg'*
4012'helplang' 'hlg' string (default: messages language or empty)
4013 global
4014 {only available when compiled with the |+multi_lang|
4015 feature}
4016 {not in Vi}
4017 Comma separated list of languages. Vim will use the first language
4018 for which the desired help can be found. The English help will always
4019 be used as a last resort. You can add "en" to prefer English over
4020 another language, but that will only find tags that exist in that
4021 language and not in the English help.
4022 Example: >
4023 :set helplang=de,it
4024< This will first search German, then Italian and finally English help
4025 files.
4026 When using |CTRL-]| and ":help!" in a non-English help file Vim will
4027 try to find the tag in the current language before using this option.
4028 See |help-translated|.
4029
4030 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
4031'hidden' 'hid' boolean (default off)
4032 global
4033 {not in Vi}
4034 When off a buffer is unloaded when it is |abandon|ed. When on a
4035 buffer becomes hidden when it is |abandon|ed. If the buffer is still
4036 displayed in another window, it does not become hidden, of course.
4037 The commands that move through the buffer list sometimes make a buffer
4038 hidden although the 'hidden' option is off: When the buffer is
4039 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004040 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004041 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 This option is set for one command with ":hide {command}" |:hide|.
4043 WARNING: It's easy to forget that you have changes in hidden buffers.
4044 Think twice when using ":q!" or ":qa!".
4045
4046 *'highlight'* *'hl'*
4047'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02004048 "8:SpecialKey,~:EndOfBuffer,@:NonText,
4049 d:Directory,e:ErrorMsg,i:IncSearch,
4050 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
4051 N:CursorLineNr,r:Question,s:StatusLine,
4052 S:StatusLineNC,c:VertSplit,t:Title,
4053 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
4054 F:FoldColumn,A:DiffAdd,C:DiffChange,
4055 D:DiffDelete,T:DiffText,>:SignColumn,
4056 B:SpellBad,P:SpellCap,R:SpellRare,
4057 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02004058 x:PmenuSbar,X:PmenuThumb,*:TabLine,
4059 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02004060 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02004061 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 global
4063 {not in Vi}
4064 This option can be used to set highlighting mode for various
4065 occasions. It is a comma separated list of character pairs. The
4066 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004067 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02004069 |hl-EndOfBuffer| ~ lines after the last line in the buffer
4070 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 characters from 'showbreak'
4072 |hl-Directory| d directories in CTRL-D listing and other special
4073 things in listings
4074 |hl-ErrorMsg| e error messages
4075 h (obsolete, ignored)
4076 |hl-IncSearch| i 'incsearch' highlighting
4077 |hl-Search| l last search pattern highlighting (see 'hlsearch')
4078 |hl-MoreMsg| m |more-prompt|
4079 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02004080 |hl-LineNr| n line number for ":number" and ":#" commands, and
4081 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004082 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
4083 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 |hl-Question| r |hit-enter| prompt and yes/no questions
4085 |hl-StatusLine| s status line of current window |status-line|
4086 |hl-StatusLineNC| S status lines of not-current windows
4087 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
4088 |hl-VertSplit| c column used to separate vertically split windows
4089 |hl-Visual| v Visual mode
4090 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
4091 Selection" Only X11 Gui's |gui-x11| and
4092 |xterm-clipboard|.
4093 |hl-WarningMsg| w warning messages
4094 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4095 |hl-Folded| f line used for closed folds
4096 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004097 |hl-DiffAdd| A added line in diff mode
4098 |hl-DiffChange| C changed line in diff mode
4099 |hl-DiffDelete| D deleted line in diff mode
4100 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004102 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004103 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004104 |hl-SpellRare| R rare word |spell|
4105 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004106 |hl-Conceal| - the placeholders used for concealed characters
4107 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004108 |hl-Pmenu| + popup menu normal line
4109 |hl-PmenuSel| = popup menu normal line
4110 |hl-PmenuSbar| x popup menu scrollbar
4111 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
4113 The display modes are:
4114 r reverse (termcap entry "mr" and "me")
4115 i italic (termcap entry "ZH" and "ZR")
4116 b bold (termcap entry "md" and "me")
4117 s standout (termcap entry "so" and "se")
4118 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004119 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004120 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 n no highlighting
4122 - no highlighting
4123 : use a highlight group
4124 The default is used for occasions that are not included.
4125 If you want to change what the display modes do, see |dos-colors|
4126 for an example.
4127 When using the ':' display mode, this must be followed by the name of
4128 a highlight group. A highlight group can be used to define any type
4129 of highlighting, including using color. See |:highlight| on how to
4130 define one. The default uses a different group for each occasion.
4131 See |highlight-default| for the default highlight groups.
4132
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004134'history' 'hi' number (Vim default: 50, Vi default: 0,
4135 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 global
4137 {not in Vi}
4138 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004139 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004141 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 NOTE: This option is set to the Vi default value when 'compatible' is
4143 set and to the Vim default value when 'compatible' is reset.
4144
4145 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4146'hkmap' 'hk' boolean (default off)
4147 global
4148 {not in Vi}
4149 {only available when compiled with the |+rightleft|
4150 feature}
4151 When on, the keyboard is mapped for the Hebrew character set.
4152 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4153 toggle this option. See |rileft.txt|.
4154 NOTE: This option is reset when 'compatible' is set.
4155
4156 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4157'hkmapp' 'hkp' boolean (default off)
4158 global
4159 {not in Vi}
4160 {only available when compiled with the |+rightleft|
4161 feature}
4162 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4163 This is useful if you have a non-Hebrew keyboard.
4164 See |rileft.txt|.
4165 NOTE: This option is reset when 'compatible' is set.
4166
Bram Moolenaar036986f2017-03-16 17:41:02 +01004167 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4168'hlsearch' 'hls' boolean (default off)
4169 global
4170 {not in Vi}
4171 {not available when compiled without the
4172 |+extra_search| feature}
4173 When there is a previous search pattern, highlight all its matches.
4174 The type of highlighting used can be set with the 'l' occasion in the
4175 'highlight' option. This uses the "Search" highlight group by
4176 default. Note that only the matching text is highlighted, any offsets
4177 are not applied.
4178 See also: 'incsearch' and |:match|.
4179 When you get bored looking at the highlighted matches, you can turn it
4180 off with |:nohlsearch|. This does not change the option value, as
4181 soon as you use a search command, the highlighting comes back.
4182 'redrawtime' specifies the maximum time spent on finding matches.
4183 When the search pattern can match an end-of-line, Vim will try to
4184 highlight all of the matched text. However, this depends on where the
4185 search starts. This will be the first line in the window or the first
4186 line below a closed fold. A match in a previous line which is not
4187 drawn may not continue in a newly drawn line.
4188 You can specify whether the highlight status is restored on startup
4189 with the 'h' flag in 'viminfo' |viminfo-h|.
4190 NOTE: This option is reset when 'compatible' is set.
4191
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 *'icon'* *'noicon'*
4193'icon' boolean (default off, on when title can be restored)
4194 global
4195 {not in Vi}
4196 {not available when compiled without the |+title|
4197 feature}
4198 When on, the icon text of the window will be set to the value of
4199 'iconstring' (if it is not empty), or to the name of the file
4200 currently being edited. Only the last part of the name is used.
4201 Overridden by the 'iconstring' option.
4202 Only works if the terminal supports setting window icons (currently
4203 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4204 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4205 builtin termcap).
4206 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004207 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004209 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210
4211 *'iconstring'*
4212'iconstring' string (default "")
4213 global
4214 {not in Vi}
4215 {not available when compiled without the |+title|
4216 feature}
4217 When this option is not empty, it will be used for the icon text of
4218 the window. This happens only when the 'icon' option is on.
4219 Only works if the terminal supports setting window icon text
4220 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4221 Does not work for MS Windows.
4222 When Vim was compiled with HAVE_X11 defined, the original icon will be
4223 restored if possible |X11|.
4224 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004225 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226 'titlestring' for example settings.
4227 {not available when compiled without the |+statusline| feature}
4228
4229 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4230'ignorecase' 'ic' boolean (default off)
4231 global
4232 Ignore case in search patterns. Also used when searching in the tags
4233 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004234 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 Can be overruled by using "\c" or "\C" in the pattern, see
4236 |/ignorecase|.
4237
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004238 *'imactivatefunc'* *'imaf'*
4239'imactivatefunc' 'imaf' string (default "")
4240 global
4241 {not in Vi}
4242 {only available when compiled with |+xim| and
4243 |+GUI_GTK|}
4244 This option specifies a function that will be called to
4245 activate/inactivate Input Method.
4246
4247 Example: >
4248 function ImActivateFunc(active)
4249 if a:active
4250 ... do something
4251 else
4252 ... do something
4253 endif
4254 " return value is not used
4255 endfunction
4256 set imactivatefunc=ImActivateFunc
4257<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 *'imactivatekey'* *'imak'*
4259'imactivatekey' 'imak' string (default "")
4260 global
4261 {not in Vi}
4262 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004263 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 Specifies the key that your Input Method in X-Windows uses for
4265 activation. When this is specified correctly, vim can fully control
4266 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4267 You can't use this option to change the activation key, the option
4268 tells Vim what the key is.
4269 Format:
4270 [MODIFIER_FLAG-]KEY_STRING
4271
4272 These characters can be used for MODIFIER_FLAG (case is ignored):
4273 S Shift key
4274 L Lock key
4275 C Control key
4276 1 Mod1 key
4277 2 Mod2 key
4278 3 Mod3 key
4279 4 Mod4 key
4280 5 Mod5 key
4281 Combinations are allowed, for example "S-C-space" or "SC-space" are
4282 both shift+ctrl+space.
4283 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4284
4285 Example: >
4286 :set imactivatekey=S-space
4287< "S-space" means shift+space. This is the activation key for kinput2 +
4288 canna (Japanese), and ami (Korean).
4289
4290 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4291'imcmdline' 'imc' boolean (default off)
4292 global
4293 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004294 {only available when compiled with the |+xim|,
4295 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 When set the Input Method is always on when starting to edit a command
4297 line, unless entering a search pattern (see 'imsearch' for that).
4298 Setting this option is useful when your input method allows entering
4299 English characters directly, e.g., when it's used to type accented
4300 characters with dead keys.
4301
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004302 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4304 global
4305 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004306 {only available when compiled with the |+xim|,
4307 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 When set the Input Method is never used. This is useful to disable
4309 the IM when it doesn't work properly.
4310 Currently this option is on by default for SGI/IRIX machines. This
4311 may change in later releases.
4312
4313 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004314'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 local to buffer
4316 {not in Vi}
4317 Specifies whether :lmap or an Input Method (IM) is to be used in
4318 Insert mode. Valid values:
4319 0 :lmap is off and IM is off
4320 1 :lmap is ON and IM is off
4321 2 :lmap is off and IM is ON
4322 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4323 or |global-ime|.
4324 To always reset the option to zero when leaving Insert mode with <Esc>
4325 this can be used: >
4326 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4327< This makes :lmap and IM turn off automatically when leaving Insert
4328 mode.
4329 Note that this option changes when using CTRL-^ in Insert mode
4330 |i_CTRL-^|.
4331 The value is set to 1 when setting 'keymap' to a valid keymap name.
4332 It is also used for the argument of commands like "r" and "f".
4333 The value 0 may not work correctly with Athena and Motif with some XIM
4334 methods. Use 'imdisable' to disable XIM then.
4335
4336 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004337'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 local to buffer
4339 {not in Vi}
4340 Specifies whether :lmap or an Input Method (IM) is to be used when
4341 entering a search pattern. Valid values:
4342 -1 the value of 'iminsert' is used, makes it look like
4343 'iminsert' is also used when typing a search pattern
4344 0 :lmap is off and IM is off
4345 1 :lmap is ON and IM is off
4346 2 :lmap is off and IM is ON
4347 Note that this option changes when using CTRL-^ in Command-line mode
4348 |c_CTRL-^|.
4349 The value is set to 1 when it is not -1 and setting the 'keymap'
4350 option to a valid keymap name.
4351 The value 0 may not work correctly with Athena and Motif with some XIM
4352 methods. Use 'imdisable' to disable XIM then.
4353
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004354 *'imstatusfunc'* *'imsf'*
4355'imstatusfunc' 'imsf' string (default "")
4356 global
4357 {not in Vi}
4358 {only available when compiled with |+xim| and
4359 |+GUI_GTK|}
4360 This option specifies a function that is called to obtain the status
4361 of Input Method. It must return a positive number when IME is active.
4362
4363 Example: >
4364 function ImStatusFunc()
4365 let is_active = ...do something
4366 return is_active ? 1 : 0
4367 endfunction
4368 set imstatusfunc=ImStatusFunc
4369<
4370 NOTE: This function is invoked very often. Keep it fast.
4371
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004372 *'imstyle'* *'imst'*
4373'imstyle' 'imst' number (default 1)
4374 global
4375 {not in Vi}
4376 {only available when compiled with |+xim| and
4377 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004378 This option specifies the input style of Input Method:
4379 0 use on-the-spot style
4380 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004381 See: |xim-input-style|
4382
4383 For a long time on-the-spot sytle had been used in GTK version of vim,
4384 however, it is known that it causes troubles when using mappings,
4385 |single-repeat|, etc. Therefore over-the-spot style becomes the
4386 default now. This should work fine for most people, however if you
4387 have any problem with it, try using on-the-spot style.
4388
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 *'include'* *'inc'*
4390'include' 'inc' string (default "^\s*#\s*include")
4391 global or local to buffer |global-local|
4392 {not in Vi}
4393 {not available when compiled without the
4394 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004395 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 pattern, just like for the "/" command (See |pattern|). The default
4397 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004398 "]I", "[d", etc.
4399 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004400 comes after the matched pattern. But if "\zs" appears in the pattern
4401 then the text matched from "\zs" to the end, or until "\ze" if it
4402 appears, is used as the file name. Use this to include characters
4403 that are not in 'isfname', such as a space. You can then use
4404 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004405 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406
4407 *'includeexpr'* *'inex'*
4408'includeexpr' 'inex' string (default "")
4409 local to buffer
4410 {not in Vi}
4411 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004412 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004414 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415 :set includeexpr=substitute(v:fname,'\\.','/','g')
4416< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004417
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004419 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 Also used for |<cfile>|.
4421
Bram Moolenaar30b65812012-07-12 22:01:11 +02004422 The expression will be evaluated in the |sandbox| when set from a
4423 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004424
4425 It is not allowed to change text or jump to another window while
4426 evaluating 'includeexpr' |textlock|.
4427
Bram Moolenaar071d4272004-06-13 20:20:40 +00004428 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004429'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4430 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 global
4432 {not in Vi}
4433 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004434 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004435 While typing a search command, show where the pattern, as it was typed
4436 so far, matches. The matched string is highlighted. If the pattern
4437 is invalid or not found, nothing is shown. The screen will be updated
4438 often, this is only useful on fast terminals.
4439 Note that the match will be shown, but the cursor will return to its
4440 original position when no match is found and when pressing <Esc>. You
4441 still need to finish the search command with <Enter> to move the
4442 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004443 You can use the CTRL-G and CTRL-T keys to move to the next and
4444 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004445 When compiled with the |+reltime| feature Vim only searches for about
4446 half a second. With a complicated pattern and/or a lot of text the
4447 match may not be found. This is to avoid that Vim hangs while you
4448 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004449 The highlighting can be set with the 'i' flag in 'highlight'.
4450 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004451 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004452 to the command line. If 'ignorecase' and 'smartcase' are set and the
4453 command line has no uppercase characters, the added character is
4454 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004455 CTRL-R CTRL-W can be used to add the word at the end of the current
4456 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 NOTE: This option is reset when 'compatible' is set.
4458
4459 *'indentexpr'* *'inde'*
4460'indentexpr' 'inde' string (default "")
4461 local to buffer
4462 {not in Vi}
4463 {not available when compiled without the |+cindent|
4464 or |+eval| features}
4465 Expression which is evaluated to obtain the proper indent for a line.
4466 It is used when a new line is created, for the |=| operator and
4467 in Insert mode as specified with the 'indentkeys' option.
4468 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004469 'smartindent' indenting. When 'lisp' is set, this option is
4470 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 When 'paste' is set this option is not used for indenting.
4472 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004473 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 when the expression is evaluated (but it may be moved around).
4475 The expression must return the number of spaces worth of indent. It
4476 can return "-1" to keep the current indent (this means 'autoindent' is
4477 used for the indent).
4478 Functions useful for computing the indent are |indent()|, |cindent()|
4479 and |lispindent()|.
4480 The evaluation of the expression must not have side effects! It must
4481 not change the text, jump to another window, etc. Afterwards the
4482 cursor position is always restored, thus the cursor may be moved.
4483 Normally this option would be set to call a function: >
4484 :set indentexpr=GetMyIndent()
4485< Error messages will be suppressed, unless the 'debug' option contains
4486 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004487 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004488 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
Bram Moolenaar30b65812012-07-12 22:01:11 +02004490 The expression will be evaluated in the |sandbox| when set from a
4491 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004492
4493 It is not allowed to change text or jump to another window while
4494 evaluating 'indentexpr' |textlock|.
4495
4496
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 *'indentkeys'* *'indk'*
4498'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4499 local to buffer
4500 {not in Vi}
4501 {not available when compiled without the |+cindent|
4502 feature}
4503 A list of keys that, when typed in Insert mode, cause reindenting of
4504 the current line. Only happens if 'indentexpr' isn't empty.
4505 The format is identical to 'cinkeys', see |indentkeys-format|.
4506 See |C-indenting| and |indent-expression|.
4507
4508 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4509'infercase' 'inf' boolean (default off)
4510 local to buffer
4511 {not in Vi}
4512 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004513 'ignorecase' is also on, the case of the match is adjusted depending
4514 on the typed text. If the typed text contains a lowercase letter
4515 where the match has an upper case letter, the completed part is made
4516 lowercase. If the typed text has no lowercase letters and the match
4517 has a lowercase letter where the typed text has an uppercase letter,
4518 and there is a letter before it, the completed part is made uppercase.
4519 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520
4521 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4522'insertmode' 'im' boolean (default off)
4523 global
4524 {not in Vi}
4525 Makes Vim work in a way that Insert mode is the default mode. Useful
4526 if you want to use Vim as a modeless editor. Used for |evim|.
4527 These Insert mode commands will be useful:
4528 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004529 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 this is a mapping, it is executed as if 'insertmode' was off.
4531 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004533 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4534 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535
4536 These items change when 'insertmode' is set:
4537 - when starting to edit of a file, Vim goes to Insert mode.
4538 - <Esc> in Insert mode is a no-op and beeps.
4539 - <Esc> in Normal mode makes Vim go to Insert mode.
4540 - CTRL-L in Insert mode is a command, it is not inserted.
4541 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4542 However, when <Esc> is used inside a mapping, it behaves like
4543 'insertmode' was not set. This was done to be able to use the same
4544 mappings with 'insertmode' set or not set.
4545 When executing commands with |:normal| 'insertmode' is not used.
4546
4547 NOTE: This option is reset when 'compatible' is set.
4548
4549 *'isfname'* *'isf'*
4550'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4551 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4552 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4553 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4554 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4555 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4556 global
4557 {not in Vi}
4558 The characters specified by this option are included in file names and
4559 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004560 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 Multi-byte characters 256 and above are always included, only the
4562 characters up to 255 are specified with this option.
4563 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004564 Think twice before adding white space to this option. Although a
4565 space may appear inside a file name, the effect will be that Vim
4566 doesn't know where a file name starts or ends when doing completion.
4567 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568
4569 Note that on systems using a backslash as path separator, Vim tries to
4570 do its best to make it work as you would expect. That is a bit
4571 tricky, since Vi originally used the backslash to escape special
4572 characters. Vim will not remove a backslash in front of a normal file
4573 name character on these systems, but it will on Unix and alikes. The
4574 '&' and '^' are not included by default, because these are special for
4575 cmd.exe.
4576
4577 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004578 Each part can be a single character number or a range. A range is two
4579 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 decimal number between 0 and 255 or the ASCII character itself (does
4581 not work for digits). Example:
4582 "_,-,128-140,#-43" (include '_' and '-' and the range
4583 128 to 140 and '#' to 43)
4584 If a part starts with '^', the following character number or range
4585 will be excluded from the option. The option is interpreted from left
4586 to right. Put the excluded character after the range where it is
4587 included. To include '^' itself use it as the last character of the
4588 option or the end of a range. Example:
4589 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4590 If the character is '@', all characters where isalpha() returns TRUE
4591 are included. Normally these are the characters a to z and A to Z,
4592 plus accented characters. To include '@' itself use "@-@". Examples:
4593 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004594 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 "a-z,A-Z,@-@" All letters plus the '@' character.
4596 A comma can be included by using it where a character number is
4597 expected. Example:
4598 "48-57,,,_" Digits, comma and underscore.
4599 A comma can be excluded by prepending a '^'. Example:
4600 " -~,^,,9" All characters from space to '~', excluding
4601 comma, plus <Tab>.
4602 See |option-backslash| about including spaces and backslashes.
4603
4604 *'isident'* *'isi'*
4605'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4606 "@,48-57,_,128-167,224-235"
4607 otherwise: "@,48-57,_,192-255")
4608 global
4609 {not in Vi}
4610 The characters given by this option are included in identifiers.
4611 Identifiers are used in recognizing environment variables and after a
4612 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004613 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 option.
4615 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004616 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4618
4619 *'iskeyword'* *'isk'*
4620'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4621 "@,48-57,_,128-167,224-235"
4622 otherwise: "@,48-57,_,192-255"
4623 Vi default: "@,48-57,_")
4624 local to buffer
4625 {not in Vi}
4626 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004627 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 'isfname' for a description of the format of this option. For C
4629 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4630 For a help file it is set to all non-blank printable characters except
4631 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4632 command).
4633 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004634 This option also influences syntax highlighting, unless the syntax
4635 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 NOTE: This option is set to the Vi default value when 'compatible' is
4637 set and to the Vim default value when 'compatible' is reset.
4638
4639 *'isprint'* *'isp'*
4640'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4641 "@,~-255"; otherwise: "@,161-255")
4642 global
4643 {not in Vi}
4644 The characters given by this option are displayed directly on the
4645 screen. It is also used for "\p" in a |pattern|. The characters from
4646 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4647 even when they are not included in 'isprint' or excluded. See
4648 'isfname' for a description of the format of this option.
4649
4650 Non-printable characters are displayed with two characters:
4651 0 - 31 "^@" - "^_"
4652 32 - 126 always single characters
4653 127 "^?"
4654 128 - 159 "~@" - "~_"
4655 160 - 254 "| " - "|~"
4656 255 "~?"
4657 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4658 displayed as <xx>, with the hexadecimal value of the byte.
4659 When 'display' contains "uhex" all unprintable characters are
4660 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004661 The SpecialKey highlighting will be used for unprintable characters.
4662 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663
4664 Multi-byte characters 256 and above are always included, only the
4665 characters up to 255 are specified with this option. When a character
4666 is printable but it is not available in the current font, a
4667 replacement character will be shown.
4668 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4669 There is no option to specify these characters.
4670
4671 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4672'joinspaces' 'js' boolean (default on)
4673 global
4674 {not in Vi}
4675 Insert two spaces after a '.', '?' and '!' with a join command.
4676 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4677 Otherwise only one space is inserted.
4678 NOTE: This option is set when 'compatible' is set.
4679
4680 *'key'*
4681'key' string (default "")
4682 local to buffer
4683 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004684 {only available when compiled with the |+cryptv|
4685 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004687 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 Careful: Do not set the key value by hand, someone might see the typed
4689 key. Use the |:X| command. But you can make 'key' empty: >
4690 :set key=
4691< It is not possible to get the value of this option with ":set key" or
4692 "echo &key". This is to avoid showing it to someone who shouldn't
4693 know. It also means you cannot see it yourself once you have set it,
4694 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004695 You can use "&key" in an expression to detect whether encryption is
4696 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697
4698 *'keymap'* *'kmp'* *E544*
4699'keymap' 'kmp' string (default "")
4700 local to buffer
4701 {not in Vi}
4702 {only available when compiled with the |+keymap|
4703 feature}
4704 Name of a keyboard mapping. See |mbyte-keymap|.
4705 Setting this option to a valid keymap name has the side effect of
4706 setting 'iminsert' to one, so that the keymap becomes effective.
4707 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004708 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709
4710 *'keymodel'* *'km'*
4711'keymodel' 'km' string (default "")
4712 global
4713 {not in Vi}
4714 List of comma separated words, which enable special things that keys
4715 can do. These values can be used:
4716 startsel Using a shifted special key starts selection (either
4717 Select mode or Visual mode, depending on "key" being
4718 present in 'selectmode').
4719 stopsel Using a not-shifted special key stops selection.
4720 Special keys in this context are the cursor keys, <End>, <Home>,
4721 <PageUp> and <PageDown>.
4722 The 'keymodel' option is set by the |:behave| command.
4723
4724 *'keywordprg'* *'kp'*
4725'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004726 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 global or local to buffer |global-local|
4728 {not in Vi}
4729 Program to use for the |K| command. Environment variables are
4730 expanded |:set_env|. ":help" may be used to access the Vim internal
4731 help. (Note that previously setting the global option to the empty
4732 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004733 When the first character is ":", the command is invoked as a Vim
4734 Ex command prefixed with [count].
4735 When "man", "man -s" or an Ex command is used, Vim will automatically
4736 translate a count for the "K" command and pass it as the first
4737 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 See |option-backslash| about including spaces and backslashes.
4739 Example: >
4740 :set keywordprg=man\ -s
4741< This option cannot be set from a |modeline| or in the |sandbox|, for
4742 security reasons.
4743
4744 *'langmap'* *'lmap'* *E357* *E358*
4745'langmap' 'lmap' string (default "")
4746 global
4747 {not in Vi}
4748 {only available when compiled with the |+langmap|
4749 feature}
4750 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004751 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004752 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 care of translating these special characters to the original meaning
4754 of the key. This means you don't have to change the keyboard mode to
4755 be able to execute Normal mode commands.
4756 This is the opposite of the 'keymap' option, where characters are
4757 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004758 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004759 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004760 This option cannot be set from a |modeline| or in the |sandbox|, for
4761 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004763 Example (for Greek, in UTF-8): *greek* >
4764 :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 +00004765< Example (exchanges meaning of z and y for commands): >
4766 :set langmap=zy,yz,ZY,YZ
4767<
4768 The 'langmap' option is a list of parts, separated with commas. Each
4769 part can be in one of two forms:
4770 1. A list of pairs. Each pair is a "from" character immediately
4771 followed by the "to" character. Examples: "aA", "aAbBcC".
4772 2. A list of "from" characters, a semi-colon and a list of "to"
4773 characters. Example: "abc;ABC"
4774 Example: "aA,fgh;FGH,cCdDeE"
4775 Special characters need to be preceded with a backslash. These are
4776 ";", ',' and backslash itself.
4777
4778 This will allow you to activate vim actions without having to switch
4779 back and forth between the languages. Your language characters will
4780 be understood as normal vim English characters (according to the
4781 langmap mappings) in the following cases:
4782 o Normal/Visual mode (commands, buffer/register names, user mappings)
4783 o Insert/Replace Mode: Register names after CTRL-R
4784 o Insert/Replace Mode: Mappings
4785 Characters entered in Command-line mode will NOT be affected by
4786 this option. Note that this option can be changed at any time
4787 allowing to switch between mappings for different languages/encodings.
4788 Use a mapping to avoid having to type it each time!
4789
4790 *'langmenu'* *'lm'*
4791'langmenu' 'lm' string (default "")
4792 global
4793 {not in Vi}
4794 {only available when compiled with the |+menu| and
4795 |+multi_lang| features}
4796 Language to use for menu translation. Tells which file is loaded
4797 from the "lang" directory in 'runtimepath': >
4798 "lang/menu_" . &langmenu . ".vim"
4799< (without the spaces). For example, to always use the Dutch menus, no
4800 matter what $LANG is set to: >
4801 :set langmenu=nl_NL.ISO_8859-1
4802< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004803 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 If your $LANG is set to a non-English language but you do want to use
4805 the English menus: >
4806 :set langmenu=none
4807< This option must be set before loading menus, switching on filetype
4808 detection or syntax highlighting. Once the menus are defined setting
4809 this option has no effect. But you could do this: >
4810 :source $VIMRUNTIME/delmenu.vim
4811 :set langmenu=de_DE.ISO_8859-1
4812 :source $VIMRUNTIME/menu.vim
4813< Warning: This deletes all menus that you defined yourself!
4814
Bram Moolenaard94464e2015-11-02 15:28:18 +01004815 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004816'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004817 global
4818 {not in Vi}
4819 {only available when compiled with the |+langmap|
4820 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004821 This is just like 'langremap' but with the value inverted. It only
4822 exists for backwards compatibility. When setting 'langremap' then
4823 'langnoremap' is set to the inverted value, and the other way around.
4824
4825 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4826'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4827 global
4828 {not in Vi}
4829 {only available when compiled with the |+langmap|
4830 feature}
4831 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004832 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004833 'langmap' disables some of your mappings, try resetting this option.
4834 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004835 that works for you to avoid mappings to break.
4836
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 *'laststatus'* *'ls'*
4838'laststatus' 'ls' number (default 1)
4839 global
4840 {not in Vi}
4841 The value of this option influences when the last window will have a
4842 status line:
4843 0: never
4844 1: only if there are at least two windows
4845 2: always
4846 The screen looks nicer with a status line if you have several
4847 windows, but it takes another screen line. |status-line|
4848
4849 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4850'lazyredraw' 'lz' boolean (default off)
4851 global
4852 {not in Vi}
4853 When this option is set, the screen will not be redrawn while
4854 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004855 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 update use |:redraw|.
4857
4858 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4859'linebreak' 'lbr' boolean (default off)
4860 local to window
4861 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004862 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004864 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 than at the last character that fits on the screen. Unlike
4866 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004867 it only affects the way the file is displayed, not its contents.
4868 If 'breakindent' is set, line is visually indented. Then, the value
4869 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004870 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 Note that <Tab> characters after an <EOL> are mostly not displayed
4872 with the right amount of white space.
4873
4874 *'lines'* *E593*
4875'lines' number (default 24 or terminal height)
4876 global
4877 Number of lines of the Vim window.
4878 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004879 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 When Vim is running in the GUI or in a resizable window, setting this
4881 option will cause the window size to be changed. When you only want
4882 to use the size for the GUI, put the command in your |gvimrc| file.
4883 Vim limits the number of lines to what fits on the screen. You can
4884 use this command to get the tallest window possible: >
4885 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004886< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004887 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 When you set this option and Vim is unable to change the physical
4889 number of lines of the display, the display may be messed up.
4890
4891 *'linespace'* *'lsp'*
4892'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4893 global
4894 {not in Vi}
4895 {only in the GUI}
4896 Number of pixel lines inserted between characters. Useful if the font
4897 uses the full character cell height, making lines touch each other.
4898 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004899 With some fonts there can be too much room between lines (to have
4900 space for ascents and descents). Then it makes sense to set
4901 'linespace' to a negative value. This may cause display problems
4902 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
4904 *'lisp'* *'nolisp'*
4905'lisp' boolean (default off)
4906 local to buffer
4907 {not available when compiled without the |+lispindent|
4908 feature}
4909 Lisp mode: When <Enter> is typed in insert mode set the indent for
4910 the next line to Lisp standards (well, sort of). Also happens with
4911 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4912 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4913 better. Also see 'lispwords'.
4914 The '-' character is included in keyword characters. Redefines the
4915 "=" operator to use this same indentation algorithm rather than
4916 calling an external program if 'equalprg' is empty.
4917 This option is not used when 'paste' is set.
4918 {Vi: Does it a little bit differently}
4919
4920 *'lispwords'* *'lw'*
4921'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004922 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 {not in Vi}
4924 {not available when compiled without the |+lispindent|
4925 feature}
4926 Comma separated list of words that influence the Lisp indenting.
4927 |'lisp'|
4928
4929 *'list'* *'nolist'*
4930'list' boolean (default off)
4931 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004932 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4933 line. Useful to see the difference between tabs and spaces and for
4934 trailing blanks. Further changed by the 'listchars' option.
4935
4936 The cursor is displayed at the start of the space a Tab character
4937 occupies, not at the end as usual in Normal mode. To get this cursor
4938 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004939 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004940<
4941 Note that list mode will also affect formatting (set with 'textwidth'
4942 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 changing the way tabs are displayed.
4944
4945 *'listchars'* *'lcs'*
4946'listchars' 'lcs' string (default "eol:$")
4947 global
4948 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004949 Strings to use in 'list' mode and for the |:list| command. It is a
4950 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004951 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 eol:c Character to show at the end of each line. When
4953 omitted, there is no extra character at the end of the
4954 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004955 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004956 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004958 fill the space that the tab normally occupies.
4959 "tab:>-" will show a tab that takes four spaces as
4960 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004961 *lcs-space*
4962 space:c Character to show for a space. When omitted, spaces
4963 are left blank.
4964 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004965 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004966 trailing spaces are blank. Overrides the "space"
4967 setting for trailing spaces.
4968 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 extends:c Character to show in the last column, when 'wrap' is
4970 off and the line continues beyond the right of the
4971 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004972 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 precedes:c Character to show in the first column, when 'wrap'
4974 is off and there is text preceding the character
4975 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004976 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004977 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004978 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004979 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004980 nbsp:c Character to show for a non-breakable space character
4981 (0xA0 (160 decimal) and U+202F). Left blank when
4982 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004984 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004986 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987
4988 Examples: >
4989 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004990 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 :set lcs=extends:>,precedes:<
4992< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004993 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004994 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995
4996 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4997'loadplugins' 'lpl' boolean (default on)
4998 global
4999 {not in Vi}
5000 When on the plugin scripts are loaded when starting up |load-plugins|.
5001 This option can be reset in your |vimrc| file to disable the loading
5002 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02005003 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
5004 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005
Bram Moolenaard94464e2015-11-02 15:28:18 +01005006 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005007'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005008 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005009 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005010 {only available when compiled with the |+lua/dyn|
5011 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005012 Specifies the name of the Lua shared library. The default is
5013 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005014 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005015 This option cannot be set from a |modeline| or in the |sandbox|, for
5016 security reasons.
5017
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00005018 *'macatsui'* *'nomacatsui'*
5019'macatsui' boolean (default on)
5020 global
5021 {only available in Mac GUI version}
5022 This is a workaround for when drawing doesn't work properly. When set
5023 and compiled with multi-byte support ATSUI text drawing is used. When
5024 not set ATSUI text drawing is not used. Switch this option off when
5025 you experience drawing problems. In a future version the problems may
5026 be solved and this option becomes obsolete. Therefore use this method
5027 to unset it: >
5028 if exists('&macatsui')
5029 set nomacatsui
5030 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00005031< Another option to check if you have drawing problems is
5032 'termencoding'.
5033
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 *'magic'* *'nomagic'*
5035'magic' boolean (default on)
5036 global
5037 Changes the special characters that can be used in search patterns.
5038 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02005039 WARNING: Switching this option off most likely breaks plugins! That
5040 is because many patterns assume it's on and will fail when it's off.
5041 Only switch it off when working with old Vi scripts. In any other
5042 situation write patterns that work when 'magic' is on. Include "\M"
5043 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044
5045 *'makeef'* *'mef'*
5046'makeef' 'mef' string (default: "")
5047 global
5048 {not in Vi}
5049 {not available when compiled without the |+quickfix|
5050 feature}
5051 Name of the errorfile for the |:make| command (see |:make_makeprg|)
5052 and the |:grep| command.
5053 When it is empty, an internally generated temp file will be used.
5054 When "##" is included, it is replaced by a number to make the name
5055 unique. This makes sure that the ":make" command doesn't overwrite an
5056 existing file.
5057 NOT used for the ":cf" command. See 'errorfile' for that.
5058 Environment variables are expanded |:set_env|.
5059 See |option-backslash| about including spaces and backslashes.
5060 This option cannot be set from a |modeline| or in the |sandbox|, for
5061 security reasons.
5062
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005063 *'makeencoding'* *'menc'*
5064'makeencoding' 'menc' string (default "")
5065 global or local to buffer |global-local|
5066 {only available when compiled with the |+multi_byte|
5067 feature}
5068 {not in Vi}
5069 Encoding used for reading the output of external commands. When empty,
5070 encoding is not converted.
5071 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
5072 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
5073 and `:laddfile`.
5074
5075 This would be mostly useful when you use MS-Windows and set 'encoding'
5076 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
5077 'makeencoding' to "char" has the same effect as setting to the system
5078 locale encoding. Example: >
5079 :set encoding=utf-8
5080 :set makeencoding=char " system locale is used
5081<
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 *'makeprg'* *'mp'*
5083'makeprg' 'mp' string (default "make", VMS: "MMS")
5084 global or local to buffer |global-local|
5085 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00005086 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01005087 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
5088 which are expanded to the current and alternate file name. Use |::S|
5089 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00005090 Environment variables are expanded |:set_env|. See |option-backslash|
5091 about including spaces and backslashes.
5092 Note that a '|' must be escaped twice: once for ":set" and once for
5093 the interpretation of a command. When you use a filter called
5094 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 :set makeprg=gmake\ \\\|\ myfilter
5096< The placeholder "$*" can be given (even multiple times) to specify
5097 where the arguments will be included, for example: >
5098 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
5099< This option cannot be set from a |modeline| or in the |sandbox|, for
5100 security reasons.
5101
5102 *'matchpairs'* *'mps'*
5103'matchpairs' 'mps' string (default "(:),{:},[:]")
5104 local to buffer
5105 {not in Vi}
5106 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01005107 other.
5108 Only character pairs are allowed that are different, thus you cannot
5109 jump between two double quotes.
5110 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00005111 The pairs must be separated by a comma. Example for including '<' and
5112 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 :set mps+=<:>
5114
5115< A more exotic example, to jump between the '=' and ';' in an
5116 assignment, useful for languages like C and Java: >
5117 :au FileType c,cpp,java set mps+==:;
5118
5119< For a more advanced way of using "%", see the matchit.vim plugin in
5120 the $VIMRUNTIME/macros directory. |add-local-help|
5121
5122 *'matchtime'* *'mat'*
5123'matchtime' 'mat' number (default 5)
5124 global
5125 {not in Vi}{in Nvi}
5126 Tenths of a second to show the matching paren, when 'showmatch' is
5127 set. Note that this is not in milliseconds, like other options that
5128 set a time. This is to be compatible with Nvi.
5129
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005130 *'maxcombine'* *'mco'*
5131'maxcombine' 'mco' number (default 2)
5132 global
5133 {not in Vi}
5134 {only available when compiled with the |+multi_byte|
5135 feature}
5136 The maximum number of combining characters supported for displaying.
5137 Only used when 'encoding' is "utf-8".
5138 The default is OK for most languages. Hebrew may require 4.
5139 Maximum value is 6.
5140 Even when this option is set to 2 you can still edit text with more
5141 combining characters, you just can't see them. Use |g8| or |ga|.
5142 See |mbyte-combining|.
5143
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 *'maxfuncdepth'* *'mfd'*
5145'maxfuncdepth' 'mfd' number (default 100)
5146 global
5147 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005148 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005149 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 Maximum depth of function calls for user functions. This normally
5151 catches endless recursion. When using a recursive function with
5152 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5153 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005154 Increasing this limit above 200 also changes the maximum for Ex
5155 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 See also |:function|.
5157
5158 *'maxmapdepth'* *'mmd'* *E223*
5159'maxmapdepth' 'mmd' number (default 1000)
5160 global
5161 {not in Vi}
5162 Maximum number of times a mapping is done without resulting in a
5163 character to be used. This normally catches endless mappings, like
5164 ":map x y" with ":map y x". It still does not catch ":map g wg",
5165 because the 'w' is used before the next mapping is done. See also
5166 |key-mapping|.
5167
5168 *'maxmem'* *'mm'*
5169'maxmem' 'mm' number (default between 256 to 5120 (system
5170 dependent) or half the amount of memory
5171 available)
5172 global
5173 {not in Vi}
5174 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5175 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005176 other memory to be freed. The maximum usable value is about 2000000.
5177 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005179 *'maxmempattern'* *'mmp'*
5180'maxmempattern' 'mmp' number (default 1000)
5181 global
5182 {not in Vi}
5183 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005184 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005185 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005186 When Vim runs into the limit it gives an error message and mostly
5187 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005188 Running into the limit often means that the pattern is very
5189 inefficient or too complex. This may already happen with the pattern
5190 "\(.\)*" on a very long line. ".*" works much better.
5191 Vim may run out of memory before hitting the 'maxmempattern' limit.
5192
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 *'maxmemtot'* *'mmt'*
5194'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5195 dependent) or half the amount of memory
5196 available)
5197 global
5198 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005199 Maximum amount of memory in Kbyte to use for all buffers together.
5200 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005201 without a limit.
5202 On 64 bit machines higher values might work. But hey, do you really
5203 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005204 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005205 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005206 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
5208 *'menuitems'* *'mis'*
5209'menuitems' 'mis' number (default 25)
5210 global
5211 {not in Vi}
5212 {not available when compiled without the |+menu|
5213 feature}
5214 Maximum number of items to use in a menu. Used for menus that are
5215 generated from a list of items, e.g., the Buffers menu. Changing this
5216 option has no direct effect, the menu must be refreshed first.
5217
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005218 *'mkspellmem'* *'msm'*
5219'mkspellmem' 'msm' string (default "460000,2000,500")
5220 global
5221 {not in Vi}
5222 {not available when compiled without the |+syntax|
5223 feature}
5224 Parameters for |:mkspell|. This tunes when to start compressing the
5225 word tree. Compression can be slow when there are many words, but
5226 it's needed to avoid running out of memory. The amount of memory used
5227 per word depends very much on how similar the words are, that's why
5228 this tuning is complicated.
5229
5230 There are three numbers, separated by commas:
5231 {start},{inc},{added}
5232
5233 For most languages the uncompressed word tree fits in memory. {start}
5234 gives the amount of memory in Kbyte that can be used before any
5235 compression is done. It should be a bit smaller than the amount of
5236 memory that is available to Vim.
5237
5238 When going over the {start} limit the {inc} number specifies the
5239 amount of memory in Kbyte that can be allocated before another
5240 compression is done. A low number means compression is done after
5241 less words are added, which is slow. A high number means more memory
5242 will be allocated.
5243
5244 After doing compression, {added} times 1024 words can be added before
5245 the {inc} limit is ignored and compression is done when any extra
5246 amount of memory is needed. A low number means there is a smaller
5247 chance of hitting the {inc} limit, less memory is used but it's
5248 slower.
5249
5250 The languages for which these numbers are important are Italian and
5251 Hungarian. The default works for when you have about 512 Mbyte. If
5252 you have 1 Gbyte you could use: >
5253 :set mkspellmem=900000,3000,800
5254< If you have less than 512 Mbyte |:mkspell| may fail for some
5255 languages, no matter what you set 'mkspellmem' to.
5256
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005258'modeline' 'ml' boolean (Vim default: on (off for root),
5259 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 local to buffer
5261 *'modelines'* *'mls'*
5262'modelines' 'mls' number (default 5)
5263 global
5264 {not in Vi}
5265 If 'modeline' is on 'modelines' gives the number of lines that is
5266 checked for set commands. If 'modeline' is off or 'modelines' is zero
5267 no lines are checked. See |modeline|.
5268 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5269 set and to the Vim default value when 'compatible' is reset.
5270
5271 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5272'modifiable' 'ma' boolean (default on)
5273 local to buffer
5274 {not in Vi} *E21*
5275 When off the buffer contents cannot be changed. The 'fileformat' and
5276 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005277 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278
5279 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5280'modified' 'mod' boolean (default off)
5281 local to buffer
5282 {not in Vi}
5283 When on, the buffer is considered to be modified. This option is set
5284 when:
5285 1. A change was made to the text since it was last written. Using the
5286 |undo| command to go back to the original text will reset the
5287 option. But undoing changes that were made before writing the
5288 buffer will set the option again, since the text is different from
5289 when it was written.
5290 2. 'fileformat' or 'fileencoding' is different from its original
5291 value. The original value is set when the buffer is read or
5292 written. A ":set nomodified" command also resets the original
5293 values to the current values and the 'modified' option will be
5294 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005295 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005296 This option is not set when a change is made to the buffer as the
5297 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5298 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5299 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5301 will be ignored.
5302
5303 *'more'* *'nomore'*
5304'more' boolean (Vim default: on, Vi default: off)
5305 global
5306 {not in Vi}
5307 When on, listings pause when the whole screen is filled. You will get
5308 the |more-prompt|. When this option is off there are no pauses, the
5309 listing continues until finished.
5310 NOTE: This option is set to the Vi default value when 'compatible' is
5311 set and to the Vim default value when 'compatible' is reset.
5312
5313 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005314'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5315 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 global
5317 {not in Vi}
5318 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005319 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5320 sysmouse and Linux console with gpm). For using the mouse in the
5321 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 The mouse can be enabled for different modes:
5323 n Normal mode
5324 v Visual mode
5325 i Insert mode
5326 c Command-line mode
5327 h all previous modes when editing a help file
5328 a all previous modes
5329 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 Normally you would enable the mouse in all four modes with: >
5331 :set mouse=a
5332< When the mouse is not enabled, the GUI will still use the mouse for
5333 modeless selection. This doesn't move the text cursor.
5334
5335 See |mouse-using|. Also see |'clipboard'|.
5336
5337 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005338 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 the mouse buttons can still be used by keeping the shift key pressed.
5340 Also see the 'clipboard' option.
5341
5342 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5343'mousefocus' 'mousef' boolean (default off)
5344 global
5345 {not in Vi}
5346 {only works in the GUI}
5347 The window that the mouse pointer is on is automatically activated.
5348 When changing the window layout or window focus in another way, the
5349 mouse pointer is moved to the window with keyboard focus. Off is the
5350 default because it makes using the pull down menus a little goofy, as
5351 a pointer transit may activate a window unintentionally.
5352
5353 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5354'mousehide' 'mh' boolean (default on)
5355 global
5356 {not in Vi}
5357 {only works in the GUI}
5358 When on, the mouse pointer is hidden when characters are typed.
5359 The mouse pointer is restored when the mouse is moved.
5360
5361 *'mousemodel'* *'mousem'*
5362'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5363 global
5364 {not in Vi}
5365 Sets the model to use for the mouse. The name mostly specifies what
5366 the right mouse button is used for:
5367 extend Right mouse button extends a selection. This works
5368 like in an xterm.
5369 popup Right mouse button pops up a menu. The shifted left
5370 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005371 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 popup_setpos Like "popup", but the cursor will be moved to the
5373 position where the mouse was clicked, and thus the
5374 selected operation will act upon the clicked object.
5375 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005376 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 course, that right clicking outside a selection will
5378 end Visual mode.
5379 Overview of what button does what for each model:
5380 mouse extend popup(_setpos) ~
5381 left click place cursor place cursor
5382 left drag start selection start selection
5383 shift-left search word extend selection
5384 right click extend selection popup menu (place cursor)
5385 right drag extend selection -
5386 middle click paste paste
5387
5388 In the "popup" model the right mouse button produces a pop-up menu.
5389 You need to define this first, see |popup-menu|.
5390
5391 Note that you can further refine the meaning of buttons with mappings.
5392 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5393 selection (because that's handled in the GUI code directly).
5394
5395 The 'mousemodel' option is set by the |:behave| command.
5396
5397 *'mouseshape'* *'mouses'* *E547*
5398'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005399 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 global
5401 {not in Vi}
5402 {only available when compiled with the |+mouseshape|
5403 feature}
5404 This option tells Vim what the mouse pointer should look like in
5405 different modes. The option is a comma separated list of parts, much
5406 like used for 'guicursor'. Each part consist of a mode/location-list
5407 and an argument-list:
5408 mode-list:shape,mode-list:shape,..
5409 The mode-list is a dash separated list of these modes/locations:
5410 In a normal window: ~
5411 n Normal mode
5412 v Visual mode
5413 ve Visual mode with 'selection' "exclusive" (same as 'v',
5414 if not specified)
5415 o Operator-pending mode
5416 i Insert mode
5417 r Replace mode
5418
5419 Others: ~
5420 c appending to the command-line
5421 ci inserting in the command-line
5422 cr replacing in the command-line
5423 m at the 'Hit ENTER' or 'More' prompts
5424 ml idem, but cursor in the last line
5425 e any mode, pointer below last window
5426 s any mode, pointer on a status line
5427 sd any mode, while dragging a status line
5428 vs any mode, pointer on a vertical separator line
5429 vd any mode, while dragging a vertical separator line
5430 a everywhere
5431
5432 The shape is one of the following:
5433 avail name looks like ~
5434 w x arrow Normal mouse pointer
5435 w x blank no pointer at all (use with care!)
5436 w x beam I-beam
5437 w x updown up-down sizing arrows
5438 w x leftright left-right sizing arrows
5439 w x busy The system's usual busy pointer
5440 w x no The system's usual 'no input' pointer
5441 x udsizing indicates up-down resizing
5442 x lrsizing indicates left-right resizing
5443 x crosshair like a big thin +
5444 x hand1 black hand
5445 x hand2 white hand
5446 x pencil what you write with
5447 x question big ?
5448 x rightup-arrow arrow pointing right-up
5449 w x up-arrow arrow pointing up
5450 x <number> any X11 pointer number (see X11/cursorfont.h)
5451
5452 The "avail" column contains a 'w' if the shape is available for Win32,
5453 x for X11.
5454 Any modes not specified or shapes not available use the normal mouse
5455 pointer.
5456
5457 Example: >
5458 :set mouseshape=s:udsizing,m:no
5459< will make the mouse turn to a sizing arrow over the status lines and
5460 indicate no input when the hit-enter prompt is displayed (since
5461 clicking the mouse has no effect in this state.)
5462
5463 *'mousetime'* *'mouset'*
5464'mousetime' 'mouset' number (default 500)
5465 global
5466 {not in Vi}
5467 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5468 time in msec between two mouse clicks for the second click to be
5469 recognized as a multi click.
5470
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005471 *'mzquantum'* *'mzq'*
5472'mzquantum' 'mzq' number (default 100)
5473 global
5474 {not in Vi}
5475 {not available when compiled without the |+mzscheme|
5476 feature}
5477 The number of milliseconds between polls for MzScheme threads.
5478 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005479 NOTE: This option is set to the Vim default value when 'compatible'
5480 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005481
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005483'nrformats' 'nf' string (default "bin,octal,hex",
5484 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005485 local to buffer
5486 {not in Vi}
5487 This defines what bases Vim will consider for numbers when using the
5488 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5489 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005490 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005492 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005493 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005495 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 considered to be hexadecimal. Example: Using CTRL-X on
5497 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005498 bin If included, numbers starting with "0b" or "0B" will be
5499 considered to be binary. Example: Using CTRL-X on
5500 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005501 Numbers which simply begin with a digit in the range 1-9 are always
5502 considered decimal. This also happens for numbers that are not
5503 recognized as octal or hex.
5504
5505 *'number'* *'nu'* *'nonumber'* *'nonu'*
5506'number' 'nu' boolean (default off)
5507 local to window
5508 Print the line number in front of each line. When the 'n' option is
5509 excluded from 'cpoptions' a wrapped line will not use the column of
5510 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005511 The 'numberwidth' option can be used to set the room used for the line
5512 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 When a long, wrapped line doesn't start with the first character, '-'
5514 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005515 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5516 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005517 *number_relativenumber*
5518 The 'relativenumber' option changes the displayed number to be
5519 relative to the cursor. Together with 'number' there are these
5520 four combinations (cursor in line 3):
5521
Bram Moolenaar3848e002016-03-19 18:42:29 +01005522 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005523 'nornu' 'nornu' 'rnu' 'rnu'
5524
5525 |apple | 1 apple | 2 apple | 2 apple
5526 |pear | 2 pear | 1 pear | 1 pear
5527 |nobody | 3 nobody | 0 nobody |3 nobody
5528 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005530 *'numberwidth'* *'nuw'*
5531'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5532 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005533 {not in Vi}
5534 {only available when compiled with the |+linebreak|
5535 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005536 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005537 when the 'number' or 'relativenumber' option is set or printing lines
5538 with a line number. Since one space is always between the number and
5539 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005540 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005541 fit the highest line number in the buffer respectively the number of
5542 rows in the window, depending on whether 'number' or 'relativenumber'
5543 is set. Thus with the Vim default of 4 there is room for a line number
5544 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005545 The minimum value is 1, the maximum value is 10.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005546 NOTE: This option is set to the Vi default value when 'compatible' is
5547 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005548
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005549 *'omnifunc'* *'ofu'*
5550'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005551 local to buffer
5552 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005553 {not available when compiled without the |+eval|
5554 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005555 This option specifies a function to be used for Insert mode omni
5556 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005557 See |complete-functions| for an explanation of how the function is
5558 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005559 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005560 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005561 This option cannot be set from a |modeline| or in the |sandbox|, for
5562 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005563
5564
Bram Moolenaar02467872007-05-06 13:22:01 +00005565 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005566'opendevice' 'odev' boolean (default off)
5567 global
5568 {not in Vi}
5569 {only for MS-DOS, MS-Windows and OS/2}
5570 Enable reading and writing from devices. This may get Vim stuck on a
5571 device that can be opened but doesn't actually do the I/O. Therefore
5572 it is off by default.
5573 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5574 result in editing a device.
5575
5576
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005577 *'operatorfunc'* *'opfunc'*
5578'operatorfunc' 'opfunc' string (default: empty)
5579 global
5580 {not in Vi}
5581 This option specifies a function to be called by the |g@| operator.
5582 See |:map-operator| for more info and an example.
5583
5584 This option cannot be set from a |modeline| or in the |sandbox|, for
5585 security reasons.
5586
5587
Bram Moolenaar251e1912011-06-19 05:09:16 +02005588 *'osfiletype'* *'oft'*
5589'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 local to buffer
5591 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005592 This option was supported on RISC OS, which has been removed.
5593
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005595 *'packpath'* *'pp'*
5596'packpath' 'pp' string (default: see 'runtimepath')
5597 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005598 Directories used to find packages. See |packages|.
5599
5600
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005602'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 global
5604 Specifies the nroff macros that separate paragraphs. These are pairs
5605 of two letters (see |object-motions|).
5606
5607 *'paste'* *'nopaste'*
5608'paste' boolean (default off)
5609 global
5610 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005611 Put Vim in Paste mode. This is useful if you want to cut or copy
5612 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 unexpected effects.
5614 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005615 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616 knows about pasting and will mostly do the right thing without 'paste'
5617 being set. The same is true for a terminal where Vim handles the
5618 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005619 This option is reset when starting the GUI. Thus if you set it in
5620 your .vimrc it will work in a terminal, but not in the GUI. Setting
5621 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5622 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 When the 'paste' option is switched on (also when it was already on):
5624 - mapping in Insert mode and Command-line mode is disabled
5625 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005626 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005627 - 'expandtab' is reset
5628 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 - 'revins' is reset
5630 - 'ruler' is reset
5631 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005632 - 'smartindent' is reset
5633 - 'smarttab' is reset
5634 - 'softtabstop' is set to 0
5635 - 'textwidth' is set to 0
5636 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005639 - 'indentexpr'
5640 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641 NOTE: When you start editing another file while the 'paste' option is
5642 on, settings from the modelines or autocommands may change the
5643 settings again, causing trouble when pasting text. You might want to
5644 set the 'paste' option again.
5645 When the 'paste' option is reset the mentioned options are restored to
5646 the value before the moment 'paste' was switched from off to on.
5647 Resetting 'paste' before ever setting it does not have any effect.
5648 Since mapping doesn't work while 'paste' is active, you need to use
5649 the 'pastetoggle' option to toggle the 'paste' option with some key.
5650
5651 *'pastetoggle'* *'pt'*
5652'pastetoggle' 'pt' string (default "")
5653 global
5654 {not in Vi}
5655 When non-empty, specifies the key sequence that toggles the 'paste'
5656 option. This is like specifying a mapping: >
5657 :map {keys} :set invpaste<CR>
5658< Where {keys} is the value of 'pastetoggle'.
5659 The difference is that it will work even when 'paste' is set.
5660 'pastetoggle' works in Insert mode and Normal mode, but not in
5661 Command-line mode.
5662 Mappings are checked first, thus overrule 'pastetoggle'. However,
5663 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5664 this: >
5665 :map <F10> :set paste<CR>
5666 :map <F11> :set nopaste<CR>
5667 :imap <F10> <C-O>:set paste<CR>
5668 :imap <F11> <nop>
5669 :set pastetoggle=<F11>
5670< This will make <F10> start paste mode and <F11> stop paste mode.
5671 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5672 mode everything is inserted literally, except the 'pastetoggle' key
5673 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005674 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675
5676 *'pex'* *'patchexpr'*
5677'patchexpr' 'pex' string (default "")
5678 global
5679 {not in Vi}
5680 {not available when compiled without the |+diff|
5681 feature}
5682 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005683 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684
Bram Moolenaardbc28022014-07-26 13:40:44 +02005685 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005686'patchmode' 'pm' string (default "")
5687 global
5688 {not in Vi}
5689 When non-empty the oldest version of a file is kept. This can be used
5690 to keep the original version of a file if you are changing files in a
5691 source distribution. Only the first time that a file is written a
5692 copy of the original file will be kept. The name of the copy is the
5693 name of the original file with the string in the 'patchmode' option
5694 appended. This option should start with a dot. Use a string like
5695 ".org". 'backupdir' must not be empty for this to work (Detail: The
5696 backup file is renamed to the patchmode file after the new file has
5697 been successfully written, that's why it must be possible to write a
5698 backup file). If there was no file to be backed up, an empty file is
5699 created.
5700 When the 'backupskip' pattern matches, a patchmode file is not made.
5701 Using 'patchmode' for compressed files appends the extension at the
5702 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5703 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005704 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005706 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707'path' 'pa' string (default on Unix: ".,/usr/include,,"
5708 on OS/2: ".,/emx/include,,"
5709 other systems: ".,,")
5710 global or local to buffer |global-local|
5711 {not in Vi}
5712 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005713 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5714 provided that the file being searched for has a relative path (not
5715 starting with "/", "./" or "../"). The directories in the 'path'
5716 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 - Use commas to separate directory names: >
5718 :set path=.,/usr/local/include,/usr/include
5719< - Spaces can also be used to separate directory names (for backwards
5720 compatibility with version 3.0). To have a space in a directory
5721 name, precede it with an extra backslash, and escape the space: >
5722 :set path=.,/dir/with\\\ space
5723< - To include a comma in a directory name precede it with an extra
5724 backslash: >
5725 :set path=.,/dir/with\\,comma
5726< - To search relative to the directory of the current file, use: >
5727 :set path=.
5728< - To search in the current directory use an empty string between two
5729 commas: >
5730 :set path=,,
5731< - A directory name may end in a ':' or '/'.
5732 - Environment variables are expanded |:set_env|.
5733 - When using |netrw.vim| URLs can be used. For example, adding
5734 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005735 - Search upwards and downwards in a directory tree using "*", "**" and
5736 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 {not available when compiled without the |+path_extra| feature}
5738 - Careful with '\' characters, type two to get one in the option: >
5739 :set path=.,c:\\include
5740< Or just use '/' instead: >
5741 :set path=.,c:/include
5742< Don't forget "." or files won't even be found in the same directory as
5743 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005744 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 it is something like 256 or 1024 characters.
5746 You can check if all the include files are found, using the value of
5747 'path', see |:checkpath|.
5748 The use of |:set+=| and |:set-=| is preferred when adding or removing
5749 directories from the list. This avoids problems when a future version
5750 uses another default. To remove the current directory use: >
5751 :set path-=
5752< To add the current directory use: >
5753 :set path+=
5754< To use an environment variable, you probably need to replace the
5755 separator. Here is an example to append $INCL, in which directory
5756 names are separated with a semi-colon: >
5757 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5758< Replace the ';' with a ':' or whatever separator is used. Note that
5759 this doesn't work when $INCL contains a comma or white space.
5760
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005761 *'perldll'*
5762'perldll' string (default depends on the build)
5763 global
5764 {not in Vi}
5765 {only available when compiled with the |+perl/dyn|
5766 feature}
5767 Specifies the name of the Perl shared library. The default is
5768 DYNAMIC_PERL_DLL, which was specified at compile time.
5769 Environment variables are expanded |:set_env|.
5770 This option cannot be set from a |modeline| or in the |sandbox|, for
5771 security reasons.
5772
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5774'preserveindent' 'pi' boolean (default off)
5775 local to buffer
5776 {not in Vi}
5777 When changing the indent of the current line, preserve as much of the
5778 indent structure as possible. Normally the indent is replaced by a
5779 series of tabs followed by spaces as required (unless |'expandtab'| is
5780 enabled, in which case only spaces are used). Enabling this option
5781 means the indent will preserve as many existing characters as possible
5782 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005783 'expandtab' does not apply to the preserved white space, a Tab remains
5784 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785 NOTE: When using ">>" multiple times the resulting indent is a mix of
5786 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005787 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 Also see 'copyindent'.
5789 Use |:retab| to clean up white space.
5790
5791 *'previewheight'* *'pvh'*
5792'previewheight' 'pvh' number (default 12)
5793 global
5794 {not in Vi}
5795 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005796 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005797 Default height for a preview window. Used for |:ptag| and associated
5798 commands. Used for |CTRL-W_}| when no count is given.
5799
5800 *'previewwindow'* *'nopreviewwindow'*
5801 *'pvw'* *'nopvw'* *E590*
5802'previewwindow' 'pvw' boolean (default off)
5803 local to window
5804 {not in Vi}
5805 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005806 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005807 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 set. It's normally not set directly, but by using one of the commands
5809 |:ptag|, |:pedit|, etc.
5810
5811 *'printdevice'* *'pdev'*
5812'printdevice' 'pdev' string (default empty)
5813 global
5814 {not in Vi}
5815 {only available when compiled with the |+printer|
5816 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005817 The name of the printer to be used for |:hardcopy|.
5818 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005819 This option cannot be set from a |modeline| or in the |sandbox|, for
5820 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821
Bram Moolenaar8299df92004-07-10 09:47:34 +00005822 *'printencoding'* *'penc'*
5823'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 global
5825 {not in Vi}
5826 {only available when compiled with the |+printer|
5827 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005828 Sets the character encoding used when printing.
5829 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830
5831 *'printexpr'* *'pexpr'*
5832'printexpr' 'pexpr' String (default: see below)
5833 global
5834 {not in Vi}
5835 {only available when compiled with the |+printer|
5836 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005837 Expression used to print the PostScript produced with |:hardcopy|.
5838 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005839 This option cannot be set from a |modeline| or in the |sandbox|, for
5840 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841
Bram Moolenaar8299df92004-07-10 09:47:34 +00005842 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843'printfont' 'pfn' string (default "courier")
5844 global
5845 {not in Vi}
5846 {only available when compiled with the |+printer|
5847 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005848 The name of the font that will be used for |:hardcopy|.
5849 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850
5851 *'printheader'* *'pheader'*
5852'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5853 global
5854 {not in Vi}
5855 {only available when compiled with the |+printer|
5856 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005857 The format of the header produced in |:hardcopy| output.
5858 See |pheader-option|.
5859
5860 *'printmbcharset'* *'pmbcs'*
5861'printmbcharset' 'pmbcs' string (default "")
5862 global
5863 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005864 {only available when compiled with the |+printer|,
5865 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005866 The CJK character set to be used for CJK output from |:hardcopy|.
5867 See |pmbcs-option|.
5868
5869 *'printmbfont'* *'pmbfn'*
5870'printmbfont' 'pmbfn' string (default "")
5871 global
5872 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005873 {only available when compiled with the |+printer|,
5874 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005875 List of font names to be used for CJK output from |:hardcopy|.
5876 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877
5878 *'printoptions'* *'popt'*
5879'printoptions' 'popt' string (default "")
5880 global
5881 {not in Vi}
5882 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005883 List of items that control the format of the output of |:hardcopy|.
5884 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005886 *'prompt'* *'noprompt'*
5887'prompt' boolean (default on)
5888 global
5889 When on a ":" prompt is used in Ex mode.
5890
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005891 *'pumheight'* *'ph'*
5892'pumheight' 'ph' number (default 0)
5893 global
5894 {not available when compiled without the
5895 |+insert_expand| feature}
5896 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005897 Determines the maximum number of items to show in the popup menu for
5898 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005899 |ins-completion-menu|.
5900
Bram Moolenaard94464e2015-11-02 15:28:18 +01005901 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005902'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005903 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005904 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005905 {only available when compiled with the |+python/dyn|
5906 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005907 Specifies the name of the Python 2.x shared library. The default is
5908 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005909 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005912
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005913 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005914'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005915 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005916 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005917 {only available when compiled with the |+python3/dyn|
5918 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005919 Specifies the name of the Python 3 shared library. The default is
5920 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005921 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005922 This option cannot be set from a |modeline| or in the |sandbox|, for
5923 security reasons.
5924
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005925 *'pyxversion'* *'pyx'*
5926'pyxversion' 'pyx' number (default depends on the build)
5927 global
5928 {not in Vi}
5929 {only available when compiled with the |+python| or
5930 the |+python3| feature}
5931 Specifies the python version used for pyx* functions and commands
5932 |python_x|. The default value is as follows:
5933
5934 Compiled with Default ~
5935 |+python| and |+python3| 0
5936 only |+python| 2
5937 only |+python3| 3
5938
5939 Available values are 0, 2 and 3.
5940 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5941 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5942 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5943 to 2 if Python 2 is available.
5944 See also: |has-pythonx|
5945
5946 If Vim is compiled with only |+python| or |+python3| setting
5947 'pyxversion' has no effect. The pyx* functions and commands are
5948 always the same as the compiled version.
5949
5950 This option cannot be set from a |modeline| or in the |sandbox|, for
5951 security reasons.
5952
Bram Moolenaar677ee682005-01-27 14:41:15 +00005953 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005954'quoteescape' 'qe' string (default "\")
5955 local to buffer
5956 {not in Vi}
5957 The characters that are used to escape quotes in a string. Used for
5958 objects like a', a" and a` |a'|.
5959 When one of the characters in this option is found inside a string,
5960 the following character will be skipped. The default value makes the
5961 text "foo\"bar\\" considered to be one string.
5962
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5964'readonly' 'ro' boolean (default off)
5965 local to buffer
5966 If on, writes fail unless you use a '!'. Protects you from
5967 accidentally overwriting a file. Default on when Vim is started
5968 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005969 When using ":w!" the 'readonly' option is reset for the current
5970 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005972 set for the newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005973 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005975 *'redrawtime'* *'rdt'*
5976'redrawtime' 'rdt' number (default 2000)
5977 global
5978 {not in Vi}
5979 {only available when compiled with the |+reltime|
5980 feature}
5981 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005982 searching for patterns for 'hlsearch', |:match| highlighting an syntax
5983 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005984 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005985 matches will be highlighted.
5986 For syntax highlighting the time applies per window. When over the
5987 limit syntax highlighting is disabled until |CTRL-L| is used.
5988 This is used to avoid that Vim hangs when using a very complicated
5989 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005990
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005991 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005992'regexpengine' 're' number (default 0)
5993 global
5994 {not in Vi}
5995 This selects the default regexp engine. |two-engines|
5996 The possible values are:
5997 0 automatic selection
5998 1 old engine
5999 2 NFA engine
6000 Note that when using the NFA engine and the pattern contains something
6001 that is not supported the pattern will not match. This is only useful
6002 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01006003 Using automatic selection enables Vim to switch the engine, if the
6004 default engine becomes too costly. E.g., when the NFA engine uses too
6005 many states. This should prevent Vim from hanging on a combination of
6006 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02006007
Bram Moolenaar64486672010-05-16 15:46:46 +02006008 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
6009'relativenumber' 'rnu' boolean (default off)
6010 local to window
6011 {not in Vi}
6012 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02006013 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02006014 precede some vertical motion commands (e.g. j k + -) with, without
6015 having to calculate it yourself. Especially useful in combination with
6016 other commands (e.g. y d c < > gq gw =).
6017 When the 'n' option is excluded from 'cpoptions' a wrapped
6018 line will not use the column of line numbers (this is the default when
6019 'compatible' isn't set).
6020 The 'numberwidth' option can be used to set the room used for the line
6021 number.
6022 When a long, wrapped line doesn't start with the first character, '-'
6023 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006024 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
6025 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02006026
6027 The number in front of the cursor line also depends on the value of
6028 'number', see |number_relativenumber| for all combinations of the two
6029 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02006030
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 *'remap'* *'noremap'*
6032'remap' boolean (default on)
6033 global
6034 Allows for mappings to work recursively. If you do not want this for
6035 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00006036 NOTE: To avoid portability problems with Vim scripts, always keep
6037 this option at the default "on". Only switch it off when working with
6038 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006040 *'renderoptions'* *'rop'*
6041'renderoptions' 'rop' string (default: empty)
6042 global
6043 {not in Vi}
6044 {only available when compiled with GUI and DIRECTX on
6045 MS-Windows}
6046 Select a text renderer and set its options. The options depend on the
6047 renderer.
6048
6049 Syntax: >
6050 set rop=type:{renderer}(,{name}:{value})*
6051<
6052 Currently, only one optional renderer is available.
6053
6054 render behavior ~
6055 directx Vim will draw text using DirectX (DirectWrite). It makes
6056 drawn glyphs more beautiful than default GDI.
6057 It requires 'encoding' is "utf-8", and only works on
6058 MS-Windows Vista or newer version.
6059
6060 Options:
6061 name meaning type value ~
6062 gamma gamma float 1.0 - 2.2 (maybe)
6063 contrast enhancedContrast float (unknown)
6064 level clearTypeLevel float (unknown)
6065 geom pixelGeometry int 0 - 2 (see below)
6066 renmode renderingMode int 0 - 6 (see below)
6067 taamode textAntialiasMode int 0 - 3 (see below)
6068
6069 See this URL for detail:
6070 http://msdn.microsoft.com/en-us/library/dd368190.aspx
6071
6072 For geom: structure of a device pixel.
6073 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6074 1 - DWRITE_PIXEL_GEOMETRY_RGB
6075 2 - DWRITE_PIXEL_GEOMETRY_BGR
6076
6077 See this URL for detail:
6078 http://msdn.microsoft.com/en-us/library/dd368114.aspx
6079
6080 For renmode: method of rendering glyphs.
6081 0 - DWRITE_RENDERING_MODE_DEFAULT
6082 1 - DWRITE_RENDERING_MODE_ALIASED
6083 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6084 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6085 4 - DWRITE_RENDERING_MODE_NATURAL
6086 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6087 6 - DWRITE_RENDERING_MODE_OUTLINE
6088
6089 See this URL for detail:
6090 http://msdn.microsoft.com/en-us/library/dd368118.aspx
6091
6092 For taamode: antialiasing mode used for drawing text.
6093 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6094 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6095 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6096 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6097
6098 See this URL for detail:
6099 http://msdn.microsoft.com/en-us/library/dd368170.aspx
6100
6101 Example: >
6102 set encoding=utf-8
6103 set gfn=Ricty_Diminished:h12:cSHIFTJIS
6104 set rop=type:directx
6105<
6106 If select a raster font (Courier, Terminal or FixedSys) to
6107 'guifont', it fallbacks to be drawn by GDI automatically.
6108
6109 Other render types are currently not supported.
6110
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 *'report'*
6112'report' number (default 2)
6113 global
6114 Threshold for reporting number of lines changed. When the number of
6115 changed lines is more than 'report' a message will be given for most
6116 ":" commands. If you want it always, set 'report' to 0.
6117 For the ":substitute" command the number of substitutions is used
6118 instead of the number of lines.
6119
6120 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6121'restorescreen' 'rs' boolean (default on)
6122 global
6123 {not in Vi} {only in Windows 95/NT console version}
6124 When set, the screen contents is restored when exiting Vim. This also
6125 happens when executing external commands.
6126
6127 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6128 options in your .vimrc. To disable restoring:
6129 set t_ti= t_te=
6130 To enable restoring (for an xterm):
6131 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6132 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6133
6134 *'revins'* *'ri'* *'norevins'* *'nori'*
6135'revins' 'ri' boolean (default off)
6136 global
6137 {not in Vi}
6138 {only available when compiled with the |+rightleft|
6139 feature}
6140 Inserting characters in Insert mode will work backwards. See "typing
6141 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6142 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006143 NOTE: This option is reset when 'compatible' is set.
6144 This option is reset when 'paste' is set and restored when 'paste' is
6145 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146
6147 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6148'rightleft' 'rl' boolean (default off)
6149 local to window
6150 {not in Vi}
6151 {only available when compiled with the |+rightleft|
6152 feature}
6153 When on, display orientation becomes right-to-left, i.e., characters
6154 that are stored in the file appear from the right to the left.
6155 Using this option, it is possible to edit files for languages that
6156 are written from the right to the left such as Hebrew and Arabic.
6157 This option is per window, so it is possible to edit mixed files
6158 simultaneously, or to view the same file in both ways (this is
6159 useful whenever you have a mixed text file with both right-to-left
6160 and left-to-right strings so that both sets are displayed properly
6161 in different windows). Also see |rileft.txt|.
6162
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006163 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164'rightleftcmd' 'rlc' string (default "search")
6165 local to window
6166 {not in Vi}
6167 {only available when compiled with the |+rightleft|
6168 feature}
6169 Each word in this option enables the command line editing to work in
6170 right-to-left mode for a group of commands:
6171
6172 search "/" and "?" commands
6173
6174 This is useful for languages such as Hebrew, Arabic and Farsi.
6175 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6176
Bram Moolenaard94464e2015-11-02 15:28:18 +01006177 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006178'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006179 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006180 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006181 {only available when compiled with the |+ruby/dyn|
6182 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006183 Specifies the name of the Ruby shared library. The default is
6184 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006185 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006186 This option cannot be set from a |modeline| or in the |sandbox|, for
6187 security reasons.
6188
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006190'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 global
6192 {not in Vi}
6193 {not available when compiled without the
6194 |+cmdline_info| feature}
6195 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006196 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 text in the file is shown on the far right:
6198 Top first line is visible
6199 Bot last line is visible
6200 All first and last line are visible
6201 45% relative position in the file
6202 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006203 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006205 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 this option takes precedence over 'ruler' and 'rulerformat'
6207 If the number of characters displayed is different from the number of
6208 bytes in the text (e.g., for a TAB or a multi-byte character), both
6209 the text column (byte number) and the screen column are shown,
6210 separated with a dash.
6211 For an empty line "0-1" is shown.
6212 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006213 This option is reset when 'paste' is set and restored when 'paste' is
6214 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 If you don't want to see the ruler all the time but want to know where
6216 you are, use "g CTRL-G" |g_CTRL-G|.
6217 NOTE: This option is reset when 'compatible' is set.
6218
6219 *'rulerformat'* *'ruf'*
6220'rulerformat' 'ruf' string (default empty)
6221 global
6222 {not in Vi}
6223 {not available when compiled without the |+statusline|
6224 feature}
6225 When this option is not empty, it determines the content of the ruler
6226 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006227 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 The default ruler width is 17 characters. To make the ruler 15
6229 characters wide, put "%15(" at the start and "%)" at the end.
6230 Example: >
6231 :set rulerformat=%15(%c%V\ %p%%%)
6232<
6233 *'runtimepath'* *'rtp'* *vimfiles*
6234'runtimepath' 'rtp' string (default:
6235 Unix: "$HOME/.vim,
6236 $VIM/vimfiles,
6237 $VIMRUNTIME,
6238 $VIM/vimfiles/after,
6239 $HOME/.vim/after"
6240 Amiga: "home:vimfiles,
6241 $VIM/vimfiles,
6242 $VIMRUNTIME,
6243 $VIM/vimfiles/after,
6244 home:vimfiles/after"
6245 PC, OS/2: "$HOME/vimfiles,
6246 $VIM/vimfiles,
6247 $VIMRUNTIME,
6248 $VIM/vimfiles/after,
6249 $HOME/vimfiles/after"
6250 Macintosh: "$VIM:vimfiles,
6251 $VIMRUNTIME,
6252 $VIM:vimfiles:after"
6253 RISC-OS: "Choices:vimfiles,
6254 $VIMRUNTIME,
6255 Choices:vimfiles/after"
6256 VMS: "sys$login:vimfiles,
6257 $VIM/vimfiles,
6258 $VIMRUNTIME,
6259 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006260 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 global
6262 {not in Vi}
6263 This is a list of directories which will be searched for runtime
6264 files:
6265 filetype.vim filetypes by file name |new-filetype|
6266 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006267 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 colors/ color scheme files |:colorscheme|
6269 compiler/ compiler files |:compiler|
6270 doc/ documentation |write-local-help|
6271 ftplugin/ filetype plugins |write-filetype-plugin|
6272 indent/ indent scripts |indent-expression|
6273 keymap/ key mapping files |mbyte-keymap|
6274 lang/ menu translations |:menutrans|
6275 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006276 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 plugin/ plugin scripts |write-plugin|
6278 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006279 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 syntax/ syntax files |mysyntaxfile|
6281 tutor/ files for vimtutor |tutor|
6282
6283 And any other file searched for with the |:runtime| command.
6284
6285 The defaults for most systems are setup to search five locations:
6286 1. In your home directory, for your personal preferences.
6287 2. In a system-wide Vim directory, for preferences from the system
6288 administrator.
6289 3. In $VIMRUNTIME, for files distributed with Vim.
6290 *after-directory*
6291 4. In the "after" directory in the system-wide Vim directory. This is
6292 for the system administrator to overrule or add to the distributed
6293 defaults (rarely needed)
6294 5. In the "after" directory in your home directory. This is for
6295 personal preferences to overrule or add to the distributed defaults
6296 or system-wide settings (rarely needed).
6297
Bram Moolenaard0796902016-09-16 20:02:31 +02006298 More entries are added when using |packages|. If it gets very long
6299 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6300 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006301
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6303 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006304 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 wildcards.
6306 See |:runtime|.
6307 Example: >
6308 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6309< This will use the directory "~/vimruntime" first (containing your
6310 personal Vim runtime files), then "/mygroup/vim" (shared between a
6311 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6312 files).
6313 You probably should always include $VIMRUNTIME somewhere, to use the
6314 distributed runtime files. You can put a directory before $VIMRUNTIME
6315 to find files which replace a distributed runtime files. You can put
6316 a directory after $VIMRUNTIME to find files which add to distributed
6317 runtime files.
6318 This option cannot be set from a |modeline| or in the |sandbox|, for
6319 security reasons.
6320
6321 *'scroll'* *'scr'*
6322'scroll' 'scr' number (default: half the window height)
6323 local to window
6324 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6325 set to half the number of lines in the window when the window size
6326 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006327 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6329 the number of screen lines instead of file lines, makes a difference
6330 when lines wrap}
6331
6332 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6333'scrollbind' 'scb' boolean (default off)
6334 local to window
6335 {not in Vi}
6336 {not available when compiled without the |+scrollbind|
6337 feature}
6338 See also |scroll-binding|. When this option is set, the current
6339 window scrolls as other scrollbind windows (windows that also have
6340 this option set) scroll. This option is useful for viewing the
6341 differences between two versions of a file, see 'diff'.
6342 See |'scrollopt'| for options that determine how this option should be
6343 interpreted.
6344 This option is mostly reset when splitting a window to edit another
6345 file. This means that ":split | edit file" results in two windows
6346 with scroll-binding, but ":split file" does not.
6347
6348 *'scrolljump'* *'sj'*
6349'scrolljump' 'sj' number (default 1)
6350 global
6351 {not in Vi}
6352 Minimal number of lines to scroll when the cursor gets off the
6353 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6354 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006355 When set to a negative number from -1 to -100 this is used as the
6356 percentage of the window height. Thus -50 scrolls half the window
6357 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006358 NOTE: This option is set to 1 when 'compatible' is set.
6359
6360 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006361'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362 global
6363 {not in Vi}
6364 Minimal number of screen lines to keep above and below the cursor.
6365 This will make some context visible around where you are working. If
6366 you set it to a very large value (999) the cursor line will always be
6367 in the middle of the window (except at the start or end of the file or
6368 when long lines wrap).
6369 For scrolling horizontally see 'sidescrolloff'.
6370 NOTE: This option is set to 0 when 'compatible' is set.
6371
6372 *'scrollopt'* *'sbo'*
6373'scrollopt' 'sbo' string (default "ver,jump")
6374 global
6375 {not available when compiled without the |+scrollbind|
6376 feature}
6377 {not in Vi}
6378 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006379 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6380 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 The following words are available:
6382 ver Bind vertical scrolling for 'scrollbind' windows
6383 hor Bind horizontal scrolling for 'scrollbind' windows
6384 jump Applies to the offset between two windows for vertical
6385 scrolling. This offset is the difference in the first
6386 displayed line of the bound windows. When moving
6387 around in a window, another 'scrollbind' window may
6388 reach a position before the start or after the end of
6389 the buffer. The offset is not changed though, when
6390 moving back the 'scrollbind' window will try to scroll
6391 to the desired position when possible.
6392 When now making that window the current one, two
6393 things can be done with the relative offset:
6394 1. When "jump" is not included, the relative offset is
6395 adjusted for the scroll position in the new current
6396 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006397 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 2. When "jump" is included, the other windows are
6399 scrolled to keep the same relative offset. When
6400 going back to the other window, it still uses the
6401 same relative offset.
6402 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006403 When 'diff' mode is active there always is vertical scroll binding,
6404 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405
6406 *'sections'* *'sect'*
6407'sections' 'sect' string (default "SHNHH HUnhsh")
6408 global
6409 Specifies the nroff macros that separate sections. These are pairs of
6410 two letters (See |object-motions|). The default makes a section start
6411 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6412
6413 *'secure'* *'nosecure'* *E523*
6414'secure' boolean (default off)
6415 global
6416 {not in Vi}
6417 When on, ":autocmd", shell and write commands are not allowed in
6418 ".vimrc" and ".exrc" in the current directory and map commands are
6419 displayed. Switch it off only if you know that you will not run into
6420 problems, or when the 'exrc' option is off. On Unix this option is
6421 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006422 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 'secure' at the end of your ~/.vimrc then.
6424 This option cannot be set from a |modeline| or in the |sandbox|, for
6425 security reasons.
6426
6427 *'selection'* *'sel'*
6428'selection' 'sel' string (default "inclusive")
6429 global
6430 {not in Vi}
6431 This option defines the behavior of the selection. It is only used
6432 in Visual and Select mode.
6433 Possible values:
6434 value past line inclusive ~
6435 old no yes
6436 inclusive yes yes
6437 exclusive yes no
6438 "past line" means that the cursor is allowed to be positioned one
6439 character past the line.
6440 "inclusive" means that the last character of the selection is included
6441 in an operation. For example, when "x" is used to delete the
6442 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006443 When "old" is used and 'virtualedit' allows the cursor to move past
6444 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 Note that when "exclusive" is used and selecting from the end
6446 backwards, you cannot include the last character of a line, when
6447 starting in Normal mode and 'virtualedit' empty.
6448
6449 The 'selection' option is set by the |:behave| command.
6450
6451 *'selectmode'* *'slm'*
6452'selectmode' 'slm' string (default "")
6453 global
6454 {not in Vi}
6455 This is a comma separated list of words, which specifies when to start
6456 Select mode instead of Visual mode, when a selection is started.
6457 Possible values:
6458 mouse when using the mouse
6459 key when using shifted special keys
6460 cmd when using "v", "V" or CTRL-V
6461 See |Select-mode|.
6462 The 'selectmode' option is set by the |:behave| command.
6463
6464 *'sessionoptions'* *'ssop'*
6465'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006466 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 global
6468 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006469 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 feature}
6471 Changes the effect of the |:mksession| command. It is a comma
6472 separated list of words. Each word enables saving and restoring
6473 something:
6474 word save and restore ~
6475 blank empty windows
6476 buffers hidden and unloaded buffers, not just those in windows
6477 curdir the current directory
6478 folds manually created folds, opened/closed folds and local
6479 fold options
6480 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006481 and contain at least one lowercase letter. Only
6482 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 help the help window
6484 localoptions options and mappings local to a window or buffer (not
6485 global values for local options)
6486 options all options and mappings (also global values for local
6487 options)
6488 resize size of the Vim window: 'lines' and 'columns'
6489 sesdir the directory in which the session file is located
6490 will become the current directory (useful with
6491 projects accessed over a network from different
6492 systems)
6493 slash backslashes in file names replaced with forward
6494 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006495 tabpages all tab pages; without this only the current tab page
6496 is restored, so that you can make a session for each
6497 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 unix with Unix end-of-line format (single <NL>), even when
6499 on Windows or DOS
6500 winpos position of the whole Vim window
6501 winsize window sizes
6502
6503 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006504 When neither "curdir" nor "sesdir" is included, file names are stored
6505 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 "slash" and "unix" are useful on Windows when sharing session files
6507 with Unix. The Unix version of Vim cannot source dos format scripts,
6508 but the Windows version of Vim can source unix format scripts.
6509
6510 *'shell'* *'sh'* *E91*
6511'shell' 'sh' string (default $SHELL or "sh",
6512 MS-DOS and Win32: "command.com" or
6513 "cmd.exe", OS/2: "cmd")
6514 global
6515 Name of the shell to use for ! and :! commands. When changing the
6516 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6517 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006518 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 See |option-backslash| about including spaces and backslashes.
6520 Environment variables are expanded |:set_env|.
6521 If the name of the shell contains a space, you might need to enclose
6522 it in quotes. Example: >
6523 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6524< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006525 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 "-f" is not inside the quotes, because it is not part of the command
6527 name. And Vim automagically recognizes the backslashes that are path
6528 separators.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 Under MS-Windows, when the executable ends in ".com" it must be
6530 included. Thus setting the shell to "command.com" or "4dos.com"
6531 works, but "command" and "4dos" do not work for all commands (e.g.,
6532 filtering).
6533 For unknown reasons, when using "4dos.com" the current directory is
6534 changed to "C:\". To avoid this set 'shell' like this: >
6535 :set shell=command.com\ /c\ 4dos
6536< This option cannot be set from a |modeline| or in the |sandbox|, for
6537 security reasons.
6538
6539 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006540'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006541 MS-DOS and Win32, when 'shell' does not
6542 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 global
6544 {not in Vi}
6545 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6546 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6547 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006548 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006549 On Unix it can have more than one flag. Each white space separated
6550 part is passed as an argument to the shell command.
6551 See |option-backslash| about including spaces and backslashes.
6552 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 This option cannot be set from a |modeline| or in the |sandbox|, for
6554 security reasons.
6555
6556 *'shellpipe'* *'sp'*
6557'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6558 global
6559 {not in Vi}
6560 {not available when compiled without the |+quickfix|
6561 feature}
6562 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006563 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 including spaces and backslashes.
6565 The name of the temporary file can be represented by "%s" if necessary
6566 (the file name is appended automatically if no %s appears in the value
6567 of this option).
6568 For the Amiga and MS-DOS the default is ">". The output is directly
6569 saved in a file and not echoed to the screen.
6570 For Unix the default it "| tee". The stdout of the compiler is saved
6571 in a file and echoed to the screen. If the 'shell' option is "csh" or
6572 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006573 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6574 default becomes "2>&1| tee". This means that stderr is also included.
6575 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6576 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 The initialization of this option is done after reading the ".vimrc"
6578 and the other initializations, so that when the 'shell' option is set
6579 there, the 'shellpipe' option changes automatically, unless it was
6580 explicitly set before.
6581 When 'shellpipe' is set to an empty string, no redirection of the
6582 ":make" output will be done. This is useful if you use a 'makeprg'
6583 that writes to 'makeef' by itself. If you want no piping, but do
6584 want to include the 'makeef', set 'shellpipe' to a single space.
6585 Don't forget to precede the space with a backslash: ":set sp=\ ".
6586 In the future pipes may be used for filtering and this option will
6587 become obsolete (at least for Unix).
6588 This option cannot be set from a |modeline| or in the |sandbox|, for
6589 security reasons.
6590
6591 *'shellquote'* *'shq'*
6592'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6593 contains "sh" somewhere: "\"")
6594 global
6595 {not in Vi}
6596 Quoting character(s), put around the command passed to the shell, for
6597 the "!" and ":!" commands. The redirection is kept outside of the
6598 quoting. See 'shellxquote' to include the redirection. It's
6599 probably not useful to set both options.
6600 This is an empty string by default. Only known to be useful for
6601 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6602 or bash, where it should be "\"". The default is adjusted according
6603 the value of 'shell', to reduce the need to set this option by the
6604 user. See |dos-shell|.
6605 This option cannot be set from a |modeline| or in the |sandbox|, for
6606 security reasons.
6607
6608 *'shellredir'* *'srr'*
6609'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6610 global
6611 {not in Vi}
6612 String to be used to put the output of a filter command in a temporary
6613 file. See also |:!|. See |option-backslash| about including spaces
6614 and backslashes.
6615 The name of the temporary file can be represented by "%s" if necessary
6616 (the file name is appended automatically if no %s appears in the value
6617 of this option).
6618 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6619 or "zsh" during initializations, the default becomes ">&". If the
6620 'shell' option is "sh", "ksh" or "bash" the default becomes
6621 ">%s 2>&1". This means that stderr is also included.
6622 For Win32, the Unix checks are done and additionally "cmd" is checked
6623 for, which makes the default ">%s 2>&1". Also, the same names with
6624 ".exe" appended are checked for.
6625 The initialization of this option is done after reading the ".vimrc"
6626 and the other initializations, so that when the 'shell' option is set
6627 there, the 'shellredir' option changes automatically unless it was
6628 explicitly set before.
6629 In the future pipes may be used for filtering and this option will
6630 become obsolete (at least for Unix).
6631 This option cannot be set from a |modeline| or in the |sandbox|, for
6632 security reasons.
6633
6634 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6635'shellslash' 'ssl' boolean (default off)
6636 global
6637 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6638 When set, a forward slash is used when expanding file names. This is
6639 useful when a Unix-like shell is used instead of command.com or
6640 cmd.exe. Backward slashes can still be typed, but they are changed to
6641 forward slashes by Vim.
6642 Note that setting or resetting this option has no effect for some
6643 existing file names, thus this option needs to be set before opening
6644 any file for best results. This might change in the future.
6645 'shellslash' only works when a backslash can be used as a path
6646 separator. To test if this is so use: >
6647 if exists('+shellslash')
6648<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006649 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6650'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6651 global
6652 {not in Vi}
6653 When on, use temp files for shell commands. When off use a pipe.
6654 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006655 Currently a pipe is only supported on Unix and MS-Windows 2K and
6656 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006657 :if has("filterpipe")
6658< The advantage of using a pipe is that nobody can read the temp file
6659 and the 'shell' command does not need to support redirection.
6660 The advantage of using a temp file is that the file type and encoding
6661 can be detected.
6662 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6663 |FilterWritePost| autocommands event are not triggered when
6664 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006665 The `system()` function does not respect this option and always uses
6666 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006667 NOTE: This option is set to the Vim default value when 'compatible'
6668 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006669
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 *'shelltype'* *'st'*
6671'shelltype' 'st' number (default 0)
6672 global
6673 {not in Vi} {only for the Amiga}
6674 On the Amiga this option influences the way how the commands work
6675 which use a shell.
6676 0 and 1: always use the shell
6677 2 and 3: use the shell only to filter lines
6678 4 and 5: use shell only for ':sh' command
6679 When not using the shell, the command is executed directly.
6680
6681 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6682 1 and 3: use "shell cmd" to start external commands
6683
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006684 *'shellxescape'* *'sxe'*
6685'shellxescape' 'sxe' string (default: "";
6686 for MS-DOS and MS-Windows: "\"&|<>()@^")
6687 global
6688 {not in Vi}
6689 When 'shellxquote' is set to "(" then the characters listed in this
6690 option will be escaped with a '^' character. This makes it possible
6691 to execute most external commands with cmd.exe.
6692
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 *'shellxquote'* *'sxq'*
6694'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006695 for Win32, when 'shell' is cmd.exe: "("
6696 for Win32, when 'shell' contains "sh"
6697 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 for Unix, when using system(): "\"")
6699 global
6700 {not in Vi}
6701 Quoting character(s), put around the command passed to the shell, for
6702 the "!" and ":!" commands. Includes the redirection. See
6703 'shellquote' to exclude the redirection. It's probably not useful
6704 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006705 When the value is '(' then ')' is appended. When the value is '"('
6706 then ')"' is appended.
6707 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006708 This is an empty string by default on most systems, but is known to be
6709 useful for on Win32 version, either for cmd.exe which automatically
6710 strips off the first and last quote on a command, or 3rd-party shells
6711 such as the MKS Korn Shell or bash, where it should be "\"". The
6712 default is adjusted according the value of 'shell', to reduce the need
6713 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 This option cannot be set from a |modeline| or in the |sandbox|, for
6715 security reasons.
6716
6717 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6718'shiftround' 'sr' boolean (default off)
6719 global
6720 {not in Vi}
6721 Round indent to multiple of 'shiftwidth'. Applies to > and <
6722 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6723 a multiple of 'shiftwidth' (this is Vi compatible).
6724 NOTE: This option is reset when 'compatible' is set.
6725
6726 *'shiftwidth'* *'sw'*
6727'shiftwidth' 'sw' number (default 8)
6728 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006729 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006731 When zero the 'ts' value will be used. Use the |shiftwidth()|
6732 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733
6734 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006735'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6736 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737 global
6738 {not in Vi}
6739 This option helps to avoid all the |hit-enter| prompts caused by file
6740 messages, for example with CTRL-G, and to avoid some other messages.
6741 It is a list of flags:
6742 flag meaning when present ~
6743 f use "(3 of 5)" instead of "(file 3 of 5)"
6744 i use "[noeol]" instead of "[Incomplete last line]"
6745 l use "999L, 888C" instead of "999 lines, 888 characters"
6746 m use "[+]" instead of "[Modified]"
6747 n use "[New]" instead of "[New File]"
6748 r use "[RO]" instead of "[readonly]"
6749 w use "[w]" instead of "written" for file write message
6750 and "[a]" instead of "appended" for ':w >> file' command
6751 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6752 "[unix format]" and "[mac]" instead of "[mac format]".
6753 a all of the above abbreviations
6754
6755 o overwrite message for writing a file with subsequent message
6756 for reading a file (useful for ":wn" or when 'autowrite' on)
6757 O message for reading a file overwrites any previous message.
6758 Also for quickfix message (e.g., ":cn").
6759 s don't give "search hit BOTTOM, continuing at TOP" or "search
6760 hit TOP, continuing at BOTTOM" messages
6761 t truncate file message at the start if it is too long to fit
6762 on the command-line, "<" will appear in the left most column.
6763 Ignored in Ex mode.
6764 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006765 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 Ignored in Ex mode.
6767 W don't give "written" or "[w]" when writing a file
6768 A don't give the "ATTENTION" message when an existing swap file
6769 is found.
6770 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006771 c don't give |ins-completion-menu| messages. For example,
6772 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6773 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006774 q use "recording" instead of "recording @a"
6775 F don't give the file info when editing a file, like `:silent`
6776 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777
6778 This gives you the opportunity to avoid that a change between buffers
6779 requires you to hit <Enter>, but still gives as useful a message as
6780 possible for the space available. To get the whole message that you
6781 would have got with 'shm' empty, use ":file!"
6782 Useful values:
6783 shm= No abbreviation of message.
6784 shm=a Abbreviation, but no loss of information.
6785 shm=at Abbreviation, and truncate message when necessary.
6786
6787 NOTE: This option is set to the Vi default value when 'compatible' is
6788 set and to the Vim default value when 'compatible' is reset.
6789
6790 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6791'shortname' 'sn' boolean (default off)
6792 local to buffer
6793 {not in Vi, not in MS-DOS versions}
6794 Filenames are assumed to be 8 characters plus one extension of 3
6795 characters. Multiple dots in file names are not allowed. When this
6796 option is on, dots in file names are replaced with underscores when
6797 adding an extension (".~" or ".swp"). This option is not available
6798 for MS-DOS, because then it would always be on. This option is useful
6799 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6800 or crossdos. When running the Win32 GUI version under Win32s, this
6801 option is always on by default.
6802
6803 *'showbreak'* *'sbr'* *E595*
6804'showbreak' 'sbr' string (default "")
6805 global
6806 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006807 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 feature}
6809 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006810 values are "> " or "+++ ": >
6811 :set showbreak=>\
6812< Note the backslash to escape the trailing space. It's easier like
6813 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006814 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006815< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816 comma (in a future version the comma might be used to separate the
6817 part that is shown at the end and at the start of a line).
6818 The characters are highlighted according to the '@' flag in
6819 'highlight'.
6820 Note that tabs after the showbreak will be displayed differently.
6821 If you want the 'showbreak' to appear in between line numbers, add the
6822 "n" flag to 'cpoptions'.
6823
6824 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006825'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6826 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 global
6828 {not in Vi}
6829 {not available when compiled without the
6830 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006831 Show (partial) command in the last line of the screen. Set this
6832 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 In Visual mode the size of the selected area is shown:
6834 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006835 If the number of bytes is different it is also displayed: "2-6"
6836 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006838 - When selecting a block, the size in screen characters:
6839 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 NOTE: This option is set to the Vi default value when 'compatible' is
6841 set and to the Vim default value when 'compatible' is reset.
6842
6843 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6844'showfulltag' 'sft' boolean (default off)
6845 global
6846 {not in Vi}
6847 When completing a word in insert mode (see |ins-completion|) from the
6848 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006849 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006850 matched a C function, you can see a template for what arguments are
6851 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006852 Note that this doesn't work well together with having "longest" in
6853 'completeopt', because the completion from the search pattern may not
6854 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855
6856 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6857'showmatch' 'sm' boolean (default off)
6858 global
6859 When a bracket is inserted, briefly jump to the matching one. The
6860 jump is only done if the match can be seen on the screen. The time to
6861 show the match can be set with 'matchtime'.
6862 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006863 seen or not).
6864 This option is reset when 'paste' is set and restored when 'paste' is
6865 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006866 When the 'm' flag is not included in 'cpoptions', typing a character
6867 will immediately move the cursor back to where it belongs.
6868 See the "sm" field in 'guicursor' for setting the cursor shape and
6869 blinking when showing the match.
6870 The 'matchpairs' option can be used to specify the characters to show
6871 matches for. 'rightleft' and 'revins' are used to look for opposite
6872 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006873 Also see the matchparen plugin for highlighting the match when moving
6874 around |pi_paren.txt|.
6875 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876
6877 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6878'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6879 global
6880 If in Insert, Replace or Visual mode put a message on the last line.
6881 Use the 'M' flag in 'highlight' to set the type of highlighting for
6882 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006883 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 doesn't mean XIM is really active, especially when 'imactivatekey' is
6885 not set.
6886 NOTE: This option is set to the Vi default value when 'compatible' is
6887 set and to the Vim default value when 'compatible' is reset.
6888
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006889 *'showtabline'* *'stal'*
6890'showtabline' 'stal' number (default 1)
6891 global
6892 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006893 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006894 feature}
6895 The value of this option specifies when the line with tab page labels
6896 will be displayed:
6897 0: never
6898 1: only if there are at least two tab pages
6899 2: always
6900 This is both for the GUI and non-GUI implementation of the tab pages
6901 line.
6902 See |tab-page| for more information about tab pages.
6903
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 *'sidescroll'* *'ss'*
6905'sidescroll' 'ss' number (default 0)
6906 global
6907 {not in Vi}
6908 The minimal number of columns to scroll horizontally. Used only when
6909 the 'wrap' option is off and the cursor is moved off of the screen.
6910 When it is zero the cursor will be put in the middle of the screen.
6911 When using a slow terminal set it to a large number or 0. When using
6912 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6913 commands.
6914
6915 *'sidescrolloff'* *'siso'*
6916'sidescrolloff' 'siso' number (default 0)
6917 global
6918 {not in Vi}
6919 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006920 right of the cursor if 'nowrap' is set. Setting this option to a
6921 value greater than 0 while having |'sidescroll'| also at a non-zero
6922 value makes some context visible in the line you are scrolling in
6923 horizontally (except at beginning of the line). Setting this option
6924 to a large value (like 999) has the effect of keeping the cursor
6925 horizontally centered in the window, as long as one does not come too
6926 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 NOTE: This option is set to 0 when 'compatible' is set.
6928
6929 Example: Try this together with 'sidescroll' and 'listchars' as
6930 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006931 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932
6933 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6934 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006935<
6936 *'signcolumn'* *'scl'*
6937'signcolumn' 'scl' string (default "auto")
6938 local to window
6939 {not in Vi}
6940 {not available when compiled without the |+signs|
6941 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006942 Whether or not to draw the signcolumn. Valid values are:
6943 "auto" only when there is a sign to display
6944 "no" never
6945 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946
6947
6948 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6949'smartcase' 'scs' boolean (default off)
6950 global
6951 {not in Vi}
6952 Override the 'ignorecase' option if the search pattern contains upper
6953 case characters. Only used when the search pattern is typed and
6954 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006955 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6957 recalling the search pattern from history and hitting <Enter>.
6958 NOTE: This option is reset when 'compatible' is set.
6959
6960 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6961'smartindent' 'si' boolean (default off)
6962 local to buffer
6963 {not in Vi}
6964 {not available when compiled without the
6965 |+smartindent| feature}
6966 Do smart autoindenting when starting a new line. Works for C-like
6967 programs, but can also be used for other languages. 'cindent' does
6968 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006969 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006970 setting 'si' has no effect. 'indentexpr' is a more advanced
6971 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 Normally 'autoindent' should also be on when using 'smartindent'.
6973 An indent is automatically inserted:
6974 - After a line ending in '{'.
6975 - After a line starting with a keyword from 'cinwords'.
6976 - Before a line starting with '}' (only with the "O" command).
6977 When typing '}' as the first character in a new line, that line is
6978 given the same indent as the matching '{'.
6979 When typing '#' as the first character in a new line, the indent for
6980 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006981 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6983 When using the ">>" command, lines starting with '#' are not shifted
6984 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006985 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006986 This option is reset when 'paste' is set and restored when 'paste' is
6987 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006988
6989 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6990'smarttab' 'sta' boolean (default off)
6991 global
6992 {not in Vi}
6993 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006994 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6995 <BS> will delete a 'shiftwidth' worth of space at the start of the
6996 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006997 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006998 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6999 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007000 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00007002 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02007003 This option is reset when 'paste' is set and restored when 'paste' is
7004 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005 NOTE: This option is reset when 'compatible' is set.
7006
7007 *'softtabstop'* *'sts'*
7008'softtabstop' 'sts' number (default 0)
7009 local to buffer
7010 {not in Vi}
7011 Number of spaces that a <Tab> counts for while performing editing
7012 operations, like inserting a <Tab> or using <BS>. It "feels" like
7013 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
7014 used. This is useful to keep the 'ts' setting at its standard value
7015 of 8, while being able to edit like it is set to 'sts'. However,
7016 commands like "x" still work on the actual characters.
7017 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02007018 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02007019 'softtabstop' is set to 0 when the 'paste' option is set and restored
7020 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 See also |ins-expandtab|. When 'expandtab' is not set, the number of
7022 spaces is minimized by using <Tab>s.
7023 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
7024 set.
7025 NOTE: This option is set to 0 when 'compatible' is set.
7026
Bram Moolenaar217ad922005-03-20 22:37:15 +00007027 *'spell'* *'nospell'*
7028'spell' boolean (default off)
7029 local to window
7030 {not in Vi}
7031 {not available when compiled without the |+syntax|
7032 feature}
7033 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007034 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007035
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007036 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007037'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007038 local to buffer
7039 {not in Vi}
7040 {not available when compiled without the |+syntax|
7041 feature}
7042 Pattern to locate the end of a sentence. The following word will be
7043 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007044 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007045 When this check is not wanted make this option empty.
7046 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007047 Be careful with special characters, see |option-backslash| about
7048 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007049 To set this option automatically depending on the language, see
7050 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007051
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007052 *'spellfile'* *'spf'*
7053'spellfile' 'spf' string (default empty)
7054 local to buffer
7055 {not in Vi}
7056 {not available when compiled without the |+syntax|
7057 feature}
7058 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007059 commands. It must end in ".{encoding}.add". You need to include the
7060 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007061 *E765*
7062 It may also be a comma separated list of names. A count before the
7063 |zg| and |zw| commands can be used to access each. This allows using
7064 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007065 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007066 you: Using the first directory in 'runtimepath' that is writable. If
7067 there is no "spell" directory yet it will be created. For the file
7068 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007069 ignoring the region.
7070 The resulting ".spl" file will be used for spell checking, it does not
7071 have to appear in 'spelllang'.
7072 Normally one file is used for all regions, but you can add the region
7073 name if you want to. However, it will then only be used when
7074 'spellfile' is set to it, for entries in 'spelllang' only files
7075 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007076 This option cannot be set from a |modeline| or in the |sandbox|, for
7077 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007078
Bram Moolenaar217ad922005-03-20 22:37:15 +00007079 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007080'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007081 local to buffer
7082 {not in Vi}
7083 {not available when compiled without the |+syntax|
7084 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007085 A comma separated list of word list names. When the 'spell' option is
7086 on spellchecking will be done for these languages. Example: >
7087 set spelllang=en_us,nl,medical
7088< This means US English, Dutch and medical words are recognized. Words
7089 that are not recognized will be highlighted.
7090 The word list name must not include a comma or dot. Using a dash is
7091 recommended to separate the two letter language name from a
7092 specification. Thus "en-rare" is used for rare English words.
7093 A region name must come last and have the form "_xx", where "xx" is
7094 the two-letter, lower case region name. You can use more than one
7095 region by listing them: "en_us,en_ca" supports both US and Canadian
7096 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007097 Britain. (Note: currently en_au and en_nz dictionaries are older than
7098 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007099 If the name "cjk" is included East Asian characters are excluded from
7100 spell checking. This is useful when editing text that also has Asian
7101 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007102 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007103 As a special case the name of a .spl file can be given as-is. The
7104 first "_xx" in the name is removed and used as the region name
7105 (_xx is an underscore, two letters and followed by a non-letter).
7106 This is mainly for testing purposes. You must make sure the correct
7107 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007108 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007109 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7110 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007111 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007112
Bram Moolenaar98692072006-02-04 00:57:42 +00007113 If the |spellfile.vim| plugin is active and you use a language name
7114 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7115 will ask you if you want to download the file.
7116
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007117 After this option has been set successfully, Vim will source the files
7118 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00007119 up to the first comma, dot or underscore.
7120 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007121
7122
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007123 *'spellsuggest'* *'sps'*
7124'spellsuggest' 'sps' string (default "best")
7125 global
7126 {not in Vi}
7127 {not available when compiled without the |+syntax|
7128 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007129 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007130 the |spellsuggest()| function. This is a comma-separated list of
7131 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007132
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007133 best Internal method that works best for English. Finds
7134 changes like "fast" and uses a bit of sound-a-like
7135 scoring to improve the ordering.
7136
7137 double Internal method that uses two methods and mixes the
7138 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007139 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007140 word. That only works when the language specifies
7141 sound folding. Can be slow and doesn't always give
7142 better results.
7143
7144 fast Internal method that only checks for simple changes:
7145 character inserts/deletes/swaps. Works well for
7146 simple typing mistakes.
7147
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007148 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007149 Not used for |spellsuggest()|. The number of
7150 suggestions is never more than the value of 'lines'
7151 minus two.
7152
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007153 file:{filename} Read file {filename}, which must have two columns,
7154 separated by a slash. The first column contains the
7155 bad word, the second column the suggested good word.
7156 Example:
7157 theribal/terrible ~
7158 Use this for common mistakes that do not appear at the
7159 top of the suggestion list with the internal methods.
7160 Lines without a slash are ignored, use this for
7161 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007162 The word in the second column must be correct,
7163 otherwise it will not be used. Add the word to an
7164 ".add" file if it is currently flagged as a spelling
7165 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007166 The file is used for all languages.
7167
7168 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7169 trouble with spaces. |v:val| holds the badly spelled
7170 word. The expression must evaluate to a List of
7171 Lists, each with a suggestion and a score.
7172 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007173 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007174 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007175 internal methods use. A lower score is better.
7176 This may invoke |spellsuggest()| if you temporarily
7177 set 'spellsuggest' to exclude the "expr:" part.
7178 Errors are silently ignored, unless you set the
7179 'verbose' option to a non-zero value.
7180
7181 Only one of "best", "double" or "fast" may be used. The others may
7182 appear several times in any order. Example: >
7183 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7184<
7185 This option cannot be set from a |modeline| or in the |sandbox|, for
7186 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007187
7188
Bram Moolenaar071d4272004-06-13 20:20:40 +00007189 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7190'splitbelow' 'sb' boolean (default off)
7191 global
7192 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007193 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 feature}
7195 When on, splitting a window will put the new window below the current
7196 one. |:split|
7197
7198 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7199'splitright' 'spr' boolean (default off)
7200 global
7201 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007202 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 feature}
7204 When on, splitting a window will put the new window right of the
7205 current one. |:vsplit|
7206
7207 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7208'startofline' 'sol' boolean (default on)
7209 global
7210 {not in Vi}
7211 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007212 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007213 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007214 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 with a linewise operator, with "%" with a count and to buffer changing
7216 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7217 only has a line number, e.g., ":25" or ":+".
7218 In case of buffer changing commands the cursor is placed at the column
7219 where it was the last time the buffer was edited.
7220 NOTE: This option is set when 'compatible' is set.
7221
Bram Moolenaar00654022011-02-25 14:42:19 +01007222 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007224 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 {not in Vi}
7226 {not available when compiled without the |+statusline|
7227 feature}
7228 When nonempty, this option determines the content of the status line.
7229 Also see |status-line|.
7230
7231 The option consists of printf style '%' items interspersed with
7232 normal text. Each status line item is of the form:
7233 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007234 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007235 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236
Bram Moolenaar238a5642006-02-21 22:12:05 +00007237 When the option starts with "%!" then it is used as an expression,
7238 evaluated and the result is used as the option value. Example: >
7239 :set statusline=%!MyStatusLine()
7240< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007241 Note that the "%!" expression is evaluated in the context of the
7242 current window and buffer, while %{} items are evaluated in the
7243 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007244
7245 When there is error while evaluating the option then it will be made
7246 empty to avoid further errors. Otherwise screen updating would loop.
7247
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 Note that the only effect of 'ruler' when this option is set (and
7249 'laststatus' is 2) is controlling the output of |CTRL-G|.
7250
7251 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007252 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007253 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007254 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 minwid Minimum width of the item, padding as set by '-' & '0'.
7256 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007257 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 on the left for text items. Numeric items will be
7259 shifted down to maxwid-2 digits followed by '>'number
7260 where number is the amount of missing digits, much like
7261 an exponential notation.
7262 item A one letter code as described below.
7263
7264 Following is a description of the possible statusline items. The
7265 second character in "item" is the type:
7266 N for number
7267 S for string
7268 F for flags as described below
7269 - not applicable
7270
7271 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007272 f S Path to the file in the buffer, as typed or relative to current
7273 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007274 F S Full path to the file in the buffer.
7275 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007276 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007278 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007280 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007282 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007284 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7286 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007287 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7289 being used: "<keymap>"
7290 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007291 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 B N As above, in hexadecimal.
7293 o N Byte number in file of byte under cursor, first byte is 1.
7294 Mnemonic: Offset from start of file (with one added)
7295 {not available when compiled without |+byte_offset| feature}
7296 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007297 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 l N Line number.
7299 L N Number of lines in buffer.
7300 c N Column number.
7301 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007302 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 p N Percentage through file in lines as in |CTRL-G|.
7304 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007305 percentage described for 'ruler'. Always 3 in length, unless
7306 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007307 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007309 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007310 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 ( - Start of item group. Can be used for setting the width and
7312 alignment of a section. Must be followed by %) somewhere.
7313 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007314 T N For 'tabline': start of tab page N label. Use %T after the last
7315 label. This information is used for mouse clicks.
7316 X N For 'tabline': start of close tab N label. Use %X after the
7317 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7318 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 < - Where to truncate line if too long. Default is at the start.
7320 No width fields allowed.
7321 = - Separation point between left and right aligned items.
7322 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007323 # - Set highlight group. The name must follow and then a # again.
7324 Thus use %#HLname# for highlight group HLname. The same
7325 highlighting is used, also for the statusline of non-current
7326 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007327 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007328 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 The difference between User{N} and StatusLine will be applied
7330 to StatusLineNC for the statusline of non-current windows.
7331 The number N must be between 1 and 9. See |hl-User1..9|
7332
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007333 When displaying a flag, Vim removes the leading comma, if any, when
7334 that flag comes right after plaintext. This will make a nice display
7335 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007336
Bram Moolenaar582fd852005-03-28 20:58:01 +00007337 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 not set) and a minwid is not set for the group, the whole group will
7339 become empty. This will make a group like the following disappear
7340 completely from the statusline when none of the flags are set. >
7341 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007342< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007343 Beware that an expression is evaluated each and every time the status
7344 line is displayed. The current buffer and current window will be set
7345 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007346 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007348 real current buffer.
7349
Bram Moolenaar30b65812012-07-12 22:01:11 +02007350 The 'statusline' option will be evaluated in the |sandbox| if set from
7351 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007352
7353 It is not allowed to change text or jump to another window while
7354 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355
7356 If the statusline is not updated when you want it (e.g., after setting
7357 a variable that's used in an expression), you can force an update by
7358 setting an option without changing its value. Example: >
7359 :let &ro = &ro
7360
7361< A result of all digits is regarded a number for display purposes.
7362 Otherwise the result is taken as flag text and applied to the rules
7363 described above.
7364
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007365 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007367 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368
7369 Examples:
7370 Emulate standard status line with 'ruler' set >
7371 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7372< Similar, but add ASCII value of char under the cursor (like "ga") >
7373 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7374< Display byte count and byte value, modified flag in red. >
7375 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7376 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7377< Display a ,GZ flag if a compressed file is loaded >
7378 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7379< In the |:autocmd|'s: >
7380 :let b:gzflag = 1
7381< And: >
7382 :unlet b:gzflag
7383< And define this function: >
7384 :function VarExists(var, val)
7385 : if exists(a:var) | return a:val | else | return '' | endif
7386 :endfunction
7387<
7388 *'suffixes'* *'su'*
7389'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7390 global
7391 {not in Vi}
7392 Files with these suffixes get a lower priority when multiple files
7393 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 suffixes. Spaces after the comma are ignored. A dot is also seen as
7395 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 separator, precede it with a backslash (see |option-backslash| about
7397 including spaces and backslashes).
7398 See 'wildignore' for completely ignoring files.
7399 The use of |:set+=| and |:set-=| is preferred when adding or removing
7400 suffixes from the list. This avoids problems when a future version
7401 uses another default.
7402
7403 *'suffixesadd'* *'sua'*
7404'suffixesadd' 'sua' string (default "")
7405 local to buffer
7406 {not in Vi}
7407 {not available when compiled without the
7408 |+file_in_path| feature}
7409 Comma separated list of suffixes, which are used when searching for a
7410 file for the "gf", "[I", etc. commands. Example: >
7411 :set suffixesadd=.java
7412<
7413 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7414'swapfile' 'swf' boolean (default on)
7415 local to buffer
7416 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007417 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 swapfile is not wanted for a specific buffer. For example, with
7419 confidential information that even root must not be able to access.
7420 Careful: All text will be in memory:
7421 - Don't use this for big files.
7422 - Recovery will be impossible!
7423 A swapfile will only be present when |'updatecount'| is non-zero and
7424 'swapfile' is set.
7425 When 'swapfile' is reset, the swap file for the current buffer is
7426 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7427 non-zero, a swap file is immediately created.
7428 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007429 If you want to open a new buffer without creating a swap file for it,
7430 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431
7432 This option is used together with 'bufhidden' and 'buftype' to
7433 specify special kinds of buffers. See |special-buffers|.
7434
7435 *'swapsync'* *'sws'*
7436'swapsync' 'sws' string (default "fsync")
7437 global
7438 {not in Vi}
7439 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007440 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007441 When this option is empty parts of the swap file may be in memory and
7442 not written to disk. When the system crashes you may lose more work.
7443 On Unix the system does a sync now and then without Vim asking for it,
7444 so the disadvantage of setting this option off is small. On some
7445 systems the swap file will not be written at all. For a unix system
7446 setting it to "sync" will use the sync() call instead of the default
7447 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007448 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007449
7450 *'switchbuf'* *'swb'*
7451'switchbuf' 'swb' string (default "")
7452 global
7453 {not in Vi}
7454 This option controls the behavior when switching between buffers.
7455 Possible values (comma separated list):
7456 useopen If included, jump to the first open window that
7457 contains the specified buffer (if there is one).
7458 Otherwise: Do not examine other windows.
7459 This setting is checked with |quickfix| commands, when
7460 jumping to errors (":cc", ":cn", "cp", etc.). It is
7461 also used in all buffer related split commands, for
7462 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007463 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007464 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007466 a buffer for a |quickfix| command that display errors.
7467 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007468 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007469 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007470 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007472 *'synmaxcol'* *'smc'*
7473'synmaxcol' 'smc' number (default 3000)
7474 local to buffer
7475 {not in Vi}
7476 {not available when compiled without the |+syntax|
7477 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007478 Maximum column in which to search for syntax items. In long lines the
7479 text after this column is not highlighted and following lines may not
7480 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007481 This helps to avoid very slow redrawing for an XML file that is one
7482 long line.
7483 Set to zero to remove the limit.
7484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 *'syntax'* *'syn'*
7486'syntax' 'syn' string (default empty)
7487 local to buffer
7488 {not in Vi}
7489 {not available when compiled without the |+syntax|
7490 feature}
7491 When this option is set, the syntax with this name is loaded, unless
7492 syntax highlighting has been switched off with ":syntax off".
7493 Otherwise this option does not always reflect the current syntax (the
7494 b:current_syntax variable does).
7495 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007496 not automatically recognized. Example, in an IDL file:
7497 /* vim: set syntax=idl : */ ~
7498 When a dot appears in the value then this separates two filetype
7499 names. Example:
7500 /* vim: set syntax=c.doxygen : */ ~
7501 This will use the "c" syntax first, then the "doxygen" syntax.
7502 Note that the second one must be prepared to be loaded as an addition,
7503 otherwise it will be skipped. More than one dot may appear.
7504 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 :set syntax=OFF
7506< To switch syntax highlighting on according to the current value of the
7507 'filetype' option: >
7508 :set syntax=ON
7509< What actually happens when setting the 'syntax' option is that the
7510 Syntax autocommand event is triggered with the value as argument.
7511 This option is not copied to another buffer, independent of the 's' or
7512 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007513 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007515 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007516'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007517 global
7518 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007519 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007520 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007521 When nonempty, this option determines the content of the tab pages
7522 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007523 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007524
7525 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007526 option and only when there is no GUI tab line. When 'e' is in
7527 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007528 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007529
7530 The value is evaluated like with 'statusline'. You can use
7531 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007532 the text to be displayed. Use "%1T" for the first label, "%2T" for
7533 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007534
7535 Keep in mind that only one of the tab pages is the current one, others
7536 are invisible and you can't jump to their windows.
7537
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007538
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007539 *'tabpagemax'* *'tpm'*
7540'tabpagemax' 'tpm' number (default 10)
7541 global
7542 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007543 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007544 feature}
7545 Maximum number of tab pages to be opened by the |-p| command line
7546 argument or the ":tab all" command. |tabpage|
7547
7548
7549 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550'tabstop' 'ts' number (default 8)
7551 local to buffer
7552 Number of spaces that a <Tab> in the file counts for. Also see
7553 |:retab| command, and 'softtabstop' option.
7554
7555 Note: Setting 'tabstop' to any other value than 8 can make your file
7556 appear wrong in many places (e.g., when printing it).
7557
7558 There are four main ways to use tabs in Vim:
7559 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7560 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007561 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 behave like a tab appears every 4 (or 3) characters.
7563 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7564 'expandtab'. This way you will always insert spaces. The
7565 formatting will never be messed up when 'tabstop' is changed.
7566 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007567 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 works when using Vim to edit the file.
7569 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7570 'noexpandtab'. This should then work (for initial indents only)
7571 for any tabstop setting that people use. It might be nice to have
7572 tabs after the first non-blank inserted as spaces if you do this
7573 though. Otherwise aligned comments will be wrong when 'tabstop' is
7574 changed.
7575
7576 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7577'tagbsearch' 'tbs' boolean (default on)
7578 global
7579 {not in Vi}
7580 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007581 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 searching makes searching for a tag a LOT faster, but a linear search
7583 will find more tags if the tags file wasn't properly sorted.
7584 Vim normally assumes that your tags files are sorted, or indicate that
7585 they are not sorted. Only when this is not the case does the
7586 'tagbsearch' option need to be switched off.
7587
7588 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007589 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 certain files, or retry all files with a linear search. When
7591 'tagbsearch' is off, only a linear search is done.
7592
7593 Linear searching is done anyway, for one file, when Vim finds a line
7594 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007595 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596< [The whitespace before and after the '0' must be a single <Tab>]
7597
7598 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007599 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 instead of a normal tag name, a retry is done with a linear search.
7601 Tags in unsorted tags files, and matches with different case will only
7602 be found in the retry.
7603
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007604 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007605 linear search can be avoided when case is ignored. Use a value of '2'
7606 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7607 sorted with the -f switch to "sort" in most unices, as in the command:
7608 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7609 (at least 5.5) the --sort=foldcase switch can be used for this as
7610 well. Note that case must be folded to uppercase for this to work.
7611
7612 By default, tag searches are case-sensitive. Case is ignored when
7613 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7614 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007615 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7616 'tagcase' is "smart", and the pattern contains only lowercase
7617 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618
7619 When 'tagbsearch' is off, tags searching is slower when a full match
7620 exists, but faster when no full match exists. Tags in unsorted tags
7621 files may only be found with 'tagbsearch' off.
7622 When the tags file is not sorted, or sorted in a wrong way (not on
7623 ASCII byte value), 'tagbsearch' should be off, or the line given above
7624 must be included in the tags file.
7625 This option doesn't affect commands that find all matching tags (e.g.,
7626 command-line completion and ":help").
7627 {Vi: always uses binary search in some versions}
7628
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007629 *'tagcase'* *'tc'*
7630'tagcase' 'tc' string (default "followic")
7631 global or local to buffer |global-local|
7632 {not in Vi}
7633 This option specifies how case is handled when searching the tags
7634 file:
7635 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007636 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007637 ignore Ignore case
7638 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007639 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007640 NOTE: This option is set to the Vi default value when 'compatible' is
7641 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007642
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 *'taglength'* *'tl'*
7644'taglength' 'tl' number (default 0)
7645 global
7646 If non-zero, tags are significant up to this number of characters.
7647
7648 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7649'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7650 global
7651 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007652 If on and using a tags file in another directory, file names in that
7653 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 NOTE: This option is set to the Vi default value when 'compatible' is
7655 set and to the Vim default value when 'compatible' is reset.
7656
7657 *'tags'* *'tag'* *E433*
7658'tags' 'tag' string (default "./tags,tags", when compiled with
7659 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7660 global or local to buffer |global-local|
7661 Filenames for the tag command, separated by spaces or commas. To
7662 include a space or comma in a file name, precede it with a backslash
7663 (see |option-backslash| about including spaces and backslashes).
7664 When a file name starts with "./", the '.' is replaced with the path
7665 of the current file. But only when the 'd' flag is not included in
7666 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7667 |tags-option|.
7668 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007669 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7670 find all files named "tags" below "/lib". The filename itself cannot
7671 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7672 files called "tags?". {not available when compiled without the
7673 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007674 The |tagfiles()| function can be used to get a list of the file names
7675 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7677 files are also supported. They are automatically recognized. The
7678 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7679 differences are ignored (MS-Windows). |emacs-tags|
7680 The use of |:set+=| and |:set-=| is preferred when adding or removing
7681 file names from the list. This avoids problems when a future version
7682 uses another default.
7683 {Vi: default is "tags /usr/lib/tags"}
7684
7685 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7686'tagstack' 'tgst' boolean (default on)
7687 global
7688 {not in all versions of Vi}
7689 When on, the |tagstack| is used normally. When off, a ":tag" or
7690 ":tselect" command with an argument will not push the tag onto the
7691 tagstack. A following ":tag" without an argument, a ":pop" command or
7692 any other command that uses the tagstack will use the unmodified
7693 tagstack, but does change the pointer to the active entry.
7694 Resetting this option is useful when using a ":tag" command in a
7695 mapping which should not change the tagstack.
7696
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007697 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007698'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007699 global
7700 {not in Vi}
7701 {only available when compiled with the |+tcl/dyn|
7702 feature}
7703 Specifies the name of the Tcl shared library. The default is
7704 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007705 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007706 This option cannot be set from a |modeline| or in the |sandbox|, for
7707 security reasons.
7708
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 *'term'* *E529* *E530* *E531*
7710'term' string (default is $TERM, if that fails:
7711 in the GUI: "builtin_gui"
7712 on Amiga: "amiga"
7713 on BeOS: "beos-ansi"
7714 on Mac: "mac-ansi"
7715 on MiNT: "vt52"
7716 on MS-DOS: "pcterm"
7717 on OS/2: "os2ansi"
7718 on Unix: "ansi"
7719 on VMS: "ansi"
7720 on Win 32: "win32")
7721 global
7722 Name of the terminal. Used for choosing the terminal control
7723 characters. Environment variables are expanded |:set_env|.
7724 For example: >
7725 :set term=$TERM
7726< See |termcap|.
7727
7728 *'termbidi'* *'tbidi'*
7729 *'notermbidi'* *'notbidi'*
7730'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7731 global
7732 {not in Vi}
7733 {only available when compiled with the |+arabic|
7734 feature}
7735 The terminal is in charge of Bi-directionality of text (as specified
7736 by Unicode). The terminal is also expected to do the required shaping
7737 that some languages (such as Arabic) require.
7738 Setting this option implies that 'rightleft' will not be set when
7739 'arabic' is set and the value of 'arabicshape' will be ignored.
7740 Note that setting 'termbidi' has the immediate effect that
7741 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7742 This option is reset when the GUI is started.
7743 For further details see |arabic.txt|.
7744
7745 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007746'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 Macintosh GUI: "macroman")
7748 global
7749 {only available when compiled with the |+multi_byte|
7750 feature}
7751 {not in Vi}
7752 Encoding used for the terminal. This specifies what character
7753 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007754 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007755 display). Except for the Mac when 'macatsui' is off, then
7756 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007758 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007759 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7760 Any attempts to set a different value will be rejected, and an error
7761 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007762 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 because the Win32 system always passes Unicode characters.
7764 When empty, the same encoding is used as for the 'encoding' option.
7765 This is the normal value.
7766 Not all combinations for 'termencoding' and 'encoding' are valid. See
7767 |encoding-table|.
7768 The value for this option must be supported by internal conversions or
7769 iconv(). When this is not possible no conversion will be done and you
7770 will probably experience problems with non-ASCII characters.
7771 Example: You are working with the locale set to euc-jp (Japanese) and
7772 want to edit a UTF-8 file: >
7773 :let &termencoding = &encoding
7774 :set encoding=utf-8
7775< You need to do this when your system has no locale support for UTF-8.
7776
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007777 *'termguicolors'* *'tgc'*
7778'termguicolors' 'tgc' boolean (default off)
7779 global
7780 {not in Vi}
7781 {not available when compiled without the
7782 |+termguicolors| feature}
7783 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7784 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7785 compatible terminal.
7786 If setting this option does not work (produces a colorless UI)
7787 reading |xterm-true-color| might help.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007788 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007789 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007790
Bram Moolenaar74675a62017-07-15 13:53:23 +02007791 *'termkey'* *'tk'*
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007792'termkey' 'tk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007793 local to window
7794 {not in Vi}
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007795 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007796 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007797 The <> notation can be used, e.g.: >
7798 :set termkey=<C-L>
7799< The string must be one key stroke but can be multiple bytes.
7800 When not set CTRL-W is used, so that CTRL-W : gets you to the command
7801 line. If 'termkey' is set to CTRL-L then CTRL-L : gets you to the
7802 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007803
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007804 *'termsize'* *'tms'*
Bram Moolenaar74675a62017-07-15 13:53:23 +02007805'termsize' 'tms' string (default "")
7806 local to window
7807 {not in Vi}
7808 Size of the |terminal| window. Format: {rows}x{columns}.
7809 - When empty the terminal gets the size from the window.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007810 - When set (e.g., "24x80") the terminal size is not adjusted to the
7811 window size. If the window is smaller only the top-left part is
7812 displayed.
7813 When rows is zero then use the height of the window.
7814 When columns is zero then use the width of the window.
7815 For example: "30x0" uses 30 rows with the current window width.
7816 Using "0x0" is the same as empty.
7817 Note that the command running in the terminal window may still change
7818 the size of the terminal. In that case the Vim window will be
7819 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007820
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 *'terse'* *'noterse'*
7822'terse' boolean (default off)
7823 global
7824 When set: Add 's' flag to 'shortmess' option (this makes the message
7825 for a search that hits the start or end of the file not being
7826 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7827 shortens a lot of messages}
7828
7829 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7830'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7831 global
7832 {not in Vi}
7833 This option is obsolete. Use 'fileformats'.
7834 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7835 set to the default value for the current system. When 'textauto' is
7836 reset, 'fileformats' is made empty.
7837 NOTE: This option is set to the Vi default value when 'compatible' is
7838 set and to the Vim default value when 'compatible' is reset.
7839
7840 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7841'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7842 others: default off)
7843 local to buffer
7844 {not in Vi}
7845 This option is obsolete. Use 'fileformat'.
7846 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7847 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7848 "unix".
7849
7850 *'textwidth'* *'tw'*
7851'textwidth' 'tw' number (default 0)
7852 local to buffer
7853 {not in Vi}
7854 Maximum width of text that is being inserted. A longer line will be
7855 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007856 this.
7857 'textwidth' is set to 0 when the 'paste' option is set and restored
7858 when 'paste' is reset.
7859 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007861 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 NOTE: This option is set to 0 when 'compatible' is set.
7863
7864 *'thesaurus'* *'tsr'*
7865'thesaurus' 'tsr' string (default "")
7866 global or local to buffer |global-local|
7867 {not in Vi}
7868 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007869 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 the file should contain words with similar meaning, separated by
7871 non-keyword characters (white space is preferred). Maximum line
7872 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007873 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007874 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007875 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007876 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 after a comma are ignored, otherwise spaces are included in the file
7878 name. See |option-backslash| about using backslashes.
7879 The use of |:set+=| and |:set-=| is preferred when adding or removing
7880 directories from the list. This avoids problems when a future version
7881 uses another default.
7882 Backticks cannot be used in this option for security reasons.
7883
7884 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7885'tildeop' 'top' boolean (default off)
7886 global
7887 {not in Vi}
7888 When on: The tilde command "~" behaves like an operator.
7889 NOTE: This option is reset when 'compatible' is set.
7890
7891 *'timeout'* *'to'* *'notimeout'* *'noto'*
7892'timeout' 'to' boolean (default on)
7893 global
7894 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007895'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 global
7897 {not in Vi}
7898 These two options together determine the behavior when part of a
7899 mapped key sequence or keyboard code has been received:
7900
7901 'timeout' 'ttimeout' action ~
7902 off off do not time out
7903 on on or off time out on :mappings and key codes
7904 off on time out on key codes
7905
7906 If both options are off, Vim will wait until either the complete
7907 mapping or key sequence has been received, or it is clear that there
7908 is no mapping or key sequence for the received characters. For
7909 example: if you have mapped "vl" and Vim has received 'v', the next
7910 character is needed to see if the 'v' is followed by an 'l'.
7911 When one of the options is on, Vim will wait for about 1 second for
7912 the next character to arrive. After that the already received
7913 characters are interpreted as single characters. The waiting time can
7914 be changed with the 'timeoutlen' option.
7915 On slow terminals or very busy systems timing out may cause
7916 malfunctioning cursor keys. If both options are off, Vim waits
7917 forever after an entered <Esc> if there are key codes that start
7918 with <Esc>. You will have to type <Esc> twice. If you do not have
7919 problems with key codes, but would like to have :mapped key
7920 sequences not timing out in 1 second, set the 'ttimeout' option and
7921 reset the 'timeout' option.
7922
7923 NOTE: 'ttimeout' is reset when 'compatible' is set.
7924
7925 *'timeoutlen'* *'tm'*
7926'timeoutlen' 'tm' number (default 1000)
7927 global
7928 {not in all versions of Vi}
7929 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007930'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 global
7932 {not in Vi}
7933 The time in milliseconds that is waited for a key code or mapped key
7934 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7935 when part of a command has been typed.
7936 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7937 different timeout value for key codes is desired set 'ttimeoutlen' to
7938 a non-negative number.
7939
7940 ttimeoutlen mapping delay key code delay ~
7941 < 0 'timeoutlen' 'timeoutlen'
7942 >= 0 'timeoutlen' 'ttimeoutlen'
7943
7944 The timeout only happens when the 'timeout' and 'ttimeout' options
7945 tell so. A useful setting would be >
7946 :set timeout timeoutlen=3000 ttimeoutlen=100
7947< (time out on mapping after three seconds, time out on key codes after
7948 a tenth of a second).
7949
7950 *'title'* *'notitle'*
7951'title' boolean (default off, on when title can be restored)
7952 global
7953 {not in Vi}
7954 {not available when compiled without the |+title|
7955 feature}
7956 When on, the title of the window will be set to the value of
7957 'titlestring' (if it is not empty), or to:
7958 filename [+=-] (path) - VIM
7959 Where:
7960 filename the name of the file being edited
7961 - indicates the file cannot be modified, 'ma' off
7962 + indicates the file was modified
7963 = indicates the file is read-only
7964 =+ indicates the file is read-only and modified
7965 (path) is the path of the file being edited
7966 - VIM the server name |v:servername| or "VIM"
7967 Only works if the terminal supports setting window titles
7968 (currently Amiga console, Win32 console, all GUI versions and
7969 terminals with a non- empty 't_ts' option - these are Unix xterm and
7970 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7971 *X11*
7972 When Vim was compiled with HAVE_X11 defined, the original title will
7973 be restored if possible. The output of ":version" will include "+X11"
7974 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7975 works for the icon name |'icon'|.
7976 But: When Vim was started with the |-X| argument, restoring the title
7977 will not work (except in the GUI).
7978 If the title cannot be restored, it is set to the value of 'titleold'.
7979 You might want to restore the title outside of Vim then.
7980 When using an xterm from a remote machine you can use this command:
7981 rsh machine_name xterm -display $DISPLAY &
7982 then the WINDOWID environment variable should be inherited and the
7983 title of the window should change back to what it should be after
7984 exiting Vim.
7985
7986 *'titlelen'*
7987'titlelen' number (default 85)
7988 global
7989 {not in Vi}
7990 {not available when compiled without the |+title|
7991 feature}
7992 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007993 title. When the title is longer, only the end of the path name is
7994 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 Using a percentage makes this adapt to the width of the window. But
7996 it won't work perfectly, because the actual number of characters
7997 available also depends on the font used and other things in the title
7998 bar. When 'titlelen' is zero the full path is used. Otherwise,
7999 values from 1 to 30000 percent can be used.
8000 'titlelen' is also used for the 'titlestring' option.
8001
8002 *'titleold'*
8003'titleold' string (default "Thanks for flying Vim")
8004 global
8005 {not in Vi}
8006 {only available when compiled with the |+title|
8007 feature}
8008 This option will be used for the window title when exiting Vim if the
8009 original title cannot be restored. Only happens if 'title' is on or
8010 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008011 This option cannot be set from a |modeline| or in the |sandbox|, for
8012 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 *'titlestring'*
8014'titlestring' string (default "")
8015 global
8016 {not in Vi}
8017 {not available when compiled without the |+title|
8018 feature}
8019 When this option is not empty, it will be used for the title of the
8020 window. This happens only when the 'title' option is on.
8021 Only works if the terminal supports setting window titles (currently
8022 Amiga console, Win32 console, all GUI versions and terminals with a
8023 non-empty 't_ts' option).
8024 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008025 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 When this option contains printf-style '%' items, they will be
8027 expanded according to the rules used for 'statusline'.
8028 Example: >
8029 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8030 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8031< The value of 'titlelen' is used to align items in the middle or right
8032 of the available space.
8033 Some people prefer to have the file name first: >
8034 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8035< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008036 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 separating space only when needed.
8038 NOTE: Use of special characters in 'titlestring' may cause the display
8039 to be garbled (e.g., when it contains a CR or NL character).
8040 {not available when compiled without the |+statusline| feature}
8041
8042 *'toolbar'* *'tb'*
8043'toolbar' 'tb' string (default "icons,tooltips")
8044 global
8045 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8046 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008047 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 possible values are:
8049 icons Toolbar buttons are shown with icons.
8050 text Toolbar buttons shown with text.
8051 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008052 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 tooltips Tooltips are active for toolbar buttons.
8054 Tooltips refer to the popup help text which appears after the mouse
8055 cursor is placed over a toolbar button for a brief moment.
8056
8057 If you want the toolbar to be shown with icons as well as text, do the
8058 following: >
8059 :set tb=icons,text
8060< Motif and Athena cannot display icons and text at the same time. They
8061 will show icons if both are requested.
8062
8063 If none of the strings specified in 'toolbar' are valid or if
8064 'toolbar' is empty, this option is ignored. If you want to disable
8065 the toolbar, you need to set the 'guioptions' option. For example: >
8066 :set guioptions-=T
8067< Also see |gui-toolbar|.
8068
8069 *'toolbariconsize'* *'tbis'*
8070'toolbariconsize' 'tbis' string (default "small")
8071 global
8072 {not in Vi}
Bram Moolenaar3df01732017-02-17 22:47:16 +01008073 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008075 tiny Use tiny icons.
8076 small Use small icons (default).
8077 medium Use medium-sized icons.
8078 large Use large icons.
8079 huge Use even larger icons.
8080 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008082 the current theme. Common dimensions are giant=48x48, huge=32x32,
8083 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084
8085 If 'toolbariconsize' is empty, the global default size as determined
8086 by user preferences or the current theme is used.
8087
8088 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8089'ttybuiltin' 'tbi' boolean (default on)
8090 global
8091 {not in Vi}
8092 When on, the builtin termcaps are searched before the external ones.
8093 When off the builtin termcaps are searched after the external ones.
8094 When this option is changed, you should set the 'term' option next for
8095 the change to take effect, for example: >
8096 :set notbi term=$TERM
8097< See also |termcap|.
8098 Rationale: The default for this option is "on", because the builtin
8099 termcap entries are generally better (many systems contain faulty
8100 xterm entries...).
8101
8102 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8103'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8104 sun-cmd, screen, rxvt, dtterm or
8105 iris-ansi; also on when running Vim in
8106 a DOS console)
8107 global
8108 {not in Vi}
8109 Indicates a fast terminal connection. More characters will be sent to
8110 the screen for redrawing, instead of using insert/delete line
8111 commands. Improves smoothness of redrawing when there are multiple
8112 windows and the terminal does not support a scrolling region.
8113 Also enables the extra writing of characters at the end of each screen
8114 line for lines that wrap. This helps when using copy/paste with the
8115 mouse in an xterm and other terminals.
8116
8117 *'ttymouse'* *'ttym'*
8118'ttymouse' 'ttym' string (default depends on 'term')
8119 global
8120 {not in Vi}
8121 {only in Unix and VMS, doesn't work in the GUI; not
8122 available when compiled without |+mouse|}
8123 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008124 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 *xterm-mouse*
8126 xterm xterm-like mouse handling. The mouse generates
8127 "<Esc>[Mscr", where "scr" is three bytes:
8128 "s" = button state
8129 "c" = column plus 33
8130 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008131 This only works up to 223 columns! See "dec",
8132 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 xterm2 Works like "xterm", but with the xterm reporting the
8134 mouse position while the mouse is dragged. This works
8135 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008136 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 work. See below for how Vim detects this
8138 automatically.
8139 *netterm-mouse*
8140 netterm NetTerm mouse handling. The mouse generates
8141 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
8142 for the row and column.
8143 *dec-mouse*
8144 dec DEC terminal mouse handling. The mouse generates a
8145 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008146 This is also available for an Xterm, if it was
8147 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 *jsbterm-mouse*
8149 jsbterm JSB term mouse handling.
8150 *pterm-mouse*
8151 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008152 *urxvt-mouse*
8153 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008154 The mouse works only if the terminal supports this
8155 encoding style, but it does not have 223 columns limit
8156 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008157 *sgr-mouse*
8158 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008159 mouse reporting. The mouse works even in columns
8160 beyond 223. This option is backward compatible with
8161 "xterm2" because it can also decode "xterm2" style
8162 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163
8164 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008165 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8166 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8168 recognized, if enabled at compile time. DEC terminal mouse codes
8169 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008170 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8171 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008172 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008173 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8174 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8175 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008176 Additionally, if vim is compiled with the |+termresponse| feature and
8177 |t_RV| is set to the escape sequence to request the xterm version
8178 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02008180 from 95 to 276. The "sgr" value will be set if the xterm version is
8181 277 or highter.
8182 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8183 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184 :set t_RV=
8185<
8186 *'ttyscroll'* *'tsl'*
8187'ttyscroll' 'tsl' number (default 999)
8188 global
8189 Maximum number of lines to scroll the screen. If there are more lines
8190 to scroll the window is redrawn. For terminals where scrolling is
8191 very slow and redrawing is not slow this can be set to a small number,
8192 e.g., 3, to speed up displaying.
8193
8194 *'ttytype'* *'tty'*
8195'ttytype' 'tty' string (default from $TERM)
8196 global
8197 Alias for 'term', see above.
8198
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008199 *'undodir'* *'udir'*
8200'undodir' 'udir' string (default ".")
8201 global
8202 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008203 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008204 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008205 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008206 "." means using the directory of the file. The undo file name for
8207 "file.txt" is ".file.txt.un~".
8208 For other directories the file name is the full path of the edited
8209 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008210 When writing: The first directory that exists is used. "." always
8211 works, no directories after "." will be used for writing.
8212 When reading all entries are tried to find an undo file. The first
8213 undo file that exists is used. When it cannot be read an error is
8214 given, no further entry is used.
8215 See |undo-persistence|.
8216
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008217 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008218'undofile' 'udf' boolean (default off)
8219 local to buffer
8220 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008221 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008222 When on, Vim automatically saves undo history to an undo file when
8223 writing a buffer to a file, and restores undo history from the same
8224 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008225 The directory where the undo file is stored is specified by 'undodir'.
8226 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008227 The undo file is not read when 'undoreload' causes the buffer from
8228 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008229 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008230 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008231
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 *'undolevels'* *'ul'*
8233'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8234 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008235 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 {not in Vi}
8237 Maximum number of changes that can be undone. Since undo information
8238 is kept in memory, higher numbers will cause more memory to be used
8239 (nevertheless, a single change can use an unlimited amount of memory).
8240 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8241 itself: >
8242 set ul=0
8243< But you can also get Vi compatibility by including the 'u' flag in
8244 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008245 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008246 Set to -1 for no undo at all. You might want to do this only for the
8247 current buffer: >
8248 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008249< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008250
8251 The local value is set to -123456 when the global value is to be used.
8252
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008253 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008255 *'undoreload'* *'ur'*
8256'undoreload' 'ur' number (default 10000)
8257 global
8258 {not in Vi}
8259 Save the whole buffer for undo when reloading it. This applies to the
8260 ":e!" command and reloading for when the buffer changed outside of
8261 Vim. |FileChangedShell|
8262 The save only happens when this options is negative or when the number
8263 of lines is smaller than the value of this option.
8264 Set this option to zero to disable undo for a reload.
8265
8266 When saving undo for a reload, any undo file is not read.
8267
8268 Note that this causes the whole buffer to be stored in memory. Set
8269 this option to a lower value if you run out of memory.
8270
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 *'updatecount'* *'uc'*
8272'updatecount' 'uc' number (default: 200)
8273 global
8274 {not in Vi}
8275 After typing this many characters the swap file will be written to
8276 disk. When zero, no swap file will be created at all (see chapter on
8277 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8278 Vim with the "-n" option, see |startup|. When editing in readonly
8279 mode this option will be initialized to 10000.
8280 The swapfile can be disabled per buffer with |'swapfile'|.
8281 When 'updatecount' is set from zero to non-zero, swap files are
8282 created for all buffers that have 'swapfile' set. When 'updatecount'
8283 is set to zero, existing swap files are not deleted.
8284 Also see |'swapsync'|.
8285 This option has no meaning in buffers where |'buftype'| is "nofile"
8286 or "nowrite".
8287
8288 *'updatetime'* *'ut'*
8289'updatetime' 'ut' number (default 4000)
8290 global
8291 {not in Vi}
8292 If this many milliseconds nothing is typed the swap file will be
8293 written to disk (see |crash-recovery|). Also used for the
8294 |CursorHold| autocommand event.
8295
8296 *'verbose'* *'vbs'*
8297'verbose' 'vbs' number (default 0)
8298 global
8299 {not in Vi, although some versions have a boolean
8300 verbose option}
8301 When bigger than zero, Vim will give messages about what it is doing.
8302 Currently, these messages are given:
8303 >= 1 When the viminfo file is read or written.
8304 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008305 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 >= 8 Files for which a group of autocommands is executed.
8307 >= 9 Every executed autocommand.
8308 >= 12 Every executed function.
8309 >= 13 When an exception is thrown, caught, finished, or discarded.
8310 >= 14 Anything pending in a ":finally" clause.
8311 >= 15 Every executed Ex command (truncated at 200 characters).
8312
8313 This option can also be set with the "-V" argument. See |-V|.
8314 This option is also set by the |:verbose| command.
8315
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008316 When the 'verbosefile' option is set then the verbose messages are not
8317 displayed.
8318
8319 *'verbosefile'* *'vfile'*
8320'verbosefile' 'vfile' string (default empty)
8321 global
8322 {not in Vi}
8323 When not empty all messages are written in a file with this name.
8324 When the file exists messages are appended.
8325 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008326 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008327 Setting 'verbosefile' to a new value is like making it empty first.
8328 The difference with |:redir| is that verbose messages are not
8329 displayed when 'verbosefile' is set.
8330
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 *'viewdir'* *'vdir'*
8332'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8333 "$VIM/vimfiles/view",
8334 for Unix: "~/.vim/view",
8335 for Macintosh: "$VIM:vimfiles:view"
8336 for VMS: "sys$login:vimfiles/view"
8337 for RiscOS: "Choices:vimfiles/view")
8338 global
8339 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008340 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 feature}
8342 Name of the directory where to store files for |:mkview|.
8343 This option cannot be set from a |modeline| or in the |sandbox|, for
8344 security reasons.
8345
8346 *'viewoptions'* *'vop'*
8347'viewoptions' 'vop' string (default: "folds,options,cursor")
8348 global
8349 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008350 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 feature}
8352 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008353 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 word save and restore ~
8355 cursor cursor position in file and in window
8356 folds manually created folds, opened/closed folds and local
8357 fold options
8358 options options and mappings local to a window or buffer (not
8359 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008360 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 slash backslashes in file names replaced with forward
8362 slashes
8363 unix with Unix end-of-line format (single <NL>), even when
8364 on Windows or DOS
8365
8366 "slash" and "unix" are useful on Windows when sharing view files
8367 with Unix. The Unix version of Vim cannot source dos format scripts,
8368 but the Windows version of Vim can source unix format scripts.
8369
8370 *'viminfo'* *'vi'* *E526* *E527* *E528*
8371'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008372 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8373 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8374 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 global
8376 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008377 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378 feature}
8379 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008380 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8381 "NONE".
8382 The string should be a comma separated list of parameters, each
8383 consisting of a single character identifying the particular parameter,
8384 followed by a number or string which specifies the value of that
8385 parameter. If a particular character is left out, then the default
8386 value is used for that parameter. The following is a list of the
8387 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008389 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 ! When included, save and restore global variables that start
8391 with an uppercase letter, and don't contain a lowercase
8392 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008393 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008394 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008395 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 " Maximum number of lines saved for each register. Old name of
8397 the '<' item, with the disadvantage that you need to put a
8398 backslash before the ", otherwise it will be recognized as the
8399 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008400 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 % When included, save and restore the buffer list. If Vim is
8402 started with a file name argument, the buffer list is not
8403 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008404 buffer list is restored from the viminfo file. Quickfix
8405 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8406 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008407 When followed by a number, the number specifies the maximum
8408 number of buffers that are stored. Without a number all
8409 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008410 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 ' Maximum number of previously edited files for which the marks
8412 are remembered. This parameter must always be included when
8413 'viminfo' is non-empty.
8414 Including this item also means that the |jumplist| and the
8415 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008416 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008417 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008418 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 patterns are also saved. When not included, the value of
8420 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008421 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008423 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008424 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 < Maximum number of lines saved for each register. If zero then
8426 registers are not saved. When not included, all lines are
8427 saved. '"' is the old name for this item.
8428 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008429 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008431 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008432 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 c When included, convert the text in the viminfo file from the
8434 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008435 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008436 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 f Whether file marks need to be stored. If zero, file marks ('0
8438 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008439 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008441 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 h Disable the effect of 'hlsearch' when loading the viminfo
8443 file. When not included, it depends on whether ":nohlsearch"
8444 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008445 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008446 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008447 the 'n'. Must be at the end of the option! If the
8448 'viminfofile' option is set, that file name overrides the one
8449 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008450 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008451 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 r Removable media. The argument is a string (up to the next
8453 ','). This parameter can be given several times. Each
8454 specifies the start of a path for which no marks will be
8455 stored. This is to avoid removable media. For MS-DOS you
8456 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8457 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8458 ignored. Maximum length of each 'r' argument is 50
8459 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008460 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008461 s Maximum size of an item in Kbyte. If zero then registers are
8462 not saved. Currently only applies to registers. The default
8463 "s10" will exclude registers with more than 10 Kbyte of text.
8464 Also see the '<' item above: line count limit.
8465
8466 Example: >
8467 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8468<
8469 '50 Marks will be remembered for the last 50 files you
8470 edited.
8471 <1000 Contents of registers (up to 1000 lines each) will be
8472 remembered.
8473 s100 Registers with more than 100 Kbyte text are skipped.
8474 :0 Command-line history will not be saved.
8475 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8476 no / Since '/' is not specified, the default will be used,
8477 that is, save all of the search history, and also the
8478 previous search and substitute patterns.
8479 no % The buffer list will not be saved nor read back.
8480 no h 'hlsearch' highlighting will be restored.
8481
8482 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8483 load the contents of the file, this is not done automatically.
8484
8485 This option cannot be set from a |modeline| or in the |sandbox|, for
8486 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008487 NOTE: This option is set to the Vim default value when 'compatible'
8488 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008490 *'viminfofile'* *'vif'*
8491'viminfofile' 'vif' string (default: "")
8492 global
8493 {not in Vi}
8494 {not available when compiled without the |+viminfo|
8495 feature}
8496 When non-empty, overrides the file name used for viminfo.
8497 When equal to "NONE" no viminfo file will be read or written.
8498 This option can be set with the |-i| command line flag. The |--clean|
8499 command line flag sets it to "NONE".
8500
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 *'virtualedit'* *'ve'*
8502'virtualedit' 've' string (default "")
8503 global
8504 {not in Vi}
8505 {not available when compiled without the
8506 |+virtualedit| feature}
8507 A comma separated list of these words:
8508 block Allow virtual editing in Visual block mode.
8509 insert Allow virtual editing in Insert mode.
8510 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008511 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008512
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008514 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008515 of the line. Useful for selecting a rectangle in Visual mode and
8516 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008517 "onemore" is not the same, it will only allow moving the cursor just
8518 after the last character of the line. This makes some commands more
8519 consistent. Previously the cursor was always past the end of the line
8520 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008521 break some plugins or Vim scripts. For example because |l| can move
8522 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008523 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008524 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008525 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008526 It doesn't make sense to combine "all" with "onemore", but you will
8527 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008528 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529
8530 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8531'visualbell' 'vb' boolean (default off)
8532 global
8533 {not in Vi}
Bram Moolenaar74675a62017-07-15 13:53:23 +02008534 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008535 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008536 use: >
8537 :set vb t_vb=
8538< If you want a short flash, you can use this on many terminals: >
8539 :set vb t_vb=[?5h$<100>[?5l
8540< Here $<100> specifies the time, you can use a smaller or bigger value
8541 to get a shorter or longer flash.
8542
8543 Note: Vim will limit the bell to once per half a second. This avoids
8544 having to wait for the flashing to finish when there are lots of
8545 bells, e.g. on key repeat. This also happens without 'visualbell'
8546 set.
8547
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8549 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8550 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008551
8552 Note: When the GUI starts, 't_vb' is reset to its default value. You
8553 might want to set it again in your |gvimrc|.
8554
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 Does not work on the Amiga, you always get a screen flash.
8556 Also see 'errorbells'.
8557
8558 *'warn'* *'nowarn'*
8559'warn' boolean (default on)
8560 global
8561 Give a warning message when a shell command is used while the buffer
8562 has been changed.
8563
8564 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8565'weirdinvert' 'wiv' boolean (default off)
8566 global
8567 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008568 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008569 It is provided for backwards compatibility with version 4.x.
8570 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8571 vice versa. Has no effect when the GUI is running.
8572
8573 *'whichwrap'* *'ww'*
8574'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8575 global
8576 {not in Vi}
8577 Allow specified keys that move the cursor left/right to move to the
8578 previous/next line when the cursor is on the first/last character in
8579 the line. Concatenate characters to allow this for these keys:
8580 char key mode ~
8581 b <BS> Normal and Visual
8582 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008583 h "h" Normal and Visual (not recommended)
8584 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008585 < <Left> Normal and Visual
8586 > <Right> Normal and Visual
8587 ~ "~" Normal
8588 [ <Left> Insert and Replace
8589 ] <Right> Insert and Replace
8590 For example: >
8591 :set ww=<,>,[,]
8592< allows wrap only when cursor keys are used.
8593 When the movement keys are used in combination with a delete or change
8594 operator, the <EOL> also counts for a character. This makes "3h"
8595 different from "3dh" when the cursor crosses the end of a line. This
8596 is also true for "x" and "X", because they do the same as "dl" and
8597 "dh". If you use this, you may also want to use the mapping
8598 ":map <BS> X" to make backspace delete the character in front of the
8599 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008600 When 'l' is included and it is used after an operator at the end of a
8601 line then it will not move to the next line. This makes "dl", "cl",
8602 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 NOTE: This option is set to the Vi default value when 'compatible' is
8604 set and to the Vim default value when 'compatible' is reset.
8605
8606 *'wildchar'* *'wc'*
8607'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8608 global
8609 {not in Vi}
8610 Character you have to type to start wildcard expansion in the
8611 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008612 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 The character is not recognized when used inside a macro. See
8614 'wildcharm' for that.
8615 Although 'wc' is a number option, you can set it to a special key: >
8616 :set wc=<Esc>
8617< NOTE: This option is set to the Vi default value when 'compatible' is
8618 set and to the Vim default value when 'compatible' is reset.
8619
8620 *'wildcharm'* *'wcm'*
8621'wildcharm' 'wcm' number (default: none (0))
8622 global
8623 {not in Vi}
8624 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008625 recognized when used inside a macro. You can find "spare" command-line
8626 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 you'll never actually type 'wildcharm', just use it in mappings that
8628 automatically invoke completion mode, e.g.: >
8629 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008630 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631< Then after typing :ss you can use CTRL-P & CTRL-N.
8632
8633 *'wildignore'* *'wig'*
8634'wildignore' 'wig' string (default "")
8635 global
8636 {not in Vi}
8637 {not available when compiled without the |+wildignore|
8638 feature}
8639 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008640 patterns is ignored when expanding |wildcards|, completing file or
8641 directory names, and influences the result of |expand()|, |glob()| and
8642 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8644 Also see 'suffixes'.
8645 Example: >
8646 :set wildignore=*.o,*.obj
8647< The use of |:set+=| and |:set-=| is preferred when adding or removing
8648 a pattern from the list. This avoids problems when a future version
8649 uses another default.
8650
Bram Moolenaar94950a92010-12-02 16:01:29 +01008651
Bram Moolenaar81af9252010-12-10 20:35:50 +01008652 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008653'wildignorecase' 'wic' boolean (default off)
8654 global
8655 {not in Vi}
8656 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008657 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008658 Does not apply when the shell is used to expand wildcards, which
8659 happens when there are special characters.
8660
8661
Bram Moolenaar071d4272004-06-13 20:20:40 +00008662 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008663'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008664 global
8665 {not in Vi}
8666 {not available if compiled without the |+wildmenu|
8667 feature}
8668 When 'wildmenu' is on, command-line completion operates in an enhanced
8669 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8670 the possible matches are shown just above the command line, with the
8671 first match highlighted (overwriting the status line, if there is
8672 one). Keys that show the previous/next match, such as <Tab> or
8673 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8674 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8675 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008676 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 If there are more matches than can fit in the line, a ">" is shown on
8678 the right and/or a "<" is shown on the left. The status line scrolls
8679 as needed.
8680 The "wildmenu" mode is abandoned when a key is hit that is not used
8681 for selecting a completion.
8682 While the "wildmenu" is active the following keys have special
8683 meanings:
8684
8685 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8686 <Down> - in filename/menu name completion: move into a
8687 subdirectory or submenu.
8688 <CR> - in menu completion, when the cursor is just after a
8689 dot: move into a submenu.
8690 <Up> - in filename/menu name completion: move up into
8691 parent directory or parent menu.
8692
8693 This makes the menus accessible from the console |console-menus|.
8694
8695 If you prefer the <Left> and <Right> keys to move the cursor instead
8696 of selecting a different match, use this: >
8697 :cnoremap <Left> <Space><BS><Left>
8698 :cnoremap <Right> <Space><BS><Right>
8699<
8700 The "WildMenu" highlighting is used for displaying the current match
8701 |hl-WildMenu|.
8702
8703 *'wildmode'* *'wim'*
8704'wildmode' 'wim' string (Vim default: "full")
8705 global
8706 {not in Vi}
8707 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008708 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008709 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 first part specifies the behavior for the first use of 'wildchar',
8711 The second part for the second use, etc.
8712 These are the possible values for each part:
8713 "" Complete only the first match.
8714 "full" Complete the next full match. After the last match,
8715 the original string is used and then the first match
8716 again.
8717 "longest" Complete till longest common string. If this doesn't
8718 result in a longer string, use the next part.
8719 "longest:full" Like "longest", but also start 'wildmenu' if it is
8720 enabled.
8721 "list" When more than one match, list all matches.
8722 "list:full" When more than one match, list all matches and
8723 complete first match.
8724 "list:longest" When more than one match, list all matches and
8725 complete till longest common string.
8726 When there is only a single match, it is fully completed in all cases.
8727
8728 Examples: >
8729 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008730< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 :set wildmode=longest,full
8732< Complete longest common string, then each full match >
8733 :set wildmode=list:full
8734< List all matches and complete each full match >
8735 :set wildmode=list,full
8736< List all matches without completing, then each full match >
8737 :set wildmode=longest,list
8738< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008739 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008741 *'wildoptions'* *'wop'*
8742'wildoptions' 'wop' string (default "")
8743 global
8744 {not in Vi}
8745 {not available when compiled without the |+wildignore|
8746 feature}
8747 A list of words that change how command line completion is done.
8748 Currently only one word is allowed:
8749 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008750 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008751 is displayed per line. Often used tag kinds are:
8752 d #define
8753 f function
8754 Also see |cmdline-completion|.
8755
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 *'winaltkeys'* *'wak'*
8757'winaltkeys' 'wak' string (default "menu")
8758 global
8759 {not in Vi}
8760 {only used in Win32, Motif, GTK and Photon GUI}
8761 Some GUI versions allow the access to menu entries by using the ALT
8762 key in combination with a character that appears underlined in the
8763 menu. This conflicts with the use of the ALT key for mappings and
8764 entering special characters. This option tells what to do:
8765 no Don't use ALT keys for menus. ALT key combinations can be
8766 mapped, but there is no automatic handling. This can then be
8767 done with the |:simalt| command.
8768 yes ALT key handling is done by the windowing system. ALT key
8769 combinations cannot be mapped.
8770 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008771 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 keys can be mapped.
8773 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8774 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008775 This option is not used for <F10>; on Win32 and with GTK <F10> will
8776 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008777
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008778 *'window'* *'wi'*
8779'window' 'wi' number (default screen height - 1)
8780 global
8781 Window height. Do not confuse this with the height of the Vim window,
8782 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008783 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8784 value is smaller than 'lines' minus one. The screen will scroll
8785 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008786 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8787 in a much smarter way, taking care of wrapping lines.
8788 When resizing the Vim window, the value is smaller than 1 or more than
8789 or equal to 'lines' it will be set to 'lines' minus 1.
8790 {Vi also uses the option to specify the number of displayed lines}
8791
Bram Moolenaar071d4272004-06-13 20:20:40 +00008792 *'winheight'* *'wh'* *E591*
8793'winheight' 'wh' number (default 1)
8794 global
8795 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008796 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008797 feature}
8798 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008799 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008800 focus goes to a window that is smaller, its size is increased, at the
8801 cost of the height of other windows.
8802 Set 'winheight' to a small number for normal editing.
8803 Set it to 999 to make the current window fill most of the screen.
8804 Other windows will be only 'winminheight' high. This has the drawback
8805 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8806 to create only two windows, set the option after startup is done,
8807 using the |VimEnter| event: >
8808 au VimEnter * set winheight=999
8809< Minimum value is 1.
8810 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 height of the current window.
8812 'winheight' applies to the current window. Use 'winminheight' to set
8813 the minimal height for other windows.
8814
8815 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8816'winfixheight' 'wfh' boolean (default off)
8817 local to window
8818 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008819 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008820 feature}
8821 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008822 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8823 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008824 The height may be changed anyway when running out of room.
8825
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008826 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8827'winfixwidth' 'wfw' boolean (default off)
8828 local to window
8829 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008830 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008831 feature}
8832 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008833 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008834 The width may be changed anyway when running out of room.
8835
Bram Moolenaar071d4272004-06-13 20:20:40 +00008836 *'winminheight'* *'wmh'*
8837'winminheight' 'wmh' number (default 1)
8838 global
8839 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008840 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008841 feature}
8842 The minimal height of a window, when it's not the current window.
8843 This is a hard minimum, windows will never become smaller.
8844 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8845 status bar) if necessary. They will return to at least one line when
8846 they become active (since the cursor has to have somewhere to go.)
8847 Use 'winheight' to set the minimal height of the current window.
8848 This option is only checked when making a window smaller. Don't use a
8849 large number, it will cause errors when opening more than a few
8850 windows. A value of 0 to 3 is reasonable.
8851
8852 *'winminwidth'* *'wmw'*
8853'winminwidth' 'wmw' number (default 1)
8854 global
8855 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008856 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008857 feature}
8858 The minimal width of a window, when it's not the current window.
8859 This is a hard minimum, windows will never become smaller.
8860 When set to zero, windows may be "squashed" to zero columns (i.e. just
8861 a vertical separator) if necessary. They will return to at least one
8862 line when they become active (since the cursor has to have somewhere
8863 to go.)
8864 Use 'winwidth' to set the minimal width of the current window.
8865 This option is only checked when making a window smaller. Don't use a
8866 large number, it will cause errors when opening more than a few
8867 windows. A value of 0 to 12 is reasonable.
8868
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008869 *'winptydll'*
8870'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8871 global
8872 {not in Vi}
8873 {only available when compiled with the |terminal|
8874 feature on MS-Windows}
8875 Specifies the name of the winpty shared library, used for the
8876 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008877 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008878 a fallback.
8879 Environment variables are expanded |:set_env|.
8880 This option cannot be set from a |modeline| or in the |sandbox|, for
8881 security reasons.
8882
Bram Moolenaar071d4272004-06-13 20:20:40 +00008883 *'winwidth'* *'wiw'* *E592*
8884'winwidth' 'wiw' number (default 20)
8885 global
8886 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008887 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 feature}
8889 Minimal number of columns for the current window. This is not a hard
8890 minimum, Vim will use fewer columns if there is not enough room. If
8891 the current window is smaller, its size is increased, at the cost of
8892 the width of other windows. Set it to 999 to make the current window
8893 always fill the screen. Set it to a small number for normal editing.
8894 The width is not adjusted after one of the commands to change the
8895 width of the current window.
8896 'winwidth' applies to the current window. Use 'winminwidth' to set
8897 the minimal width for other windows.
8898
8899 *'wrap'* *'nowrap'*
8900'wrap' boolean (default on)
8901 local to window
8902 {not in Vi}
8903 This option changes how text is displayed. It doesn't change the text
8904 in the buffer, see 'textwidth' for that.
8905 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008906 displaying continues on the next line. When off lines will not wrap
8907 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008908 moved to a part that is not shown, the screen will scroll
8909 horizontally.
8910 The line will be broken in the middle of a word if necessary. See
8911 'linebreak' to get the break at a word boundary.
8912 To make scrolling horizontally a bit more useful, try this: >
8913 :set sidescroll=5
8914 :set listchars+=precedes:<,extends:>
8915< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008916 This option can't be set from a |modeline| when the 'diff' option is
8917 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008918
8919 *'wrapmargin'* *'wm'*
8920'wrapmargin' 'wm' number (default 0)
8921 local to buffer
8922 Number of characters from the right window border where wrapping
8923 starts. When typing text beyond this limit, an <EOL> will be inserted
8924 and inserting continues on the next line.
8925 Options that add a margin, such as 'number' and 'foldcolumn', cause
8926 the text width to be further reduced. This is Vi compatible.
8927 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008928 This option is set to 0 when 'paste' is set and restored when 'paste'
8929 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008930 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8931 and less usefully}
8932
8933 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8934'wrapscan' 'ws' boolean (default on) *E384* *E385*
8935 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008936 Searches wrap around the end of the file. Also applies to |]s| and
8937 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008938
8939 *'write'* *'nowrite'*
8940'write' boolean (default on)
8941 global
8942 {not in Vi}
8943 Allows writing files. When not set, writing a file is not allowed.
8944 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008945 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008946 argument. Filtering text is still possible, even though this requires
8947 writing a temporary file.
8948
8949 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8950'writeany' 'wa' boolean (default off)
8951 global
8952 Allows writing to any file with no need for "!" override.
8953
8954 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8955'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8956 otherwise)
8957 global
8958 {not in Vi}
8959 Make a backup before overwriting a file. The backup is removed after
8960 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008961 also on.
8962 WARNING: Switching this option off means that when Vim fails to write
8963 your buffer correctly and then, for whatever reason, Vim exits, you
8964 lose both the original file and what you were writing. Only reset
8965 this option if your file system is almost full and it makes the write
8966 fail (and make sure not to exit Vim until the write was successful).
8967 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008968 When the 'backupskip' pattern matches, a backup is not made anyway.
8969 NOTE: This option is set to the default value when 'compatible' is
8970 set.
8971
8972 *'writedelay'* *'wd'*
8973'writedelay' 'wd' number (default 0)
8974 global
8975 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008976 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008977 screen. When non-zero, characters are sent to the terminal one by
8978 one. For MS-DOS pcterm this does not work. For debugging purposes.
8979
8980 vim:tw=78:ts=8:ft=help:norl: