blob: 88dca60b7727d140ce82ea8a7f16be5ada92c898 [file] [log] [blame]
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01001*options.txt* For Vim version 8.0. Last change: 2017 Jan 02
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100245has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
730
731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
732'autochdir' 'acd' boolean (default off)
733 global
734 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
746 {not in Vi}
747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
769 {not in Vi}
770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {small difference from Vi: After the indent is deleted when typing
802 <Esc> or <CR>, the cursor position when moving up or down is after the
803 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
804
805 *'autoread'* *'ar'* *'noautoread'* *'noar'*
806'autoread' 'ar' boolean (default off)
807 global or local to buffer |global-local|
808 {not in Vi}
809 When a file has been detected to have been changed outside of Vim and
810 it has not been changed inside of Vim, automatically read it again.
811 When the file has been deleted this is not done. |timestamp|
812 If this option has a local value, use this command to switch back to
813 using the global value: >
814 :set autoread<
815<
816 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
817'autowrite' 'aw' boolean (default off)
818 global
819 Write the contents of the file, if it has been modified, on each
820 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000821 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
823 Note that for some commands the 'autowrite' option is not used, see
824 'autowriteall' for that.
825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
829 {not in Vi}
830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
832 Setting this option also implies that Vim behaves like 'autowrite' has
833 been set.
834
835 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200836'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 global
838 {not in Vi}
839 When set to "dark", Vim will try to use colors that look good on a
840 dark background. When set to "light", Vim will try to use colors that
841 look good on a light background. Any other value is illegal.
842 Vim tries to set the default value according to the terminal used.
843 This will not always be correct.
844 Setting this option does not change the background color, it tells Vim
845 what the background color looks like. For changing the background
846 color, see |:hi-normal|.
847
848 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000850 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 setting 'background' will cause the color scheme to be reloaded. If
853 the color scheme adjusts to the value of 'background' this will work.
854 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 When setting 'background' to the default value with: >
858 :set background&
859< Vim will guess the value. In the GUI this should work correctly,
860 in other cases Vim might not be able to guess the right value.
861
862 When starting the GUI, the default value for 'background' will be
863 "light". When the value is not set in the .gvimrc, and Vim detects
864 that the background is actually quite dark, 'background' is set to
865 "dark". But this happens only AFTER the .gvimrc file has been read
866 (because the window needs to be opened to find the actual background
867 color). To get around this, force the GUI window to be opened by
868 putting a ":gui" command in the .gvimrc file, before where the value
869 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870
871 For MS-DOS, Windows and OS/2 the default is "dark".
872 For other systems "dark" is used when 'term' is "linux",
873 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
874 background. Otherwise the default is "light".
875
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 Normally this option would be set in the .vimrc file. Possibly
877 depending on the terminal name. Example: >
878 :if &term == "pcterm"
879 : set background=dark
880 :endif
881< When this option is set, the default settings for the highlight groups
882 will change. To use other settings, place ":highlight" commands AFTER
883 the setting of the 'background' option.
884 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
885 to select the colors for syntax highlighting. After changing this
886 option, you must load syntax.vim again to see the result. This can be
887 done with ":syntax on".
888
889 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200890'backspace' 'bs' string (default "", set to "indent,eol,start"
891 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 global
893 {not in Vi}
894 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
895 mode. This is a list of items, separated by commas. Each item allows
896 a way to backspace over something:
897 value effect ~
898 indent allow backspacing over autoindent
899 eol allow backspacing over line breaks (join lines)
900 start allow backspacing over the start of insert; CTRL-W and CTRL-U
901 stop once at the start of insert.
902
903 When the value is empty, Vi compatible backspacing is used.
904
905 For backwards compatibility with version 5.4 and earlier:
906 value effect ~
907 0 same as ":set backspace=" (Vi compatible)
908 1 same as ":set backspace=indent,eol"
909 2 same as ":set backspace=indent,eol,start"
910
911 See |:fixdel| if your <BS> or <Del> key does not do what you want.
912 NOTE: This option is set to "" when 'compatible' is set.
913
914 *'backup'* *'bk'* *'nobackup'* *'nobk'*
915'backup' 'bk' boolean (default off)
916 global
917 {not in Vi}
918 Make a backup before overwriting a file. Leave it around after the
919 file has been successfully written. If you do not want to keep the
920 backup file, but you do want a backup while the file is being
921 written, reset this option and set the 'writebackup' option (this is
922 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 |backup-table| for more explanations.
925 When the 'backupskip' pattern matches, a backup is not made anyway.
926 When 'patchmode' is set, the backup may be renamed to become the
927 oldest version of a file.
928 NOTE: This option is reset when 'compatible' is set.
929
930 *'backupcopy'* *'bkc'*
931'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 {not in Vi}
934 When writing a file and a backup is made, this option tells how it's
935 done. This is a comma separated list of words.
936
937 The main values are:
938 "yes" make a copy of the file and overwrite the original one
939 "no" rename the file and write a new one
940 "auto" one of the previous, what works best
941
942 Extra values that can be combined with the ones above are:
943 "breaksymlink" always break symlinks when writing
944 "breakhardlink" always break hardlinks when writing
945
946 Making a copy and overwriting the original file:
947 - Takes extra time to copy the file.
948 + When the file has special attributes, is a (hard/symbolic) link or
949 has a resource fork, all this is preserved.
950 - When the file is a link the backup will have the name of the link,
951 not of the real file.
952
953 Renaming the file and writing a new one:
954 + It's fast.
955 - Sometimes not all attributes of the file can be copied to the new
956 file.
957 - When the file is a link the new file will not be a link.
958
959 The "auto" value is the middle way: When Vim sees that renaming file
960 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000961 the file is not a link) that is used. When problems are expected, a
962 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 The "breaksymlink" and "breakhardlink" values can be used in
965 combination with any of "yes", "no" and "auto". When included, they
966 force Vim to always break either symbolic or hard links by doing
967 exactly what the "no" option does, renaming the original file to
968 become the backup and writing a new file in its place. This can be
969 useful for example in source trees where all the files are symbolic or
970 hard links and any changes should stay in the local source tree, not
971 be propagated back to the original source.
972 *crontab*
973 One situation where "no" and "auto" will cause problems: A program
974 that opens a file, invokes Vim to edit that file, and then tests if
975 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000976 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 example.
978
979 When a copy is made, the original file is truncated and then filled
980 with the new text. This means that protection bits, owner and
981 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 group of the backup is set to the group of the original file. If this
984 fails, the protection bits for the group are made the same as for
985 others.
986
987 When the file is renamed this is the other way around: The backup has
988 the same attributes of the original file, and the newly written file
989 is owned by the current user. When the file was a (hard/symbolic)
990 link, the new file will not! That's why the "auto" value doesn't
991 rename when the file is a link. The owner and group of the newly
992 written file will be set to the same ones as the original file, but
993 the system may refuse to do this. In that case the "auto" value will
994 again not rename the file.
995
996 *'backupdir'* *'bdir'*
997'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100998 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 for Unix: ".,~/tmp,~/")
1000 global
1001 {not in Vi}
1002 List of directories for the backup file, separated with commas.
1003 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001004 where this is possible. The directory must exist, Vim will not
1005 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001006 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 impossible!). Writing may fail because of this.
1008 - A directory "." means to put the backup file in the same directory
1009 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001010 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 put the backup file relative to where the edited file is. The
1012 leading "." is replaced with the path name of the edited file.
1013 ("." inside a directory name has no special meaning).
1014 - Spaces after the comma are ignored, other spaces are considered part
1015 of the directory name. To have a space at the start of a directory
1016 name, precede it with a backslash.
1017 - To include a comma in a directory name precede it with a backslash.
1018 - A directory name may end in an '/'.
1019 - Environment variables are expanded |:set_env|.
1020 - Careful with '\' characters, type one before a space, type two to
1021 get one in the option (see |option-backslash|), for example: >
1022 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1023< - For backwards compatibility with Vim version 3.0 a '>' at the start
1024 of the option is removed.
1025 See also 'backup' and 'writebackup' options.
1026 If you want to hide your backup files on Unix, consider this value: >
1027 :set backupdir=./.backup,~/.backup,.,/tmp
1028< You must create a ".backup" directory in each directory and in your
1029 home directory for this to work properly.
1030 The use of |:set+=| and |:set-=| is preferred when adding or removing
1031 directories from the list. This avoids problems when a future version
1032 uses another default.
1033 This option cannot be set from a |modeline| or in the |sandbox|, for
1034 security reasons.
1035
1036 *'backupext'* *'bex'* *E589*
1037'backupext' 'bex' string (default "~", for VMS: "_")
1038 global
1039 {not in Vi}
1040 String which is appended to a file name to make the name of the
1041 backup file. The default is quite unusual, because this avoids
1042 accidentally overwriting existing files with a backup file. You might
1043 prefer using ".bak", but make sure that you don't have files with
1044 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001045 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001047 If you like to keep a lot of backups, you could use a BufWritePre
1048 autocommand to change 'backupext' just before writing the file to
1049 include a timestamp. >
1050 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1051< Use 'backupdir' to put the backup in a different directory.
1052
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 *'backupskip'* *'bsk'*
1054'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1055 global
1056 {not in Vi}
1057 {not available when compiled without the |+wildignore|
1058 feature}
1059 A list of file patterns. When one of the patterns matches with the
1060 name of the file which is written, no backup file is created. Both
1061 the specified file name and the full path name of the file are used.
1062 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1063 Watch out for special characters, see |option-backslash|.
1064 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001065 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001066
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001067 WARNING: Not having a backup file means that when Vim fails to write
1068 your buffer correctly and then, for whatever reason, Vim exits, you
1069 lose both the original file and what you were writing. Only disable
1070 backups if you don't care about losing the file.
1071
Bram Moolenaar02467872007-05-06 13:22:01 +00001072 Note that environment variables are not expanded. If you want to use
1073 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001074 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001075
1076< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001077 backup would be made by renaming the original file crontab won't see
1078 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079
1080 *'balloondelay'* *'bdlay'*
1081'balloondelay' 'bdlay' number (default: 600)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
1085 feature}
1086 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1087
1088 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1089'ballooneval' 'beval' boolean (default off)
1090 global
1091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001093 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 Switch on the |balloon-eval| functionality.
1095
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096 *'balloonexpr'* *'bexpr'*
1097'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001098 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001099 {not in Vi}
1100 {only available when compiled with the |+balloon_eval|
1101 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001102 Expression for text to show in evaluation balloon. It is only used
1103 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001104
1105 v:beval_bufnr number of the buffer in which balloon is going to show
1106 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001107 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001108 v:beval_lnum line number
1109 v:beval_col column number (byte index)
1110 v:beval_text word under or after the mouse pointer
1111
1112 The evaluation of the expression must not have side effects!
1113 Example: >
1114 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001115 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001116 \', column ' . v:beval_col .
1117 \ ' of file ' . bufname(v:beval_bufnr) .
1118 \ ' on word "' . v:beval_text . '"'
1119 endfunction
1120 set bexpr=MyBalloonExpr()
1121 set ballooneval
1122<
1123 NOTE: The balloon is displayed only if the cursor is on a text
1124 character. If the result of evaluating 'balloonexpr' is not empty,
1125 Vim does not try to send a message to an external debugger (Netbeans
1126 or Sun Workshop).
1127
Bram Moolenaar30b65812012-07-12 22:01:11 +02001128 The expression will be evaluated in the |sandbox| when set from a
1129 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001130
1131 It is not allowed to change text or jump to another window while
1132 evaluating 'balloonexpr' |textlock|.
1133
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001134 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001135 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001136< When they are supported "\n" characters will start a new line. If the
1137 expression evaluates to a |List| this is equal to using each List item
1138 as a string and putting "\n" in between them.
1139
Bram Moolenaar165bc692015-07-21 17:53:25 +02001140 *'belloff'* *'bo'*
1141'belloff' 'bo' string (default "")
1142 global
1143 {not in Vi}
1144 Specifies for which events the bell will not be rung. It is a comma
1145 separated list of items. For each item that is present, the bell
1146 will be silenced. This is most useful to specify specific events in
1147 insert mode to be silenced.
1148
1149 item meaning when present ~
1150 all All events.
1151 backspace When hitting <BS> or <Del> and deleting results in an
1152 error.
1153 cursor Fail to move around using the cursor keys or
1154 <PageUp>/<PageDown> in |Insert-mode|.
1155 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1156 |i_CTRL-X_CTRL-T|.
1157 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1158 |i_CTRL-E|.
1159 ctrlg Unknown Char after <C-G> in Insert mode.
1160 error Other Error occurred (e.g. try to join last line)
1161 (mostly used in |Normal-mode| or |Cmdline-mode|).
1162 esc hitting <Esc> in |Normal-mode|.
1163 ex In |Visual-mode|, hitting |Q| results in an error.
1164 hangul Error occurred when using hangul input.
1165 insertmode Pressing <Esc> in 'insertmode'.
1166 lang Calling the beep module for Lua/Mzscheme/TCL.
1167 mess No output available for |g<|.
1168 showmatch Error occurred for 'showmatch' function.
1169 operator Empty region error |cpo-E|.
1170 register Unknown register after <C-R> in |Insert-mode|.
1171 shell Bell from shell output |:!|.
1172 spell Error happened on spell suggest.
1173 wildmode More matches in |cmdline-completion| available
1174 (depends on the 'wildmode' setting).
1175
1176 This is most useful, to fine tune when in insert mode the bell should
1177 be rung. For normal mode and ex commands, the bell is often rung to
1178 indicate that an error occurred. It can be silenced by adding the
1179 "error" keyword.
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1182'binary' 'bin' boolean (default off)
1183 local to buffer
1184 {not in Vi}
1185 This option should be set before editing a binary file. You can also
1186 use the |-b| Vim argument. When this option is switched on a few
1187 options will be changed (also when it already was on):
1188 'textwidth' will be set to 0
1189 'wrapmargin' will be set to 0
1190 'modeline' will be off
1191 'expandtab' will be off
1192 Also, 'fileformat' and 'fileformats' options will not be used, the
1193 file is read and written like 'fileformat' was "unix" (a single <NL>
1194 separates lines).
1195 The 'fileencoding' and 'fileencodings' options will not be used, the
1196 file is read without conversion.
1197 NOTE: When you start editing a(nother) file while the 'bin' option is
1198 on, settings from autocommands may change the settings again (e.g.,
1199 'textwidth'), causing trouble when editing. You might want to set
1200 'bin' again when the file has been loaded.
1201 The previous values of these options are remembered and restored when
1202 'bin' is switched from on to off. Each buffer has its own set of
1203 saved option values.
1204 To edit a file with 'binary' set you can use the |++bin| argument.
1205 This avoids you have to do ":set bin", which would have effect for all
1206 files you edit.
1207 When writing a file the <EOL> for the last line is only written if
1208 there was one in the original file (normally Vim appends an <EOL> to
1209 the last line if there is none; this would make the file longer). See
1210 the 'endofline' option.
1211
1212 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1213'bioskey' 'biosk' boolean (default on)
1214 global
1215 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001216 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
1218 *'bomb'* *'nobomb'*
1219'bomb' boolean (default off)
1220 local to buffer
1221 {not in Vi}
1222 {only available when compiled with the |+multi_byte|
1223 feature}
1224 When writing a file and the following conditions are met, a BOM (Byte
1225 Order Mark) is prepended to the file:
1226 - this option is on
1227 - the 'binary' option is off
1228 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1229 endian variants.
1230 Some applications use the BOM to recognize the encoding of the file.
1231 Often used for UCS-2 files on MS-Windows. For other applications it
1232 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001233 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1235 check for the presence of the BOM is done and 'bomb' set accordingly.
1236 Unless 'binary' is set, it is removed from the first line, so that you
1237 don't see it when editing. When you don't change the options, the BOM
1238 will be restored when writing the file.
1239
1240 *'breakat'* *'brk'*
1241'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1242 global
1243 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001244 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 feature}
1246 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001247 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1248 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001250 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001251'breakindent' 'bri' boolean (default off)
1252 local to window
1253 {not in Vi}
1254 {not available when compiled without the |+linebreak|
1255 feature}
1256 Every wrapped line will continue visually indented (same amount of
1257 space as the beginning of that line), thus preserving horizontal blocks
1258 of text.
1259
1260 *'breakindentopt'* *'briopt'*
1261'breakindentopt' 'briopt' string (default empty)
1262 local to window
1263 {not in Vi}
1264 {not available when compiled without the |+linebreak|
1265 feature}
1266 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001267 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001268 min:{n} Minimum text width that will be kept after
1269 applying 'breakindent', even if the resulting
1270 text should normally be narrower. This prevents
1271 text indented almost to the right window border
1272 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001273 shift:{n} After applying 'breakindent', the wrapped line's
1274 beginning will be shifted by the given number of
1275 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276 indentation (negative) or emphasizing the line
1277 continuation (positive).
1278 sbr Display the 'showbreak' value before applying the
1279 additional indent.
1280 The default value for min is 20 and shift is 0.
1281
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001283'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001285 {not in Vi} {only for Motif, Athena, GTK, Mac and
1286 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001288 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001289 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 buffer Use the directory of the related buffer.
1291 current Use the current directory.
1292 {path} Use the specified directory
1293
1294 *'bufhidden'* *'bh'*
1295'bufhidden' 'bh' string (default: "")
1296 local to buffer
1297 {not in Vi}
1298 {not available when compiled without the |+quickfix|
1299 feature}
1300 This option specifies what happens when a buffer is no longer
1301 displayed in a window:
1302 <empty> follow the global 'hidden' option
1303 hide hide the buffer (don't unload it), also when 'hidden'
1304 is not set
1305 unload unload the buffer, also when 'hidden' is set or using
1306 |:hide|
1307 delete delete the buffer from the buffer list, also when
1308 'hidden' is set or using |:hide|, like using
1309 |:bdelete|
1310 wipe wipe out the buffer from the buffer list, also when
1311 'hidden' is set or using |:hide|, like using
1312 |:bwipeout|
1313
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001314 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001315 are lost without a warning. Also, these values may break autocommands
1316 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 This option is used together with 'buftype' and 'swapfile' to specify
1318 special kinds of buffers. See |special-buffers|.
1319
1320 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1321'buflisted' 'bl' boolean (default: on)
1322 local to buffer
1323 {not in Vi}
1324 When this option is set, the buffer shows up in the buffer list. If
1325 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1326 This option is reset by Vim for buffers that are only used to remember
1327 a file name or marks. Vim sets it when starting to edit a buffer.
1328 But not when moving to a buffer with ":buffer".
1329
1330 *'buftype'* *'bt'* *E382*
1331'buftype' 'bt' string (default: "")
1332 local to buffer
1333 {not in Vi}
1334 {not available when compiled without the |+quickfix|
1335 feature}
1336 The value of this option specifies the type of a buffer:
1337 <empty> normal buffer
1338 nofile buffer which is not related to a file and will not be
1339 written
1340 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001341 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001342 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001343 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001345 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 help help buffer (you are not supposed to set this
1347 manually)
1348
1349 This option is used together with 'bufhidden' and 'swapfile' to
1350 specify special kinds of buffers. See |special-buffers|.
1351
1352 Be careful with changing this option, it can have many side effects!
1353
Bram Moolenaar280f1262006-01-30 00:14:18 +00001354 A "quickfix" buffer is only used for the error list and the location
1355 list. This value is set by the |:cwindow| and |:lwindow| commands and
1356 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
1358 "nofile" and "nowrite" buffers are similar:
1359 both: The buffer is not to be written to disk, ":w" doesn't
1360 work (":w filename" does work though).
1361 both: The buffer is never considered to be |'modified'|.
1362 There is no warning when the changes will be lost, for
1363 example when you quit Vim.
1364 both: A swap file is only created when using too much memory
1365 (when 'swapfile' has been reset there is never a swap
1366 file).
1367 nofile only: The buffer name is fixed, it is not handled like a
1368 file name. It is not modified in response to a |:cd|
1369 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001370 both: When using ":e bufname" and already editing "bufname"
1371 the buffer is made empty and autocommands are
1372 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001373 *E676*
1374 "acwrite" implies that the buffer name is not related to a file, like
1375 "nofile", but it will be written. Thus, in contrast to "nofile" and
1376 "nowrite", ":w" does work and a modified buffer can't be abandoned
1377 without saving. For writing there must be matching |BufWriteCmd|,
1378 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 *'casemap'* *'cmp'*
1381'casemap' 'cmp' string (default: "internal,keepascii")
1382 global
1383 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001384 {only available when compiled with the |+multi_byte|
1385 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 Specifies details about changing the case of letters. It may contain
1387 these words, separated by a comma:
1388 internal Use internal case mapping functions, the current
1389 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001390 matters when 'encoding' is a Unicode encoding,
1391 "latin1" or "iso-8859-15". When "internal" is
1392 omitted, the towupper() and towlower() system library
1393 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1395 case mapping, the current locale is not effective.
1396 This probably only matters for Turkish.
1397
1398 *'cdpath'* *'cd'* *E344* *E346*
1399'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1400 global
1401 {not in Vi}
1402 {not available when compiled without the
1403 |+file_in_path| feature}
1404 This is a list of directories which will be searched when using the
1405 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001406 for has a relative path, not an absolute part starting with "/", "./"
1407 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 The 'cdpath' option's value has the same form and semantics as
1409 |'path'|. Also see |file-searching|.
1410 The default value is taken from $CDPATH, with a "," prepended to look
1411 in the current directory first.
1412 If the default value taken from $CDPATH is not what you want, include
1413 a modified version of the following command in your vimrc file to
1414 override it: >
1415 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1416< This option cannot be set from a |modeline| or in the |sandbox|, for
1417 security reasons.
1418 (parts of 'cdpath' can be passed to the shell to expand file names).
1419
1420 *'cedit'*
1421'cedit' string (Vi default: "", Vim default: CTRL-F)
1422 global
1423 {not in Vi}
1424 {not available when compiled without the |+vertsplit|
1425 feature}
1426 The key used in Command-line Mode to open the command-line window.
1427 The default is CTRL-F when 'compatible' is off.
1428 Only non-printable keys are allowed.
1429 The key can be specified as a single character, but it is difficult to
1430 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001431 :exe "set cedit=\<C-Y>"
1432 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433< |Nvi| also has this option, but it only uses the first character.
1434 See |cmdwin|.
1435
1436 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1437'charconvert' 'ccv' string (default "")
1438 global
1439 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001440 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 {not in Vi}
1442 An expression that is used for character encoding conversion. It is
1443 evaluated when a file that is to be read or has been written has a
1444 different encoding from what is desired.
1445 'charconvert' is not used when the internal iconv() function is
1446 supported and is able to do the conversion. Using iconv() is
1447 preferred, because it is much faster.
1448 'charconvert' is not used when reading stdin |--|, because there is no
1449 file to convert from. You will have to save the text in a file first.
1450 The expression must return zero or an empty string for success,
1451 non-zero for failure.
1452 The possible encoding names encountered are in 'encoding'.
1453 Additionally, names given in 'fileencodings' and 'fileencoding' are
1454 used.
1455 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1456 is done internally by Vim, 'charconvert' is not used for this.
1457 'charconvert' is also used to convert the viminfo file, if the 'c'
1458 flag is present in 'viminfo'. Also used for Unicode conversion.
1459 Example: >
1460 set charconvert=CharConvert()
1461 fun CharConvert()
1462 system("recode "
1463 \ . v:charconvert_from . ".." . v:charconvert_to
1464 \ . " <" . v:fname_in . " >" v:fname_out)
1465 return v:shell_error
1466 endfun
1467< The related Vim variables are:
1468 v:charconvert_from name of the current encoding
1469 v:charconvert_to name of the desired encoding
1470 v:fname_in name of the input file
1471 v:fname_out name of the output file
1472 Note that v:fname_in and v:fname_out will never be the same.
1473 Note that v:charconvert_from and v:charconvert_to may be different
1474 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1475 Encryption is not done by Vim when using 'charconvert'. If you want
1476 to encrypt the file after conversion, 'charconvert' should take care
1477 of this.
1478 This option cannot be set from a |modeline| or in the |sandbox|, for
1479 security reasons.
1480
1481 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1482'cindent' 'cin' boolean (default off)
1483 local to buffer
1484 {not in Vi}
1485 {not available when compiled without the |+cindent|
1486 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001487 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 that trigger reindenting in insert mode and 'cinoptions' to set your
1489 preferred indent style.
1490 If 'indentexpr' is not empty, it overrules 'cindent'.
1491 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1492 the "=" operator indents using this algorithm rather than calling an
1493 external program.
1494 See |C-indenting|.
1495 When you don't like the way 'cindent' works, try the 'smartindent'
1496 option or 'indentexpr'.
1497 This option is not used when 'paste' is set.
1498 NOTE: This option is reset when 'compatible' is set.
1499
1500 *'cinkeys'* *'cink'*
1501'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1502 local to buffer
1503 {not in Vi}
1504 {not available when compiled without the |+cindent|
1505 feature}
1506 A list of keys that, when typed in Insert mode, cause reindenting of
1507 the current line. Only used if 'cindent' is on and 'indentexpr' is
1508 empty.
1509 For the format of this option see |cinkeys-format|.
1510 See |C-indenting|.
1511
1512 *'cinoptions'* *'cino'*
1513'cinoptions' 'cino' string (default "")
1514 local to buffer
1515 {not in Vi}
1516 {not available when compiled without the |+cindent|
1517 feature}
1518 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1519 program. See |cinoptions-values| for the values of this option, and
1520 |C-indenting| for info on C indenting in general.
1521
1522
1523 *'cinwords'* *'cinw'*
1524'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without both the
1528 |+cindent| and the |+smartindent| features}
1529 These keywords start an extra indent in the next line when
1530 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1531 an appropriate place (inside {}).
1532 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1533 matter, include the keyword both the uppercase and lowercase:
1534 "if,If,IF".
1535
1536 *'clipboard'* *'cb'*
1537'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1538 for X-windows, "" otherwise)
1539 global
1540 {not in Vi}
1541 {only in GUI versions or when the |+xterm_clipboard|
1542 feature is included}
1543 This option is a list of comma separated names.
1544 These names are recognized:
1545
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001546 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 unnamed When included, Vim will use the clipboard register '*'
1548 for all yank, delete, change and put operations which
1549 would normally go to the unnamed register. When a
1550 register is explicitly specified, it will always be
1551 used regardless of whether "unnamed" is in 'clipboard'
1552 or not. The clipboard register can always be
1553 explicitly accessed using the "* notation. Also see
1554 |gui-clipboard|.
1555
Bram Moolenaar30b65812012-07-12 22:01:11 +02001556 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001557 unnamedplus A variant of the "unnamed" flag which uses the
1558 clipboard register '+' (|quoteplus|) instead of
1559 register '*' for all yank, delete, change and put
1560 operations which would normally go to the unnamed
1561 register. When "unnamed" is also included to the
1562 option, yank operations (but not delete, change or
1563 put) will additionally copy the text into register
1564 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001565 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001566 Availability can be checked with: >
1567 if has('unnamedplus')
1568<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001569 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 autoselect Works like the 'a' flag in 'guioptions': If present,
1571 then whenever Visual mode is started, or the Visual
1572 area extended, Vim tries to become the owner of the
1573 windowing system's global selection or put the
1574 selected text on the clipboard used by the selection
1575 register "*. See |guioptions_a| and |quotestar| for
1576 details. When the GUI is active, the 'a' flag in
1577 'guioptions' is used, when the GUI is not active, this
1578 "autoselect" flag is used.
1579 Also applies to the modeless selection.
1580
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001581 *clipboard-autoselectplus*
1582 autoselectplus Like "autoselect" but using the + register instead of
1583 the * register. Compare to the 'P' flag in
1584 'guioptions'.
1585
1586 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 autoselectml Like "autoselect", but for the modeless selection
1588 only. Compare to the 'A' flag in 'guioptions'.
1589
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001590 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001591 html When the clipboard contains HTML, use this when
1592 pasting. When putting text on the clipboard, mark it
1593 as HTML. This works to copy rendered HTML from
1594 Firefox, paste it as raw HTML in Vim, select the HTML
1595 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001596 You probably want to add this only temporarily,
1597 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001598 Only supported for GTK version 2 and later.
1599 Only available with the |+multi_byte| feature.
1600
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001601 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 exclude:{pattern}
1603 Defines a pattern that is matched against the name of
1604 the terminal 'term'. If there is a match, no
1605 connection will be made to the X server. This is
1606 useful in this situation:
1607 - Running Vim in a console.
1608 - $DISPLAY is set to start applications on another
1609 display.
1610 - You do not want to connect to the X server in the
1611 console, but do want this in a terminal emulator.
1612 To never connect to the X server use: >
1613 exclude:.*
1614< This has the same effect as using the |-X| argument.
1615 Note that when there is no connection to the X server
1616 the window title won't be restored and the clipboard
1617 cannot be accessed.
1618 The value of 'magic' is ignored, {pattern} is
1619 interpreted as if 'magic' was on.
1620 The rest of the option value will be used for
1621 {pattern}, this must be the last entry.
1622
1623 *'cmdheight'* *'ch'*
1624'cmdheight' 'ch' number (default 1)
1625 global
1626 {not in Vi}
1627 Number of screen lines to use for the command-line. Helps avoiding
1628 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001629 The value of this option is stored with the tab page, so that each tab
1630 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631
1632 *'cmdwinheight'* *'cwh'*
1633'cmdwinheight' 'cwh' number (default 7)
1634 global
1635 {not in Vi}
1636 {not available when compiled without the |+vertsplit|
1637 feature}
1638 Number of screen lines to use for the command-line window. |cmdwin|
1639
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001640 *'colorcolumn'* *'cc'*
1641'colorcolumn' 'cc' string (default "")
1642 local to window
1643 {not in Vi}
1644 {not available when compiled without the |+syntax|
1645 feature}
1646 'colorcolumn' is a comma separated list of screen columns that are
1647 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1648 text. Will make screen redrawing slower.
1649 The screen column can be an absolute number, or a number preceded with
1650 '+' or '-', which is added to or subtracted from 'textwidth'. >
1651
1652 :set cc=+1 " highlight column after 'textwidth'
1653 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1654 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1655<
1656 When 'textwidth' is zero then the items with '-' and '+' are not used.
1657 A maximum of 256 columns are highlighted.
1658
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 *'columns'* *'co'* *E594*
1660'columns' 'co' number (default 80 or terminal width)
1661 global
1662 {not in Vi}
1663 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001664 initialization and does not have to be set by hand. Also see
1665 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 When Vim is running in the GUI or in a resizable window, setting this
1667 option will cause the window size to be changed. When you only want
1668 to use the size for the GUI, put the command in your |gvimrc| file.
1669 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001670 number of columns of the display, the display may be messed up. For
1671 the GUI it is always possible and Vim limits the number of columns to
1672 what fits on the screen. You can use this command to get the widest
1673 window possible: >
1674 :set columns=9999
1675< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676
1677 *'comments'* *'com'* *E524* *E525*
1678'comments' 'com' string (default
1679 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1680 local to buffer
1681 {not in Vi}
1682 {not available when compiled without the |+comments|
1683 feature}
1684 A comma separated list of strings that can start a comment line. See
1685 |format-comments|. See |option-backslash| about using backslashes to
1686 insert a space.
1687
1688 *'commentstring'* *'cms'* *E537*
1689'commentstring' 'cms' string (default "/*%s*/")
1690 local to buffer
1691 {not in Vi}
1692 {not available when compiled without the |+folding|
1693 feature}
1694 A template for a comment. The "%s" in the value is replaced with the
1695 comment text. Currently only used to add markers for folding, see
1696 |fold-marker|.
1697
1698 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001699'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001700 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 global
1702 {not in Vi}
1703 This option has the effect of making Vim either more Vi-compatible, or
1704 make Vim behave in a more useful way.
1705 This is a special kind of option, because when it's set or reset,
1706 other options are also changed as a side effect. CAREFUL: Setting or
1707 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001708 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 set this option in your vimrc file, you should probably put it at the
1710 very start.
1711 By default this option is on and the Vi defaults are used for the
1712 options. This default was chosen for those people who want to use Vim
1713 just like Vi, and don't even (want to) know about the 'compatible'
1714 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001715 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001716 this option is switched off, and all options that have not been
1717 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001718 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001719 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001720 happen for the system-wide vimrc or gvimrc file, nor for a file given
1721 with the |-u| argument). Also see |compatible-default| and
1722 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 You can also set this option with the "-C" argument, and reset it with
1724 "-N". See |-C| and |-N|.
1725 Switching this option off makes the Vim defaults be used for options
1726 that have a different Vi and Vim default value. See the options
1727 marked with a '+' below. Other options are not modified.
1728 At the moment this option is set, several other options will be set
1729 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001730 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 editing.
1732 See also 'cpoptions'.
1733
1734 option + set value effect ~
1735
1736 'allowrevins' off no CTRL-_ command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 'backspace' "" normal backspace
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02001738 'backupcopy' Unix: "yes" backup file is a copy
1739 else: "auto" copy or rename backup file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 'backup' off no backup file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 'cedit' + "" no key to open the |cmdwin|
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02001742 'cindent' off no C code indentation
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743 'cpoptions' + (all flags) Vi-compatible flags
1744 'cscopetag' off don't use cscope for ":tag"
1745 'cscopetagorder' 0 see |cscopetagorder|
1746 'cscopeverbose' off see |cscopeverbose|
1747 'digraph' off no digraphs
1748 'esckeys' + off no <Esc>-keys in Insert mode
1749 'expandtab' off tabs not expanded to spaces
1750 'fileformats' + "" no automatic file format detection,
1751 "dos,unix" except for DOS, Windows and OS/2
1752 'formatoptions' + "vt" Vi compatible formatting
1753 'gdefault' off no default 'g' flag for ":s"
1754 'history' + 0 no commandline history
1755 'hkmap' off no Hebrew keyboard mapping
1756 'hkmapp' off no phonetic Hebrew keyboard mapping
1757 'hlsearch' off no highlighting of search matches
1758 'incsearch' off no incremental searching
1759 'indentexpr' "" no indenting by expression
1760 'insertmode' off do not start in Insert mode
1761 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1762 characters and '_'
1763 'joinspaces' on insert 2 spaces after period
1764 'modeline' + off no modelines
1765 'more' + off no pauses in listings
1766 'revins' off no reverse insert
1767 'ruler' off no ruler
1768 'scrolljump' 1 no jump scroll
1769 'scrolloff' 0 no scroll offset
1770 'shiftround' off indent not rounded to shiftwidth
1771 'shortmess' + "" no shortening of messages
1772 'showcmd' + off command characters not shown
1773 'showmode' + off current mode not shown
1774 'smartcase' off no automatic ignore case switch
1775 'smartindent' off no smart indentation
1776 'smarttab' off no smart tab size
1777 'softtabstop' 0 tabs are always 'tabstop' positions
1778 'startofline' on goto startofline with some commands
1779 'tagrelative' + off tag file names are not relative
1780 'textauto' + off no automatic textmode detection
1781 'textwidth' 0 no automatic line wrap
1782 'tildeop' off tilde is not an operator
1783 'ttimeout' off no terminal timeout
Bram Moolenaar2ec618c2016-10-01 14:47:05 +02001784 'viminfo' + {unchanged} no viminfo file
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 'whichwrap' + "" left-right movements don't wrap
1786 'wildchar' + CTRL-E only when the current value is <Tab>
1787 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001788 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789
1790 *'complete'* *'cpt'* *E535*
1791'complete' 'cpt' string (default: ".,w,b,u,t,i")
1792 local to buffer
1793 {not in Vi}
1794 This option specifies how keyword completion |ins-completion| works
1795 when CTRL-P or CTRL-N are used. It is also used for whole-line
1796 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1797 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001798 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 w scan buffers from other windows
1800 b scan other loaded buffers that are in the buffer list
1801 u scan the unloaded buffers that are in the buffer list
1802 U scan the buffers that are not in the buffer list
1803 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001804 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 k{dict} scan the file {dict}. Several "k" flags can be given,
1806 patterns are valid too. For example: >
1807 :set cpt=k/usr/dict/*,k~/spanish
1808< s scan the files given with the 'thesaurus' option
1809 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1810 are valid too.
1811 i scan current and included files
1812 d scan current and included files for defined name or macro
1813 |i_CTRL-X_CTRL-D|
1814 ] tag completion
1815 t same as "]"
1816
1817 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1818 not executed, this may lead to unexpected completions from some files
1819 (gzipped files for example). Unloaded buffers are not scanned for
1820 whole-line completion.
1821
1822 The default is ".,w,b,u,t,i", which means to scan:
1823 1. the current buffer
1824 2. buffers in other windows
1825 3. other loaded buffers
1826 4. unloaded buffers
1827 5. tags
1828 6. included files
1829
1830 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001831 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1832 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001834 *'completefunc'* *'cfu'*
1835'completefunc' 'cfu' string (default: empty)
1836 local to buffer
1837 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001838 {not available when compiled without the |+eval|
1839 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001840 This option specifies a function to be used for Insert mode completion
1841 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001842 See |complete-functions| for an explanation of how the function is
1843 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001844 This option cannot be set from a |modeline| or in the |sandbox|, for
1845 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001846
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001847 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001848'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001849 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001850 {not available when compiled without the
1851 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001852 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001853 A comma separated list of options for Insert mode completion
1854 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001855
1856 menu Use a popup menu to show the possible completions. The
1857 menu is only shown when there is more than one match and
1858 sufficient colors are available. |ins-completion-menu|
1859
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001860 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001861 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001862 match, e.g., what file it comes from.
1863
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001864 longest Only insert the longest common text of the matches. If
1865 the menu is displayed you can use CTRL-L to add more
1866 characters. Whether case is ignored depends on the kind
1867 of completion. For buffer text the 'ignorecase' option is
1868 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001869
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001870 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001871 completion in the preview window. Only works in
1872 combination with "menu" or "menuone".
1873
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001874 noinsert Do not insert any text for a match until the user selects
1875 a match from the menu. Only works in combination with
1876 "menu" or "menuone". No effect if "longest" is present.
1877
1878 noselect Do not select a match in the menu, force the user to
1879 select one from the menu. Only works in combination with
1880 "menu" or "menuone".
1881
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001882
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001883 *'concealcursor'* *'cocu'*
1884'concealcursor' 'cocu' string (default: "")
1885 local to window
1886 {not in Vi}
1887 {not available when compiled without the |+conceal|
1888 feature}
1889 Sets the modes in which text in the cursor line can also be concealed.
1890 When the current mode is listed then concealing happens just like in
1891 other lines.
1892 n Normal mode
1893 v Visual mode
1894 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001895 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001896
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001897 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001898 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001899 are moving around text is concealed, but when starting to insert text
1900 or selecting a Visual area the concealed text is displayed, so that
1901 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001902 Keep in mind that the cursor position is not always where it's
1903 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001904
1905
1906'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001907 number (default 0)
1908 local to window
1909 {not in Vi}
1910 {not available when compiled without the |+conceal|
1911 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001912 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1913 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001914
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001915 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001916 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001917 1 Each block of concealed text is replaced with one
1918 character. If the syntax item does not have a custom
1919 replacement character defined (see |:syn-cchar|) the
1920 character defined in 'listchars' is used (default is a
1921 space).
1922 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001923 2 Concealed text is completely hidden unless it has a
1924 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001925 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001926 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001927
Bram Moolenaara7781e02010-07-19 20:13:22 +02001928 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001929 edit and copy the text. This can be changed with the 'concealcursor'
1930 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001931
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1933'confirm' 'cf' boolean (default off)
1934 global
1935 {not in Vi}
1936 When 'confirm' is on, certain operations that would normally
1937 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1938 instead raise a |dialog| asking if you wish to save the current
1939 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1940 If 'confirm' is off you can still activate confirmation for one
1941 command only (this is most useful in mappings) with the |:confirm|
1942 command.
1943 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1944
1945 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1946'conskey' 'consk' boolean (default off)
1947 global
1948 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001949 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950
1951 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1952'copyindent' 'ci' boolean (default off)
1953 local to buffer
1954 {not in Vi}
1955 Copy the structure of the existing lines indent when autoindenting a
1956 new line. Normally the new indent is reconstructed by a series of
1957 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1958 in which case only spaces are used). Enabling this option makes the
1959 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001960 existing line. 'expandtab' has no effect on these characters, a Tab
1961 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 line, the remaining space is filled in the normal manner.
1963 NOTE: 'copyindent' is reset when 'compatible' is set.
1964 Also see 'preserveindent'.
1965
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001966 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967'cpoptions' 'cpo' string (Vim default: "aABceFs",
1968 Vi default: all flags)
1969 global
1970 {not in Vi}
1971 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001972 this indicates Vi-compatible behavior. This is used for things where
1973 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 'cpoptions' stands for "compatible-options".
1975 Commas can be added for readability.
1976 To avoid problems with flags that are added in the future, use the
1977 "+=" and "-=" feature of ":set" |add-option-flags|.
1978 NOTE: This option is set to the Vi default value when 'compatible' is
1979 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001980 NOTE: This option is set to the POSIX default value at startup when
1981 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001982 variable exists |posix|. This means Vim tries to behave like the
1983 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984
1985 contains behavior ~
1986 *cpo-a*
1987 a When included, a ":read" command with a file name
1988 argument will set the alternate file name for the
1989 current window.
1990 *cpo-A*
1991 A When included, a ":write" command with a file name
1992 argument will set the alternate file name for the
1993 current window.
1994 *cpo-b*
1995 b "\|" in a ":map" command is recognized as the end of
1996 the map command. The '\' is included in the mapping,
1997 the text after the '|' is interpreted as the next
1998 command. Use a CTRL-V instead of a backslash to
1999 include the '|' in the mapping. Applies to all
2000 mapping, abbreviation, menu and autocmd commands.
2001 See also |map_bar|.
2002 *cpo-B*
2003 B A backslash has no special meaning in mappings,
2004 abbreviations and the "to" part of the menu commands.
2005 Remove this flag to be able to use a backslash like a
2006 CTRL-V. For example, the command ":map X \<Esc>"
2007 results in X being mapped to:
2008 'B' included: "\^[" (^[ is a real <Esc>)
2009 'B' excluded: "<Esc>" (5 characters)
2010 ('<' excluded in both cases)
2011 *cpo-c*
2012 c Searching continues at the end of any match at the
2013 cursor position, but not further than the start of the
2014 next line. When not present searching continues
2015 one character from the cursor position. With 'c'
2016 "abababababab" only gets three matches when repeating
2017 "/abab", without 'c' there are five matches.
2018 *cpo-C*
2019 C Do not concatenate sourced lines that start with a
2020 backslash. See |line-continuation|.
2021 *cpo-d*
2022 d Using "./" in the 'tags' option doesn't mean to use
2023 the tags file relative to the current file, but the
2024 tags file in the current directory.
2025 *cpo-D*
2026 D Can't use CTRL-K to enter a digraph after Normal mode
2027 commands with a character argument, like |r|, |f| and
2028 |t|.
2029 *cpo-e*
2030 e When executing a register with ":@r", always add a
2031 <CR> to the last line, also when the register is not
2032 linewise. If this flag is not present, the register
2033 is not linewise and the last line does not end in a
2034 <CR>, then the last line is put on the command-line
2035 and can be edited before hitting <CR>.
2036 *cpo-E*
2037 E It is an error when using "y", "d", "c", "g~", "gu" or
2038 "gU" on an Empty region. The operators only work when
2039 at least one character is to be operate on. Example:
2040 This makes "y0" fail in the first column.
2041 *cpo-f*
2042 f When included, a ":read" command with a file name
2043 argument will set the file name for the current buffer,
2044 if the current buffer doesn't have a file name yet.
2045 *cpo-F*
2046 F When included, a ":write" command with a file name
2047 argument will set the file name for the current
2048 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002049 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 *cpo-g*
2051 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002052 *cpo-H*
2053 H When using "I" on a line with only blanks, insert
2054 before the last blank. Without this flag insert after
2055 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 *cpo-i*
2057 i When included, interrupting the reading of a file will
2058 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002059 *cpo-I*
2060 I When moving the cursor up or down just after inserting
2061 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 *cpo-j*
2063 j When joining lines, only add two spaces after a '.',
2064 not after '!' or '?'. Also see 'joinspaces'.
2065 *cpo-J*
2066 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002067 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 white space.
2069 *cpo-k*
2070 k Disable the recognition of raw key codes in
2071 mappings, abbreviations, and the "to" part of menu
2072 commands. For example, if <Key> sends ^[OA (where ^[
2073 is <Esc>), the command ":map X ^[OA" results in X
2074 being mapped to:
2075 'k' included: "^[OA" (3 characters)
2076 'k' excluded: "<Key>" (one key code)
2077 Also see the '<' flag below.
2078 *cpo-K*
2079 K Don't wait for a key code to complete when it is
2080 halfway a mapping. This breaks mapping <F1><F1> when
2081 only part of the second <F1> has been read. It
2082 enables cancelling the mapping by typing <F1><Esc>.
2083 *cpo-l*
2084 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002085 literally, only "\]", "\^", "\-" and "\\" are special.
2086 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2088 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002089 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 *cpo-L*
2091 L When the 'list' option is set, 'wrapmargin',
2092 'textwidth', 'softtabstop' and Virtual Replace mode
2093 (see |gR|) count a <Tab> as two characters, instead of
2094 the normal behavior of a <Tab>.
2095 *cpo-m*
2096 m When included, a showmatch will always wait half a
2097 second. When not included, a showmatch will wait half
2098 a second or until a character is typed. |'showmatch'|
2099 *cpo-M*
2100 M When excluded, "%" matching will take backslashes into
2101 account. Thus in "( \( )" and "\( ( \)" the outer
2102 parenthesis match. When included "%" ignores
2103 backslashes, which is Vi compatible.
2104 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002105 n When included, the column used for 'number' and
2106 'relativenumber' will also be used for text of wrapped
2107 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 *cpo-o*
2109 o Line offset to search command is not remembered for
2110 next search.
2111 *cpo-O*
2112 O Don't complain if a file is being overwritten, even
2113 when it didn't exist when editing it. This is a
2114 protection against a file unexpectedly created by
2115 someone else. Vi didn't complain about this.
2116 *cpo-p*
2117 p Vi compatible Lisp indenting. When not present, a
2118 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002119 *cpo-P*
2120 P When included, a ":write" command that appends to a
2121 file will set the file name for the current buffer, if
2122 the current buffer doesn't have a file name yet and
2123 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002124 *cpo-q*
2125 q When joining multiple lines leave the cursor at the
2126 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *cpo-r*
2128 r Redo ("." command) uses "/" to repeat a search
2129 command, instead of the actually used search string.
2130 *cpo-R*
2131 R Remove marks from filtered lines. Without this flag
2132 marks are kept like |:keepmarks| was used.
2133 *cpo-s*
2134 s Set buffer options when entering the buffer for the
2135 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002136 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 set when the buffer is created.
2138 *cpo-S*
2139 S Set buffer options always when entering a buffer
2140 (except 'readonly', 'fileformat', 'filetype' and
2141 'syntax'). This is the (most) Vi compatible setting.
2142 The options are set to the values in the current
2143 buffer. When you change an option and go to another
2144 buffer, the value is copied. Effectively makes the
2145 buffer options global to all buffers.
2146
2147 's' 'S' copy buffer options
2148 no no when buffer created
2149 yes no when buffer first entered (default)
2150 X yes each time when buffer entered (vi comp.)
2151 *cpo-t*
2152 t Search pattern for the tag command is remembered for
2153 "n" command. Otherwise Vim only puts the pattern in
2154 the history for search pattern, but doesn't change the
2155 last used search pattern.
2156 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002157 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 *cpo-v*
2159 v Backspaced characters remain visible on the screen in
2160 Insert mode. Without this flag the characters are
2161 erased from the screen right away. With this flag the
2162 screen newly typed text overwrites backspaced
2163 characters.
2164 *cpo-w*
2165 w When using "cw" on a blank character, only change one
2166 character and not all blanks until the start of the
2167 next word.
2168 *cpo-W*
2169 W Don't overwrite a readonly file. When omitted, ":w!"
2170 overwrites a readonly file, if possible.
2171 *cpo-x*
2172 x <Esc> on the command-line executes the command-line.
2173 The default in Vim is to abandon the command-line,
2174 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002175 *cpo-X*
2176 X When using a count with "R" the replaced text is
2177 deleted only once. Also when repeating "R" with "."
2178 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 *cpo-y*
2180 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002181 *cpo-Z*
2182 Z When using "w!" while the 'readonly' option is set,
2183 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 *cpo-!*
2185 ! When redoing a filter command, use the last used
2186 external command, whatever it was. Otherwise the last
2187 used -filter- command is used.
2188 *cpo-$*
2189 $ When making a change to one line, don't redisplay the
2190 line, but put a '$' at the end of the changed text.
2191 The changed text will be overwritten when you type the
2192 new text. The line is redisplayed if you type any
2193 command that moves the cursor from the insertion
2194 point.
2195 *cpo-%*
2196 % Vi-compatible matching is done for the "%" command.
2197 Does not recognize "#if", "#endif", etc.
2198 Does not recognize "/*" and "*/".
2199 Parens inside single and double quotes are also
2200 counted, causing a string that contains a paren to
2201 disturb the matching. For example, in a line like
2202 "if (strcmp("foo(", s))" the first paren does not
2203 match the last one. When this flag is not included,
2204 parens inside single and double quotes are treated
2205 specially. When matching a paren outside of quotes,
2206 everything inside quotes is ignored. When matching a
2207 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002208 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002209 This flag is also used for other features, such as
2210 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002211 *cpo--*
2212 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002213 it would go above the first line or below the last
2214 line. Without it the cursor moves to the first or
2215 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002216 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002217 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002218 *cpo-+*
2219 + When included, a ":write file" command will reset the
2220 'modified' flag of the buffer, even though the buffer
2221 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002222 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 * Use ":*" in the same way as ":@". When not included,
2224 ":*" is an alias for ":'<,'>", select the Visual area.
2225 *cpo-<*
2226 < Disable the recognition of special key codes in |<>|
2227 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002228 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 ":map X <Tab>" results in X being mapped to:
2230 '<' included: "<Tab>" (5 characters)
2231 '<' excluded: "^I" (^I is a real <Tab>)
2232 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002233 *cpo->*
2234 > When appending to a register, put a line break before
2235 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002236 *cpo-;*
2237 ; When using |,| or |;| to repeat the last |t| search
2238 and the cursor is right in front of the searched
2239 character, the cursor won't move. When not included,
2240 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002241 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002242
2243 POSIX flags. These are not included in the Vi default value, except
2244 when $VIM_POSIX was set on startup. |posix|
2245
2246 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002247 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002248 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002249 *cpo-&*
2250 & When ":preserve" was used keep the swap file when
2251 exiting normally while this buffer is still loaded.
2252 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002253 *cpo-\*
2254 \ Backslash in a [] range in a search pattern is taken
2255 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002256 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2257 '\' excluded: "/[ \-]" finds <Space> and '-'
2258 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002259 *cpo-/*
2260 / When "%" is used as the replacement string in a |:s|
2261 command, use the previous replacement string. |:s%|
2262 *cpo-{*
2263 { The |{| and |}| commands also stop at a "{" character
2264 at the start of a line.
2265 *cpo-.*
2266 . The ":chdir" and ":cd" commands fail if the current
2267 buffer is modified, unless ! is used. Vim doesn't
2268 need this, since it remembers the full path of an
2269 opened file.
2270 *cpo-bar*
2271 | The value of the $LINES and $COLUMNS environment
2272 variables overrule the terminal size values obtained
2273 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002274
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002276 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002277'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002278 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002279 {not in Vi}
2280 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002281 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002282 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002283 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002284 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002285 blowfish Blowfish method. Medium strong encryption but it has
2286 an implementation flaw. Requires Vim 7.3 or later,
2287 files can NOT be read by Vim 7.2 and older. This adds
2288 a "seed" to the file, every time you write the file
2289 the encrypted bytes will be different.
2290 *blowfish2*
2291 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002292 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002293 and older. This adds a "seed" to the file, every time
2294 you write the file the encrypted bytes will be
2295 different. The whole undo file is encrypted, not just
2296 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002297
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002298 You should use "blowfish2", also to re-encrypt older files.
2299
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002300 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002301 to the detected method of the file being read. Thus if you write it
2302 without changing 'cryptmethod' the same method will be used.
2303 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002304 explicitly write it, you don't get a warning unless there are other
2305 modifications. Also see |:X|.
2306
2307 When setting the global value to an empty string, it will end up with
2308 the value "zip". When setting the local value to an empty string the
2309 buffer will use the global value.
2310
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002311 When a new encryption method is added in a later version of Vim, and
2312 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002313 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002314
2315
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 *'cscopepathcomp'* *'cspc'*
2317'cscopepathcomp' 'cspc' number (default 0)
2318 global
2319 {not available when compiled without the |+cscope|
2320 feature}
2321 {not in Vi}
2322 Determines how many components of the path to show in a list of tags.
2323 See |cscopepathcomp|.
2324
2325 *'cscopeprg'* *'csprg'*
2326'cscopeprg' 'csprg' string (default "cscope")
2327 global
2328 {not available when compiled without the |+cscope|
2329 feature}
2330 {not in Vi}
2331 Specifies the command to execute cscope. See |cscopeprg|.
2332 This option cannot be set from a |modeline| or in the |sandbox|, for
2333 security reasons.
2334
2335 *'cscopequickfix'* *'csqf'*
2336'cscopequickfix' 'csqf' string (default "")
2337 global
2338 {not available when compiled without the |+cscope|
2339 or |+quickfix| features}
2340 {not in Vi}
2341 Specifies whether to use quickfix window to show cscope results.
2342 See |cscopequickfix|.
2343
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002344 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002345'cscoperelative' 'csre' boolean (default off)
2346 global
2347 {not available when compiled without the |+cscope|
2348 feature}
2349 {not in Vi}
2350 In the absence of a prefix (-P) for cscope. setting this option enables
2351 to use the basename of cscope.out path as the prefix.
2352 See |cscoperelative|.
2353
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2355'cscopetag' 'cst' boolean (default off)
2356 global
2357 {not available when compiled without the |+cscope|
2358 feature}
2359 {not in Vi}
2360 Use cscope for tag commands. See |cscope-options|.
2361 NOTE: This option is reset when 'compatible' is set.
2362
2363 *'cscopetagorder'* *'csto'*
2364'cscopetagorder' 'csto' number (default 0)
2365 global
2366 {not available when compiled without the |+cscope|
2367 feature}
2368 {not in Vi}
2369 Determines the order in which ":cstag" performs a search. See
2370 |cscopetagorder|.
2371 NOTE: This option is set to 0 when 'compatible' is set.
2372
2373 *'cscopeverbose'* *'csverb'*
2374 *'nocscopeverbose'* *'nocsverb'*
2375'cscopeverbose' 'csverb' boolean (default off)
2376 global
2377 {not available when compiled without the |+cscope|
2378 feature}
2379 {not in Vi}
2380 Give messages when adding a cscope database. See |cscopeverbose|.
2381 NOTE: This option is reset when 'compatible' is set.
2382
Bram Moolenaar860cae12010-06-05 23:22:07 +02002383 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2384'cursorbind' 'crb' boolean (default off)
2385 local to window
2386 {not in Vi}
2387 {not available when compiled without the |+cursorbind|
2388 feature}
2389 When this option is set, as the cursor in the current
2390 window moves other cursorbound windows (windows that also have
2391 this option set) move their cursors to the corresponding line and
2392 column. This option is useful for viewing the
2393 differences between two versions of a file (see 'diff'); in diff mode,
2394 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002395 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002396
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002397
2398 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2399'cursorcolumn' 'cuc' boolean (default off)
2400 local to window
2401 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002402 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002403 feature}
2404 Highlight the screen column of the cursor with CursorColumn
2405 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2406 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002407 If you only want the highlighting in the current window you can use
2408 these autocommands: >
2409 au WinLeave * set nocursorline nocursorcolumn
2410 au WinEnter * set cursorline cursorcolumn
2411<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002412
2413 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2414'cursorline' 'cul' boolean (default off)
2415 local to window
2416 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002417 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002418 feature}
2419 Highlight the screen line of the cursor with CursorLine
2420 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2421 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002422 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002423 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002424
2425
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 *'debug'*
2427'debug' string (default "")
2428 global
2429 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002430 These values can be used:
2431 msg Error messages that would otherwise be omitted will be given
2432 anyway.
2433 throw Error messages that would otherwise be omitted will be given
2434 anyway and also throw an exception and set |v:errmsg|.
2435 beep A message will be given when otherwise only a beep would be
2436 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002437 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002438 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2439 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440
2441 *'define'* *'def'*
2442'define' 'def' string (default "^\s*#\s*define")
2443 global or local to buffer |global-local|
2444 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002445 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446 pattern, just like for the "/" command. This option is used for the
2447 commands like "[i" and "[d" |include-search|. The 'isident' option is
2448 used to recognize the defined name after the match:
2449 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2450 See |option-backslash| about inserting backslashes to include a space
2451 or backslash.
2452 The default value is for C programs. For C++ this value would be
2453 useful, to include const type declarations: >
2454 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2455< When using the ":set" command, you need to double the backslashes!
2456
2457 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2458'delcombine' 'deco' boolean (default off)
2459 global
2460 {not in Vi}
2461 {only available when compiled with the |+multi_byte|
2462 feature}
2463 If editing Unicode and this option is set, backspace and Normal mode
2464 "x" delete each combining character on its own. When it is off (the
2465 default) the character along with its combining characters are
2466 deleted.
2467 Note: When 'delcombine' is set "xx" may work different from "2x"!
2468
2469 This is useful for Arabic, Hebrew and many other languages where one
2470 may have combining characters overtop of base characters, and want
2471 to remove only the combining ones.
2472
2473 *'dictionary'* *'dict'*
2474'dictionary' 'dict' string (default "")
2475 global or local to buffer |global-local|
2476 {not in Vi}
2477 List of file names, separated by commas, that are used to lookup words
2478 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2479 contain a list of words. This can be one word per line, or several
2480 words per line, separated by non-keyword characters (white space is
2481 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002482 When this option is empty, or an entry "spell" is present, spell
2483 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002484 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 after a comma are ignored, otherwise spaces are included in the file
2486 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002487 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 Where to find a list of words?
2489 - On FreeBSD, there is the file "/usr/share/dict/words".
2490 - In the Simtel archive, look in the "msdos/linguist" directory.
2491 - In "miscfiles" of the GNU collection.
2492 The use of |:set+=| and |:set-=| is preferred when adding or removing
2493 directories from the list. This avoids problems when a future version
2494 uses another default.
2495 Backticks cannot be used in this option for security reasons.
2496
2497 *'diff'* *'nodiff'*
2498'diff' boolean (default off)
2499 local to window
2500 {not in Vi}
2501 {not available when compiled without the |+diff|
2502 feature}
2503 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002504 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505
2506 *'dex'* *'diffexpr'*
2507'diffexpr' 'dex' string (default "")
2508 global
2509 {not in Vi}
2510 {not available when compiled without the |+diff|
2511 feature}
2512 Expression which is evaluated to obtain an ed-style diff file from two
2513 versions of a file. See |diff-diffexpr|.
2514 This option cannot be set from a |modeline| or in the |sandbox|, for
2515 security reasons.
2516
2517 *'dip'* *'diffopt'*
2518'diffopt' 'dip' string (default "filler")
2519 global
2520 {not in Vi}
2521 {not available when compiled without the |+diff|
2522 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 All are optional. Items must be separated by a comma.
2525
2526 filler Show filler lines, to keep the text
2527 synchronized with a window that has inserted
2528 lines at the same position. Mostly useful
2529 when windows are side-by-side and 'scrollbind'
2530 is set.
2531
2532 context:{n} Use a context of {n} lines between a change
2533 and a fold that contains unchanged lines.
2534 When omitted a context of six lines is used.
2535 See |fold-diff|.
2536
2537 icase Ignore changes in case of text. "a" and "A"
2538 are considered the same. Adds the "-i" flag
2539 to the "diff" command if 'diffexpr' is empty.
2540
2541 iwhite Ignore changes in amount of white space. Adds
2542 the "-b" flag to the "diff" command if
2543 'diffexpr' is empty. Check the documentation
2544 of the "diff" command for what this does
2545 exactly. It should ignore adding trailing
2546 white space, but not leading white space.
2547
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002548 horizontal Start diff mode with horizontal splits (unless
2549 explicitly specified otherwise).
2550
2551 vertical Start diff mode with vertical splits (unless
2552 explicitly specified otherwise).
2553
2554 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2555 starting diff mode. Without this 2 is used.
2556
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 Examples: >
2558
2559 :set diffopt=filler,context:4
2560 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002561 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562<
2563 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2564'digraph' 'dg' boolean (default off)
2565 global
2566 {not in Vi}
2567 {not available when compiled without the |+digraphs|
2568 feature}
2569 Enable the entering of digraphs in Insert mode with {char1} <BS>
2570 {char2}. See |digraphs|.
2571 NOTE: This option is reset when 'compatible' is set.
2572
2573 *'directory'* *'dir'*
2574'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002575 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 for Unix: ".,~/tmp,/var/tmp,/tmp")
2577 global
2578 List of directory names for the swap file, separated with commas.
2579 - The swap file will be created in the first directory where this is
2580 possible.
2581 - Empty means that no swap file will be used (recovery is
2582 impossible!).
2583 - A directory "." means to put the swap file in the same directory as
2584 the edited file. On Unix, a dot is prepended to the file name, so
2585 it doesn't show in a directory listing. On MS-Windows the "hidden"
2586 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002587 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 put the swap file relative to where the edited file is. The leading
2589 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002590 - For Unix and Win32, if a directory ends in two path separators "//"
2591 or "\\", the swap file name will be built from the complete path to
2592 the file with all path separators substituted to percent '%' signs.
2593 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002594 On Win32, when a separating comma is following, you must use "//",
2595 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 - Spaces after the comma are ignored, other spaces are considered part
2597 of the directory name. To have a space at the start of a directory
2598 name, precede it with a backslash.
2599 - To include a comma in a directory name precede it with a backslash.
2600 - A directory name may end in an ':' or '/'.
2601 - Environment variables are expanded |:set_env|.
2602 - Careful with '\' characters, type one before a space, type two to
2603 get one in the option (see |option-backslash|), for example: >
2604 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2605< - For backwards compatibility with Vim version 3.0 a '>' at the start
2606 of the option is removed.
2607 Using "." first in the list is recommended. This means that editing
2608 the same file twice will result in a warning. Using "/tmp" on Unix is
2609 discouraged: When the system crashes you lose the swap file.
2610 "/var/tmp" is often not cleared when rebooting, thus is a better
2611 choice than "/tmp". But it can contain a lot of files, your swap
2612 files get lost in the crowd. That is why a "tmp" directory in your
2613 home directory is tried first.
2614 The use of |:set+=| and |:set-=| is preferred when adding or removing
2615 directories from the list. This avoids problems when a future version
2616 uses another default.
2617 This option cannot be set from a |modeline| or in the |sandbox|, for
2618 security reasons.
2619 {Vi: directory to put temp file in, defaults to "/tmp"}
2620
2621 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002622'display' 'dy' string (default "", set to "truncate" in
2623 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 global
2625 {not in Vi}
2626 Change the way text is displayed. This is comma separated list of
2627 flags:
2628 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002629 in a window will be displayed. "@@@" is put in the
2630 last columns of the last screen line to indicate the
2631 rest of the line is not displayed.
2632 truncate Like "lastline", but "@@@" is displayed in the first
2633 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 uhex Show unprintable characters hexadecimal as <xx>
2635 instead of using ^C and ~C.
2636
Bram Moolenaard0796902016-09-16 20:02:31 +02002637 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002638 doesn't fit is replaced with "@" lines.
2639
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 *'eadirection'* *'ead'*
2641'eadirection' 'ead' string (default "both")
2642 global
2643 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002644 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 feature}
2646 Tells when the 'equalalways' option applies:
2647 ver vertically, width of windows is not affected
2648 hor horizontally, height of windows is not affected
2649 both width and height of windows is affected
2650
2651 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2652'edcompatible' 'ed' boolean (default off)
2653 global
2654 Makes the 'g' and 'c' flags of the ":substitute" command to be
2655 toggled each time the flag is given. See |complex-change|. See
2656 also 'gdefault' option.
2657 Switching this option on is discouraged!
2658
Bram Moolenaar03413f42016-04-12 21:07:15 +02002659 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002660'emoji' 'emo' boolean (default: on)
2661 global
2662 {not in Vi}
2663 {only available when compiled with the |+multi_byte|
2664 feature}
2665 When on all Unicode emoji characters are considered to be full width.
2666
2667
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 *'encoding'* *'enc'* *E543*
2669'encoding' 'enc' string (default: "latin1" or value from $LANG)
2670 global
2671 {only available when compiled with the |+multi_byte|
2672 feature}
2673 {not in Vi}
2674 Sets the character encoding used inside Vim. It applies to text in
2675 the buffers, registers, Strings in expressions, text stored in the
2676 viminfo file, etc. It sets the kind of characters which Vim can work
2677 with. See |encoding-names| for the possible values.
2678
2679 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002680 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002682 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683
Bram Moolenaar865242e2010-07-14 21:12:05 +02002684 This option cannot be set from a |modeline|. It would most likely
2685 corrupt the text.
2686
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2688 "utf-8". Although care has been taken to allow different values of
2689 'encoding', "utf-8" is the natural choice for the environment and
2690 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002691 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 versions, and to avoid changing the encoding of newly created files
2693 without your knowledge (in case 'fileencodings' is empty).
2694
2695 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002696 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 iconv() or as specified with 'charconvert'.
2698
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002699 If you need to know whether 'encoding' is a multi-byte encoding, you
2700 can use: >
2701 if has("multi_byte_encoding")
2702<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 Normally 'encoding' will be equal to your current locale. This will
2704 be the default if Vim recognizes your environment settings. If
2705 'encoding' is not set to the current locale, 'termencoding' must be
2706 set to convert typed and displayed text. See |encoding-table|.
2707
2708 When you set this option, it fires the |EncodingChanged| autocommand
2709 event so that you can set up fonts if necessary.
2710
2711 When the option is set, the value is converted to lowercase. Thus
2712 you can set it with uppercase values too. Underscores are translated
2713 to '-' signs.
2714 When the encoding is recognized, it is changed to the standard name.
2715 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2716 "iso-8859-2" and "utf8" becomes "utf-8".
2717
2718 Note: "latin1" is also used when the encoding could not be detected.
2719 This only works when editing files in the same encoding! When the
2720 actual character set is not latin1, make sure 'fileencoding' and
2721 'fileencodings' are empty. When conversion is needed, switch to using
2722 utf-8.
2723
2724 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2725 You don't notice this while editing, but it does matter for the
2726 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2727 setting 'encoding' to one of these values instead of utf-8 only has
2728 effect for encoding used for files when 'fileencoding' is empty.
2729
Bram Moolenaar661b1822005-07-28 22:36:45 +00002730 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2731 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732
2733 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2734'endofline' 'eol' boolean (default on)
2735 local to buffer
2736 {not in Vi}
2737 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002738 is on, or 'fixeol' option is off, no <EOL> will be written for the
2739 last line in the file. This option is automatically set or reset when
2740 starting to edit a new file, depending on whether file has an <EOL>
2741 for the last line in the file. Normally you don't have to set or
2742 reset this option.
2743 When 'binary' is off and 'fixeol' is on the value is not used when
2744 writing the file. When 'binary' is on or 'fixeol' is off it is used
2745 to remember the presence of a <EOL> for the last line in the file, so
2746 that when you write the file the situation from the original file can
2747 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748
2749 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2750'equalalways' 'ea' boolean (default on)
2751 global
2752 {not in Vi}
2753 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002754 splitting or closing a window. This also happens the moment the
2755 option is switched on. When off, splitting a window will reduce the
2756 size of the current window and leave the other windows the same. When
2757 closing a window the extra lines are given to the window next to it
2758 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 When mixing vertically and horizontally split windows, a minimal size
2760 is computed and some windows may be larger if there is room. The
2761 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002762 Changing the height and width of a window can be avoided by setting
2763 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002764 If a window size is specified when creating a new window sizes are
2765 currently not equalized (it's complicated, but may be implemented in
2766 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767
2768 *'equalprg'* *'ep'*
2769'equalprg' 'ep' string (default "")
2770 global or local to buffer |global-local|
2771 {not in Vi}
2772 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002773 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002774 or 'indentexpr'. When Vim was compiled without internal formatting,
2775 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002776 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 about including spaces and backslashes.
2778 This option cannot be set from a |modeline| or in the |sandbox|, for
2779 security reasons.
2780
2781 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2782'errorbells' 'eb' boolean (default off)
2783 global
2784 Ring the bell (beep or screen flash) for error messages. This only
2785 makes a difference for error messages, the bell will be used always
2786 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002787 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002788 screen flash or do nothing. See 'belloff' to finetune when to ring the
2789 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790
2791 *'errorfile'* *'ef'*
2792'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2793 others: "errors.err")
2794 global
2795 {not in Vi}
2796 {not available when compiled without the |+quickfix|
2797 feature}
2798 Name of the errorfile for the QuickFix mode (see |:cf|).
2799 When the "-q" command-line argument is used, 'errorfile' is set to the
2800 following argument. See |-q|.
2801 NOT used for the ":make" command. See 'makeef' for that.
2802 Environment variables are expanded |:set_env|.
2803 See |option-backslash| about including spaces and backslashes.
2804 This option cannot be set from a |modeline| or in the |sandbox|, for
2805 security reasons.
2806
2807 *'errorformat'* *'efm'*
2808'errorformat' 'efm' string (default is very long)
2809 global or local to buffer |global-local|
2810 {not in Vi}
2811 {not available when compiled without the |+quickfix|
2812 feature}
2813 Scanf-like description of the format for the lines in the error file
2814 (see |errorformat|).
2815
2816 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2817'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2818 global
2819 {not in Vi}
2820 Function keys that start with an <Esc> are recognized in Insert
2821 mode. When this option is off, the cursor and function keys cannot be
2822 used in Insert mode if they start with an <Esc>. The advantage of
2823 this is that the single <Esc> is recognized immediately, instead of
2824 after one second. Instead of resetting this option, you might want to
2825 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2826 when 'esckeys' is off, you can still map anything, but the cursor keys
2827 won't work by default.
2828 NOTE: This option is set to the Vi default value when 'compatible' is
2829 set and to the Vim default value when 'compatible' is reset.
2830
2831 *'eventignore'* *'ei'*
2832'eventignore' 'ei' string (default "")
2833 global
2834 {not in Vi}
2835 {not available when compiled without the |+autocmd|
2836 feature}
2837 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002838 When set to "all" or when "all" is one of the items, all autocommand
2839 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 Otherwise this is a comma separated list of event names. Example: >
2841 :set ei=WinEnter,WinLeave
2842<
2843 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2844'expandtab' 'et' boolean (default off)
2845 local to buffer
2846 {not in Vi}
2847 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002848 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2850 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002851 This option is reset when the 'paste' option is set and restored when
2852 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853 NOTE: This option is reset when 'compatible' is set.
2854
2855 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2856'exrc' 'ex' boolean (default off)
2857 global
2858 {not in Vi}
2859 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002860 directory.
2861
2862 Setting this option is a potential security leak. E.g., consider
2863 unpacking a package or fetching files from github, a .vimrc in there
2864 might be a trojan horse. BETTER NOT SET THIS OPTION!
2865 Instead, define an autocommand in your .vimrc to set options for a
2866 matching directory.
2867
2868 If you do switch this option on you should also consider setting the
2869 'secure' option (see |initialization|).
2870 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 This option cannot be set from a |modeline| or in the |sandbox|, for
2872 security reasons.
2873
2874 *'fileencoding'* *'fenc'* *E213*
2875'fileencoding' 'fenc' string (default: "")
2876 local to buffer
2877 {only available when compiled with the |+multi_byte|
2878 feature}
2879 {not in Vi}
2880 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002881
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002883 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 When 'fileencoding' is empty, the same value as 'encoding' will be
2885 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002886 Conversion will also be done when 'encoding' and 'fileencoding' are
2887 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2888 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002890 'encoding' is "utf-8" or another Unicode encoding, conversion
2891 is most likely done in a way that the reverse conversion
2892 results in the same text. When 'encoding' is not "utf-8" some
2893 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 See 'encoding' for the possible values. Additionally, values may be
2896 specified that can be handled by the converter, see
2897 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002898
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 When reading a file 'fileencoding' will be set from 'fileencodings'.
2900 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002901 'fileencoding', use the |++enc| argument. One exception: when
2902 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002903 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002904
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2906 When the option is set, the value is converted to lowercase. Thus
2907 you can set it with uppercase values too. '_' characters are
2908 replaced with '-'. If a name is recognized from the list for
2909 'encoding', it is replaced by the standard name. For example
2910 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002911
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 When this option is set, after starting to edit a file, the 'modified'
2913 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002914
2915 Keep in mind that changing 'fenc' from a modeline happens
2916 AFTER the text has been read, thus it applies to when the file will be
2917 written. If you do set 'fenc' in a modeline, you might want to set
2918 'nomodified' to avoid not being able to ":q".
2919
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 This option can not be changed when 'modifiable' is off.
2921
2922 *'fe'*
2923 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002924 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 old short name was 'fe', which is no longer used.
2926
2927 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002928'fileencodings' 'fencs' string (default: "ucs-bom",
2929 "ucs-bom,utf-8,default,latin1" when
2930 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 global
2932 {only available when compiled with the |+multi_byte|
2933 feature}
2934 {not in Vi}
2935 This is a list of character encodings considered when starting to edit
2936 an existing file. When a file is read, Vim tries to use the first
2937 mentioned character encoding. If an error is detected, the next one
2938 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002939 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 an empty string, which means the value of 'encoding' is used.
2941 WARNING: Conversion can cause loss of information! When
2942 'encoding' is "utf-8" (or one of the other Unicode variants)
2943 conversion is most likely done in a way that the reverse
2944 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002945 "utf-8" some non-ASCII characters may be lost! You can use
2946 the |++bad| argument to specify what is done with characters
2947 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 For an empty file or a file with only ASCII characters most encodings
2949 will work and the first entry of 'fileencodings' will be used (except
2950 "ucs-bom", which requires the BOM to be present). If you prefer
2951 another encoding use an BufReadPost autocommand event to test if your
2952 preferred encoding is to be used. Example: >
2953 au BufReadPost * if search('\S', 'w') == 0 |
2954 \ set fenc=iso-2022-jp | endif
2955< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2956 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002957 When the |++enc| argument is used then the value of 'fileencodings' is
2958 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002959 Note that 'fileencodings' is not used for a new file, the global value
2960 of 'fileencoding' is used instead. You can set it with: >
2961 :setglobal fenc=iso-8859-2
2962< This means that a non-existing file may get a different encoding than
2963 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 The special value "ucs-bom" can be used to check for a Unicode BOM
2965 (Byte Order Mark) at the start of the file. It must not be preceded
2966 by "utf-8" or another Unicode encoding for this to work properly.
2967 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2968 because Vim cannot detect an error, thus the encoding is always
2969 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002970 The special value "default" can be used for the encoding from the
2971 environment. This is the default value for 'encoding'. It is useful
2972 when 'encoding' is set to "utf-8" and your environment uses a
2973 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002974 When 'encoding' is "utf-8" and a file contains an illegal byte
2975 sequence it won't be recognized as UTF-8. You can use the |8g8|
2976 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 WRONG VALUES: WHAT'S WRONG:
2978 latin1,utf-8 "latin1" will always be used
2979 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2980 file
2981 cp1250,latin1 "cp1250" will always be used
2982 If 'fileencodings' is empty, 'fileencoding' is not modified.
2983 See 'fileencoding' for the possible values.
2984 Setting this option does not have an effect until the next time a file
2985 is read.
2986
2987 *'fileformat'* *'ff'*
2988'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2989 Unix default: "unix",
2990 Macintosh default: "mac")
2991 local to buffer
2992 {not in Vi}
2993 This gives the <EOL> of the current buffer, which is used for
2994 reading/writing the buffer from/to a file:
2995 dos <CR> <NL>
2996 unix <NL>
2997 mac <CR>
2998 When "dos" is used, CTRL-Z at the end of a file is ignored.
2999 See |file-formats| and |file-read|.
3000 For the character encoding of the file see 'fileencoding'.
3001 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003002 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 This option is set automatically when starting to edit a file and
3004 'fileformats' is not empty and 'binary' is off.
3005 When this option is set, after starting to edit a file, the 'modified'
3006 option is set, because the file would be different when written.
3007 This option can not be changed when 'modifiable' is off.
3008 For backwards compatibility: When this option is set to "dos",
3009 'textmode' is set, otherwise 'textmode' is reset.
3010
3011 *'fileformats'* *'ffs'*
3012'fileformats' 'ffs' string (default:
3013 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3014 Vim Unix: "unix,dos",
3015 Vim Mac: "mac,unix,dos",
3016 Vi Cygwin: "unix,dos",
3017 Vi others: "")
3018 global
3019 {not in Vi}
3020 This gives the end-of-line (<EOL>) formats that will be tried when
3021 starting to edit a new buffer and when reading a file into an existing
3022 buffer:
3023 - When empty, the format defined with 'fileformat' will be used
3024 always. It is not set automatically.
3025 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003026 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 'fileformats' name will be used when a file is read into an existing
3028 buffer, no matter what 'fileformat' for that buffer is set to.
3029 - When more than one name is present, separated by commas, automatic
3030 <EOL> detection will be done when reading a file. When starting to
3031 edit a file, a check is done for the <EOL>:
3032 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3033 'fileformat' is set to "dos".
3034 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003035 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003037 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3038 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003039 This means that "mac" is only chosen when:
3040 "unix" is not present or no <NL> is found in the file, and
3041 "dos" is not present or no <CR><NL> is found in the file.
3042 Except: if "unix" was chosen, but there is a <CR> before
3043 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003044 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 4. If 'fileformat' is still not set, the first name from
3046 'fileformats' is used.
3047 When reading a file into an existing buffer, the same is done, but
3048 this happens like 'fileformat' has been set appropriately for that
3049 file only, the option is not changed.
3050 When 'binary' is set, the value of 'fileformats' is not used.
3051
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003052 When Vim starts up with an empty buffer the first item is used. You
3053 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3056 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3057 done:
3058 - When 'fileformats' is empty, there is no automatic detection. Dos
3059 format will be used.
3060 - When 'fileformats' is set to one or more names, automatic detection
3061 is done. This is based on the first <NL> in the file: If there is a
3062 <CR> in front of it, Dos format is used, otherwise Unix format is
3063 used.
3064 Also see |file-formats|.
3065 For backwards compatibility: When this option is set to an empty
3066 string or one format (no comma is included), 'textauto' is reset,
3067 otherwise 'textauto' is set.
3068 NOTE: This option is set to the Vi default value when 'compatible' is
3069 set and to the Vim default value when 'compatible' is reset.
3070
Bram Moolenaarbf884932013-04-05 22:26:15 +02003071 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3072'fileignorecase' 'fic' boolean (default on for systems where case in file
3073 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003074 global
3075 {not in Vi}
3076 When set case is ignored when using file names and directories.
3077 See 'wildignorecase' for only ignoring case when doing completion.
3078
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 *'filetype'* *'ft'*
3080'filetype' 'ft' string (default: "")
3081 local to buffer
3082 {not in Vi}
3083 {not available when compiled without the |+autocmd|
3084 feature}
3085 When this option is set, the FileType autocommand event is triggered.
3086 All autocommands that match with the value of this option will be
3087 executed. Thus the value of 'filetype' is used in place of the file
3088 name.
3089 Otherwise this option does not always reflect the current file type.
3090 This option is normally set when the file type is detected. To enable
3091 this use the ":filetype on" command. |:filetype|
3092 Setting this option to a different value is most useful in a modeline,
3093 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003094 Example, for in an IDL file:
3095 /* vim: set filetype=idl : */ ~
3096 |FileType| |filetypes|
3097 When a dot appears in the value then this separates two filetype
3098 names. Example:
3099 /* vim: set filetype=c.doxygen : */ ~
3100 This will use the "c" filetype first, then the "doxygen" filetype.
3101 This works both for filetype plugins and for syntax files. More than
3102 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 This option is not copied to another buffer, independent of the 's' or
3104 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003105 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106
3107 *'fillchars'* *'fcs'*
3108'fillchars' 'fcs' string (default "vert:|,fold:-")
3109 global
3110 {not in Vi}
3111 {not available when compiled without the |+windows|
3112 and |+folding| features}
3113 Characters to fill the statuslines and vertical separators.
3114 It is a comma separated list of items:
3115
3116 item default Used for ~
3117 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003118 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 vert:c '|' vertical separators |:vsplit|
3120 fold:c '-' filling 'foldtext'
3121 diff:c '-' deleted lines of the 'diff' option
3122
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003123 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003124 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 otherwise.
3126
3127 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003128 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129< This is similar to the default, except that these characters will also
3130 be used when there is highlighting.
3131
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003132 for "stl" and "stlnc" only single-byte values are supported.
3133
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 The highlighting used for these items:
3135 item highlight group ~
3136 stl:c StatusLine |hl-StatusLine|
3137 stlnc:c StatusLineNC |hl-StatusLineNC|
3138 vert:c VertSplit |hl-VertSplit|
3139 fold:c Folded |hl-Folded|
3140 diff:c DiffDelete |hl-DiffDelete|
3141
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003142 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3143'fixendofline' 'fixeol' boolean (default on)
3144 local to buffer
3145 {not in Vi}
3146 When writing a file and this option is on, <EOL> at the end of file
3147 will be restored if missing. Turn this option off if you want to
3148 preserve the situation from the original file.
3149 When the 'binary' option is set the value of this option doesn't
3150 matter.
3151 See the 'endofline' option.
3152
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3154'fkmap' 'fk' boolean (default off) *E198*
3155 global
3156 {not in Vi}
3157 {only available when compiled with the |+rightleft|
3158 feature}
3159 When on, the keyboard is mapped for the Farsi character set.
3160 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162
3163 *'foldclose'* *'fcl'*
3164'foldclose' 'fcl' string (default "")
3165 global
3166 {not in Vi}
3167 {not available when compiled without the |+folding|
3168 feature}
3169 When set to "all", a fold is closed when the cursor isn't in it and
3170 its level is higher than 'foldlevel'. Useful if you want folds to
3171 automatically close when moving out of them.
3172
3173 *'foldcolumn'* *'fdc'*
3174'foldcolumn' 'fdc' number (default 0)
3175 local to window
3176 {not in Vi}
3177 {not available when compiled without the |+folding|
3178 feature}
3179 When non-zero, a column with the specified width is shown at the side
3180 of the window which indicates open and closed folds. The maximum
3181 value is 12.
3182 See |folding|.
3183
3184 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3185'foldenable' 'fen' boolean (default on)
3186 local to window
3187 {not in Vi}
3188 {not available when compiled without the |+folding|
3189 feature}
3190 When off, all folds are open. This option can be used to quickly
3191 switch between showing all text unfolded and viewing the text with
3192 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003193 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 'foldenable' is off.
3195 This option is set by commands that create a new fold or close a fold.
3196 See |folding|.
3197
3198 *'foldexpr'* *'fde'*
3199'foldexpr' 'fde' string (default: "0")
3200 local to window
3201 {not in Vi}
3202 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003203 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003205 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003206
Bram Moolenaar30b65812012-07-12 22:01:11 +02003207 The expression will be evaluated in the |sandbox| if set from a
3208 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003209 This option can't be set from a |modeline| when the 'diff' option is
3210 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003211
3212 It is not allowed to change text or jump to another window while
3213 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214
3215 *'foldignore'* *'fdi'*
3216'foldignore' 'fdi' string (default: "#")
3217 local to window
3218 {not in Vi}
3219 {not available when compiled without the |+folding|
3220 feature}
3221 Used only when 'foldmethod' is "indent". Lines starting with
3222 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003223 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 The default "#" works well for C programs. See |fold-indent|.
3225
3226 *'foldlevel'* *'fdl'*
3227'foldlevel' 'fdl' number (default: 0)
3228 local to window
3229 {not in Vi}
3230 {not available when compiled without the |+folding|
3231 feature}
3232 Sets the fold level: Folds with a higher level will be closed.
3233 Setting this option to zero will close all folds. Higher numbers will
3234 close fewer folds.
3235 This option is set by commands like |zm|, |zM| and |zR|.
3236 See |fold-foldlevel|.
3237
3238 *'foldlevelstart'* *'fdls'*
3239'foldlevelstart' 'fdls' number (default: -1)
3240 global
3241 {not in Vi}
3242 {not available when compiled without the |+folding|
3243 feature}
3244 Sets 'foldlevel' when starting to edit another buffer in a window.
3245 Useful to always start editing with all folds closed (value zero),
3246 some folds closed (one) or no folds closed (99).
3247 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003248 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 ignores this option and closes all folds.
3250 It is also done before BufReadPre autocommands, to allow an autocmd to
3251 overrule the 'foldlevel' value for specific files.
3252 When the value is negative, it is not used.
3253
3254 *'foldmarker'* *'fmr'* *E536*
3255'foldmarker' 'fmr' string (default: "{{{,}}}")
3256 local to window
3257 {not in Vi}
3258 {not available when compiled without the |+folding|
3259 feature}
3260 The start and end marker used when 'foldmethod' is "marker". There
3261 must be one comma, which separates the start and end marker. The
3262 marker is a literal string (a regular expression would be too slow).
3263 See |fold-marker|.
3264
3265 *'foldmethod'* *'fdm'*
3266'foldmethod' 'fdm' string (default: "manual")
3267 local to window
3268 {not in Vi}
3269 {not available when compiled without the |+folding|
3270 feature}
3271 The kind of folding used for the current window. Possible values:
3272 |fold-manual| manual Folds are created manually.
3273 |fold-indent| indent Lines with equal indent form a fold.
3274 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3275 |fold-marker| marker Markers are used to specify folds.
3276 |fold-syntax| syntax Syntax highlighting items specify folds.
3277 |fold-diff| diff Fold text that is not changed.
3278
3279 *'foldminlines'* *'fml'*
3280'foldminlines' 'fml' number (default: 1)
3281 local to window
3282 {not in Vi}
3283 {not available when compiled without the |+folding|
3284 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003285 Sets the number of screen lines above which a fold can be displayed
3286 closed. Also for manually closed folds. With the default value of
3287 one a fold can only be closed if it takes up two or more screen lines.
3288 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003289 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 "zc" to close a fold, which is displayed open because it's smaller
3291 than 'foldminlines', a following "zc" may close a containing fold.
3292
3293 *'foldnestmax'* *'fdn'*
3294'foldnestmax' 'fdn' number (default: 20)
3295 local to window
3296 {not in Vi}
3297 {not available when compiled without the |+folding|
3298 feature}
3299 Sets the maximum nesting of folds for the "indent" and "syntax"
3300 methods. This avoids that too many folds will be created. Using more
3301 than 20 doesn't work, because the internal limit is 20.
3302
3303 *'foldopen'* *'fdo'*
3304'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3305 search,tag,undo")
3306 global
3307 {not in Vi}
3308 {not available when compiled without the |+folding|
3309 feature}
3310 Specifies for which type of commands folds will be opened, if the
3311 command moves the cursor into a closed fold. It is a comma separated
3312 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003313 NOTE: When the command is part of a mapping this option is not used.
3314 Add the |zv| command to the mapping to get the same effect.
3315 (rationale: the mapping may want to control opening folds itself)
3316
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 item commands ~
3318 all any
3319 block "(", "{", "[[", "[{", etc.
3320 hor horizontal movements: "l", "w", "fx", etc.
3321 insert any command in Insert mode
3322 jump far jumps: "G", "gg", etc.
3323 mark jumping to a mark: "'m", CTRL-O, etc.
3324 percent "%"
3325 quickfix ":cn", ":crew", ":make", etc.
3326 search search for a pattern: "/", "n", "*", "gd", etc.
3327 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003328 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 tag jumping to a tag: ":ta", CTRL-T, etc.
3330 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 When a movement command is used for an operator (e.g., "dl" or "y%")
3332 this option is not used. This means the operator will include the
3333 whole closed fold.
3334 Note that vertical movements are not here, because it would make it
3335 very difficult to move onto a closed fold.
3336 In insert mode the folds containing the cursor will always be open
3337 when text is inserted.
3338 To close folds you can re-apply 'foldlevel' with the |zx| command or
3339 set the 'foldclose' option to "all".
3340
3341 *'foldtext'* *'fdt'*
3342'foldtext' 'fdt' string (default: "foldtext()")
3343 local to window
3344 {not in Vi}
3345 {not available when compiled without the |+folding|
3346 feature}
3347 An expression which is used to specify the text displayed for a closed
3348 fold. See |fold-foldtext|.
3349
Bram Moolenaar30b65812012-07-12 22:01:11 +02003350 The expression will be evaluated in the |sandbox| if set from a
3351 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003352
3353 It is not allowed to change text or jump to another window while
3354 evaluating 'foldtext' |textlock|.
3355
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003356 *'formatexpr'* *'fex'*
3357'formatexpr' 'fex' string (default "")
3358 local to buffer
3359 {not in Vi}
3360 {not available when compiled without the |+eval|
3361 feature}
3362 Expression which is evaluated to format a range of lines for the |gq|
3363 operator or automatic formatting (see 'formatoptions'). When this
3364 option is empty 'formatprg' is used.
3365
3366 The |v:lnum| variable holds the first line to be formatted.
3367 The |v:count| variable holds the number of lines to be formatted.
3368 The |v:char| variable holds the character that is going to be
3369 inserted if the expression is being evaluated due to
3370 automatic formatting. This can be empty. Don't insert
3371 it yet!
3372
3373 Example: >
3374 :set formatexpr=mylang#Format()
3375< This will invoke the mylang#Format() function in the
3376 autoload/mylang.vim file in 'runtimepath'. |autoload|
3377
3378 The expression is also evaluated when 'textwidth' is set and adding
3379 text beyond that limit. This happens under the same conditions as
3380 when internal formatting is used. Make sure the cursor is kept in the
3381 same spot relative to the text then! The |mode()| function will
3382 return "i" or "R" in this situation.
3383
3384 When the expression evaluates to non-zero Vim will fall back to using
3385 the internal format mechanism.
3386
3387 The expression will be evaluated in the |sandbox| when set from a
3388 modeline, see |sandbox-option|. That stops the option from working,
3389 since changing the buffer text is not allowed.
3390
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 *'formatoptions'* *'fo'*
3392'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3393 local to buffer
3394 {not in Vi}
3395 This is a sequence of letters which describes how automatic
3396 formatting is to be done. See |fo-table|. When the 'paste' option is
3397 on, no formatting is done (like 'formatoptions' is empty). Commas can
3398 be inserted for readability.
3399 To avoid problems with flags that are added in the future, use the
3400 "+=" and "-=" feature of ":set" |add-option-flags|.
3401 NOTE: This option is set to the Vi default value when 'compatible' is
3402 set and to the Vim default value when 'compatible' is reset.
3403
Bram Moolenaar86b68352004-12-27 21:59:20 +00003404 *'formatlistpat'* *'flp'*
3405'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3406 local to buffer
3407 {not in Vi}
3408 A pattern that is used to recognize a list header. This is used for
3409 the "n" flag in 'formatoptions'.
3410 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003411 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003412 while still checking more characters. There must be a character
3413 following the pattern, when it matches the whole line it is handled
3414 like there is no match.
3415 The default recognizes a number, followed by an optional punctuation
3416 character and white space.
3417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 *'formatprg'* *'fp'*
3419'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003420 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 {not in Vi}
3422 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003423 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003425 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003426 If the 'formatexpr' option is not empty it will be used instead.
3427 Otherwise, if 'formatprg' option is an empty string, the internal
3428 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003429 Environment variables are expanded |:set_env|. See |option-backslash|
3430 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003431 This option cannot be set from a |modeline| or in the |sandbox|, for
3432 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433
Bram Moolenaard94464e2015-11-02 15:28:18 +01003434 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003435'fsync' 'fs' boolean (default on)
3436 global
3437 {not in Vi}
3438 When on, the library function fsync() will be called after writing a
3439 file. This will flush a file to disk, ensuring that it is safely
3440 written even on filesystems which do metadata-only journaling. This
3441 will force the harddrive to spin up on Linux systems running in laptop
3442 mode, so it may be undesirable in some situations. Be warned that
3443 turning this off increases the chances of data loss after a crash. On
3444 systems without an fsync() implementation, this variable is always
3445 off.
3446 Also see 'swapsync' for controlling fsync() on swap files.
3447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3449'gdefault' 'gd' boolean (default off)
3450 global
3451 {not in Vi}
3452 When on, the ":substitute" flag 'g' is default on. This means that
3453 all matches in a line are substituted instead of one. When a 'g' flag
3454 is given to a ":substitute" command, this will toggle the substitution
3455 of all or one match. See |complex-change|.
3456
3457 command 'gdefault' on 'gdefault' off ~
3458 :s/// subst. all subst. one
3459 :s///g subst. one subst. all
3460 :s///gg subst. all subst. one
3461
3462 NOTE: This option is reset when 'compatible' is set.
3463
3464 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003465'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 global
3467 {not in Vi}
3468 Format to recognize for the ":grep" command output.
3469 This is a scanf-like string that uses the same format as the
3470 'errorformat' option: see |errorformat|.
3471
3472 *'grepprg'* *'gp'*
3473'grepprg' 'gp' string (default "grep -n ",
3474 Unix: "grep -n $* /dev/null",
3475 Win32: "findstr /n" or "grep -n",
3476 VMS: "SEARCH/NUMBERS ")
3477 global or local to buffer |global-local|
3478 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003479 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 and '#' characters, which are expanded like when used in a command-
3481 line. The placeholder "$*" is allowed to specify where the arguments
3482 will be included. Environment variables are expanded |:set_env|. See
3483 |option-backslash| about including spaces and backslashes.
3484 When your "grep" accepts the "-H" argument, use this to make ":grep"
3485 also work well with a single file: >
3486 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003487< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003488 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3489 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003490 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 apply equally to 'grepprg'.
3492 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3493 otherwise it's "grep -n".
3494 This option cannot be set from a |modeline| or in the |sandbox|, for
3495 security reasons.
3496
3497 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3498'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3499 ve:ver35-Cursor,
3500 o:hor50-Cursor,
3501 i-ci:ver25-Cursor/lCursor,
3502 r-cr:hor20-Cursor/lCursor,
3503 sm:block-Cursor
3504 -blinkwait175-blinkoff150-blinkon175",
3505 for MS-DOS and Win32 console:
3506 "n-v-c:block,o:hor50,i-ci:hor15,
3507 r-cr:hor30,sm:block")
3508 global
3509 {not in Vi}
3510 {only available when compiled with GUI enabled, and
3511 for MS-DOS and Win32 console}
3512 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003513 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514 the height of the cursor can be changed. This can be done by
3515 specifying a block cursor, or a percentage for a vertical or
3516 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003517 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3518 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003520 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 mode-list and an argument-list:
3522 mode-list:argument-list,mode-list:argument-list,..
3523 The mode-list is a dash separated list of these modes:
3524 n Normal mode
3525 v Visual mode
3526 ve Visual mode with 'selection' "exclusive" (same as 'v',
3527 if not specified)
3528 o Operator-pending mode
3529 i Insert mode
3530 r Replace mode
3531 c Command-line Normal (append) mode
3532 ci Command-line Insert mode
3533 cr Command-line Replace mode
3534 sm showmatch in Insert mode
3535 a all modes
3536 The argument-list is a dash separated list of these arguments:
3537 hor{N} horizontal bar, {N} percent of the character height
3538 ver{N} vertical bar, {N} percent of the character width
3539 block block cursor, fills the whole character
3540 [only one of the above three should be present]
3541 blinkwait{N} *cursor-blinking*
3542 blinkon{N}
3543 blinkoff{N}
3544 blink times for cursor: blinkwait is the delay before
3545 the cursor starts blinking, blinkon is the time that
3546 the cursor is shown and blinkoff is the time that the
3547 cursor is not shown. The times are in msec. When one
3548 of the numbers is zero, there is no blinking. The
3549 default is: "blinkwait700-blinkon400-blinkoff250".
3550 These numbers are used for a missing entry. This
3551 means that blinking is enabled by default. To switch
3552 blinking off you can use "blinkon0". The cursor only
3553 blinks when Vim is waiting for input, not while
3554 executing a command.
3555 To make the cursor blink in an xterm, see
3556 |xterm-blink|.
3557 {group-name}
3558 a highlight group name, that sets the color and font
3559 for the cursor
3560 {group-name}/{group-name}
3561 Two highlight group names, the first is used when
3562 no language mappings are used, the other when they
3563 are. |language-mapping|
3564
3565 Examples of parts:
3566 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3567 block cursor with colors from the "nCursor"
3568 highlight group
3569 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3570 In Insert and Command-line Insert mode, use a
3571 30% vertical bar cursor with colors from the
3572 "iCursor" highlight group. Blink a bit
3573 faster.
3574
3575 The 'a' mode is different. It will set the given argument-list for
3576 all modes. It does not reset anything to defaults. This can be used
3577 to do a common setting for all modes. For example, to switch off
3578 blinking: "a:blinkon0"
3579
3580 Examples of cursor highlighting: >
3581 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3582 :highlight Cursor gui=NONE guifg=bg guibg=fg
3583<
3584 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003585 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586'guifont' 'gfn' string (default "")
3587 global
3588 {not in Vi}
3589 {only available when compiled with GUI enabled}
3590 This is a list of fonts which will be used for the GUI version of Vim.
3591 In its simplest form the value is just one font name. When
3592 the font cannot be found you will get an error message. To try other
3593 font names a list can be specified, font names separated with commas.
3594 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003595
Bram Moolenaar05159a02005-02-26 23:04:13 +00003596 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3597 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003598
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 Spaces after a comma are ignored. To include a comma in a font name
3600 precede it with a backslash. Setting an option requires an extra
3601 backslash before a space and a backslash. See also
3602 |option-backslash|. For example: >
3603 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003604< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003606
3607 If none of the fonts can be loaded, Vim will keep the current setting.
3608 If an empty font list is given, Vim will try using other resource
3609 settings (for X, it will use the Vim.font resource), and finally it
3610 will try some builtin default which should always be there ("7x13" in
3611 the case of X). The font names given should be "normal" fonts. Vim
3612 will try to find the related bold and italic fonts.
3613
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003614 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003615 :set guifont=*
3616< will bring up a font requester, where you can pick the font you want.
3617
3618 The font name depends on the GUI used. See |setting-guifont| for a
3619 way to set 'guifont' for various systems.
3620
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 For the GTK+ 2 GUI the font name looks like this: >
3622 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003623< That's all. XLFDs are not used. For Chinese this is reported to work
3624 well: >
3625 if has("gui_gtk2")
3626 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3627 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3628 endif
3629<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003630 For Mac OSX you can use something like this: >
3631 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003632< Also see 'macatsui', it can help fix display problems.
3633 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003635 width). An exception is GTK 2: all fonts are accepted, but
3636 mono-spaced fonts look best.
3637
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 To preview a font on X11, you might be able to use the "xfontsel"
3639 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003640
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 For the Win32 GUI *E244* *E245*
3642 - takes these options in the font name:
3643 hXX - height is XX (points, can be floating-point)
3644 wXX - width is XX (points, can be floating-point)
3645 b - bold
3646 i - italic
3647 u - underline
3648 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003649 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3651 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3652 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003653 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003654 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003655 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003656 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003657 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658
3659 Use a ':' to separate the options.
3660 - A '_' can be used in the place of a space, so you don't need to use
3661 backslashes to escape the spaces.
3662 - Examples: >
3663 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3664 :set guifont=Andale_Mono:h7.5:w4.5
3665< See also |font-sizes|.
3666
3667 *'guifontset'* *'gfs'*
3668 *E250* *E252* *E234* *E597* *E598*
3669'guifontset' 'gfs' string (default "")
3670 global
3671 {not in Vi}
3672 {only available when compiled with GUI enabled and
3673 with the |+xfontset| feature}
3674 {not available in the GTK+ 2 GUI}
3675 When not empty, specifies two (or more) fonts to be used. The first
3676 one for normal English, the second one for your special language. See
3677 |xfontset|.
3678 Setting this option also means that all font names will be handled as
3679 a fontset name. Also the ones used for the "font" argument of the
3680 |:highlight| command.
3681 The fonts must match with the current locale. If fonts for the
3682 character sets that the current locale uses are not included, setting
3683 'guifontset' will fail.
3684 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3685 the comma-separated names are alternative names, one of which will be
3686 used. In 'guifontset' the whole string is one fontset name,
3687 including the commas. It is not possible to specify alternative
3688 fontset names.
3689 This example works on many X11 systems: >
3690 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3691<
3692 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3693'guifontwide' 'gfw' string (default "")
3694 global
3695 {not in Vi}
3696 {only available when compiled with GUI enabled}
3697 When not empty, specifies a comma-separated list of fonts to be used
3698 for double-width characters. The first font that can be loaded is
3699 used.
3700 Note: The size of these fonts must be exactly twice as wide as the one
3701 specified with 'guifont' and the same height.
3702
3703 All GUI versions but GTK+ 2:
3704
3705 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3706 'guifontset' is empty or invalid.
3707 When 'guifont' is set and a valid font is found in it and
3708 'guifontwide' is empty Vim will attempt to find a matching
3709 double-width font and set 'guifontwide' to it.
3710
3711 GTK+ 2 GUI only: *guifontwide_gtk2*
3712
3713 If set and valid, 'guifontwide' is always used for double width
3714 characters, even if 'encoding' is not set to "utf-8".
3715 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003716 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 font for characters not available in 'guifont'. Thus you do not need
3718 to set 'guifontwide' at all unless you want to override the choice
3719 made by Pango/Xft.
3720
Bram Moolenaar0f272122013-01-23 18:37:40 +01003721 Windows +multibyte only: *guifontwide_win_mbyte*
3722
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003723 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003724
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 *'guiheadroom'* *'ghr'*
3726'guiheadroom' 'ghr' number (default 50)
3727 global
3728 {not in Vi} {only for GTK and X11 GUI}
3729 The number of pixels subtracted from the screen height when fitting
3730 the GUI window on the screen. Set this before the GUI is started,
3731 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003732 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 lines will be left for window decorations and other items on the
3734 screen. Set it to a negative value to allow windows taller than the
3735 screen.
3736
3737 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003738'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3739 removed in |defaults.vim|),
3740 "aegimrLtT" (GTK, Motif and Athena),
3741 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 global
3743 {not in Vi}
3744 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003745 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 sequence of letters which describes what components and options of the
3747 GUI should be used.
3748 To avoid problems with flags that are added in the future, use the
3749 "+=" and "-=" feature of ":set" |add-option-flags|.
3750
3751 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003752 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 'a' Autoselect: If present, then whenever VISUAL mode is started,
3754 or the Visual area extended, Vim tries to become the owner of
3755 the windowing system's global selection. This means that the
3756 Visually highlighted text is available for pasting into other
3757 applications as well as into Vim itself. When the Visual mode
3758 ends, possibly due to an operation on the text, or when an
3759 application wants to paste the selection, the highlighted text
3760 is automatically yanked into the "* selection register.
3761 Thus the selection is still available for pasting into other
3762 applications after the VISUAL mode has ended.
3763 If not present, then Vim won't become the owner of the
3764 windowing system's global selection unless explicitly told to
3765 by a yank or delete operation for the "* register.
3766 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003767 *'go-P'*
3768 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003769 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003770 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 applies to the modeless selection.
3773
3774 'guioptions' autoselect Visual autoselect modeless ~
3775 "" - -
3776 "a" yes yes
3777 "A" - yes
3778 "aA" yes yes
3779
Bram Moolenaar02467872007-05-06 13:22:01 +00003780 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 'c' Use console dialogs instead of popup dialogs for simple
3782 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003783 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003784 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003785 'guitablabel' can be used to change the text in the labels.
3786 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003787 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003788 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003789 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 'f' Foreground: Don't use fork() to detach the GUI from the shell
3791 where it was started. Use this for programs that wait for the
3792 editor to finish (e.g., an e-mail program). Alternatively you
3793 can use "gvim -f" or ":gui -f" to start the GUI in the
3794 foreground. |gui-fork|
3795 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003796 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003797 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3799 corner of the window. It's black&white on non-GTK, because of
3800 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003801 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003803 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003804 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003806 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 file is sourced the system menu has already been loaded; the
3808 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003809 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 'g' Grey menu items: Make menu items that are not active grey. If
3811 'g' is not included inactive menu items are not shown at all.
3812 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003813 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 't' Include tearoff menu items. Currently only works for Win32,
3815 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003816 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003817 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003818 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003819 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003821 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'R' Right-hand scrollbar is present when there is a vertically
3823 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003824 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003826 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'L' Left-hand scrollbar is present when there is a vertically
3828 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003829 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3831 the longest visible line, or on the cursor line if the 'h'
3832 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003833 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 'h' Limit horizontal scrollbar size to the length of the cursor
3835 line. Reduces computations. |gui-horiz-scroll|
3836
3837 And yes, you may even have scrollbars on the left AND the right if
3838 you really want to :-). See |gui-scrollbars| for more information.
3839
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003840 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 'v' Use a vertical button layout for dialogs. When not included,
3842 a horizontal layout is preferred, but when it doesn't fit a
3843 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003844 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 'p' Use Pointer callbacks for X11 GUI. This is required for some
3846 window managers. If the cursor is not blinking or hollow at
3847 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003848 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003850 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003851 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852
Bram Moolenaar02467872007-05-06 13:22:01 +00003853
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 *'guipty'* *'noguipty'*
3855'guipty' boolean (default on)
3856 global
3857 {not in Vi}
3858 {only available when compiled with GUI enabled}
3859 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3860 I/O to/from shell commands. See |gui-pty|.
3861
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003862 *'guitablabel'* *'gtl'*
3863'guitablabel' 'gtl' string (default empty)
3864 global
3865 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003866 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003867 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003868 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003869 pages line. When empty and when the result is empty Vim will use a
3870 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003871
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003872 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003873 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003874 The expression will be evaluated in the |sandbox| when set from a
3875 modeline, see |sandbox-option|.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003876
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003877 Only used when the GUI tab pages line is displayed. 'e' must be
3878 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3879 used.
3880
Bram Moolenaar57657d82006-04-21 22:12:41 +00003881 *'guitabtooltip'* *'gtt'*
3882'guitabtooltip' 'gtt' string (default empty)
3883 global
3884 {not in Vi}
3885 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003886 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003887 When nonempty describes the text to use in a tooltip for the GUI tab
3888 pages line. When empty Vim will use a default tooltip.
3889 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003890 You can include a line break. Simplest method is to use |:let|: >
3891 :let &guitabtooltip = "line one\nline two"
3892<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003893
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 *'helpfile'* *'hf'*
3895'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3896 (others) "$VIMRUNTIME/doc/help.txt")
3897 global
3898 {not in Vi}
3899 Name of the main help file. All distributed help files should be
3900 placed together in one directory. Additionally, all "doc" directories
3901 in 'runtimepath' will be used.
3902 Environment variables are expanded |:set_env|. For example:
3903 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003904 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 spaces and backslashes.
3906 This option cannot be set from a |modeline| or in the |sandbox|, for
3907 security reasons.
3908
3909 *'helpheight'* *'hh'*
3910'helpheight' 'hh' number (default 20)
3911 global
3912 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003913 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 feature}
3915 Minimal initial height of the help window when it is opened with the
3916 ":help" command. The initial height of the help window is half of the
3917 current window, or (when the 'ea' option is on) the same as other
3918 windows. When the height is less than 'helpheight', the height is
3919 set to 'helpheight'. Set to zero to disable.
3920
3921 *'helplang'* *'hlg'*
3922'helplang' 'hlg' string (default: messages language or empty)
3923 global
3924 {only available when compiled with the |+multi_lang|
3925 feature}
3926 {not in Vi}
3927 Comma separated list of languages. Vim will use the first language
3928 for which the desired help can be found. The English help will always
3929 be used as a last resort. You can add "en" to prefer English over
3930 another language, but that will only find tags that exist in that
3931 language and not in the English help.
3932 Example: >
3933 :set helplang=de,it
3934< This will first search German, then Italian and finally English help
3935 files.
3936 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3937 try to find the tag in the current language before using this option.
3938 See |help-translated|.
3939
3940 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3941'hidden' 'hid' boolean (default off)
3942 global
3943 {not in Vi}
3944 When off a buffer is unloaded when it is |abandon|ed. When on a
3945 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3946 displayed in another window, it does not become hidden, of course.
3947 The commands that move through the buffer list sometimes make a buffer
3948 hidden although the 'hidden' option is off: When the buffer is
3949 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003951 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 This option is set for one command with ":hide {command}" |:hide|.
3953 WARNING: It's easy to forget that you have changes in hidden buffers.
3954 Think twice when using ":q!" or ":qa!".
3955
3956 *'highlight'* *'hl'*
3957'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003958 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3959 d:Directory,e:ErrorMsg,i:IncSearch,
3960 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3961 N:CursorLineNr,r:Question,s:StatusLine,
3962 S:StatusLineNC,c:VertSplit,t:Title,
3963 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
3964 F:FoldColumn,A:DiffAdd,C:DiffChange,
3965 D:DiffDelete,T:DiffText,>:SignColumn,
3966 B:SpellBad,P:SpellCap,R:SpellRare,
3967 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003968 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 global
3970 {not in Vi}
3971 This option can be used to set highlighting mode for various
3972 occasions. It is a comma separated list of character pairs. The
3973 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003974 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003976 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3977 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 characters from 'showbreak'
3979 |hl-Directory| d directories in CTRL-D listing and other special
3980 things in listings
3981 |hl-ErrorMsg| e error messages
3982 h (obsolete, ignored)
3983 |hl-IncSearch| i 'incsearch' highlighting
3984 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3985 |hl-MoreMsg| m |more-prompt|
3986 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003987 |hl-LineNr| n line number for ":number" and ":#" commands, and
3988 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003989 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3990 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 |hl-Question| r |hit-enter| prompt and yes/no questions
3992 |hl-StatusLine| s status line of current window |status-line|
3993 |hl-StatusLineNC| S status lines of not-current windows
3994 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3995 |hl-VertSplit| c column used to separate vertically split windows
3996 |hl-Visual| v Visual mode
3997 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3998 Selection" Only X11 Gui's |gui-x11| and
3999 |xterm-clipboard|.
4000 |hl-WarningMsg| w warning messages
4001 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
4002 |hl-Folded| f line used for closed folds
4003 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00004004 |hl-DiffAdd| A added line in diff mode
4005 |hl-DiffChange| C changed line in diff mode
4006 |hl-DiffDelete| D deleted line in diff mode
4007 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004009 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004010 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004011 |hl-SpellRare| R rare word |spell|
4012 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004013 |hl-Conceal| - the placeholders used for concealed characters
4014 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004015 |hl-Pmenu| + popup menu normal line
4016 |hl-PmenuSel| = popup menu normal line
4017 |hl-PmenuSbar| x popup menu scrollbar
4018 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019
4020 The display modes are:
4021 r reverse (termcap entry "mr" and "me")
4022 i italic (termcap entry "ZH" and "ZR")
4023 b bold (termcap entry "md" and "me")
4024 s standout (termcap entry "so" and "se")
4025 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004026 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 n no highlighting
4028 - no highlighting
4029 : use a highlight group
4030 The default is used for occasions that are not included.
4031 If you want to change what the display modes do, see |dos-colors|
4032 for an example.
4033 When using the ':' display mode, this must be followed by the name of
4034 a highlight group. A highlight group can be used to define any type
4035 of highlighting, including using color. See |:highlight| on how to
4036 define one. The default uses a different group for each occasion.
4037 See |highlight-default| for the default highlight groups.
4038
4039 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4040'hlsearch' 'hls' boolean (default off)
4041 global
4042 {not in Vi}
4043 {not available when compiled without the
4044 |+extra_search| feature}
4045 When there is a previous search pattern, highlight all its matches.
4046 The type of highlighting used can be set with the 'l' occasion in the
4047 'highlight' option. This uses the "Search" highlight group by
4048 default. Note that only the matching text is highlighted, any offsets
4049 are not applied.
4050 See also: 'incsearch' and |:match|.
4051 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004052 off with |:nohlsearch|. This does not change the option value, as
4053 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004054 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 When the search pattern can match an end-of-line, Vim will try to
4056 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004057 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004059 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004060 You can specify whether the highlight status is restored on startup
4061 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 NOTE: This option is reset when 'compatible' is set.
4063
4064 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004065'history' 'hi' number (Vim default: 50, Vi default: 0,
4066 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 global
4068 {not in Vi}
4069 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004070 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004072 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 NOTE: This option is set to the Vi default value when 'compatible' is
4074 set and to the Vim default value when 'compatible' is reset.
4075
4076 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4077'hkmap' 'hk' boolean (default off)
4078 global
4079 {not in Vi}
4080 {only available when compiled with the |+rightleft|
4081 feature}
4082 When on, the keyboard is mapped for the Hebrew character set.
4083 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4084 toggle this option. See |rileft.txt|.
4085 NOTE: This option is reset when 'compatible' is set.
4086
4087 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4088'hkmapp' 'hkp' boolean (default off)
4089 global
4090 {not in Vi}
4091 {only available when compiled with the |+rightleft|
4092 feature}
4093 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4094 This is useful if you have a non-Hebrew keyboard.
4095 See |rileft.txt|.
4096 NOTE: This option is reset when 'compatible' is set.
4097
4098 *'icon'* *'noicon'*
4099'icon' boolean (default off, on when title can be restored)
4100 global
4101 {not in Vi}
4102 {not available when compiled without the |+title|
4103 feature}
4104 When on, the icon text of the window will be set to the value of
4105 'iconstring' (if it is not empty), or to the name of the file
4106 currently being edited. Only the last part of the name is used.
4107 Overridden by the 'iconstring' option.
4108 Only works if the terminal supports setting window icons (currently
4109 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4110 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4111 builtin termcap).
4112 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004113 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004115 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116
4117 *'iconstring'*
4118'iconstring' string (default "")
4119 global
4120 {not in Vi}
4121 {not available when compiled without the |+title|
4122 feature}
4123 When this option is not empty, it will be used for the icon text of
4124 the window. This happens only when the 'icon' option is on.
4125 Only works if the terminal supports setting window icon text
4126 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4127 Does not work for MS Windows.
4128 When Vim was compiled with HAVE_X11 defined, the original icon will be
4129 restored if possible |X11|.
4130 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004131 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 'titlestring' for example settings.
4133 {not available when compiled without the |+statusline| feature}
4134
4135 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4136'ignorecase' 'ic' boolean (default off)
4137 global
4138 Ignore case in search patterns. Also used when searching in the tags
4139 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004140 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 Can be overruled by using "\c" or "\C" in the pattern, see
4142 |/ignorecase|.
4143
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004144 *'imactivatefunc'* *'imaf'*
4145'imactivatefunc' 'imaf' string (default "")
4146 global
4147 {not in Vi}
4148 {only available when compiled with |+xim| and
4149 |+GUI_GTK|}
4150 This option specifies a function that will be called to
4151 activate/inactivate Input Method.
4152
4153 Example: >
4154 function ImActivateFunc(active)
4155 if a:active
4156 ... do something
4157 else
4158 ... do something
4159 endif
4160 " return value is not used
4161 endfunction
4162 set imactivatefunc=ImActivateFunc
4163<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 *'imactivatekey'* *'imak'*
4165'imactivatekey' 'imak' string (default "")
4166 global
4167 {not in Vi}
4168 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004169 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004170 Specifies the key that your Input Method in X-Windows uses for
4171 activation. When this is specified correctly, vim can fully control
4172 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4173 You can't use this option to change the activation key, the option
4174 tells Vim what the key is.
4175 Format:
4176 [MODIFIER_FLAG-]KEY_STRING
4177
4178 These characters can be used for MODIFIER_FLAG (case is ignored):
4179 S Shift key
4180 L Lock key
4181 C Control key
4182 1 Mod1 key
4183 2 Mod2 key
4184 3 Mod3 key
4185 4 Mod4 key
4186 5 Mod5 key
4187 Combinations are allowed, for example "S-C-space" or "SC-space" are
4188 both shift+ctrl+space.
4189 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4190
4191 Example: >
4192 :set imactivatekey=S-space
4193< "S-space" means shift+space. This is the activation key for kinput2 +
4194 canna (Japanese), and ami (Korean).
4195
4196 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4197'imcmdline' 'imc' boolean (default off)
4198 global
4199 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004200 {only available when compiled with the |+xim|,
4201 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 When set the Input Method is always on when starting to edit a command
4203 line, unless entering a search pattern (see 'imsearch' for that).
4204 Setting this option is useful when your input method allows entering
4205 English characters directly, e.g., when it's used to type accented
4206 characters with dead keys.
4207
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004208 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4210 global
4211 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004212 {only available when compiled with the |+xim|,
4213 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 When set the Input Method is never used. This is useful to disable
4215 the IM when it doesn't work properly.
4216 Currently this option is on by default for SGI/IRIX machines. This
4217 may change in later releases.
4218
4219 *'iminsert'* *'imi'*
4220'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4221 local to buffer
4222 {not in Vi}
4223 Specifies whether :lmap or an Input Method (IM) is to be used in
4224 Insert mode. Valid values:
4225 0 :lmap is off and IM is off
4226 1 :lmap is ON and IM is off
4227 2 :lmap is off and IM is ON
4228 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4229 or |global-ime|.
4230 To always reset the option to zero when leaving Insert mode with <Esc>
4231 this can be used: >
4232 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4233< This makes :lmap and IM turn off automatically when leaving Insert
4234 mode.
4235 Note that this option changes when using CTRL-^ in Insert mode
4236 |i_CTRL-^|.
4237 The value is set to 1 when setting 'keymap' to a valid keymap name.
4238 It is also used for the argument of commands like "r" and "f".
4239 The value 0 may not work correctly with Athena and Motif with some XIM
4240 methods. Use 'imdisable' to disable XIM then.
4241
4242 *'imsearch'* *'ims'*
4243'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4244 local to buffer
4245 {not in Vi}
4246 Specifies whether :lmap or an Input Method (IM) is to be used when
4247 entering a search pattern. Valid values:
4248 -1 the value of 'iminsert' is used, makes it look like
4249 'iminsert' is also used when typing a search pattern
4250 0 :lmap is off and IM is off
4251 1 :lmap is ON and IM is off
4252 2 :lmap is off and IM is ON
4253 Note that this option changes when using CTRL-^ in Command-line mode
4254 |c_CTRL-^|.
4255 The value is set to 1 when it is not -1 and setting the 'keymap'
4256 option to a valid keymap name.
4257 The value 0 may not work correctly with Athena and Motif with some XIM
4258 methods. Use 'imdisable' to disable XIM then.
4259
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004260 *'imstatusfunc'* *'imsf'*
4261'imstatusfunc' 'imsf' string (default "")
4262 global
4263 {not in Vi}
4264 {only available when compiled with |+xim| and
4265 |+GUI_GTK|}
4266 This option specifies a function that is called to obtain the status
4267 of Input Method. It must return a positive number when IME is active.
4268
4269 Example: >
4270 function ImStatusFunc()
4271 let is_active = ...do something
4272 return is_active ? 1 : 0
4273 endfunction
4274 set imstatusfunc=ImStatusFunc
4275<
4276 NOTE: This function is invoked very often. Keep it fast.
4277
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 *'include'* *'inc'*
4279'include' 'inc' string (default "^\s*#\s*include")
4280 global or local to buffer |global-local|
4281 {not in Vi}
4282 {not available when compiled without the
4283 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004284 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 pattern, just like for the "/" command (See |pattern|). The default
4286 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004287 "]I", "[d", etc.
4288 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004289 comes after the matched pattern. But if "\zs" appears in the pattern
4290 then the text matched from "\zs" to the end, or until "\ze" if it
4291 appears, is used as the file name. Use this to include characters
4292 that are not in 'isfname', such as a space. You can then use
4293 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004294 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295
4296 *'includeexpr'* *'inex'*
4297'includeexpr' 'inex' string (default "")
4298 local to buffer
4299 {not in Vi}
4300 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004301 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004303 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 :set includeexpr=substitute(v:fname,'\\.','/','g')
4305< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004306
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004308 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 Also used for |<cfile>|.
4310
Bram Moolenaar30b65812012-07-12 22:01:11 +02004311 The expression will be evaluated in the |sandbox| when set from a
4312 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004313
4314 It is not allowed to change text or jump to another window while
4315 evaluating 'includeexpr' |textlock|.
4316
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004318'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4319 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 global
4321 {not in Vi}
4322 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004323 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004324 While typing a search command, show where the pattern, as it was typed
4325 so far, matches. The matched string is highlighted. If the pattern
4326 is invalid or not found, nothing is shown. The screen will be updated
4327 often, this is only useful on fast terminals.
4328 Note that the match will be shown, but the cursor will return to its
4329 original position when no match is found and when pressing <Esc>. You
4330 still need to finish the search command with <Enter> to move the
4331 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004332 You can use the CTRL-G and CTRL-T keys to move to the next and
4333 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004334 When compiled with the |+reltime| feature Vim only searches for about
4335 half a second. With a complicated pattern and/or a lot of text the
4336 match may not be found. This is to avoid that Vim hangs while you
4337 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004338 The highlighting can be set with the 'i' flag in 'highlight'.
4339 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004340 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004341 to the command line. If 'ignorecase' and 'smartcase' are set and the
4342 command line has no uppercase characters, the added character is
4343 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004344 CTRL-R CTRL-W can be used to add the word at the end of the current
4345 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 NOTE: This option is reset when 'compatible' is set.
4347
4348 *'indentexpr'* *'inde'*
4349'indentexpr' 'inde' string (default "")
4350 local to buffer
4351 {not in Vi}
4352 {not available when compiled without the |+cindent|
4353 or |+eval| features}
4354 Expression which is evaluated to obtain the proper indent for a line.
4355 It is used when a new line is created, for the |=| operator and
4356 in Insert mode as specified with the 'indentkeys' option.
4357 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004358 'smartindent' indenting. When 'lisp' is set, this option is
4359 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 When 'paste' is set this option is not used for indenting.
4361 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004362 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 when the expression is evaluated (but it may be moved around).
4364 The expression must return the number of spaces worth of indent. It
4365 can return "-1" to keep the current indent (this means 'autoindent' is
4366 used for the indent).
4367 Functions useful for computing the indent are |indent()|, |cindent()|
4368 and |lispindent()|.
4369 The evaluation of the expression must not have side effects! It must
4370 not change the text, jump to another window, etc. Afterwards the
4371 cursor position is always restored, thus the cursor may be moved.
4372 Normally this option would be set to call a function: >
4373 :set indentexpr=GetMyIndent()
4374< Error messages will be suppressed, unless the 'debug' option contains
4375 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004376 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 NOTE: This option is made empty when 'compatible' is set.
4378
Bram Moolenaar30b65812012-07-12 22:01:11 +02004379 The expression will be evaluated in the |sandbox| when set from a
4380 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004381
4382 It is not allowed to change text or jump to another window while
4383 evaluating 'indentexpr' |textlock|.
4384
4385
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 *'indentkeys'* *'indk'*
4387'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4388 local to buffer
4389 {not in Vi}
4390 {not available when compiled without the |+cindent|
4391 feature}
4392 A list of keys that, when typed in Insert mode, cause reindenting of
4393 the current line. Only happens if 'indentexpr' isn't empty.
4394 The format is identical to 'cinkeys', see |indentkeys-format|.
4395 See |C-indenting| and |indent-expression|.
4396
4397 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4398'infercase' 'inf' boolean (default off)
4399 local to buffer
4400 {not in Vi}
4401 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004402 'ignorecase' is also on, the case of the match is adjusted depending
4403 on the typed text. If the typed text contains a lowercase letter
4404 where the match has an upper case letter, the completed part is made
4405 lowercase. If the typed text has no lowercase letters and the match
4406 has a lowercase letter where the typed text has an uppercase letter,
4407 and there is a letter before it, the completed part is made uppercase.
4408 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409
4410 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4411'insertmode' 'im' boolean (default off)
4412 global
4413 {not in Vi}
4414 Makes Vim work in a way that Insert mode is the default mode. Useful
4415 if you want to use Vim as a modeless editor. Used for |evim|.
4416 These Insert mode commands will be useful:
4417 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004418 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 this is a mapping, it is executed as if 'insertmode' was off.
4420 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004422 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4423 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424
4425 These items change when 'insertmode' is set:
4426 - when starting to edit of a file, Vim goes to Insert mode.
4427 - <Esc> in Insert mode is a no-op and beeps.
4428 - <Esc> in Normal mode makes Vim go to Insert mode.
4429 - CTRL-L in Insert mode is a command, it is not inserted.
4430 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4431 However, when <Esc> is used inside a mapping, it behaves like
4432 'insertmode' was not set. This was done to be able to use the same
4433 mappings with 'insertmode' set or not set.
4434 When executing commands with |:normal| 'insertmode' is not used.
4435
4436 NOTE: This option is reset when 'compatible' is set.
4437
4438 *'isfname'* *'isf'*
4439'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4440 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4441 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4442 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4443 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4444 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4445 global
4446 {not in Vi}
4447 The characters specified by this option are included in file names and
4448 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004449 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 Multi-byte characters 256 and above are always included, only the
4451 characters up to 255 are specified with this option.
4452 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004453 Think twice before adding white space to this option. Although a
4454 space may appear inside a file name, the effect will be that Vim
4455 doesn't know where a file name starts or ends when doing completion.
4456 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457
4458 Note that on systems using a backslash as path separator, Vim tries to
4459 do its best to make it work as you would expect. That is a bit
4460 tricky, since Vi originally used the backslash to escape special
4461 characters. Vim will not remove a backslash in front of a normal file
4462 name character on these systems, but it will on Unix and alikes. The
4463 '&' and '^' are not included by default, because these are special for
4464 cmd.exe.
4465
4466 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004467 Each part can be a single character number or a range. A range is two
4468 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 decimal number between 0 and 255 or the ASCII character itself (does
4470 not work for digits). Example:
4471 "_,-,128-140,#-43" (include '_' and '-' and the range
4472 128 to 140 and '#' to 43)
4473 If a part starts with '^', the following character number or range
4474 will be excluded from the option. The option is interpreted from left
4475 to right. Put the excluded character after the range where it is
4476 included. To include '^' itself use it as the last character of the
4477 option or the end of a range. Example:
4478 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4479 If the character is '@', all characters where isalpha() returns TRUE
4480 are included. Normally these are the characters a to z and A to Z,
4481 plus accented characters. To include '@' itself use "@-@". Examples:
4482 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004483 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 "a-z,A-Z,@-@" All letters plus the '@' character.
4485 A comma can be included by using it where a character number is
4486 expected. Example:
4487 "48-57,,,_" Digits, comma and underscore.
4488 A comma can be excluded by prepending a '^'. Example:
4489 " -~,^,,9" All characters from space to '~', excluding
4490 comma, plus <Tab>.
4491 See |option-backslash| about including spaces and backslashes.
4492
4493 *'isident'* *'isi'*
4494'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4495 "@,48-57,_,128-167,224-235"
4496 otherwise: "@,48-57,_,192-255")
4497 global
4498 {not in Vi}
4499 The characters given by this option are included in identifiers.
4500 Identifiers are used in recognizing environment variables and after a
4501 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004502 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 option.
4504 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004505 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4507
4508 *'iskeyword'* *'isk'*
4509'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4510 "@,48-57,_,128-167,224-235"
4511 otherwise: "@,48-57,_,192-255"
4512 Vi default: "@,48-57,_")
4513 local to buffer
4514 {not in Vi}
4515 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004516 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 'isfname' for a description of the format of this option. For C
4518 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4519 For a help file it is set to all non-blank printable characters except
4520 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4521 command).
4522 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004523 This option also influences syntax highlighting, unless the syntax
4524 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 NOTE: This option is set to the Vi default value when 'compatible' is
4526 set and to the Vim default value when 'compatible' is reset.
4527
4528 *'isprint'* *'isp'*
4529'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4530 "@,~-255"; otherwise: "@,161-255")
4531 global
4532 {not in Vi}
4533 The characters given by this option are displayed directly on the
4534 screen. It is also used for "\p" in a |pattern|. The characters from
4535 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4536 even when they are not included in 'isprint' or excluded. See
4537 'isfname' for a description of the format of this option.
4538
4539 Non-printable characters are displayed with two characters:
4540 0 - 31 "^@" - "^_"
4541 32 - 126 always single characters
4542 127 "^?"
4543 128 - 159 "~@" - "~_"
4544 160 - 254 "| " - "|~"
4545 255 "~?"
4546 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4547 displayed as <xx>, with the hexadecimal value of the byte.
4548 When 'display' contains "uhex" all unprintable characters are
4549 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004550 The SpecialKey highlighting will be used for unprintable characters.
4551 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552
4553 Multi-byte characters 256 and above are always included, only the
4554 characters up to 255 are specified with this option. When a character
4555 is printable but it is not available in the current font, a
4556 replacement character will be shown.
4557 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4558 There is no option to specify these characters.
4559
4560 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4561'joinspaces' 'js' boolean (default on)
4562 global
4563 {not in Vi}
4564 Insert two spaces after a '.', '?' and '!' with a join command.
4565 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4566 Otherwise only one space is inserted.
4567 NOTE: This option is set when 'compatible' is set.
4568
4569 *'key'*
4570'key' string (default "")
4571 local to buffer
4572 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004573 {only available when compiled with the |+cryptv|
4574 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004576 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 Careful: Do not set the key value by hand, someone might see the typed
4578 key. Use the |:X| command. But you can make 'key' empty: >
4579 :set key=
4580< It is not possible to get the value of this option with ":set key" or
4581 "echo &key". This is to avoid showing it to someone who shouldn't
4582 know. It also means you cannot see it yourself once you have set it,
4583 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004584 You can use "&key" in an expression to detect whether encryption is
4585 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586
4587 *'keymap'* *'kmp'* *E544*
4588'keymap' 'kmp' string (default "")
4589 local to buffer
4590 {not in Vi}
4591 {only available when compiled with the |+keymap|
4592 feature}
4593 Name of a keyboard mapping. See |mbyte-keymap|.
4594 Setting this option to a valid keymap name has the side effect of
4595 setting 'iminsert' to one, so that the keymap becomes effective.
4596 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004597 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
4599 *'keymodel'* *'km'*
4600'keymodel' 'km' string (default "")
4601 global
4602 {not in Vi}
4603 List of comma separated words, which enable special things that keys
4604 can do. These values can be used:
4605 startsel Using a shifted special key starts selection (either
4606 Select mode or Visual mode, depending on "key" being
4607 present in 'selectmode').
4608 stopsel Using a not-shifted special key stops selection.
4609 Special keys in this context are the cursor keys, <End>, <Home>,
4610 <PageUp> and <PageDown>.
4611 The 'keymodel' option is set by the |:behave| command.
4612
4613 *'keywordprg'* *'kp'*
4614'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004615 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 global or local to buffer |global-local|
4617 {not in Vi}
4618 Program to use for the |K| command. Environment variables are
4619 expanded |:set_env|. ":help" may be used to access the Vim internal
4620 help. (Note that previously setting the global option to the empty
4621 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004622 When the first character is ":", the command is invoked as a Vim
4623 Ex command prefixed with [count].
4624 When "man", "man -s" or an Ex command is used, Vim will automatically
4625 translate a count for the "K" command and pass it as the first
4626 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 See |option-backslash| about including spaces and backslashes.
4628 Example: >
4629 :set keywordprg=man\ -s
4630< This option cannot be set from a |modeline| or in the |sandbox|, for
4631 security reasons.
4632
4633 *'langmap'* *'lmap'* *E357* *E358*
4634'langmap' 'lmap' string (default "")
4635 global
4636 {not in Vi}
4637 {only available when compiled with the |+langmap|
4638 feature}
4639 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004640 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004641 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 care of translating these special characters to the original meaning
4643 of the key. This means you don't have to change the keyboard mode to
4644 be able to execute Normal mode commands.
4645 This is the opposite of the 'keymap' option, where characters are
4646 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004647 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004648 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004649 This option cannot be set from a |modeline| or in the |sandbox|, for
4650 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004652 Example (for Greek, in UTF-8): *greek* >
4653 :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 +00004654< Example (exchanges meaning of z and y for commands): >
4655 :set langmap=zy,yz,ZY,YZ
4656<
4657 The 'langmap' option is a list of parts, separated with commas. Each
4658 part can be in one of two forms:
4659 1. A list of pairs. Each pair is a "from" character immediately
4660 followed by the "to" character. Examples: "aA", "aAbBcC".
4661 2. A list of "from" characters, a semi-colon and a list of "to"
4662 characters. Example: "abc;ABC"
4663 Example: "aA,fgh;FGH,cCdDeE"
4664 Special characters need to be preceded with a backslash. These are
4665 ";", ',' and backslash itself.
4666
4667 This will allow you to activate vim actions without having to switch
4668 back and forth between the languages. Your language characters will
4669 be understood as normal vim English characters (according to the
4670 langmap mappings) in the following cases:
4671 o Normal/Visual mode (commands, buffer/register names, user mappings)
4672 o Insert/Replace Mode: Register names after CTRL-R
4673 o Insert/Replace Mode: Mappings
4674 Characters entered in Command-line mode will NOT be affected by
4675 this option. Note that this option can be changed at any time
4676 allowing to switch between mappings for different languages/encodings.
4677 Use a mapping to avoid having to type it each time!
4678
4679 *'langmenu'* *'lm'*
4680'langmenu' 'lm' string (default "")
4681 global
4682 {not in Vi}
4683 {only available when compiled with the |+menu| and
4684 |+multi_lang| features}
4685 Language to use for menu translation. Tells which file is loaded
4686 from the "lang" directory in 'runtimepath': >
4687 "lang/menu_" . &langmenu . ".vim"
4688< (without the spaces). For example, to always use the Dutch menus, no
4689 matter what $LANG is set to: >
4690 :set langmenu=nl_NL.ISO_8859-1
4691< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004692 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 If your $LANG is set to a non-English language but you do want to use
4694 the English menus: >
4695 :set langmenu=none
4696< This option must be set before loading menus, switching on filetype
4697 detection or syntax highlighting. Once the menus are defined setting
4698 this option has no effect. But you could do this: >
4699 :source $VIMRUNTIME/delmenu.vim
4700 :set langmenu=de_DE.ISO_8859-1
4701 :source $VIMRUNTIME/menu.vim
4702< Warning: This deletes all menus that you defined yourself!
4703
Bram Moolenaard94464e2015-11-02 15:28:18 +01004704 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004705'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004706 global
4707 {not in Vi}
4708 {only available when compiled with the |+langmap|
4709 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004710 This is just like 'langremap' but with the value inverted. It only
4711 exists for backwards compatibility. When setting 'langremap' then
4712 'langnoremap' is set to the inverted value, and the other way around.
4713
4714 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4715'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4716 global
4717 {not in Vi}
4718 {only available when compiled with the |+langmap|
4719 feature}
4720 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004721 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004722 'langmap' disables some of your mappings, try resetting this option.
4723 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004724 that works for you to avoid mappings to break.
4725
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 *'laststatus'* *'ls'*
4727'laststatus' 'ls' number (default 1)
4728 global
4729 {not in Vi}
4730 The value of this option influences when the last window will have a
4731 status line:
4732 0: never
4733 1: only if there are at least two windows
4734 2: always
4735 The screen looks nicer with a status line if you have several
4736 windows, but it takes another screen line. |status-line|
4737
4738 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4739'lazyredraw' 'lz' boolean (default off)
4740 global
4741 {not in Vi}
4742 When this option is set, the screen will not be redrawn while
4743 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004744 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 update use |:redraw|.
4746
4747 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4748'linebreak' 'lbr' boolean (default off)
4749 local to window
4750 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004751 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004753 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 than at the last character that fits on the screen. Unlike
4755 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004756 it only affects the way the file is displayed, not its contents.
4757 If 'breakindent' is set, line is visually indented. Then, the value
4758 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004759 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 Note that <Tab> characters after an <EOL> are mostly not displayed
4761 with the right amount of white space.
4762
4763 *'lines'* *E593*
4764'lines' number (default 24 or terminal height)
4765 global
4766 Number of lines of the Vim window.
4767 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004768 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 When Vim is running in the GUI or in a resizable window, setting this
4770 option will cause the window size to be changed. When you only want
4771 to use the size for the GUI, put the command in your |gvimrc| file.
4772 Vim limits the number of lines to what fits on the screen. You can
4773 use this command to get the tallest window possible: >
4774 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004775< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004776 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 When you set this option and Vim is unable to change the physical
4778 number of lines of the display, the display may be messed up.
4779
4780 *'linespace'* *'lsp'*
4781'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4782 global
4783 {not in Vi}
4784 {only in the GUI}
4785 Number of pixel lines inserted between characters. Useful if the font
4786 uses the full character cell height, making lines touch each other.
4787 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004788 With some fonts there can be too much room between lines (to have
4789 space for ascents and descents). Then it makes sense to set
4790 'linespace' to a negative value. This may cause display problems
4791 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 *'lisp'* *'nolisp'*
4794'lisp' boolean (default off)
4795 local to buffer
4796 {not available when compiled without the |+lispindent|
4797 feature}
4798 Lisp mode: When <Enter> is typed in insert mode set the indent for
4799 the next line to Lisp standards (well, sort of). Also happens with
4800 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4801 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4802 better. Also see 'lispwords'.
4803 The '-' character is included in keyword characters. Redefines the
4804 "=" operator to use this same indentation algorithm rather than
4805 calling an external program if 'equalprg' is empty.
4806 This option is not used when 'paste' is set.
4807 {Vi: Does it a little bit differently}
4808
4809 *'lispwords'* *'lw'*
4810'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004811 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 {not in Vi}
4813 {not available when compiled without the |+lispindent|
4814 feature}
4815 Comma separated list of words that influence the Lisp indenting.
4816 |'lisp'|
4817
4818 *'list'* *'nolist'*
4819'list' boolean (default off)
4820 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004821 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4822 line. Useful to see the difference between tabs and spaces and for
4823 trailing blanks. Further changed by the 'listchars' option.
4824
4825 The cursor is displayed at the start of the space a Tab character
4826 occupies, not at the end as usual in Normal mode. To get this cursor
4827 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004828 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004829<
4830 Note that list mode will also affect formatting (set with 'textwidth'
4831 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 changing the way tabs are displayed.
4833
4834 *'listchars'* *'lcs'*
4835'listchars' 'lcs' string (default "eol:$")
4836 global
4837 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004838 Strings to use in 'list' mode and for the |:list| command. It is a
4839 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004840 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 eol:c Character to show at the end of each line. When
4842 omitted, there is no extra character at the end of the
4843 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004844 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004845 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004847 fill the space that the tab normally occupies.
4848 "tab:>-" will show a tab that takes four spaces as
4849 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004850 *lcs-space*
4851 space:c Character to show for a space. When omitted, spaces
4852 are left blank.
4853 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004854 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004855 trailing spaces are blank. Overrides the "space"
4856 setting for trailing spaces.
4857 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 extends:c Character to show in the last column, when 'wrap' is
4859 off and the line continues beyond the right of the
4860 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004861 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 precedes:c Character to show in the first column, when 'wrap'
4863 is off and there is text preceding the character
4864 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004865 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004866 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004867 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004868 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004869 nbsp:c Character to show for a non-breakable space character
4870 (0xA0 (160 decimal) and U+202F). Left blank when
4871 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004873 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004875 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876
4877 Examples: >
4878 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004879 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 :set lcs=extends:>,precedes:<
4881< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004882 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004883 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884
4885 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4886'loadplugins' 'lpl' boolean (default on)
4887 global
4888 {not in Vi}
4889 When on the plugin scripts are loaded when starting up |load-plugins|.
4890 This option can be reset in your |vimrc| file to disable the loading
4891 of plugins.
4892 Note that using the "-u NONE" and "--noplugin" command line arguments
4893 reset this option. |-u| |--noplugin|
4894
Bram Moolenaard94464e2015-11-02 15:28:18 +01004895 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004896'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004897 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004898 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004899 {only available when compiled with the |+lua/dyn|
4900 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004901 Specifies the name of the Lua shared library. The default is
4902 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004903 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004904 This option cannot be set from a |modeline| or in the |sandbox|, for
4905 security reasons.
4906
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004907 *'macatsui'* *'nomacatsui'*
4908'macatsui' boolean (default on)
4909 global
4910 {only available in Mac GUI version}
4911 This is a workaround for when drawing doesn't work properly. When set
4912 and compiled with multi-byte support ATSUI text drawing is used. When
4913 not set ATSUI text drawing is not used. Switch this option off when
4914 you experience drawing problems. In a future version the problems may
4915 be solved and this option becomes obsolete. Therefore use this method
4916 to unset it: >
4917 if exists('&macatsui')
4918 set nomacatsui
4919 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004920< Another option to check if you have drawing problems is
4921 'termencoding'.
4922
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 *'magic'* *'nomagic'*
4924'magic' boolean (default on)
4925 global
4926 Changes the special characters that can be used in search patterns.
4927 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004928 WARNING: Switching this option off most likely breaks plugins! That
4929 is because many patterns assume it's on and will fail when it's off.
4930 Only switch it off when working with old Vi scripts. In any other
4931 situation write patterns that work when 'magic' is on. Include "\M"
4932 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
4934 *'makeef'* *'mef'*
4935'makeef' 'mef' string (default: "")
4936 global
4937 {not in Vi}
4938 {not available when compiled without the |+quickfix|
4939 feature}
4940 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4941 and the |:grep| command.
4942 When it is empty, an internally generated temp file will be used.
4943 When "##" is included, it is replaced by a number to make the name
4944 unique. This makes sure that the ":make" command doesn't overwrite an
4945 existing file.
4946 NOT used for the ":cf" command. See 'errorfile' for that.
4947 Environment variables are expanded |:set_env|.
4948 See |option-backslash| about including spaces and backslashes.
4949 This option cannot be set from a |modeline| or in the |sandbox|, for
4950 security reasons.
4951
4952 *'makeprg'* *'mp'*
4953'makeprg' 'mp' string (default "make", VMS: "MMS")
4954 global or local to buffer |global-local|
4955 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004956 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004957 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4958 which are expanded to the current and alternate file name. Use |::S|
4959 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004960 Environment variables are expanded |:set_env|. See |option-backslash|
4961 about including spaces and backslashes.
4962 Note that a '|' must be escaped twice: once for ":set" and once for
4963 the interpretation of a command. When you use a filter called
4964 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 :set makeprg=gmake\ \\\|\ myfilter
4966< The placeholder "$*" can be given (even multiple times) to specify
4967 where the arguments will be included, for example: >
4968 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4969< This option cannot be set from a |modeline| or in the |sandbox|, for
4970 security reasons.
4971
4972 *'matchpairs'* *'mps'*
4973'matchpairs' 'mps' string (default "(:),{:},[:]")
4974 local to buffer
4975 {not in Vi}
4976 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004977 other.
4978 Only character pairs are allowed that are different, thus you cannot
4979 jump between two double quotes.
4980 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004981 The pairs must be separated by a comma. Example for including '<' and
4982 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 :set mps+=<:>
4984
4985< A more exotic example, to jump between the '=' and ';' in an
4986 assignment, useful for languages like C and Java: >
4987 :au FileType c,cpp,java set mps+==:;
4988
4989< For a more advanced way of using "%", see the matchit.vim plugin in
4990 the $VIMRUNTIME/macros directory. |add-local-help|
4991
4992 *'matchtime'* *'mat'*
4993'matchtime' 'mat' number (default 5)
4994 global
4995 {not in Vi}{in Nvi}
4996 Tenths of a second to show the matching paren, when 'showmatch' is
4997 set. Note that this is not in milliseconds, like other options that
4998 set a time. This is to be compatible with Nvi.
4999
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005000 *'maxcombine'* *'mco'*
5001'maxcombine' 'mco' number (default 2)
5002 global
5003 {not in Vi}
5004 {only available when compiled with the |+multi_byte|
5005 feature}
5006 The maximum number of combining characters supported for displaying.
5007 Only used when 'encoding' is "utf-8".
5008 The default is OK for most languages. Hebrew may require 4.
5009 Maximum value is 6.
5010 Even when this option is set to 2 you can still edit text with more
5011 combining characters, you just can't see them. Use |g8| or |ga|.
5012 See |mbyte-combining|.
5013
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014 *'maxfuncdepth'* *'mfd'*
5015'maxfuncdepth' 'mfd' number (default 100)
5016 global
5017 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005018 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005019 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 Maximum depth of function calls for user functions. This normally
5021 catches endless recursion. When using a recursive function with
5022 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5023 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005024 Increasing this limit above 200 also changes the maximum for Ex
5025 command resursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 See also |:function|.
5027
5028 *'maxmapdepth'* *'mmd'* *E223*
5029'maxmapdepth' 'mmd' number (default 1000)
5030 global
5031 {not in Vi}
5032 Maximum number of times a mapping is done without resulting in a
5033 character to be used. This normally catches endless mappings, like
5034 ":map x y" with ":map y x". It still does not catch ":map g wg",
5035 because the 'w' is used before the next mapping is done. See also
5036 |key-mapping|.
5037
5038 *'maxmem'* *'mm'*
5039'maxmem' 'mm' number (default between 256 to 5120 (system
5040 dependent) or half the amount of memory
5041 available)
5042 global
5043 {not in Vi}
5044 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5045 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005046 other memory to be freed. The maximum usable value is about 2000000.
5047 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005049 *'maxmempattern'* *'mmp'*
5050'maxmempattern' 'mmp' number (default 1000)
5051 global
5052 {not in Vi}
5053 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005054 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005055 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005056 When Vim runs into the limit it gives an error message and mostly
5057 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005058 Running into the limit often means that the pattern is very
5059 inefficient or too complex. This may already happen with the pattern
5060 "\(.\)*" on a very long line. ".*" works much better.
5061 Vim may run out of memory before hitting the 'maxmempattern' limit.
5062
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 *'maxmemtot'* *'mmt'*
5064'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5065 dependent) or half the amount of memory
5066 available)
5067 global
5068 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005069 Maximum amount of memory in Kbyte to use for all buffers together.
5070 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005071 without a limit.
5072 On 64 bit machines higher values might work. But hey, do you really
5073 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005074 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005075 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005076 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077
5078 *'menuitems'* *'mis'*
5079'menuitems' 'mis' number (default 25)
5080 global
5081 {not in Vi}
5082 {not available when compiled without the |+menu|
5083 feature}
5084 Maximum number of items to use in a menu. Used for menus that are
5085 generated from a list of items, e.g., the Buffers menu. Changing this
5086 option has no direct effect, the menu must be refreshed first.
5087
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005088 *'mkspellmem'* *'msm'*
5089'mkspellmem' 'msm' string (default "460000,2000,500")
5090 global
5091 {not in Vi}
5092 {not available when compiled without the |+syntax|
5093 feature}
5094 Parameters for |:mkspell|. This tunes when to start compressing the
5095 word tree. Compression can be slow when there are many words, but
5096 it's needed to avoid running out of memory. The amount of memory used
5097 per word depends very much on how similar the words are, that's why
5098 this tuning is complicated.
5099
5100 There are three numbers, separated by commas:
5101 {start},{inc},{added}
5102
5103 For most languages the uncompressed word tree fits in memory. {start}
5104 gives the amount of memory in Kbyte that can be used before any
5105 compression is done. It should be a bit smaller than the amount of
5106 memory that is available to Vim.
5107
5108 When going over the {start} limit the {inc} number specifies the
5109 amount of memory in Kbyte that can be allocated before another
5110 compression is done. A low number means compression is done after
5111 less words are added, which is slow. A high number means more memory
5112 will be allocated.
5113
5114 After doing compression, {added} times 1024 words can be added before
5115 the {inc} limit is ignored and compression is done when any extra
5116 amount of memory is needed. A low number means there is a smaller
5117 chance of hitting the {inc} limit, less memory is used but it's
5118 slower.
5119
5120 The languages for which these numbers are important are Italian and
5121 Hungarian. The default works for when you have about 512 Mbyte. If
5122 you have 1 Gbyte you could use: >
5123 :set mkspellmem=900000,3000,800
5124< If you have less than 512 Mbyte |:mkspell| may fail for some
5125 languages, no matter what you set 'mkspellmem' to.
5126
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005128'modeline' 'ml' boolean (Vim default: on (off for root),
5129 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005130 local to buffer
5131 *'modelines'* *'mls'*
5132'modelines' 'mls' number (default 5)
5133 global
5134 {not in Vi}
5135 If 'modeline' is on 'modelines' gives the number of lines that is
5136 checked for set commands. If 'modeline' is off or 'modelines' is zero
5137 no lines are checked. See |modeline|.
5138 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5139 set and to the Vim default value when 'compatible' is reset.
5140
5141 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5142'modifiable' 'ma' boolean (default on)
5143 local to buffer
5144 {not in Vi} *E21*
5145 When off the buffer contents cannot be changed. The 'fileformat' and
5146 'fileencoding' options also can't be changed.
5147 Can be reset with the |-M| command line argument.
5148
5149 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5150'modified' 'mod' boolean (default off)
5151 local to buffer
5152 {not in Vi}
5153 When on, the buffer is considered to be modified. This option is set
5154 when:
5155 1. A change was made to the text since it was last written. Using the
5156 |undo| command to go back to the original text will reset the
5157 option. But undoing changes that were made before writing the
5158 buffer will set the option again, since the text is different from
5159 when it was written.
5160 2. 'fileformat' or 'fileencoding' is different from its original
5161 value. The original value is set when the buffer is read or
5162 written. A ":set nomodified" command also resets the original
5163 values to the current values and the 'modified' option will be
5164 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005165 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005166 This option is not set when a change is made to the buffer as the
5167 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5168 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5169 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5171 will be ignored.
5172
5173 *'more'* *'nomore'*
5174'more' boolean (Vim default: on, Vi default: off)
5175 global
5176 {not in Vi}
5177 When on, listings pause when the whole screen is filled. You will get
5178 the |more-prompt|. When this option is off there are no pauses, the
5179 listing continues until finished.
5180 NOTE: This option is set to the Vi default value when 'compatible' is
5181 set and to the Vim default value when 'compatible' is reset.
5182
5183 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005184'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5185 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 global
5187 {not in Vi}
5188 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005189 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5190 sysmouse and Linux console with gpm). For using the mouse in the
5191 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 The mouse can be enabled for different modes:
5193 n Normal mode
5194 v Visual mode
5195 i Insert mode
5196 c Command-line mode
5197 h all previous modes when editing a help file
5198 a all previous modes
5199 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 Normally you would enable the mouse in all four modes with: >
5201 :set mouse=a
5202< When the mouse is not enabled, the GUI will still use the mouse for
5203 modeless selection. This doesn't move the text cursor.
5204
5205 See |mouse-using|. Also see |'clipboard'|.
5206
5207 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005208 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 the mouse buttons can still be used by keeping the shift key pressed.
5210 Also see the 'clipboard' option.
5211
5212 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5213'mousefocus' 'mousef' boolean (default off)
5214 global
5215 {not in Vi}
5216 {only works in the GUI}
5217 The window that the mouse pointer is on is automatically activated.
5218 When changing the window layout or window focus in another way, the
5219 mouse pointer is moved to the window with keyboard focus. Off is the
5220 default because it makes using the pull down menus a little goofy, as
5221 a pointer transit may activate a window unintentionally.
5222
5223 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5224'mousehide' 'mh' boolean (default on)
5225 global
5226 {not in Vi}
5227 {only works in the GUI}
5228 When on, the mouse pointer is hidden when characters are typed.
5229 The mouse pointer is restored when the mouse is moved.
5230
5231 *'mousemodel'* *'mousem'*
5232'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5233 global
5234 {not in Vi}
5235 Sets the model to use for the mouse. The name mostly specifies what
5236 the right mouse button is used for:
5237 extend Right mouse button extends a selection. This works
5238 like in an xterm.
5239 popup Right mouse button pops up a menu. The shifted left
5240 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005241 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 popup_setpos Like "popup", but the cursor will be moved to the
5243 position where the mouse was clicked, and thus the
5244 selected operation will act upon the clicked object.
5245 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005246 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 course, that right clicking outside a selection will
5248 end Visual mode.
5249 Overview of what button does what for each model:
5250 mouse extend popup(_setpos) ~
5251 left click place cursor place cursor
5252 left drag start selection start selection
5253 shift-left search word extend selection
5254 right click extend selection popup menu (place cursor)
5255 right drag extend selection -
5256 middle click paste paste
5257
5258 In the "popup" model the right mouse button produces a pop-up menu.
5259 You need to define this first, see |popup-menu|.
5260
5261 Note that you can further refine the meaning of buttons with mappings.
5262 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5263 selection (because that's handled in the GUI code directly).
5264
5265 The 'mousemodel' option is set by the |:behave| command.
5266
5267 *'mouseshape'* *'mouses'* *E547*
5268'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005269 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270 global
5271 {not in Vi}
5272 {only available when compiled with the |+mouseshape|
5273 feature}
5274 This option tells Vim what the mouse pointer should look like in
5275 different modes. The option is a comma separated list of parts, much
5276 like used for 'guicursor'. Each part consist of a mode/location-list
5277 and an argument-list:
5278 mode-list:shape,mode-list:shape,..
5279 The mode-list is a dash separated list of these modes/locations:
5280 In a normal window: ~
5281 n Normal mode
5282 v Visual mode
5283 ve Visual mode with 'selection' "exclusive" (same as 'v',
5284 if not specified)
5285 o Operator-pending mode
5286 i Insert mode
5287 r Replace mode
5288
5289 Others: ~
5290 c appending to the command-line
5291 ci inserting in the command-line
5292 cr replacing in the command-line
5293 m at the 'Hit ENTER' or 'More' prompts
5294 ml idem, but cursor in the last line
5295 e any mode, pointer below last window
5296 s any mode, pointer on a status line
5297 sd any mode, while dragging a status line
5298 vs any mode, pointer on a vertical separator line
5299 vd any mode, while dragging a vertical separator line
5300 a everywhere
5301
5302 The shape is one of the following:
5303 avail name looks like ~
5304 w x arrow Normal mouse pointer
5305 w x blank no pointer at all (use with care!)
5306 w x beam I-beam
5307 w x updown up-down sizing arrows
5308 w x leftright left-right sizing arrows
5309 w x busy The system's usual busy pointer
5310 w x no The system's usual 'no input' pointer
5311 x udsizing indicates up-down resizing
5312 x lrsizing indicates left-right resizing
5313 x crosshair like a big thin +
5314 x hand1 black hand
5315 x hand2 white hand
5316 x pencil what you write with
5317 x question big ?
5318 x rightup-arrow arrow pointing right-up
5319 w x up-arrow arrow pointing up
5320 x <number> any X11 pointer number (see X11/cursorfont.h)
5321
5322 The "avail" column contains a 'w' if the shape is available for Win32,
5323 x for X11.
5324 Any modes not specified or shapes not available use the normal mouse
5325 pointer.
5326
5327 Example: >
5328 :set mouseshape=s:udsizing,m:no
5329< will make the mouse turn to a sizing arrow over the status lines and
5330 indicate no input when the hit-enter prompt is displayed (since
5331 clicking the mouse has no effect in this state.)
5332
5333 *'mousetime'* *'mouset'*
5334'mousetime' 'mouset' number (default 500)
5335 global
5336 {not in Vi}
5337 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5338 time in msec between two mouse clicks for the second click to be
5339 recognized as a multi click.
5340
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005341 *'mzquantum'* *'mzq'*
5342'mzquantum' 'mzq' number (default 100)
5343 global
5344 {not in Vi}
5345 {not available when compiled without the |+mzscheme|
5346 feature}
5347 The number of milliseconds between polls for MzScheme threads.
5348 Negative or zero value means no thread scheduling.
5349
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005351'nrformats' 'nf' string (default "bin,octal,hex",
5352 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 local to buffer
5354 {not in Vi}
5355 This defines what bases Vim will consider for numbers when using the
5356 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5357 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005358 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005360 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005361 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005363 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 considered to be hexadecimal. Example: Using CTRL-X on
5365 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005366 bin If included, numbers starting with "0b" or "0B" will be
5367 considered to be binary. Example: Using CTRL-X on
5368 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 Numbers which simply begin with a digit in the range 1-9 are always
5370 considered decimal. This also happens for numbers that are not
5371 recognized as octal or hex.
5372
5373 *'number'* *'nu'* *'nonumber'* *'nonu'*
5374'number' 'nu' boolean (default off)
5375 local to window
5376 Print the line number in front of each line. When the 'n' option is
5377 excluded from 'cpoptions' a wrapped line will not use the column of
5378 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005379 The 'numberwidth' option can be used to set the room used for the line
5380 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 When a long, wrapped line doesn't start with the first character, '-'
5382 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005383 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5384 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005385 *number_relativenumber*
5386 The 'relativenumber' option changes the displayed number to be
5387 relative to the cursor. Together with 'number' there are these
5388 four combinations (cursor in line 3):
5389
Bram Moolenaar3848e002016-03-19 18:42:29 +01005390 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005391 'nornu' 'nornu' 'rnu' 'rnu'
5392
5393 |apple | 1 apple | 2 apple | 2 apple
5394 |pear | 2 pear | 1 pear | 1 pear
5395 |nobody | 3 nobody | 0 nobody |3 nobody
5396 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005398 *'numberwidth'* *'nuw'*
5399'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5400 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005401 {not in Vi}
5402 {only available when compiled with the |+linebreak|
5403 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005404 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005405 when the 'number' or 'relativenumber' option is set or printing lines
5406 with a line number. Since one space is always between the number and
5407 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005408 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005409 fit the highest line number in the buffer respectively the number of
5410 rows in the window, depending on whether 'number' or 'relativenumber'
5411 is set. Thus with the Vim default of 4 there is room for a line number
5412 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005413 The minimum value is 1, the maximum value is 10.
5414 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5415
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005416 *'omnifunc'* *'ofu'*
5417'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005418 local to buffer
5419 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005420 {not available when compiled without the |+eval|
5421 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005422 This option specifies a function to be used for Insert mode omni
5423 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005424 See |complete-functions| for an explanation of how the function is
5425 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005426 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005427 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005428 This option cannot be set from a |modeline| or in the |sandbox|, for
5429 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005430
5431
Bram Moolenaar02467872007-05-06 13:22:01 +00005432 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005433'opendevice' 'odev' boolean (default off)
5434 global
5435 {not in Vi}
5436 {only for MS-DOS, MS-Windows and OS/2}
5437 Enable reading and writing from devices. This may get Vim stuck on a
5438 device that can be opened but doesn't actually do the I/O. Therefore
5439 it is off by default.
5440 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5441 result in editing a device.
5442
5443
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005444 *'operatorfunc'* *'opfunc'*
5445'operatorfunc' 'opfunc' string (default: empty)
5446 global
5447 {not in Vi}
5448 This option specifies a function to be called by the |g@| operator.
5449 See |:map-operator| for more info and an example.
5450
5451 This option cannot be set from a |modeline| or in the |sandbox|, for
5452 security reasons.
5453
5454
Bram Moolenaar251e1912011-06-19 05:09:16 +02005455 *'osfiletype'* *'oft'*
5456'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 local to buffer
5458 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005459 This option was supported on RISC OS, which has been removed.
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005462 *'packpath'* *'pp'*
5463'packpath' 'pp' string (default: see 'runtimepath')
5464 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005465 Directories used to find packages. See |packages|.
5466
5467
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005469'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 global
5471 Specifies the nroff macros that separate paragraphs. These are pairs
5472 of two letters (see |object-motions|).
5473
5474 *'paste'* *'nopaste'*
5475'paste' boolean (default off)
5476 global
5477 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005478 Put Vim in Paste mode. This is useful if you want to cut or copy
5479 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 unexpected effects.
5481 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005482 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 knows about pasting and will mostly do the right thing without 'paste'
5484 being set. The same is true for a terminal where Vim handles the
5485 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005486 This option is reset when starting the GUI. Thus if you set it in
5487 your .vimrc it will work in a terminal, but not in the GUI. Setting
5488 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5489 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 When the 'paste' option is switched on (also when it was already on):
5491 - mapping in Insert mode and Command-line mode is disabled
5492 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005494 - 'expandtab' is reset
5495 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 - 'revins' is reset
5497 - 'ruler' is reset
5498 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005499 - 'smartindent' is reset
5500 - 'smarttab' is reset
5501 - 'softtabstop' is set to 0
5502 - 'textwidth' is set to 0
5503 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005506 - 'indentexpr'
5507 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 NOTE: When you start editing another file while the 'paste' option is
5509 on, settings from the modelines or autocommands may change the
5510 settings again, causing trouble when pasting text. You might want to
5511 set the 'paste' option again.
5512 When the 'paste' option is reset the mentioned options are restored to
5513 the value before the moment 'paste' was switched from off to on.
5514 Resetting 'paste' before ever setting it does not have any effect.
5515 Since mapping doesn't work while 'paste' is active, you need to use
5516 the 'pastetoggle' option to toggle the 'paste' option with some key.
5517
5518 *'pastetoggle'* *'pt'*
5519'pastetoggle' 'pt' string (default "")
5520 global
5521 {not in Vi}
5522 When non-empty, specifies the key sequence that toggles the 'paste'
5523 option. This is like specifying a mapping: >
5524 :map {keys} :set invpaste<CR>
5525< Where {keys} is the value of 'pastetoggle'.
5526 The difference is that it will work even when 'paste' is set.
5527 'pastetoggle' works in Insert mode and Normal mode, but not in
5528 Command-line mode.
5529 Mappings are checked first, thus overrule 'pastetoggle'. However,
5530 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5531 this: >
5532 :map <F10> :set paste<CR>
5533 :map <F11> :set nopaste<CR>
5534 :imap <F10> <C-O>:set paste<CR>
5535 :imap <F11> <nop>
5536 :set pastetoggle=<F11>
5537< This will make <F10> start paste mode and <F11> stop paste mode.
5538 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5539 mode everything is inserted literally, except the 'pastetoggle' key
5540 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005541 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542
5543 *'pex'* *'patchexpr'*
5544'patchexpr' 'pex' string (default "")
5545 global
5546 {not in Vi}
5547 {not available when compiled without the |+diff|
5548 feature}
5549 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005550 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551
Bram Moolenaardbc28022014-07-26 13:40:44 +02005552 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553'patchmode' 'pm' string (default "")
5554 global
5555 {not in Vi}
5556 When non-empty the oldest version of a file is kept. This can be used
5557 to keep the original version of a file if you are changing files in a
5558 source distribution. Only the first time that a file is written a
5559 copy of the original file will be kept. The name of the copy is the
5560 name of the original file with the string in the 'patchmode' option
5561 appended. This option should start with a dot. Use a string like
5562 ".org". 'backupdir' must not be empty for this to work (Detail: The
5563 backup file is renamed to the patchmode file after the new file has
5564 been successfully written, that's why it must be possible to write a
5565 backup file). If there was no file to be backed up, an empty file is
5566 created.
5567 When the 'backupskip' pattern matches, a patchmode file is not made.
5568 Using 'patchmode' for compressed files appends the extension at the
5569 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5570 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005571 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005573 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574'path' 'pa' string (default on Unix: ".,/usr/include,,"
5575 on OS/2: ".,/emx/include,,"
5576 other systems: ".,,")
5577 global or local to buffer |global-local|
5578 {not in Vi}
5579 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005580 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5581 provided that the file being searched for has a relative path (not
5582 starting with "/", "./" or "../"). The directories in the 'path'
5583 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 - Use commas to separate directory names: >
5585 :set path=.,/usr/local/include,/usr/include
5586< - Spaces can also be used to separate directory names (for backwards
5587 compatibility with version 3.0). To have a space in a directory
5588 name, precede it with an extra backslash, and escape the space: >
5589 :set path=.,/dir/with\\\ space
5590< - To include a comma in a directory name precede it with an extra
5591 backslash: >
5592 :set path=.,/dir/with\\,comma
5593< - To search relative to the directory of the current file, use: >
5594 :set path=.
5595< - To search in the current directory use an empty string between two
5596 commas: >
5597 :set path=,,
5598< - A directory name may end in a ':' or '/'.
5599 - Environment variables are expanded |:set_env|.
5600 - When using |netrw.vim| URLs can be used. For example, adding
5601 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005602 - Search upwards and downwards in a directory tree using "*", "**" and
5603 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 {not available when compiled without the |+path_extra| feature}
5605 - Careful with '\' characters, type two to get one in the option: >
5606 :set path=.,c:\\include
5607< Or just use '/' instead: >
5608 :set path=.,c:/include
5609< Don't forget "." or files won't even be found in the same directory as
5610 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005611 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 it is something like 256 or 1024 characters.
5613 You can check if all the include files are found, using the value of
5614 'path', see |:checkpath|.
5615 The use of |:set+=| and |:set-=| is preferred when adding or removing
5616 directories from the list. This avoids problems when a future version
5617 uses another default. To remove the current directory use: >
5618 :set path-=
5619< To add the current directory use: >
5620 :set path+=
5621< To use an environment variable, you probably need to replace the
5622 separator. Here is an example to append $INCL, in which directory
5623 names are separated with a semi-colon: >
5624 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5625< Replace the ';' with a ':' or whatever separator is used. Note that
5626 this doesn't work when $INCL contains a comma or white space.
5627
Bram Moolenaard94464e2015-11-02 15:28:18 +01005628 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005629'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005630 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005631 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005632 {only available when compiled with the |+perl/dyn|
5633 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005634 Specifies the name of the Perl shared library. The default is
5635 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005636 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005637 This option cannot be set from a |modeline| or in the |sandbox|, for
5638 security reasons.
5639
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5641'preserveindent' 'pi' boolean (default off)
5642 local to buffer
5643 {not in Vi}
5644 When changing the indent of the current line, preserve as much of the
5645 indent structure as possible. Normally the indent is replaced by a
5646 series of tabs followed by spaces as required (unless |'expandtab'| is
5647 enabled, in which case only spaces are used). Enabling this option
5648 means the indent will preserve as many existing characters as possible
5649 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005650 'expandtab' does not apply to the preserved white space, a Tab remains
5651 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 NOTE: When using ">>" multiple times the resulting indent is a mix of
5653 tabs and spaces. You might not like this.
5654 NOTE: 'preserveindent' is reset when 'compatible' is set.
5655 Also see 'copyindent'.
5656 Use |:retab| to clean up white space.
5657
5658 *'previewheight'* *'pvh'*
5659'previewheight' 'pvh' number (default 12)
5660 global
5661 {not in Vi}
5662 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005663 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 Default height for a preview window. Used for |:ptag| and associated
5665 commands. Used for |CTRL-W_}| when no count is given.
5666
5667 *'previewwindow'* *'nopreviewwindow'*
5668 *'pvw'* *'nopvw'* *E590*
5669'previewwindow' 'pvw' boolean (default off)
5670 local to window
5671 {not in Vi}
5672 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005673 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005674 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 set. It's normally not set directly, but by using one of the commands
5676 |:ptag|, |:pedit|, etc.
5677
5678 *'printdevice'* *'pdev'*
5679'printdevice' 'pdev' string (default empty)
5680 global
5681 {not in Vi}
5682 {only available when compiled with the |+printer|
5683 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005684 The name of the printer to be used for |:hardcopy|.
5685 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005686 This option cannot be set from a |modeline| or in the |sandbox|, for
5687 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688
Bram Moolenaar8299df92004-07-10 09:47:34 +00005689 *'printencoding'* *'penc'*
5690'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 global
5692 {not in Vi}
5693 {only available when compiled with the |+printer|
5694 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005695 Sets the character encoding used when printing.
5696 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697
5698 *'printexpr'* *'pexpr'*
5699'printexpr' 'pexpr' String (default: see below)
5700 global
5701 {not in Vi}
5702 {only available when compiled with the |+printer|
5703 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005704 Expression used to print the PostScript produced with |:hardcopy|.
5705 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005706 This option cannot be set from a |modeline| or in the |sandbox|, for
5707 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708
Bram Moolenaar8299df92004-07-10 09:47:34 +00005709 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710'printfont' 'pfn' string (default "courier")
5711 global
5712 {not in Vi}
5713 {only available when compiled with the |+printer|
5714 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005715 The name of the font that will be used for |:hardcopy|.
5716 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
5718 *'printheader'* *'pheader'*
5719'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5720 global
5721 {not in Vi}
5722 {only available when compiled with the |+printer|
5723 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005724 The format of the header produced in |:hardcopy| output.
5725 See |pheader-option|.
5726
5727 *'printmbcharset'* *'pmbcs'*
5728'printmbcharset' 'pmbcs' string (default "")
5729 global
5730 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005731 {only available when compiled with the |+printer|,
5732 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005733 The CJK character set to be used for CJK output from |:hardcopy|.
5734 See |pmbcs-option|.
5735
5736 *'printmbfont'* *'pmbfn'*
5737'printmbfont' 'pmbfn' string (default "")
5738 global
5739 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005740 {only available when compiled with the |+printer|,
5741 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005742 List of font names to be used for CJK output from |:hardcopy|.
5743 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744
5745 *'printoptions'* *'popt'*
5746'printoptions' 'popt' string (default "")
5747 global
5748 {not in Vi}
5749 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005750 List of items that control the format of the output of |:hardcopy|.
5751 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005753 *'prompt'* *'noprompt'*
5754'prompt' boolean (default on)
5755 global
5756 When on a ":" prompt is used in Ex mode.
5757
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005758 *'pumheight'* *'ph'*
5759'pumheight' 'ph' number (default 0)
5760 global
5761 {not available when compiled without the
5762 |+insert_expand| feature}
5763 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005764 Determines the maximum number of items to show in the popup menu for
5765 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005766 |ins-completion-menu|.
5767
Bram Moolenaard94464e2015-11-02 15:28:18 +01005768 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005769'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005770 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005771 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005772 {only available when compiled with the |+python/dyn|
5773 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005774 Specifies the name of the Python 2.x shared library. The default is
5775 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005776 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005777 This option cannot be set from a |modeline| or in the |sandbox|, for
5778 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005779
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005780 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005781'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005782 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005783 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005784 {only available when compiled with the |+python3/dyn|
5785 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005786 Specifies the name of the Python 3 shared library. The default is
5787 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005788 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005789 This option cannot be set from a |modeline| or in the |sandbox|, for
5790 security reasons.
5791
Bram Moolenaar677ee682005-01-27 14:41:15 +00005792 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005793'quoteescape' 'qe' string (default "\")
5794 local to buffer
5795 {not in Vi}
5796 The characters that are used to escape quotes in a string. Used for
5797 objects like a', a" and a` |a'|.
5798 When one of the characters in this option is found inside a string,
5799 the following character will be skipped. The default value makes the
5800 text "foo\"bar\\" considered to be one string.
5801
Bram Moolenaar071d4272004-06-13 20:20:40 +00005802 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5803'readonly' 'ro' boolean (default off)
5804 local to buffer
5805 If on, writes fail unless you use a '!'. Protects you from
5806 accidentally overwriting a file. Default on when Vim is started
5807 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005808 When using ":w!" the 'readonly' option is reset for the current
5809 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005810 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005811 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005813 *'redrawtime'* *'rdt'*
5814'redrawtime' 'rdt' number (default 2000)
5815 global
5816 {not in Vi}
5817 {only available when compiled with the |+reltime|
5818 feature}
5819 The time in milliseconds for redrawing the display. This applies to
5820 searching for patterns for 'hlsearch' and |:match| highlighting.
5821 When redrawing takes more than this many milliseconds no further
5822 matches will be highlighted. This is used to avoid that Vim hangs
5823 when using a very complicated pattern.
5824
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005825 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005826'regexpengine' 're' number (default 0)
5827 global
5828 {not in Vi}
5829 This selects the default regexp engine. |two-engines|
5830 The possible values are:
5831 0 automatic selection
5832 1 old engine
5833 2 NFA engine
5834 Note that when using the NFA engine and the pattern contains something
5835 that is not supported the pattern will not match. This is only useful
5836 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005837 Using automatic selection enables Vim to switch the engine, if the
5838 default engine becomes too costly. E.g., when the NFA engine uses too
5839 many states. This should prevent Vim from hanging on a combination of
5840 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005841
Bram Moolenaar64486672010-05-16 15:46:46 +02005842 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5843'relativenumber' 'rnu' boolean (default off)
5844 local to window
5845 {not in Vi}
5846 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005847 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005848 precede some vertical motion commands (e.g. j k + -) with, without
5849 having to calculate it yourself. Especially useful in combination with
5850 other commands (e.g. y d c < > gq gw =).
5851 When the 'n' option is excluded from 'cpoptions' a wrapped
5852 line will not use the column of line numbers (this is the default when
5853 'compatible' isn't set).
5854 The 'numberwidth' option can be used to set the room used for the line
5855 number.
5856 When a long, wrapped line doesn't start with the first character, '-'
5857 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005858 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5859 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005860
5861 The number in front of the cursor line also depends on the value of
5862 'number', see |number_relativenumber| for all combinations of the two
5863 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005864
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 *'remap'* *'noremap'*
5866'remap' boolean (default on)
5867 global
5868 Allows for mappings to work recursively. If you do not want this for
5869 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005870 NOTE: To avoid portability problems with Vim scripts, always keep
5871 this option at the default "on". Only switch it off when working with
5872 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005874 *'renderoptions'* *'rop'*
5875'renderoptions' 'rop' string (default: empty)
5876 global
5877 {not in Vi}
5878 {only available when compiled with GUI and DIRECTX on
5879 MS-Windows}
5880 Select a text renderer and set its options. The options depend on the
5881 renderer.
5882
5883 Syntax: >
5884 set rop=type:{renderer}(,{name}:{value})*
5885<
5886 Currently, only one optional renderer is available.
5887
5888 render behavior ~
5889 directx Vim will draw text using DirectX (DirectWrite). It makes
5890 drawn glyphs more beautiful than default GDI.
5891 It requires 'encoding' is "utf-8", and only works on
5892 MS-Windows Vista or newer version.
5893
5894 Options:
5895 name meaning type value ~
5896 gamma gamma float 1.0 - 2.2 (maybe)
5897 contrast enhancedContrast float (unknown)
5898 level clearTypeLevel float (unknown)
5899 geom pixelGeometry int 0 - 2 (see below)
5900 renmode renderingMode int 0 - 6 (see below)
5901 taamode textAntialiasMode int 0 - 3 (see below)
5902
5903 See this URL for detail:
5904 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5905
5906 For geom: structure of a device pixel.
5907 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5908 1 - DWRITE_PIXEL_GEOMETRY_RGB
5909 2 - DWRITE_PIXEL_GEOMETRY_BGR
5910
5911 See this URL for detail:
5912 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5913
5914 For renmode: method of rendering glyphs.
5915 0 - DWRITE_RENDERING_MODE_DEFAULT
5916 1 - DWRITE_RENDERING_MODE_ALIASED
5917 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5918 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5919 4 - DWRITE_RENDERING_MODE_NATURAL
5920 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5921 6 - DWRITE_RENDERING_MODE_OUTLINE
5922
5923 See this URL for detail:
5924 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5925
5926 For taamode: antialiasing mode used for drawing text.
5927 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5928 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5929 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5930 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5931
5932 See this URL for detail:
5933 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5934
5935 Example: >
5936 set encoding=utf-8
5937 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5938 set rop=type:directx
5939<
5940 If select a raster font (Courier, Terminal or FixedSys) to
5941 'guifont', it fallbacks to be drawn by GDI automatically.
5942
5943 Other render types are currently not supported.
5944
Bram Moolenaar071d4272004-06-13 20:20:40 +00005945 *'report'*
5946'report' number (default 2)
5947 global
5948 Threshold for reporting number of lines changed. When the number of
5949 changed lines is more than 'report' a message will be given for most
5950 ":" commands. If you want it always, set 'report' to 0.
5951 For the ":substitute" command the number of substitutions is used
5952 instead of the number of lines.
5953
5954 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5955'restorescreen' 'rs' boolean (default on)
5956 global
5957 {not in Vi} {only in Windows 95/NT console version}
5958 When set, the screen contents is restored when exiting Vim. This also
5959 happens when executing external commands.
5960
5961 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5962 options in your .vimrc. To disable restoring:
5963 set t_ti= t_te=
5964 To enable restoring (for an xterm):
5965 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5966 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5967
5968 *'revins'* *'ri'* *'norevins'* *'nori'*
5969'revins' 'ri' boolean (default off)
5970 global
5971 {not in Vi}
5972 {only available when compiled with the |+rightleft|
5973 feature}
5974 Inserting characters in Insert mode will work backwards. See "typing
5975 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5976 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005977 NOTE: This option is reset when 'compatible' is set.
5978 This option is reset when 'paste' is set and restored when 'paste' is
5979 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980
5981 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5982'rightleft' 'rl' boolean (default off)
5983 local to window
5984 {not in Vi}
5985 {only available when compiled with the |+rightleft|
5986 feature}
5987 When on, display orientation becomes right-to-left, i.e., characters
5988 that are stored in the file appear from the right to the left.
5989 Using this option, it is possible to edit files for languages that
5990 are written from the right to the left such as Hebrew and Arabic.
5991 This option is per window, so it is possible to edit mixed files
5992 simultaneously, or to view the same file in both ways (this is
5993 useful whenever you have a mixed text file with both right-to-left
5994 and left-to-right strings so that both sets are displayed properly
5995 in different windows). Also see |rileft.txt|.
5996
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005997 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998'rightleftcmd' 'rlc' string (default "search")
5999 local to window
6000 {not in Vi}
6001 {only available when compiled with the |+rightleft|
6002 feature}
6003 Each word in this option enables the command line editing to work in
6004 right-to-left mode for a group of commands:
6005
6006 search "/" and "?" commands
6007
6008 This is useful for languages such as Hebrew, Arabic and Farsi.
6009 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6010
Bram Moolenaard94464e2015-11-02 15:28:18 +01006011 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006012'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006013 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006014 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01006015 {only available when compiled with the |+ruby/dyn|
6016 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006017 Specifies the name of the Ruby shared library. The default is
6018 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006019 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006020 This option cannot be set from a |modeline| or in the |sandbox|, for
6021 security reasons.
6022
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006024'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 global
6026 {not in Vi}
6027 {not available when compiled without the
6028 |+cmdline_info| feature}
6029 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006030 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 text in the file is shown on the far right:
6032 Top first line is visible
6033 Bot last line is visible
6034 All first and last line are visible
6035 45% relative position in the file
6036 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006037 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006039 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 this option takes precedence over 'ruler' and 'rulerformat'
6041 If the number of characters displayed is different from the number of
6042 bytes in the text (e.g., for a TAB or a multi-byte character), both
6043 the text column (byte number) and the screen column are shown,
6044 separated with a dash.
6045 For an empty line "0-1" is shown.
6046 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006047 This option is reset when 'paste' is set and restored when 'paste' is
6048 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 If you don't want to see the ruler all the time but want to know where
6050 you are, use "g CTRL-G" |g_CTRL-G|.
6051 NOTE: This option is reset when 'compatible' is set.
6052
6053 *'rulerformat'* *'ruf'*
6054'rulerformat' 'ruf' string (default empty)
6055 global
6056 {not in Vi}
6057 {not available when compiled without the |+statusline|
6058 feature}
6059 When this option is not empty, it determines the content of the ruler
6060 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006061 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 The default ruler width is 17 characters. To make the ruler 15
6063 characters wide, put "%15(" at the start and "%)" at the end.
6064 Example: >
6065 :set rulerformat=%15(%c%V\ %p%%%)
6066<
6067 *'runtimepath'* *'rtp'* *vimfiles*
6068'runtimepath' 'rtp' string (default:
6069 Unix: "$HOME/.vim,
6070 $VIM/vimfiles,
6071 $VIMRUNTIME,
6072 $VIM/vimfiles/after,
6073 $HOME/.vim/after"
6074 Amiga: "home:vimfiles,
6075 $VIM/vimfiles,
6076 $VIMRUNTIME,
6077 $VIM/vimfiles/after,
6078 home:vimfiles/after"
6079 PC, OS/2: "$HOME/vimfiles,
6080 $VIM/vimfiles,
6081 $VIMRUNTIME,
6082 $VIM/vimfiles/after,
6083 $HOME/vimfiles/after"
6084 Macintosh: "$VIM:vimfiles,
6085 $VIMRUNTIME,
6086 $VIM:vimfiles:after"
6087 RISC-OS: "Choices:vimfiles,
6088 $VIMRUNTIME,
6089 Choices:vimfiles/after"
6090 VMS: "sys$login:vimfiles,
6091 $VIM/vimfiles,
6092 $VIMRUNTIME,
6093 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006094 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 global
6096 {not in Vi}
6097 This is a list of directories which will be searched for runtime
6098 files:
6099 filetype.vim filetypes by file name |new-filetype|
6100 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006101 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 colors/ color scheme files |:colorscheme|
6103 compiler/ compiler files |:compiler|
6104 doc/ documentation |write-local-help|
6105 ftplugin/ filetype plugins |write-filetype-plugin|
6106 indent/ indent scripts |indent-expression|
6107 keymap/ key mapping files |mbyte-keymap|
6108 lang/ menu translations |:menutrans|
6109 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006110 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 plugin/ plugin scripts |write-plugin|
6112 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006113 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 syntax/ syntax files |mysyntaxfile|
6115 tutor/ files for vimtutor |tutor|
6116
6117 And any other file searched for with the |:runtime| command.
6118
6119 The defaults for most systems are setup to search five locations:
6120 1. In your home directory, for your personal preferences.
6121 2. In a system-wide Vim directory, for preferences from the system
6122 administrator.
6123 3. In $VIMRUNTIME, for files distributed with Vim.
6124 *after-directory*
6125 4. In the "after" directory in the system-wide Vim directory. This is
6126 for the system administrator to overrule or add to the distributed
6127 defaults (rarely needed)
6128 5. In the "after" directory in your home directory. This is for
6129 personal preferences to overrule or add to the distributed defaults
6130 or system-wide settings (rarely needed).
6131
Bram Moolenaard0796902016-09-16 20:02:31 +02006132 More entries are added when using |packages|. If it gets very long
6133 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6134 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006135
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6137 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006138 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 wildcards.
6140 See |:runtime|.
6141 Example: >
6142 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6143< This will use the directory "~/vimruntime" first (containing your
6144 personal Vim runtime files), then "/mygroup/vim" (shared between a
6145 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6146 files).
6147 You probably should always include $VIMRUNTIME somewhere, to use the
6148 distributed runtime files. You can put a directory before $VIMRUNTIME
6149 to find files which replace a distributed runtime files. You can put
6150 a directory after $VIMRUNTIME to find files which add to distributed
6151 runtime files.
6152 This option cannot be set from a |modeline| or in the |sandbox|, for
6153 security reasons.
6154
6155 *'scroll'* *'scr'*
6156'scroll' 'scr' number (default: half the window height)
6157 local to window
6158 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6159 set to half the number of lines in the window when the window size
6160 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006161 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6163 the number of screen lines instead of file lines, makes a difference
6164 when lines wrap}
6165
6166 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6167'scrollbind' 'scb' boolean (default off)
6168 local to window
6169 {not in Vi}
6170 {not available when compiled without the |+scrollbind|
6171 feature}
6172 See also |scroll-binding|. When this option is set, the current
6173 window scrolls as other scrollbind windows (windows that also have
6174 this option set) scroll. This option is useful for viewing the
6175 differences between two versions of a file, see 'diff'.
6176 See |'scrollopt'| for options that determine how this option should be
6177 interpreted.
6178 This option is mostly reset when splitting a window to edit another
6179 file. This means that ":split | edit file" results in two windows
6180 with scroll-binding, but ":split file" does not.
6181
6182 *'scrolljump'* *'sj'*
6183'scrolljump' 'sj' number (default 1)
6184 global
6185 {not in Vi}
6186 Minimal number of lines to scroll when the cursor gets off the
6187 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6188 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006189 When set to a negative number from -1 to -100 this is used as the
6190 percentage of the window height. Thus -50 scrolls half the window
6191 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 NOTE: This option is set to 1 when 'compatible' is set.
6193
6194 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006195'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 global
6197 {not in Vi}
6198 Minimal number of screen lines to keep above and below the cursor.
6199 This will make some context visible around where you are working. If
6200 you set it to a very large value (999) the cursor line will always be
6201 in the middle of the window (except at the start or end of the file or
6202 when long lines wrap).
6203 For scrolling horizontally see 'sidescrolloff'.
6204 NOTE: This option is set to 0 when 'compatible' is set.
6205
6206 *'scrollopt'* *'sbo'*
6207'scrollopt' 'sbo' string (default "ver,jump")
6208 global
6209 {not available when compiled without the |+scrollbind|
6210 feature}
6211 {not in Vi}
6212 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006213 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6214 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 The following words are available:
6216 ver Bind vertical scrolling for 'scrollbind' windows
6217 hor Bind horizontal scrolling for 'scrollbind' windows
6218 jump Applies to the offset between two windows for vertical
6219 scrolling. This offset is the difference in the first
6220 displayed line of the bound windows. When moving
6221 around in a window, another 'scrollbind' window may
6222 reach a position before the start or after the end of
6223 the buffer. The offset is not changed though, when
6224 moving back the 'scrollbind' window will try to scroll
6225 to the desired position when possible.
6226 When now making that window the current one, two
6227 things can be done with the relative offset:
6228 1. When "jump" is not included, the relative offset is
6229 adjusted for the scroll position in the new current
6230 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006231 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 2. When "jump" is included, the other windows are
6233 scrolled to keep the same relative offset. When
6234 going back to the other window, it still uses the
6235 same relative offset.
6236 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006237 When 'diff' mode is active there always is vertical scroll binding,
6238 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006239
6240 *'sections'* *'sect'*
6241'sections' 'sect' string (default "SHNHH HUnhsh")
6242 global
6243 Specifies the nroff macros that separate sections. These are pairs of
6244 two letters (See |object-motions|). The default makes a section start
6245 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6246
6247 *'secure'* *'nosecure'* *E523*
6248'secure' boolean (default off)
6249 global
6250 {not in Vi}
6251 When on, ":autocmd", shell and write commands are not allowed in
6252 ".vimrc" and ".exrc" in the current directory and map commands are
6253 displayed. Switch it off only if you know that you will not run into
6254 problems, or when the 'exrc' option is off. On Unix this option is
6255 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006256 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 'secure' at the end of your ~/.vimrc then.
6258 This option cannot be set from a |modeline| or in the |sandbox|, for
6259 security reasons.
6260
6261 *'selection'* *'sel'*
6262'selection' 'sel' string (default "inclusive")
6263 global
6264 {not in Vi}
6265 This option defines the behavior of the selection. It is only used
6266 in Visual and Select mode.
6267 Possible values:
6268 value past line inclusive ~
6269 old no yes
6270 inclusive yes yes
6271 exclusive yes no
6272 "past line" means that the cursor is allowed to be positioned one
6273 character past the line.
6274 "inclusive" means that the last character of the selection is included
6275 in an operation. For example, when "x" is used to delete the
6276 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006277 When "old" is used and 'virtualedit' allows the cursor to move past
6278 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 Note that when "exclusive" is used and selecting from the end
6280 backwards, you cannot include the last character of a line, when
6281 starting in Normal mode and 'virtualedit' empty.
6282
6283 The 'selection' option is set by the |:behave| command.
6284
6285 *'selectmode'* *'slm'*
6286'selectmode' 'slm' string (default "")
6287 global
6288 {not in Vi}
6289 This is a comma separated list of words, which specifies when to start
6290 Select mode instead of Visual mode, when a selection is started.
6291 Possible values:
6292 mouse when using the mouse
6293 key when using shifted special keys
6294 cmd when using "v", "V" or CTRL-V
6295 See |Select-mode|.
6296 The 'selectmode' option is set by the |:behave| command.
6297
6298 *'sessionoptions'* *'ssop'*
6299'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006300 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 global
6302 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006303 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 feature}
6305 Changes the effect of the |:mksession| command. It is a comma
6306 separated list of words. Each word enables saving and restoring
6307 something:
6308 word save and restore ~
6309 blank empty windows
6310 buffers hidden and unloaded buffers, not just those in windows
6311 curdir the current directory
6312 folds manually created folds, opened/closed folds and local
6313 fold options
6314 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006315 and contain at least one lowercase letter. Only
6316 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 help the help window
6318 localoptions options and mappings local to a window or buffer (not
6319 global values for local options)
6320 options all options and mappings (also global values for local
6321 options)
6322 resize size of the Vim window: 'lines' and 'columns'
6323 sesdir the directory in which the session file is located
6324 will become the current directory (useful with
6325 projects accessed over a network from different
6326 systems)
6327 slash backslashes in file names replaced with forward
6328 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006329 tabpages all tab pages; without this only the current tab page
6330 is restored, so that you can make a session for each
6331 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 unix with Unix end-of-line format (single <NL>), even when
6333 on Windows or DOS
6334 winpos position of the whole Vim window
6335 winsize window sizes
6336
6337 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006338 When neither "curdir" nor "sesdir" is included, file names are stored
6339 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 "slash" and "unix" are useful on Windows when sharing session files
6341 with Unix. The Unix version of Vim cannot source dos format scripts,
6342 but the Windows version of Vim can source unix format scripts.
6343
6344 *'shell'* *'sh'* *E91*
6345'shell' 'sh' string (default $SHELL or "sh",
6346 MS-DOS and Win32: "command.com" or
6347 "cmd.exe", OS/2: "cmd")
6348 global
6349 Name of the shell to use for ! and :! commands. When changing the
6350 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6351 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006352 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 See |option-backslash| about including spaces and backslashes.
6354 Environment variables are expanded |:set_env|.
6355 If the name of the shell contains a space, you might need to enclose
6356 it in quotes. Example: >
6357 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6358< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006359 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 "-f" is not inside the quotes, because it is not part of the command
6361 name. And Vim automagically recognizes the backslashes that are path
6362 separators.
6363 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6364 variable to change the way external commands are executed. See the
6365 libc.inf file of DJGPP.
6366 Under MS-Windows, when the executable ends in ".com" it must be
6367 included. Thus setting the shell to "command.com" or "4dos.com"
6368 works, but "command" and "4dos" do not work for all commands (e.g.,
6369 filtering).
6370 For unknown reasons, when using "4dos.com" the current directory is
6371 changed to "C:\". To avoid this set 'shell' like this: >
6372 :set shell=command.com\ /c\ 4dos
6373< This option cannot be set from a |modeline| or in the |sandbox|, for
6374 security reasons.
6375
6376 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006377'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006378 MS-DOS and Win32, when 'shell' does not
6379 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 global
6381 {not in Vi}
6382 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6383 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6384 systems, the default is set according to the value of 'shell', to
6385 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006386 OS/2 (EMX figures this out itself).
6387 On Unix it can have more than one flag. Each white space separated
6388 part is passed as an argument to the shell command.
6389 See |option-backslash| about including spaces and backslashes.
6390 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 This option cannot be set from a |modeline| or in the |sandbox|, for
6392 security reasons.
6393
6394 *'shellpipe'* *'sp'*
6395'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6396 global
6397 {not in Vi}
6398 {not available when compiled without the |+quickfix|
6399 feature}
6400 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006401 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 including spaces and backslashes.
6403 The name of the temporary file can be represented by "%s" if necessary
6404 (the file name is appended automatically if no %s appears in the value
6405 of this option).
6406 For the Amiga and MS-DOS the default is ">". The output is directly
6407 saved in a file and not echoed to the screen.
6408 For Unix the default it "| tee". The stdout of the compiler is saved
6409 in a file and echoed to the screen. If the 'shell' option is "csh" or
6410 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006411 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6412 default becomes "2>&1| tee". This means that stderr is also included.
6413 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6414 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 The initialization of this option is done after reading the ".vimrc"
6416 and the other initializations, so that when the 'shell' option is set
6417 there, the 'shellpipe' option changes automatically, unless it was
6418 explicitly set before.
6419 When 'shellpipe' is set to an empty string, no redirection of the
6420 ":make" output will be done. This is useful if you use a 'makeprg'
6421 that writes to 'makeef' by itself. If you want no piping, but do
6422 want to include the 'makeef', set 'shellpipe' to a single space.
6423 Don't forget to precede the space with a backslash: ":set sp=\ ".
6424 In the future pipes may be used for filtering and this option will
6425 become obsolete (at least for Unix).
6426 This option cannot be set from a |modeline| or in the |sandbox|, for
6427 security reasons.
6428
6429 *'shellquote'* *'shq'*
6430'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6431 contains "sh" somewhere: "\"")
6432 global
6433 {not in Vi}
6434 Quoting character(s), put around the command passed to the shell, for
6435 the "!" and ":!" commands. The redirection is kept outside of the
6436 quoting. See 'shellxquote' to include the redirection. It's
6437 probably not useful to set both options.
6438 This is an empty string by default. Only known to be useful for
6439 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6440 or bash, where it should be "\"". The default is adjusted according
6441 the value of 'shell', to reduce the need to set this option by the
6442 user. See |dos-shell|.
6443 This option cannot be set from a |modeline| or in the |sandbox|, for
6444 security reasons.
6445
6446 *'shellredir'* *'srr'*
6447'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6448 global
6449 {not in Vi}
6450 String to be used to put the output of a filter command in a temporary
6451 file. See also |:!|. See |option-backslash| about including spaces
6452 and backslashes.
6453 The name of the temporary file can be represented by "%s" if necessary
6454 (the file name is appended automatically if no %s appears in the value
6455 of this option).
6456 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6457 or "zsh" during initializations, the default becomes ">&". If the
6458 'shell' option is "sh", "ksh" or "bash" the default becomes
6459 ">%s 2>&1". This means that stderr is also included.
6460 For Win32, the Unix checks are done and additionally "cmd" is checked
6461 for, which makes the default ">%s 2>&1". Also, the same names with
6462 ".exe" appended are checked for.
6463 The initialization of this option is done after reading the ".vimrc"
6464 and the other initializations, so that when the 'shell' option is set
6465 there, the 'shellredir' option changes automatically unless it was
6466 explicitly set before.
6467 In the future pipes may be used for filtering and this option will
6468 become obsolete (at least for Unix).
6469 This option cannot be set from a |modeline| or in the |sandbox|, for
6470 security reasons.
6471
6472 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6473'shellslash' 'ssl' boolean (default off)
6474 global
6475 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6476 When set, a forward slash is used when expanding file names. This is
6477 useful when a Unix-like shell is used instead of command.com or
6478 cmd.exe. Backward slashes can still be typed, but they are changed to
6479 forward slashes by Vim.
6480 Note that setting or resetting this option has no effect for some
6481 existing file names, thus this option needs to be set before opening
6482 any file for best results. This might change in the future.
6483 'shellslash' only works when a backslash can be used as a path
6484 separator. To test if this is so use: >
6485 if exists('+shellslash')
6486<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006487 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6488'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6489 global
6490 {not in Vi}
6491 When on, use temp files for shell commands. When off use a pipe.
6492 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006493 Currently a pipe is only supported on Unix and MS-Windows 2K and
6494 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006495 :if has("filterpipe")
6496< The advantage of using a pipe is that nobody can read the temp file
6497 and the 'shell' command does not need to support redirection.
6498 The advantage of using a temp file is that the file type and encoding
6499 can be detected.
6500 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6501 |FilterWritePost| autocommands event are not triggered when
6502 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006503 The `system()` function does not respect this option and always uses
6504 temp files.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006505
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 *'shelltype'* *'st'*
6507'shelltype' 'st' number (default 0)
6508 global
6509 {not in Vi} {only for the Amiga}
6510 On the Amiga this option influences the way how the commands work
6511 which use a shell.
6512 0 and 1: always use the shell
6513 2 and 3: use the shell only to filter lines
6514 4 and 5: use shell only for ':sh' command
6515 When not using the shell, the command is executed directly.
6516
6517 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6518 1 and 3: use "shell cmd" to start external commands
6519
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006520 *'shellxescape'* *'sxe'*
6521'shellxescape' 'sxe' string (default: "";
6522 for MS-DOS and MS-Windows: "\"&|<>()@^")
6523 global
6524 {not in Vi}
6525 When 'shellxquote' is set to "(" then the characters listed in this
6526 option will be escaped with a '^' character. This makes it possible
6527 to execute most external commands with cmd.exe.
6528
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 *'shellxquote'* *'sxq'*
6530'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006531 for Win32, when 'shell' is cmd.exe: "("
6532 for Win32, when 'shell' contains "sh"
6533 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 for Unix, when using system(): "\"")
6535 global
6536 {not in Vi}
6537 Quoting character(s), put around the command passed to the shell, for
6538 the "!" and ":!" commands. Includes the redirection. See
6539 'shellquote' to exclude the redirection. It's probably not useful
6540 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006541 When the value is '(' then ')' is appended. When the value is '"('
6542 then ')"' is appended.
6543 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006544 This is an empty string by default on most systems, but is known to be
6545 useful for on Win32 version, either for cmd.exe which automatically
6546 strips off the first and last quote on a command, or 3rd-party shells
6547 such as the MKS Korn Shell or bash, where it should be "\"". The
6548 default is adjusted according the value of 'shell', to reduce the need
6549 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 This option cannot be set from a |modeline| or in the |sandbox|, for
6551 security reasons.
6552
6553 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6554'shiftround' 'sr' boolean (default off)
6555 global
6556 {not in Vi}
6557 Round indent to multiple of 'shiftwidth'. Applies to > and <
6558 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6559 a multiple of 'shiftwidth' (this is Vi compatible).
6560 NOTE: This option is reset when 'compatible' is set.
6561
6562 *'shiftwidth'* *'sw'*
6563'shiftwidth' 'sw' number (default 8)
6564 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006565 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006567 When zero the 'ts' value will be used. Use the |shiftwidth()|
6568 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569
6570 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006571'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6572 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 global
6574 {not in Vi}
6575 This option helps to avoid all the |hit-enter| prompts caused by file
6576 messages, for example with CTRL-G, and to avoid some other messages.
6577 It is a list of flags:
6578 flag meaning when present ~
6579 f use "(3 of 5)" instead of "(file 3 of 5)"
6580 i use "[noeol]" instead of "[Incomplete last line]"
6581 l use "999L, 888C" instead of "999 lines, 888 characters"
6582 m use "[+]" instead of "[Modified]"
6583 n use "[New]" instead of "[New File]"
6584 r use "[RO]" instead of "[readonly]"
6585 w use "[w]" instead of "written" for file write message
6586 and "[a]" instead of "appended" for ':w >> file' command
6587 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6588 "[unix format]" and "[mac]" instead of "[mac format]".
6589 a all of the above abbreviations
6590
6591 o overwrite message for writing a file with subsequent message
6592 for reading a file (useful for ":wn" or when 'autowrite' on)
6593 O message for reading a file overwrites any previous message.
6594 Also for quickfix message (e.g., ":cn").
6595 s don't give "search hit BOTTOM, continuing at TOP" or "search
6596 hit TOP, continuing at BOTTOM" messages
6597 t truncate file message at the start if it is too long to fit
6598 on the command-line, "<" will appear in the left most column.
6599 Ignored in Ex mode.
6600 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006601 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 Ignored in Ex mode.
6603 W don't give "written" or "[w]" when writing a file
6604 A don't give the "ATTENTION" message when an existing swap file
6605 is found.
6606 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006607 c don't give |ins-completion-menu| messages. For example,
6608 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6609 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006610 q use "recording" instead of "recording @a"
6611 F don't give the file info when editing a file, like `:silent`
6612 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613
6614 This gives you the opportunity to avoid that a change between buffers
6615 requires you to hit <Enter>, but still gives as useful a message as
6616 possible for the space available. To get the whole message that you
6617 would have got with 'shm' empty, use ":file!"
6618 Useful values:
6619 shm= No abbreviation of message.
6620 shm=a Abbreviation, but no loss of information.
6621 shm=at Abbreviation, and truncate message when necessary.
6622
6623 NOTE: This option is set to the Vi default value when 'compatible' is
6624 set and to the Vim default value when 'compatible' is reset.
6625
6626 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6627'shortname' 'sn' boolean (default off)
6628 local to buffer
6629 {not in Vi, not in MS-DOS versions}
6630 Filenames are assumed to be 8 characters plus one extension of 3
6631 characters. Multiple dots in file names are not allowed. When this
6632 option is on, dots in file names are replaced with underscores when
6633 adding an extension (".~" or ".swp"). This option is not available
6634 for MS-DOS, because then it would always be on. This option is useful
6635 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6636 or crossdos. When running the Win32 GUI version under Win32s, this
6637 option is always on by default.
6638
6639 *'showbreak'* *'sbr'* *E595*
6640'showbreak' 'sbr' string (default "")
6641 global
6642 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006643 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 feature}
6645 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006646 values are "> " or "+++ ": >
6647 :set showbreak=>\
6648< Note the backslash to escape the trailing space. It's easier like
6649 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006650 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006651< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 comma (in a future version the comma might be used to separate the
6653 part that is shown at the end and at the start of a line).
6654 The characters are highlighted according to the '@' flag in
6655 'highlight'.
6656 Note that tabs after the showbreak will be displayed differently.
6657 If you want the 'showbreak' to appear in between line numbers, add the
6658 "n" flag to 'cpoptions'.
6659
6660 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006661'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6662 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 global
6664 {not in Vi}
6665 {not available when compiled without the
6666 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006667 Show (partial) command in the last line of the screen. Set this
6668 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 In Visual mode the size of the selected area is shown:
6670 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006671 If the number of bytes is different it is also displayed: "2-6"
6672 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006674 - When selecting a block, the size in screen characters:
6675 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 NOTE: This option is set to the Vi default value when 'compatible' is
6677 set and to the Vim default value when 'compatible' is reset.
6678
6679 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6680'showfulltag' 'sft' boolean (default off)
6681 global
6682 {not in Vi}
6683 When completing a word in insert mode (see |ins-completion|) from the
6684 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006685 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 matched a C function, you can see a template for what arguments are
6687 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006688 Note that this doesn't work well together with having "longest" in
6689 'completeopt', because the completion from the search pattern may not
6690 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691
6692 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6693'showmatch' 'sm' boolean (default off)
6694 global
6695 When a bracket is inserted, briefly jump to the matching one. The
6696 jump is only done if the match can be seen on the screen. The time to
6697 show the match can be set with 'matchtime'.
6698 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006699 seen or not).
6700 This option is reset when 'paste' is set and restored when 'paste' is
6701 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 When the 'm' flag is not included in 'cpoptions', typing a character
6703 will immediately move the cursor back to where it belongs.
6704 See the "sm" field in 'guicursor' for setting the cursor shape and
6705 blinking when showing the match.
6706 The 'matchpairs' option can be used to specify the characters to show
6707 matches for. 'rightleft' and 'revins' are used to look for opposite
6708 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006709 Also see the matchparen plugin for highlighting the match when moving
6710 around |pi_paren.txt|.
6711 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712
6713 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6714'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6715 global
6716 If in Insert, Replace or Visual mode put a message on the last line.
6717 Use the 'M' flag in 'highlight' to set the type of highlighting for
6718 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006719 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006720 doesn't mean XIM is really active, especially when 'imactivatekey' is
6721 not set.
6722 NOTE: This option is set to the Vi default value when 'compatible' is
6723 set and to the Vim default value when 'compatible' is reset.
6724
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006725 *'showtabline'* *'stal'*
6726'showtabline' 'stal' number (default 1)
6727 global
6728 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006729 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006730 feature}
6731 The value of this option specifies when the line with tab page labels
6732 will be displayed:
6733 0: never
6734 1: only if there are at least two tab pages
6735 2: always
6736 This is both for the GUI and non-GUI implementation of the tab pages
6737 line.
6738 See |tab-page| for more information about tab pages.
6739
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 *'sidescroll'* *'ss'*
6741'sidescroll' 'ss' number (default 0)
6742 global
6743 {not in Vi}
6744 The minimal number of columns to scroll horizontally. Used only when
6745 the 'wrap' option is off and the cursor is moved off of the screen.
6746 When it is zero the cursor will be put in the middle of the screen.
6747 When using a slow terminal set it to a large number or 0. When using
6748 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6749 commands.
6750
6751 *'sidescrolloff'* *'siso'*
6752'sidescrolloff' 'siso' number (default 0)
6753 global
6754 {not in Vi}
6755 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006756 right of the cursor if 'nowrap' is set. Setting this option to a
6757 value greater than 0 while having |'sidescroll'| also at a non-zero
6758 value makes some context visible in the line you are scrolling in
6759 horizontally (except at beginning of the line). Setting this option
6760 to a large value (like 999) has the effect of keeping the cursor
6761 horizontally centered in the window, as long as one does not come too
6762 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 NOTE: This option is set to 0 when 'compatible' is set.
6764
6765 Example: Try this together with 'sidescroll' and 'listchars' as
6766 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006767 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768
6769 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6770 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006771<
6772 *'signcolumn'* *'scl'*
6773'signcolumn' 'scl' string (default "auto")
6774 local to window
6775 {not in Vi}
6776 {not available when compiled without the |+signs|
6777 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006778 Whether or not to draw the signcolumn. Valid values are:
6779 "auto" only when there is a sign to display
6780 "no" never
6781 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782
6783
6784 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6785'smartcase' 'scs' boolean (default off)
6786 global
6787 {not in Vi}
6788 Override the 'ignorecase' option if the search pattern contains upper
6789 case characters. Only used when the search pattern is typed and
6790 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006791 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6793 recalling the search pattern from history and hitting <Enter>.
6794 NOTE: This option is reset when 'compatible' is set.
6795
6796 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6797'smartindent' 'si' boolean (default off)
6798 local to buffer
6799 {not in Vi}
6800 {not available when compiled without the
6801 |+smartindent| feature}
6802 Do smart autoindenting when starting a new line. Works for C-like
6803 programs, but can also be used for other languages. 'cindent' does
6804 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006805 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006806 setting 'si' has no effect. 'indentexpr' is a more advanced
6807 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 Normally 'autoindent' should also be on when using 'smartindent'.
6809 An indent is automatically inserted:
6810 - After a line ending in '{'.
6811 - After a line starting with a keyword from 'cinwords'.
6812 - Before a line starting with '}' (only with the "O" command).
6813 When typing '}' as the first character in a new line, that line is
6814 given the same indent as the matching '{'.
6815 When typing '#' as the first character in a new line, the indent for
6816 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006817 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6819 When using the ">>" command, lines starting with '#' are not shifted
6820 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006821 NOTE: 'smartindent' is reset when 'compatible' is set.
6822 This option is reset when 'paste' is set and restored when 'paste' is
6823 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824
6825 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6826'smarttab' 'sta' boolean (default off)
6827 global
6828 {not in Vi}
6829 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006830 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6831 <BS> will delete a 'shiftwidth' worth of space at the start of the
6832 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006833 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006834 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6835 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006836 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006838 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006839 This option is reset when 'paste' is set and restored when 'paste' is
6840 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 NOTE: This option is reset when 'compatible' is set.
6842
6843 *'softtabstop'* *'sts'*
6844'softtabstop' 'sts' number (default 0)
6845 local to buffer
6846 {not in Vi}
6847 Number of spaces that a <Tab> counts for while performing editing
6848 operations, like inserting a <Tab> or using <BS>. It "feels" like
6849 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6850 used. This is useful to keep the 'ts' setting at its standard value
6851 of 8, while being able to edit like it is set to 'sts'. However,
6852 commands like "x" still work on the actual characters.
6853 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006854 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006855 'softtabstop' is set to 0 when the 'paste' option is set and restored
6856 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006857 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6858 spaces is minimized by using <Tab>s.
6859 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6860 set.
6861 NOTE: This option is set to 0 when 'compatible' is set.
6862
Bram Moolenaar217ad922005-03-20 22:37:15 +00006863 *'spell'* *'nospell'*
6864'spell' boolean (default off)
6865 local to window
6866 {not in Vi}
6867 {not available when compiled without the |+syntax|
6868 feature}
6869 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006870 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006871
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006872 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006873'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006874 local to buffer
6875 {not in Vi}
6876 {not available when compiled without the |+syntax|
6877 feature}
6878 Pattern to locate the end of a sentence. The following word will be
6879 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006880 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006881 When this check is not wanted make this option empty.
6882 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006883 Be careful with special characters, see |option-backslash| about
6884 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006885 To set this option automatically depending on the language, see
6886 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006887
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006888 *'spellfile'* *'spf'*
6889'spellfile' 'spf' string (default empty)
6890 local to buffer
6891 {not in Vi}
6892 {not available when compiled without the |+syntax|
6893 feature}
6894 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006895 commands. It must end in ".{encoding}.add". You need to include the
6896 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006897 *E765*
6898 It may also be a comma separated list of names. A count before the
6899 |zg| and |zw| commands can be used to access each. This allows using
6900 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006901 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006902 you: Using the first directory in 'runtimepath' that is writable. If
6903 there is no "spell" directory yet it will be created. For the file
6904 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006905 ignoring the region.
6906 The resulting ".spl" file will be used for spell checking, it does not
6907 have to appear in 'spelllang'.
6908 Normally one file is used for all regions, but you can add the region
6909 name if you want to. However, it will then only be used when
6910 'spellfile' is set to it, for entries in 'spelllang' only files
6911 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006912 This option cannot be set from a |modeline| or in the |sandbox|, for
6913 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006914
Bram Moolenaar217ad922005-03-20 22:37:15 +00006915 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006916'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006917 local to buffer
6918 {not in Vi}
6919 {not available when compiled without the |+syntax|
6920 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006921 A comma separated list of word list names. When the 'spell' option is
6922 on spellchecking will be done for these languages. Example: >
6923 set spelllang=en_us,nl,medical
6924< This means US English, Dutch and medical words are recognized. Words
6925 that are not recognized will be highlighted.
6926 The word list name must not include a comma or dot. Using a dash is
6927 recommended to separate the two letter language name from a
6928 specification. Thus "en-rare" is used for rare English words.
6929 A region name must come last and have the form "_xx", where "xx" is
6930 the two-letter, lower case region name. You can use more than one
6931 region by listing them: "en_us,en_ca" supports both US and Canadian
6932 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006933 Britain. (Note: currently en_au and en_nz dictionaries are older than
6934 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006935 If the name "cjk" is included East Asian characters are excluded from
6936 spell checking. This is useful when editing text that also has Asian
6937 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006938 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006939 As a special case the name of a .spl file can be given as-is. The
6940 first "_xx" in the name is removed and used as the region name
6941 (_xx is an underscore, two letters and followed by a non-letter).
6942 This is mainly for testing purposes. You must make sure the correct
6943 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006944 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006945 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6946 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006947 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006948
Bram Moolenaar98692072006-02-04 00:57:42 +00006949 If the |spellfile.vim| plugin is active and you use a language name
6950 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6951 will ask you if you want to download the file.
6952
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006953 After this option has been set successfully, Vim will source the files
6954 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006955 up to the first comma, dot or underscore.
6956 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006957
6958
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006959 *'spellsuggest'* *'sps'*
6960'spellsuggest' 'sps' string (default "best")
6961 global
6962 {not in Vi}
6963 {not available when compiled without the |+syntax|
6964 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006965 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006966 the |spellsuggest()| function. This is a comma-separated list of
6967 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006968
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006969 best Internal method that works best for English. Finds
6970 changes like "fast" and uses a bit of sound-a-like
6971 scoring to improve the ordering.
6972
6973 double Internal method that uses two methods and mixes the
6974 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006975 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006976 word. That only works when the language specifies
6977 sound folding. Can be slow and doesn't always give
6978 better results.
6979
6980 fast Internal method that only checks for simple changes:
6981 character inserts/deletes/swaps. Works well for
6982 simple typing mistakes.
6983
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006984 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006985 Not used for |spellsuggest()|. The number of
6986 suggestions is never more than the value of 'lines'
6987 minus two.
6988
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006989 file:{filename} Read file {filename}, which must have two columns,
6990 separated by a slash. The first column contains the
6991 bad word, the second column the suggested good word.
6992 Example:
6993 theribal/terrible ~
6994 Use this for common mistakes that do not appear at the
6995 top of the suggestion list with the internal methods.
6996 Lines without a slash are ignored, use this for
6997 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006998 The word in the second column must be correct,
6999 otherwise it will not be used. Add the word to an
7000 ".add" file if it is currently flagged as a spelling
7001 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007002 The file is used for all languages.
7003
7004 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7005 trouble with spaces. |v:val| holds the badly spelled
7006 word. The expression must evaluate to a List of
7007 Lists, each with a suggestion and a score.
7008 Example:
7009 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007010 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007011 internal methods use. A lower score is better.
7012 This may invoke |spellsuggest()| if you temporarily
7013 set 'spellsuggest' to exclude the "expr:" part.
7014 Errors are silently ignored, unless you set the
7015 'verbose' option to a non-zero value.
7016
7017 Only one of "best", "double" or "fast" may be used. The others may
7018 appear several times in any order. Example: >
7019 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7020<
7021 This option cannot be set from a |modeline| or in the |sandbox|, for
7022 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007023
7024
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7026'splitbelow' 'sb' boolean (default off)
7027 global
7028 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007029 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 feature}
7031 When on, splitting a window will put the new window below the current
7032 one. |:split|
7033
7034 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7035'splitright' 'spr' boolean (default off)
7036 global
7037 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007038 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007039 feature}
7040 When on, splitting a window will put the new window right of the
7041 current one. |:vsplit|
7042
7043 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7044'startofline' 'sol' boolean (default on)
7045 global
7046 {not in Vi}
7047 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007048 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007049 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007050 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 with a linewise operator, with "%" with a count and to buffer changing
7052 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7053 only has a line number, e.g., ":25" or ":+".
7054 In case of buffer changing commands the cursor is placed at the column
7055 where it was the last time the buffer was edited.
7056 NOTE: This option is set when 'compatible' is set.
7057
Bram Moolenaar00654022011-02-25 14:42:19 +01007058 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007060 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 {not in Vi}
7062 {not available when compiled without the |+statusline|
7063 feature}
7064 When nonempty, this option determines the content of the status line.
7065 Also see |status-line|.
7066
7067 The option consists of printf style '%' items interspersed with
7068 normal text. Each status line item is of the form:
7069 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007070 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007071 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007072
Bram Moolenaar238a5642006-02-21 22:12:05 +00007073 When the option starts with "%!" then it is used as an expression,
7074 evaluated and the result is used as the option value. Example: >
7075 :set statusline=%!MyStatusLine()
7076< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007077 Note that the "%!" expression is evaluated in the context of the
7078 current window and buffer, while %{} items are evaluated in the
7079 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007080
7081 When there is error while evaluating the option then it will be made
7082 empty to avoid further errors. Otherwise screen updating would loop.
7083
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 Note that the only effect of 'ruler' when this option is set (and
7085 'laststatus' is 2) is controlling the output of |CTRL-G|.
7086
7087 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007088 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007090 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 minwid Minimum width of the item, padding as set by '-' & '0'.
7092 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007093 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 on the left for text items. Numeric items will be
7095 shifted down to maxwid-2 digits followed by '>'number
7096 where number is the amount of missing digits, much like
7097 an exponential notation.
7098 item A one letter code as described below.
7099
7100 Following is a description of the possible statusline items. The
7101 second character in "item" is the type:
7102 N for number
7103 S for string
7104 F for flags as described below
7105 - not applicable
7106
7107 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007108 f S Path to the file in the buffer, as typed or relative to current
7109 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 F S Full path to the file in the buffer.
7111 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007112 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007114 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007116 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007118 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007120 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7122 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007123 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7125 being used: "<keymap>"
7126 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007127 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 B N As above, in hexadecimal.
7129 o N Byte number in file of byte under cursor, first byte is 1.
7130 Mnemonic: Offset from start of file (with one added)
7131 {not available when compiled without |+byte_offset| feature}
7132 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007133 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 l N Line number.
7135 L N Number of lines in buffer.
7136 c N Column number.
7137 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007138 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 p N Percentage through file in lines as in |CTRL-G|.
7140 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007141 percentage described for 'ruler'. Always 3 in length, unless
7142 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007143 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007145 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007146 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 ( - Start of item group. Can be used for setting the width and
7148 alignment of a section. Must be followed by %) somewhere.
7149 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007150 T N For 'tabline': start of tab page N label. Use %T after the last
7151 label. This information is used for mouse clicks.
7152 X N For 'tabline': start of close tab N label. Use %X after the
7153 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7154 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 < - Where to truncate line if too long. Default is at the start.
7156 No width fields allowed.
7157 = - Separation point between left and right aligned items.
7158 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007159 # - Set highlight group. The name must follow and then a # again.
7160 Thus use %#HLname# for highlight group HLname. The same
7161 highlighting is used, also for the statusline of non-current
7162 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007164 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 The difference between User{N} and StatusLine will be applied
7166 to StatusLineNC for the statusline of non-current windows.
7167 The number N must be between 1 and 9. See |hl-User1..9|
7168
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007169 When displaying a flag, Vim removes the leading comma, if any, when
7170 that flag comes right after plaintext. This will make a nice display
7171 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172
Bram Moolenaar582fd852005-03-28 20:58:01 +00007173 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 not set) and a minwid is not set for the group, the whole group will
7175 become empty. This will make a group like the following disappear
7176 completely from the statusline when none of the flags are set. >
7177 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007178< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 Beware that an expression is evaluated each and every time the status
7180 line is displayed. The current buffer and current window will be set
7181 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007182 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007184 real current buffer.
7185
Bram Moolenaar30b65812012-07-12 22:01:11 +02007186 The 'statusline' option will be evaluated in the |sandbox| if set from
7187 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007188
7189 It is not allowed to change text or jump to another window while
7190 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191
7192 If the statusline is not updated when you want it (e.g., after setting
7193 a variable that's used in an expression), you can force an update by
7194 setting an option without changing its value. Example: >
7195 :let &ro = &ro
7196
7197< A result of all digits is regarded a number for display purposes.
7198 Otherwise the result is taken as flag text and applied to the rules
7199 described above.
7200
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007201 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7203 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7204
7205 Examples:
7206 Emulate standard status line with 'ruler' set >
7207 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7208< Similar, but add ASCII value of char under the cursor (like "ga") >
7209 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7210< Display byte count and byte value, modified flag in red. >
7211 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7212 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7213< Display a ,GZ flag if a compressed file is loaded >
7214 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7215< In the |:autocmd|'s: >
7216 :let b:gzflag = 1
7217< And: >
7218 :unlet b:gzflag
7219< And define this function: >
7220 :function VarExists(var, val)
7221 : if exists(a:var) | return a:val | else | return '' | endif
7222 :endfunction
7223<
7224 *'suffixes'* *'su'*
7225'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7226 global
7227 {not in Vi}
7228 Files with these suffixes get a lower priority when multiple files
7229 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007230 suffixes. Spaces after the comma are ignored. A dot is also seen as
7231 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 separator, precede it with a backslash (see |option-backslash| about
7233 including spaces and backslashes).
7234 See 'wildignore' for completely ignoring files.
7235 The use of |:set+=| and |:set-=| is preferred when adding or removing
7236 suffixes from the list. This avoids problems when a future version
7237 uses another default.
7238
7239 *'suffixesadd'* *'sua'*
7240'suffixesadd' 'sua' string (default "")
7241 local to buffer
7242 {not in Vi}
7243 {not available when compiled without the
7244 |+file_in_path| feature}
7245 Comma separated list of suffixes, which are used when searching for a
7246 file for the "gf", "[I", etc. commands. Example: >
7247 :set suffixesadd=.java
7248<
7249 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7250'swapfile' 'swf' boolean (default on)
7251 local to buffer
7252 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 swapfile is not wanted for a specific buffer. For example, with
7255 confidential information that even root must not be able to access.
7256 Careful: All text will be in memory:
7257 - Don't use this for big files.
7258 - Recovery will be impossible!
7259 A swapfile will only be present when |'updatecount'| is non-zero and
7260 'swapfile' is set.
7261 When 'swapfile' is reset, the swap file for the current buffer is
7262 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7263 non-zero, a swap file is immediately created.
7264 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007265 If you want to open a new buffer without creating a swap file for it,
7266 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267
7268 This option is used together with 'bufhidden' and 'buftype' to
7269 specify special kinds of buffers. See |special-buffers|.
7270
7271 *'swapsync'* *'sws'*
7272'swapsync' 'sws' string (default "fsync")
7273 global
7274 {not in Vi}
7275 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007276 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 When this option is empty parts of the swap file may be in memory and
7278 not written to disk. When the system crashes you may lose more work.
7279 On Unix the system does a sync now and then without Vim asking for it,
7280 so the disadvantage of setting this option off is small. On some
7281 systems the swap file will not be written at all. For a unix system
7282 setting it to "sync" will use the sync() call instead of the default
7283 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007284 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285
7286 *'switchbuf'* *'swb'*
7287'switchbuf' 'swb' string (default "")
7288 global
7289 {not in Vi}
7290 This option controls the behavior when switching between buffers.
7291 Possible values (comma separated list):
7292 useopen If included, jump to the first open window that
7293 contains the specified buffer (if there is one).
7294 Otherwise: Do not examine other windows.
7295 This setting is checked with |quickfix| commands, when
7296 jumping to errors (":cc", ":cn", "cp", etc.). It is
7297 also used in all buffer related split commands, for
7298 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007299 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007300 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007302 a buffer for a |quickfix| command that display errors.
7303 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007304 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007305 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007306 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007308 *'synmaxcol'* *'smc'*
7309'synmaxcol' 'smc' number (default 3000)
7310 local to buffer
7311 {not in Vi}
7312 {not available when compiled without the |+syntax|
7313 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007314 Maximum column in which to search for syntax items. In long lines the
7315 text after this column is not highlighted and following lines may not
7316 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007317 This helps to avoid very slow redrawing for an XML file that is one
7318 long line.
7319 Set to zero to remove the limit.
7320
Bram Moolenaar071d4272004-06-13 20:20:40 +00007321 *'syntax'* *'syn'*
7322'syntax' 'syn' string (default empty)
7323 local to buffer
7324 {not in Vi}
7325 {not available when compiled without the |+syntax|
7326 feature}
7327 When this option is set, the syntax with this name is loaded, unless
7328 syntax highlighting has been switched off with ":syntax off".
7329 Otherwise this option does not always reflect the current syntax (the
7330 b:current_syntax variable does).
7331 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007332 not automatically recognized. Example, in an IDL file:
7333 /* vim: set syntax=idl : */ ~
7334 When a dot appears in the value then this separates two filetype
7335 names. Example:
7336 /* vim: set syntax=c.doxygen : */ ~
7337 This will use the "c" syntax first, then the "doxygen" syntax.
7338 Note that the second one must be prepared to be loaded as an addition,
7339 otherwise it will be skipped. More than one dot may appear.
7340 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007341 :set syntax=OFF
7342< To switch syntax highlighting on according to the current value of the
7343 'filetype' option: >
7344 :set syntax=ON
7345< What actually happens when setting the 'syntax' option is that the
7346 Syntax autocommand event is triggered with the value as argument.
7347 This option is not copied to another buffer, independent of the 's' or
7348 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007349 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007351 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007352'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007353 global
7354 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007355 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007356 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007357 When nonempty, this option determines the content of the tab pages
7358 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007359 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007360
7361 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007362 option and only when there is no GUI tab line. When 'e' is in
7363 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007364 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007365
7366 The value is evaluated like with 'statusline'. You can use
7367 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007368 the text to be displayed. Use "%1T" for the first label, "%2T" for
7369 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007370
7371 Keep in mind that only one of the tab pages is the current one, others
7372 are invisible and you can't jump to their windows.
7373
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007374
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007375 *'tabpagemax'* *'tpm'*
7376'tabpagemax' 'tpm' number (default 10)
7377 global
7378 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007379 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007380 feature}
7381 Maximum number of tab pages to be opened by the |-p| command line
7382 argument or the ":tab all" command. |tabpage|
7383
7384
7385 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386'tabstop' 'ts' number (default 8)
7387 local to buffer
7388 Number of spaces that a <Tab> in the file counts for. Also see
7389 |:retab| command, and 'softtabstop' option.
7390
7391 Note: Setting 'tabstop' to any other value than 8 can make your file
7392 appear wrong in many places (e.g., when printing it).
7393
7394 There are four main ways to use tabs in Vim:
7395 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7396 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007397 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 behave like a tab appears every 4 (or 3) characters.
7399 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7400 'expandtab'. This way you will always insert spaces. The
7401 formatting will never be messed up when 'tabstop' is changed.
7402 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007403 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 works when using Vim to edit the file.
7405 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7406 'noexpandtab'. This should then work (for initial indents only)
7407 for any tabstop setting that people use. It might be nice to have
7408 tabs after the first non-blank inserted as spaces if you do this
7409 though. Otherwise aligned comments will be wrong when 'tabstop' is
7410 changed.
7411
7412 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7413'tagbsearch' 'tbs' boolean (default on)
7414 global
7415 {not in Vi}
7416 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007417 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418 searching makes searching for a tag a LOT faster, but a linear search
7419 will find more tags if the tags file wasn't properly sorted.
7420 Vim normally assumes that your tags files are sorted, or indicate that
7421 they are not sorted. Only when this is not the case does the
7422 'tagbsearch' option need to be switched off.
7423
7424 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007425 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007426 certain files, or retry all files with a linear search. When
7427 'tagbsearch' is off, only a linear search is done.
7428
7429 Linear searching is done anyway, for one file, when Vim finds a line
7430 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007431 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432< [The whitespace before and after the '0' must be a single <Tab>]
7433
7434 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007435 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 instead of a normal tag name, a retry is done with a linear search.
7437 Tags in unsorted tags files, and matches with different case will only
7438 be found in the retry.
7439
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007440 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007441 linear search can be avoided when case is ignored. Use a value of '2'
7442 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7443 sorted with the -f switch to "sort" in most unices, as in the command:
7444 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7445 (at least 5.5) the --sort=foldcase switch can be used for this as
7446 well. Note that case must be folded to uppercase for this to work.
7447
7448 By default, tag searches are case-sensitive. Case is ignored when
7449 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7450 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007451 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7452 'tagcase' is "smart", and the pattern contains only lowercase
7453 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454
7455 When 'tagbsearch' is off, tags searching is slower when a full match
7456 exists, but faster when no full match exists. Tags in unsorted tags
7457 files may only be found with 'tagbsearch' off.
7458 When the tags file is not sorted, or sorted in a wrong way (not on
7459 ASCII byte value), 'tagbsearch' should be off, or the line given above
7460 must be included in the tags file.
7461 This option doesn't affect commands that find all matching tags (e.g.,
7462 command-line completion and ":help").
7463 {Vi: always uses binary search in some versions}
7464
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007465 *'tagcase'* *'tc'*
7466'tagcase' 'tc' string (default "followic")
7467 global or local to buffer |global-local|
7468 {not in Vi}
7469 This option specifies how case is handled when searching the tags
7470 file:
7471 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007472 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007473 ignore Ignore case
7474 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007475 smart Ignore case unless an upper case letter is used
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007476
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 *'taglength'* *'tl'*
7478'taglength' 'tl' number (default 0)
7479 global
7480 If non-zero, tags are significant up to this number of characters.
7481
7482 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7483'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7484 global
7485 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007486 If on and using a tags file in another directory, file names in that
7487 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 NOTE: This option is set to the Vi default value when 'compatible' is
7489 set and to the Vim default value when 'compatible' is reset.
7490
7491 *'tags'* *'tag'* *E433*
7492'tags' 'tag' string (default "./tags,tags", when compiled with
7493 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7494 global or local to buffer |global-local|
7495 Filenames for the tag command, separated by spaces or commas. To
7496 include a space or comma in a file name, precede it with a backslash
7497 (see |option-backslash| about including spaces and backslashes).
7498 When a file name starts with "./", the '.' is replaced with the path
7499 of the current file. But only when the 'd' flag is not included in
7500 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7501 |tags-option|.
7502 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007503 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7504 find all files named "tags" below "/lib". The filename itself cannot
7505 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7506 files called "tags?". {not available when compiled without the
7507 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007508 The |tagfiles()| function can be used to get a list of the file names
7509 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7511 files are also supported. They are automatically recognized. The
7512 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7513 differences are ignored (MS-Windows). |emacs-tags|
7514 The use of |:set+=| and |:set-=| is preferred when adding or removing
7515 file names from the list. This avoids problems when a future version
7516 uses another default.
7517 {Vi: default is "tags /usr/lib/tags"}
7518
7519 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7520'tagstack' 'tgst' boolean (default on)
7521 global
7522 {not in all versions of Vi}
7523 When on, the |tagstack| is used normally. When off, a ":tag" or
7524 ":tselect" command with an argument will not push the tag onto the
7525 tagstack. A following ":tag" without an argument, a ":pop" command or
7526 any other command that uses the tagstack will use the unmodified
7527 tagstack, but does change the pointer to the active entry.
7528 Resetting this option is useful when using a ":tag" command in a
7529 mapping which should not change the tagstack.
7530
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007531 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007532'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007533 global
7534 {not in Vi}
7535 {only available when compiled with the |+tcl/dyn|
7536 feature}
7537 Specifies the name of the Tcl shared library. The default is
7538 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007539 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007540 This option cannot be set from a |modeline| or in the |sandbox|, for
7541 security reasons.
7542
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 *'term'* *E529* *E530* *E531*
7544'term' string (default is $TERM, if that fails:
7545 in the GUI: "builtin_gui"
7546 on Amiga: "amiga"
7547 on BeOS: "beos-ansi"
7548 on Mac: "mac-ansi"
7549 on MiNT: "vt52"
7550 on MS-DOS: "pcterm"
7551 on OS/2: "os2ansi"
7552 on Unix: "ansi"
7553 on VMS: "ansi"
7554 on Win 32: "win32")
7555 global
7556 Name of the terminal. Used for choosing the terminal control
7557 characters. Environment variables are expanded |:set_env|.
7558 For example: >
7559 :set term=$TERM
7560< See |termcap|.
7561
7562 *'termbidi'* *'tbidi'*
7563 *'notermbidi'* *'notbidi'*
7564'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7565 global
7566 {not in Vi}
7567 {only available when compiled with the |+arabic|
7568 feature}
7569 The terminal is in charge of Bi-directionality of text (as specified
7570 by Unicode). The terminal is also expected to do the required shaping
7571 that some languages (such as Arabic) require.
7572 Setting this option implies that 'rightleft' will not be set when
7573 'arabic' is set and the value of 'arabicshape' will be ignored.
7574 Note that setting 'termbidi' has the immediate effect that
7575 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7576 This option is reset when the GUI is started.
7577 For further details see |arabic.txt|.
7578
7579 *'termencoding'* *'tenc'*
7580'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7581 Macintosh GUI: "macroman")
7582 global
7583 {only available when compiled with the |+multi_byte|
7584 feature}
7585 {not in Vi}
7586 Encoding used for the terminal. This specifies what character
7587 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007588 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007589 display). Except for the Mac when 'macatsui' is off, then
7590 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 *E617*
7592 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7593 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7594 Any attempts to set a different value will be rejected, and an error
7595 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007596 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 because the Win32 system always passes Unicode characters.
7598 When empty, the same encoding is used as for the 'encoding' option.
7599 This is the normal value.
7600 Not all combinations for 'termencoding' and 'encoding' are valid. See
7601 |encoding-table|.
7602 The value for this option must be supported by internal conversions or
7603 iconv(). When this is not possible no conversion will be done and you
7604 will probably experience problems with non-ASCII characters.
7605 Example: You are working with the locale set to euc-jp (Japanese) and
7606 want to edit a UTF-8 file: >
7607 :let &termencoding = &encoding
7608 :set encoding=utf-8
7609< You need to do this when your system has no locale support for UTF-8.
7610
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007611 *'termguicolors'* *'tgc'*
7612'termguicolors' 'tgc' boolean (default off)
7613 global
7614 {not in Vi}
7615 {not available when compiled without the
7616 |+termguicolors| feature}
7617 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7618 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7619 compatible terminal.
7620 If setting this option does not work (produces a colorless UI)
7621 reading |xterm-true-color| might help.
7622
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 *'terse'* *'noterse'*
7624'terse' boolean (default off)
7625 global
7626 When set: Add 's' flag to 'shortmess' option (this makes the message
7627 for a search that hits the start or end of the file not being
7628 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7629 shortens a lot of messages}
7630
7631 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7632'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7633 global
7634 {not in Vi}
7635 This option is obsolete. Use 'fileformats'.
7636 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7637 set to the default value for the current system. When 'textauto' is
7638 reset, 'fileformats' is made empty.
7639 NOTE: This option is set to the Vi default value when 'compatible' is
7640 set and to the Vim default value when 'compatible' is reset.
7641
7642 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7643'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7644 others: default off)
7645 local to buffer
7646 {not in Vi}
7647 This option is obsolete. Use 'fileformat'.
7648 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7649 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7650 "unix".
7651
7652 *'textwidth'* *'tw'*
7653'textwidth' 'tw' number (default 0)
7654 local to buffer
7655 {not in Vi}
7656 Maximum width of text that is being inserted. A longer line will be
7657 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007658 this.
7659 'textwidth' is set to 0 when the 'paste' option is set and restored
7660 when 'paste' is reset.
7661 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007663 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 NOTE: This option is set to 0 when 'compatible' is set.
7665
7666 *'thesaurus'* *'tsr'*
7667'thesaurus' 'tsr' string (default "")
7668 global or local to buffer |global-local|
7669 {not in Vi}
7670 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007671 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 the file should contain words with similar meaning, separated by
7673 non-keyword characters (white space is preferred). Maximum line
7674 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007675 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007676 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007677 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007678 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 after a comma are ignored, otherwise spaces are included in the file
7680 name. See |option-backslash| about using backslashes.
7681 The use of |:set+=| and |:set-=| is preferred when adding or removing
7682 directories from the list. This avoids problems when a future version
7683 uses another default.
7684 Backticks cannot be used in this option for security reasons.
7685
7686 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7687'tildeop' 'top' boolean (default off)
7688 global
7689 {not in Vi}
7690 When on: The tilde command "~" behaves like an operator.
7691 NOTE: This option is reset when 'compatible' is set.
7692
7693 *'timeout'* *'to'* *'notimeout'* *'noto'*
7694'timeout' 'to' boolean (default on)
7695 global
7696 *'ttimeout'* *'nottimeout'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007697'ttimeout' boolean (default off, set in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 global
7699 {not in Vi}
7700 These two options together determine the behavior when part of a
7701 mapped key sequence or keyboard code has been received:
7702
7703 'timeout' 'ttimeout' action ~
7704 off off do not time out
7705 on on or off time out on :mappings and key codes
7706 off on time out on key codes
7707
7708 If both options are off, Vim will wait until either the complete
7709 mapping or key sequence has been received, or it is clear that there
7710 is no mapping or key sequence for the received characters. For
7711 example: if you have mapped "vl" and Vim has received 'v', the next
7712 character is needed to see if the 'v' is followed by an 'l'.
7713 When one of the options is on, Vim will wait for about 1 second for
7714 the next character to arrive. After that the already received
7715 characters are interpreted as single characters. The waiting time can
7716 be changed with the 'timeoutlen' option.
7717 On slow terminals or very busy systems timing out may cause
7718 malfunctioning cursor keys. If both options are off, Vim waits
7719 forever after an entered <Esc> if there are key codes that start
7720 with <Esc>. You will have to type <Esc> twice. If you do not have
7721 problems with key codes, but would like to have :mapped key
7722 sequences not timing out in 1 second, set the 'ttimeout' option and
7723 reset the 'timeout' option.
7724
7725 NOTE: 'ttimeout' is reset when 'compatible' is set.
7726
7727 *'timeoutlen'* *'tm'*
7728'timeoutlen' 'tm' number (default 1000)
7729 global
7730 {not in all versions of Vi}
7731 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02007732'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|))
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 global
7734 {not in Vi}
7735 The time in milliseconds that is waited for a key code or mapped key
7736 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7737 when part of a command has been typed.
7738 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7739 different timeout value for key codes is desired set 'ttimeoutlen' to
7740 a non-negative number.
7741
7742 ttimeoutlen mapping delay key code delay ~
7743 < 0 'timeoutlen' 'timeoutlen'
7744 >= 0 'timeoutlen' 'ttimeoutlen'
7745
7746 The timeout only happens when the 'timeout' and 'ttimeout' options
7747 tell so. A useful setting would be >
7748 :set timeout timeoutlen=3000 ttimeoutlen=100
7749< (time out on mapping after three seconds, time out on key codes after
7750 a tenth of a second).
7751
7752 *'title'* *'notitle'*
7753'title' boolean (default off, on when title can be restored)
7754 global
7755 {not in Vi}
7756 {not available when compiled without the |+title|
7757 feature}
7758 When on, the title of the window will be set to the value of
7759 'titlestring' (if it is not empty), or to:
7760 filename [+=-] (path) - VIM
7761 Where:
7762 filename the name of the file being edited
7763 - indicates the file cannot be modified, 'ma' off
7764 + indicates the file was modified
7765 = indicates the file is read-only
7766 =+ indicates the file is read-only and modified
7767 (path) is the path of the file being edited
7768 - VIM the server name |v:servername| or "VIM"
7769 Only works if the terminal supports setting window titles
7770 (currently Amiga console, Win32 console, all GUI versions and
7771 terminals with a non- empty 't_ts' option - these are Unix xterm and
7772 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7773 *X11*
7774 When Vim was compiled with HAVE_X11 defined, the original title will
7775 be restored if possible. The output of ":version" will include "+X11"
7776 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7777 works for the icon name |'icon'|.
7778 But: When Vim was started with the |-X| argument, restoring the title
7779 will not work (except in the GUI).
7780 If the title cannot be restored, it is set to the value of 'titleold'.
7781 You might want to restore the title outside of Vim then.
7782 When using an xterm from a remote machine you can use this command:
7783 rsh machine_name xterm -display $DISPLAY &
7784 then the WINDOWID environment variable should be inherited and the
7785 title of the window should change back to what it should be after
7786 exiting Vim.
7787
7788 *'titlelen'*
7789'titlelen' number (default 85)
7790 global
7791 {not in Vi}
7792 {not available when compiled without the |+title|
7793 feature}
7794 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007795 title. When the title is longer, only the end of the path name is
7796 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 Using a percentage makes this adapt to the width of the window. But
7798 it won't work perfectly, because the actual number of characters
7799 available also depends on the font used and other things in the title
7800 bar. When 'titlelen' is zero the full path is used. Otherwise,
7801 values from 1 to 30000 percent can be used.
7802 'titlelen' is also used for the 'titlestring' option.
7803
7804 *'titleold'*
7805'titleold' string (default "Thanks for flying Vim")
7806 global
7807 {not in Vi}
7808 {only available when compiled with the |+title|
7809 feature}
7810 This option will be used for the window title when exiting Vim if the
7811 original title cannot be restored. Only happens if 'title' is on or
7812 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007813 This option cannot be set from a |modeline| or in the |sandbox|, for
7814 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 *'titlestring'*
7816'titlestring' string (default "")
7817 global
7818 {not in Vi}
7819 {not available when compiled without the |+title|
7820 feature}
7821 When this option is not empty, it will be used for the title of the
7822 window. This happens only when the 'title' option is on.
7823 Only works if the terminal supports setting window titles (currently
7824 Amiga console, Win32 console, all GUI versions and terminals with a
7825 non-empty 't_ts' option).
7826 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007827 be restored if possible, see |X11|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007828 When this option contains printf-style '%' items, they will be
7829 expanded according to the rules used for 'statusline'.
7830 Example: >
7831 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7832 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7833< The value of 'titlelen' is used to align items in the middle or right
7834 of the available space.
7835 Some people prefer to have the file name first: >
7836 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7837< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007838 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 separating space only when needed.
7840 NOTE: Use of special characters in 'titlestring' may cause the display
7841 to be garbled (e.g., when it contains a CR or NL character).
7842 {not available when compiled without the |+statusline| feature}
7843
7844 *'toolbar'* *'tb'*
7845'toolbar' 'tb' string (default "icons,tooltips")
7846 global
7847 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7848 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007849 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 possible values are:
7851 icons Toolbar buttons are shown with icons.
7852 text Toolbar buttons shown with text.
7853 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007854 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 tooltips Tooltips are active for toolbar buttons.
7856 Tooltips refer to the popup help text which appears after the mouse
7857 cursor is placed over a toolbar button for a brief moment.
7858
7859 If you want the toolbar to be shown with icons as well as text, do the
7860 following: >
7861 :set tb=icons,text
7862< Motif and Athena cannot display icons and text at the same time. They
7863 will show icons if both are requested.
7864
7865 If none of the strings specified in 'toolbar' are valid or if
7866 'toolbar' is empty, this option is ignored. If you want to disable
7867 the toolbar, you need to set the 'guioptions' option. For example: >
7868 :set guioptions-=T
7869< Also see |gui-toolbar|.
7870
7871 *'toolbariconsize'* *'tbis'*
7872'toolbariconsize' 'tbis' string (default "small")
7873 global
7874 {not in Vi}
7875 {only in the GTK+ 2 GUI}
7876 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007877 tiny Use tiny icons.
7878 small Use small icons (default).
7879 medium Use medium-sized icons.
7880 large Use large icons.
7881 huge Use even larger icons.
7882 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007884 the current theme. Common dimensions are giant=48x48, huge=32x32,
7885 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886
7887 If 'toolbariconsize' is empty, the global default size as determined
7888 by user preferences or the current theme is used.
7889
7890 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7891'ttybuiltin' 'tbi' boolean (default on)
7892 global
7893 {not in Vi}
7894 When on, the builtin termcaps are searched before the external ones.
7895 When off the builtin termcaps are searched after the external ones.
7896 When this option is changed, you should set the 'term' option next for
7897 the change to take effect, for example: >
7898 :set notbi term=$TERM
7899< See also |termcap|.
7900 Rationale: The default for this option is "on", because the builtin
7901 termcap entries are generally better (many systems contain faulty
7902 xterm entries...).
7903
7904 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7905'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7906 sun-cmd, screen, rxvt, dtterm or
7907 iris-ansi; also on when running Vim in
7908 a DOS console)
7909 global
7910 {not in Vi}
7911 Indicates a fast terminal connection. More characters will be sent to
7912 the screen for redrawing, instead of using insert/delete line
7913 commands. Improves smoothness of redrawing when there are multiple
7914 windows and the terminal does not support a scrolling region.
7915 Also enables the extra writing of characters at the end of each screen
7916 line for lines that wrap. This helps when using copy/paste with the
7917 mouse in an xterm and other terminals.
7918
7919 *'ttymouse'* *'ttym'*
7920'ttymouse' 'ttym' string (default depends on 'term')
7921 global
7922 {not in Vi}
7923 {only in Unix and VMS, doesn't work in the GUI; not
7924 available when compiled without |+mouse|}
7925 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007926 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 *xterm-mouse*
7928 xterm xterm-like mouse handling. The mouse generates
7929 "<Esc>[Mscr", where "scr" is three bytes:
7930 "s" = button state
7931 "c" = column plus 33
7932 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007933 This only works up to 223 columns! See "dec",
7934 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 xterm2 Works like "xterm", but with the xterm reporting the
7936 mouse position while the mouse is dragged. This works
7937 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007938 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 work. See below for how Vim detects this
7940 automatically.
7941 *netterm-mouse*
7942 netterm NetTerm mouse handling. The mouse generates
7943 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7944 for the row and column.
7945 *dec-mouse*
7946 dec DEC terminal mouse handling. The mouse generates a
7947 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007948 This is also available for an Xterm, if it was
7949 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 *jsbterm-mouse*
7951 jsbterm JSB term mouse handling.
7952 *pterm-mouse*
7953 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007954 *urxvt-mouse*
7955 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007956 The mouse works only if the terminal supports this
7957 encoding style, but it does not have 223 columns limit
7958 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007959 *sgr-mouse*
7960 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007961 mouse reporting. The mouse works even in columns
7962 beyond 223. This option is backward compatible with
7963 "xterm2" because it can also decode "xterm2" style
7964 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965
7966 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007967 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7968 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7970 recognized, if enabled at compile time. DEC terminal mouse codes
7971 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007972 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7973 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02007975 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
7976 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
7977 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02007978 Additionally, if vim is compiled with the |+termresponse| feature and
7979 |t_RV| is set to the escape sequence to request the xterm version
7980 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007982 from 95 to 276. The "sgr" value will be set if the xterm version is
7983 277 or highter.
7984 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7985 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 :set t_RV=
7987<
7988 *'ttyscroll'* *'tsl'*
7989'ttyscroll' 'tsl' number (default 999)
7990 global
7991 Maximum number of lines to scroll the screen. If there are more lines
7992 to scroll the window is redrawn. For terminals where scrolling is
7993 very slow and redrawing is not slow this can be set to a small number,
7994 e.g., 3, to speed up displaying.
7995
7996 *'ttytype'* *'tty'*
7997'ttytype' 'tty' string (default from $TERM)
7998 global
7999 Alias for 'term', see above.
8000
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008001 *'undodir'* *'udir'*
8002'undodir' 'udir' string (default ".")
8003 global
8004 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008005 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008006 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008007 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008008 "." means using the directory of the file. The undo file name for
8009 "file.txt" is ".file.txt.un~".
8010 For other directories the file name is the full path of the edited
8011 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008012 When writing: The first directory that exists is used. "." always
8013 works, no directories after "." will be used for writing.
8014 When reading all entries are tried to find an undo file. The first
8015 undo file that exists is used. When it cannot be read an error is
8016 given, no further entry is used.
8017 See |undo-persistence|.
8018
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008019 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008020'undofile' 'udf' boolean (default off)
8021 local to buffer
8022 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008023 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008024 When on, Vim automatically saves undo history to an undo file when
8025 writing a buffer to a file, and restores undo history from the same
8026 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008027 The directory where the undo file is stored is specified by 'undodir'.
8028 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008029 The undo file is not read when 'undoreload' causes the buffer from
8030 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008031 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008032
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 *'undolevels'* *'ul'*
8034'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8035 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008036 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008037 {not in Vi}
8038 Maximum number of changes that can be undone. Since undo information
8039 is kept in memory, higher numbers will cause more memory to be used
8040 (nevertheless, a single change can use an unlimited amount of memory).
8041 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8042 itself: >
8043 set ul=0
8044< But you can also get Vi compatibility by including the 'u' flag in
8045 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008046 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008047 Set to -1 for no undo at all. You might want to do this only for the
8048 current buffer: >
8049 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008051
8052 The local value is set to -123456 when the global value is to be used.
8053
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008054 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008056 *'undoreload'* *'ur'*
8057'undoreload' 'ur' number (default 10000)
8058 global
8059 {not in Vi}
8060 Save the whole buffer for undo when reloading it. This applies to the
8061 ":e!" command and reloading for when the buffer changed outside of
8062 Vim. |FileChangedShell|
8063 The save only happens when this options is negative or when the number
8064 of lines is smaller than the value of this option.
8065 Set this option to zero to disable undo for a reload.
8066
8067 When saving undo for a reload, any undo file is not read.
8068
8069 Note that this causes the whole buffer to be stored in memory. Set
8070 this option to a lower value if you run out of memory.
8071
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 *'updatecount'* *'uc'*
8073'updatecount' 'uc' number (default: 200)
8074 global
8075 {not in Vi}
8076 After typing this many characters the swap file will be written to
8077 disk. When zero, no swap file will be created at all (see chapter on
8078 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8079 Vim with the "-n" option, see |startup|. When editing in readonly
8080 mode this option will be initialized to 10000.
8081 The swapfile can be disabled per buffer with |'swapfile'|.
8082 When 'updatecount' is set from zero to non-zero, swap files are
8083 created for all buffers that have 'swapfile' set. When 'updatecount'
8084 is set to zero, existing swap files are not deleted.
8085 Also see |'swapsync'|.
8086 This option has no meaning in buffers where |'buftype'| is "nofile"
8087 or "nowrite".
8088
8089 *'updatetime'* *'ut'*
8090'updatetime' 'ut' number (default 4000)
8091 global
8092 {not in Vi}
8093 If this many milliseconds nothing is typed the swap file will be
8094 written to disk (see |crash-recovery|). Also used for the
8095 |CursorHold| autocommand event.
8096
8097 *'verbose'* *'vbs'*
8098'verbose' 'vbs' number (default 0)
8099 global
8100 {not in Vi, although some versions have a boolean
8101 verbose option}
8102 When bigger than zero, Vim will give messages about what it is doing.
8103 Currently, these messages are given:
8104 >= 1 When the viminfo file is read or written.
8105 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008106 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107 >= 8 Files for which a group of autocommands is executed.
8108 >= 9 Every executed autocommand.
8109 >= 12 Every executed function.
8110 >= 13 When an exception is thrown, caught, finished, or discarded.
8111 >= 14 Anything pending in a ":finally" clause.
8112 >= 15 Every executed Ex command (truncated at 200 characters).
8113
8114 This option can also be set with the "-V" argument. See |-V|.
8115 This option is also set by the |:verbose| command.
8116
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008117 When the 'verbosefile' option is set then the verbose messages are not
8118 displayed.
8119
8120 *'verbosefile'* *'vfile'*
8121'verbosefile' 'vfile' string (default empty)
8122 global
8123 {not in Vi}
8124 When not empty all messages are written in a file with this name.
8125 When the file exists messages are appended.
8126 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008127 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008128 Setting 'verbosefile' to a new value is like making it empty first.
8129 The difference with |:redir| is that verbose messages are not
8130 displayed when 'verbosefile' is set.
8131
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 *'viewdir'* *'vdir'*
8133'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8134 "$VIM/vimfiles/view",
8135 for Unix: "~/.vim/view",
8136 for Macintosh: "$VIM:vimfiles:view"
8137 for VMS: "sys$login:vimfiles/view"
8138 for RiscOS: "Choices:vimfiles/view")
8139 global
8140 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008141 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 feature}
8143 Name of the directory where to store files for |:mkview|.
8144 This option cannot be set from a |modeline| or in the |sandbox|, for
8145 security reasons.
8146
8147 *'viewoptions'* *'vop'*
8148'viewoptions' 'vop' string (default: "folds,options,cursor")
8149 global
8150 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008151 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 feature}
8153 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008154 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 word save and restore ~
8156 cursor cursor position in file and in window
8157 folds manually created folds, opened/closed folds and local
8158 fold options
8159 options options and mappings local to a window or buffer (not
8160 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008161 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008162 slash backslashes in file names replaced with forward
8163 slashes
8164 unix with Unix end-of-line format (single <NL>), even when
8165 on Windows or DOS
8166
8167 "slash" and "unix" are useful on Windows when sharing view files
8168 with Unix. The Unix version of Vim cannot source dos format scripts,
8169 but the Windows version of Vim can source unix format scripts.
8170
8171 *'viminfo'* *'vi'* *E526* *E527* *E528*
8172'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008173 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8174 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8175 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 global
8177 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008178 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 feature}
8180 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008181 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 separated list of parameters, each consisting of a single character
8183 identifying the particular parameter, followed by a number or string
8184 which specifies the value of that parameter. If a particular
8185 character is left out, then the default value is used for that
8186 parameter. The following is a list of the identifying characters and
8187 the effect of their value.
8188 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008189 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 ! When included, save and restore global variables that start
8191 with an uppercase letter, and don't contain a lowercase
8192 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008193 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008194 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008195 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 " Maximum number of lines saved for each register. Old name of
8197 the '<' item, with the disadvantage that you need to put a
8198 backslash before the ", otherwise it will be recognized as the
8199 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008200 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 % When included, save and restore the buffer list. If Vim is
8202 started with a file name argument, the buffer list is not
8203 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008204 buffer list is restored from the viminfo file. Quickfix
8205 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8206 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008207 When followed by a number, the number specifies the maximum
8208 number of buffers that are stored. Without a number all
8209 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008210 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 ' Maximum number of previously edited files for which the marks
8212 are remembered. This parameter must always be included when
8213 'viminfo' is non-empty.
8214 Including this item also means that the |jumplist| and the
8215 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008216 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008218 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 patterns are also saved. When not included, the value of
8220 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008221 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008223 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008224 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008225 < Maximum number of lines saved for each register. If zero then
8226 registers are not saved. When not included, all lines are
8227 saved. '"' is the old name for this item.
8228 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008229 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008230 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008231 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008232 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233 c When included, convert the text in the viminfo file from the
8234 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008235 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008236 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237 f Whether file marks need to be stored. If zero, file marks ('0
8238 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008239 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008240 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008241 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 h Disable the effect of 'hlsearch' when loading the viminfo
8243 file. When not included, it depends on whether ":nohlsearch"
8244 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008245 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008246 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008247 the 'n'. Must be at the end of the option! If the "-i"
8248 argument was given when starting Vim, that file name overrides
8249 the one given here with 'viminfo'. Environment variables are
8250 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008251 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008252 r Removable media. The argument is a string (up to the next
8253 ','). This parameter can be given several times. Each
8254 specifies the start of a path for which no marks will be
8255 stored. This is to avoid removable media. For MS-DOS you
8256 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8257 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8258 ignored. Maximum length of each 'r' argument is 50
8259 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008260 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008261 s Maximum size of an item in Kbyte. If zero then registers are
8262 not saved. Currently only applies to registers. The default
8263 "s10" will exclude registers with more than 10 Kbyte of text.
8264 Also see the '<' item above: line count limit.
8265
8266 Example: >
8267 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8268<
8269 '50 Marks will be remembered for the last 50 files you
8270 edited.
8271 <1000 Contents of registers (up to 1000 lines each) will be
8272 remembered.
8273 s100 Registers with more than 100 Kbyte text are skipped.
8274 :0 Command-line history will not be saved.
8275 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8276 no / Since '/' is not specified, the default will be used,
8277 that is, save all of the search history, and also the
8278 previous search and substitute patterns.
8279 no % The buffer list will not be saved nor read back.
8280 no h 'hlsearch' highlighting will be restored.
8281
8282 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8283 load the contents of the file, this is not done automatically.
8284
8285 This option cannot be set from a |modeline| or in the |sandbox|, for
8286 security reasons.
8287
8288 *'virtualedit'* *'ve'*
8289'virtualedit' 've' string (default "")
8290 global
8291 {not in Vi}
8292 {not available when compiled without the
8293 |+virtualedit| feature}
8294 A comma separated list of these words:
8295 block Allow virtual editing in Visual block mode.
8296 insert Allow virtual editing in Insert mode.
8297 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008298 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008299
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008301 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 of the line. Useful for selecting a rectangle in Visual mode and
8303 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008304 "onemore" is not the same, it will only allow moving the cursor just
8305 after the last character of the line. This makes some commands more
8306 consistent. Previously the cursor was always past the end of the line
8307 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008308 break some plugins or Vim scripts. For example because |l| can move
8309 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008310 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008311 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008312 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008313 It doesn't make sense to combine "all" with "onemore", but you will
8314 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008315
8316 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8317'visualbell' 'vb' boolean (default off)
8318 global
8319 {not in Vi}
8320 Use visual bell instead of beeping. The terminal code to display the
8321 visual bell is given with 't_vb'. When no beep or flash is wanted,
8322 use ":set vb t_vb=".
8323 Note: When the GUI starts, 't_vb' is reset to its default value. You
8324 might want to set it again in your |gvimrc|.
8325 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8326 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8327 where 40 is the time in msec.
8328 Does not work on the Amiga, you always get a screen flash.
8329 Also see 'errorbells'.
8330
8331 *'warn'* *'nowarn'*
8332'warn' boolean (default on)
8333 global
8334 Give a warning message when a shell command is used while the buffer
8335 has been changed.
8336
8337 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8338'weirdinvert' 'wiv' boolean (default off)
8339 global
8340 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008341 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 It is provided for backwards compatibility with version 4.x.
8343 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8344 vice versa. Has no effect when the GUI is running.
8345
8346 *'whichwrap'* *'ww'*
8347'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8348 global
8349 {not in Vi}
8350 Allow specified keys that move the cursor left/right to move to the
8351 previous/next line when the cursor is on the first/last character in
8352 the line. Concatenate characters to allow this for these keys:
8353 char key mode ~
8354 b <BS> Normal and Visual
8355 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008356 h "h" Normal and Visual (not recommended)
8357 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 < <Left> Normal and Visual
8359 > <Right> Normal and Visual
8360 ~ "~" Normal
8361 [ <Left> Insert and Replace
8362 ] <Right> Insert and Replace
8363 For example: >
8364 :set ww=<,>,[,]
8365< allows wrap only when cursor keys are used.
8366 When the movement keys are used in combination with a delete or change
8367 operator, the <EOL> also counts for a character. This makes "3h"
8368 different from "3dh" when the cursor crosses the end of a line. This
8369 is also true for "x" and "X", because they do the same as "dl" and
8370 "dh". If you use this, you may also want to use the mapping
8371 ":map <BS> X" to make backspace delete the character in front of the
8372 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008373 When 'l' is included and it is used after an operator at the end of a
8374 line then it will not move to the next line. This makes "dl", "cl",
8375 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 NOTE: This option is set to the Vi default value when 'compatible' is
8377 set and to the Vim default value when 'compatible' is reset.
8378
8379 *'wildchar'* *'wc'*
8380'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8381 global
8382 {not in Vi}
8383 Character you have to type to start wildcard expansion in the
8384 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008385 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 The character is not recognized when used inside a macro. See
8387 'wildcharm' for that.
8388 Although 'wc' is a number option, you can set it to a special key: >
8389 :set wc=<Esc>
8390< NOTE: This option is set to the Vi default value when 'compatible' is
8391 set and to the Vim default value when 'compatible' is reset.
8392
8393 *'wildcharm'* *'wcm'*
8394'wildcharm' 'wcm' number (default: none (0))
8395 global
8396 {not in Vi}
8397 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008398 recognized when used inside a macro. You can find "spare" command-line
8399 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 you'll never actually type 'wildcharm', just use it in mappings that
8401 automatically invoke completion mode, e.g.: >
8402 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008403 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404< Then after typing :ss you can use CTRL-P & CTRL-N.
8405
8406 *'wildignore'* *'wig'*
8407'wildignore' 'wig' string (default "")
8408 global
8409 {not in Vi}
8410 {not available when compiled without the |+wildignore|
8411 feature}
8412 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008413 patterns is ignored when expanding |wildcards|, completing file or
8414 directory names, and influences the result of |expand()|, |glob()| and
8415 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8417 Also see 'suffixes'.
8418 Example: >
8419 :set wildignore=*.o,*.obj
8420< The use of |:set+=| and |:set-=| is preferred when adding or removing
8421 a pattern from the list. This avoids problems when a future version
8422 uses another default.
8423
Bram Moolenaar94950a92010-12-02 16:01:29 +01008424
Bram Moolenaar81af9252010-12-10 20:35:50 +01008425 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008426'wildignorecase' 'wic' boolean (default off)
8427 global
8428 {not in Vi}
8429 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008430 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008431 Does not apply when the shell is used to expand wildcards, which
8432 happens when there are special characters.
8433
8434
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008436'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 global
8438 {not in Vi}
8439 {not available if compiled without the |+wildmenu|
8440 feature}
8441 When 'wildmenu' is on, command-line completion operates in an enhanced
8442 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8443 the possible matches are shown just above the command line, with the
8444 first match highlighted (overwriting the status line, if there is
8445 one). Keys that show the previous/next match, such as <Tab> or
8446 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8447 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8448 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008449 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 If there are more matches than can fit in the line, a ">" is shown on
8451 the right and/or a "<" is shown on the left. The status line scrolls
8452 as needed.
8453 The "wildmenu" mode is abandoned when a key is hit that is not used
8454 for selecting a completion.
8455 While the "wildmenu" is active the following keys have special
8456 meanings:
8457
8458 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8459 <Down> - in filename/menu name completion: move into a
8460 subdirectory or submenu.
8461 <CR> - in menu completion, when the cursor is just after a
8462 dot: move into a submenu.
8463 <Up> - in filename/menu name completion: move up into
8464 parent directory or parent menu.
8465
8466 This makes the menus accessible from the console |console-menus|.
8467
8468 If you prefer the <Left> and <Right> keys to move the cursor instead
8469 of selecting a different match, use this: >
8470 :cnoremap <Left> <Space><BS><Left>
8471 :cnoremap <Right> <Space><BS><Right>
8472<
8473 The "WildMenu" highlighting is used for displaying the current match
8474 |hl-WildMenu|.
8475
8476 *'wildmode'* *'wim'*
8477'wildmode' 'wim' string (Vim default: "full")
8478 global
8479 {not in Vi}
8480 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008481 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008482 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 first part specifies the behavior for the first use of 'wildchar',
8484 The second part for the second use, etc.
8485 These are the possible values for each part:
8486 "" Complete only the first match.
8487 "full" Complete the next full match. After the last match,
8488 the original string is used and then the first match
8489 again.
8490 "longest" Complete till longest common string. If this doesn't
8491 result in a longer string, use the next part.
8492 "longest:full" Like "longest", but also start 'wildmenu' if it is
8493 enabled.
8494 "list" When more than one match, list all matches.
8495 "list:full" When more than one match, list all matches and
8496 complete first match.
8497 "list:longest" When more than one match, list all matches and
8498 complete till longest common string.
8499 When there is only a single match, it is fully completed in all cases.
8500
8501 Examples: >
8502 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008503< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 :set wildmode=longest,full
8505< Complete longest common string, then each full match >
8506 :set wildmode=list:full
8507< List all matches and complete each full match >
8508 :set wildmode=list,full
8509< List all matches without completing, then each full match >
8510 :set wildmode=longest,list
8511< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008512 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008514 *'wildoptions'* *'wop'*
8515'wildoptions' 'wop' string (default "")
8516 global
8517 {not in Vi}
8518 {not available when compiled without the |+wildignore|
8519 feature}
8520 A list of words that change how command line completion is done.
8521 Currently only one word is allowed:
8522 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008523 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008524 is displayed per line. Often used tag kinds are:
8525 d #define
8526 f function
8527 Also see |cmdline-completion|.
8528
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 *'winaltkeys'* *'wak'*
8530'winaltkeys' 'wak' string (default "menu")
8531 global
8532 {not in Vi}
8533 {only used in Win32, Motif, GTK and Photon GUI}
8534 Some GUI versions allow the access to menu entries by using the ALT
8535 key in combination with a character that appears underlined in the
8536 menu. This conflicts with the use of the ALT key for mappings and
8537 entering special characters. This option tells what to do:
8538 no Don't use ALT keys for menus. ALT key combinations can be
8539 mapped, but there is no automatic handling. This can then be
8540 done with the |:simalt| command.
8541 yes ALT key handling is done by the windowing system. ALT key
8542 combinations cannot be mapped.
8543 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008544 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 keys can be mapped.
8546 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8547 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008548 This option is not used for <F10>; on Win32 and with GTK <F10> will
8549 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008550
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008551 *'window'* *'wi'*
8552'window' 'wi' number (default screen height - 1)
8553 global
8554 Window height. Do not confuse this with the height of the Vim window,
8555 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008556 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8557 value is smaller than 'lines' minus one. The screen will scroll
8558 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008559 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8560 in a much smarter way, taking care of wrapping lines.
8561 When resizing the Vim window, the value is smaller than 1 or more than
8562 or equal to 'lines' it will be set to 'lines' minus 1.
8563 {Vi also uses the option to specify the number of displayed lines}
8564
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 *'winheight'* *'wh'* *E591*
8566'winheight' 'wh' number (default 1)
8567 global
8568 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008569 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 feature}
8571 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008572 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008573 focus goes to a window that is smaller, its size is increased, at the
8574 cost of the height of other windows.
8575 Set 'winheight' to a small number for normal editing.
8576 Set it to 999 to make the current window fill most of the screen.
8577 Other windows will be only 'winminheight' high. This has the drawback
8578 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8579 to create only two windows, set the option after startup is done,
8580 using the |VimEnter| event: >
8581 au VimEnter * set winheight=999
8582< Minimum value is 1.
8583 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584 height of the current window.
8585 'winheight' applies to the current window. Use 'winminheight' to set
8586 the minimal height for other windows.
8587
8588 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8589'winfixheight' 'wfh' boolean (default off)
8590 local to window
8591 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008592 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 feature}
8594 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008595 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8596 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008597 The height may be changed anyway when running out of room.
8598
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008599 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8600'winfixwidth' 'wfw' boolean (default off)
8601 local to window
8602 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008603 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008604 feature}
8605 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008606 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008607 The width may be changed anyway when running out of room.
8608
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609 *'winminheight'* *'wmh'*
8610'winminheight' 'wmh' number (default 1)
8611 global
8612 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008613 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 feature}
8615 The minimal height of a window, when it's not the current window.
8616 This is a hard minimum, windows will never become smaller.
8617 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8618 status bar) if necessary. They will return to at least one line when
8619 they become active (since the cursor has to have somewhere to go.)
8620 Use 'winheight' to set the minimal height of the current window.
8621 This option is only checked when making a window smaller. Don't use a
8622 large number, it will cause errors when opening more than a few
8623 windows. A value of 0 to 3 is reasonable.
8624
8625 *'winminwidth'* *'wmw'*
8626'winminwidth' 'wmw' number (default 1)
8627 global
8628 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008629 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 feature}
8631 The minimal width of a window, when it's not the current window.
8632 This is a hard minimum, windows will never become smaller.
8633 When set to zero, windows may be "squashed" to zero columns (i.e. just
8634 a vertical separator) if necessary. They will return to at least one
8635 line when they become active (since the cursor has to have somewhere
8636 to go.)
8637 Use 'winwidth' to set the minimal width of the current window.
8638 This option is only checked when making a window smaller. Don't use a
8639 large number, it will cause errors when opening more than a few
8640 windows. A value of 0 to 12 is reasonable.
8641
8642 *'winwidth'* *'wiw'* *E592*
8643'winwidth' 'wiw' number (default 20)
8644 global
8645 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008646 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008647 feature}
8648 Minimal number of columns for the current window. This is not a hard
8649 minimum, Vim will use fewer columns if there is not enough room. If
8650 the current window is smaller, its size is increased, at the cost of
8651 the width of other windows. Set it to 999 to make the current window
8652 always fill the screen. Set it to a small number for normal editing.
8653 The width is not adjusted after one of the commands to change the
8654 width of the current window.
8655 'winwidth' applies to the current window. Use 'winminwidth' to set
8656 the minimal width for other windows.
8657
8658 *'wrap'* *'nowrap'*
8659'wrap' boolean (default on)
8660 local to window
8661 {not in Vi}
8662 This option changes how text is displayed. It doesn't change the text
8663 in the buffer, see 'textwidth' for that.
8664 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008665 displaying continues on the next line. When off lines will not wrap
8666 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 moved to a part that is not shown, the screen will scroll
8668 horizontally.
8669 The line will be broken in the middle of a word if necessary. See
8670 'linebreak' to get the break at a word boundary.
8671 To make scrolling horizontally a bit more useful, try this: >
8672 :set sidescroll=5
8673 :set listchars+=precedes:<,extends:>
8674< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008675 This option can't be set from a |modeline| when the 'diff' option is
8676 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677
8678 *'wrapmargin'* *'wm'*
8679'wrapmargin' 'wm' number (default 0)
8680 local to buffer
8681 Number of characters from the right window border where wrapping
8682 starts. When typing text beyond this limit, an <EOL> will be inserted
8683 and inserting continues on the next line.
8684 Options that add a margin, such as 'number' and 'foldcolumn', cause
8685 the text width to be further reduced. This is Vi compatible.
8686 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008687 This option is set to 0 when 'paste' is set and restored when 'paste'
8688 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8690 and less usefully}
8691
8692 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8693'wrapscan' 'ws' boolean (default on) *E384* *E385*
8694 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008695 Searches wrap around the end of the file. Also applies to |]s| and
8696 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008697
8698 *'write'* *'nowrite'*
8699'write' boolean (default on)
8700 global
8701 {not in Vi}
8702 Allows writing files. When not set, writing a file is not allowed.
8703 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008704 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705 argument. Filtering text is still possible, even though this requires
8706 writing a temporary file.
8707
8708 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8709'writeany' 'wa' boolean (default off)
8710 global
8711 Allows writing to any file with no need for "!" override.
8712
8713 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8714'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8715 otherwise)
8716 global
8717 {not in Vi}
8718 Make a backup before overwriting a file. The backup is removed after
8719 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008720 also on.
8721 WARNING: Switching this option off means that when Vim fails to write
8722 your buffer correctly and then, for whatever reason, Vim exits, you
8723 lose both the original file and what you were writing. Only reset
8724 this option if your file system is almost full and it makes the write
8725 fail (and make sure not to exit Vim until the write was successful).
8726 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 When the 'backupskip' pattern matches, a backup is not made anyway.
8728 NOTE: This option is set to the default value when 'compatible' is
8729 set.
8730
8731 *'writedelay'* *'wd'*
8732'writedelay' 'wd' number (default 0)
8733 global
8734 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008735 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 screen. When non-zero, characters are sent to the terminal one by
8737 one. For MS-DOS pcterm this does not work. For debugging purposes.
8738
8739 vim:tw=78:ts=8:ft=help:norl: